LiveKit JS Client SDK - v2.15.14
    Preparing search index...

    Interface ParticipantTrackPermission

    interface ParticipantTrackPermission {
        allowAll?: boolean;
        allowedTrackSids?: string[];
        participantIdentity?: string;
        participantSid?: string;
    }
    Index

    Properties

    allowAll? allowedTrackSids? participantIdentity? participantSid?

    Properties

    allowAll?: boolean

    Grant permission to all all tracks. Takes precedence over allowedTrackSids. false if unset.

    allowedTrackSids?: string[]

    The list of track ids that the target participant can subscribe to. When unset, it'll allow all tracks to be subscribed by the participant. When empty, this participant is disallowed from subscribing to any tracks.

    participantIdentity?: string

    The participant identity this permission applies to. You can either provide this or participantSid

    participantSid?: string

    The participant server id this permission applies to. You can either provide this or participantIdentity

    Settings

    Member Visibility

    On This Page

    Properties