LiveKit JS Server SDK - v2.14.0
    Preparing search index...

    Interface VideoGrant

    interface VideoGrant {
        agent?: boolean;
        canPublish?: boolean;
        canPublishData?: boolean;
        canPublishSources?: TrackSource[];
        canSubscribe?: boolean;
        canSubscribeMetrics?: boolean;
        canUpdateOwnMetadata?: boolean;
        destinationRoom?: string;
        hidden?: boolean;
        ingressAdmin?: boolean;
        recorder?: boolean;
        room?: string;
        roomAdmin?: boolean;
        roomCreate?: boolean;
        roomJoin?: boolean;
        roomList?: boolean;
        roomRecord?: boolean;
    }
    Index

    Properties

    agent? canPublish? canPublishData? canPublishSources? canSubscribe? canSubscribeMetrics? canUpdateOwnMetadata? destinationRoom? hidden? ingressAdmin? recorder? room? roomAdmin? roomCreate? roomJoin? roomList? roomRecord?

    Properties

    agent?: boolean

    participant allowed to connect to LiveKit as Agent Framework worker

    canPublish?: boolean

    allow participant to publish. If neither canPublish or canSubscribe is set, both publish and subscribe are enabled

    canPublishData?: boolean

    allow participants to publish data, defaults to true if not set

    canPublishSources?: TrackSource[]

    TrackSource types that the participant is allowed to publish When set, it supersedes CanPublish. Only sources explicitly set here can be published

    canSubscribe?: boolean

    allow participant to subscribe to other tracks

    canSubscribeMetrics?: boolean

    allow participant to subscribe to metrics

    canUpdateOwnMetadata?: boolean

    by default, a participant is not allowed to update its own metadata

    destinationRoom?: string

    destination room which this participant can forward to

    hidden?: boolean

    participant isn't visible to others

    ingressAdmin?: boolean

    permissions to control ingress, not specific to any room or ingress

    recorder?: boolean

    participant is recording the room, when set, allows room to indicate it's being recorded

    room?: string

    name of the room, must be set for admin or join permissions

    roomAdmin?: boolean

    permission to control a specific room, room must be set

    roomCreate?: boolean

    permission to create a room

    roomJoin?: boolean

    permission to join a room as a participant, room must be set

    roomList?: boolean

    permission to list rooms

    roomRecord?: boolean

    permission to start a recording

    Settings

    Member Visibility

    On This Page

    Properties