Interface VideoGrant

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

Properties

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

Properties

Optionalagent

agent?: boolean

participant allowed to connect to LiveKit as Agent Framework worker

OptionalcanPublish

canPublish?: boolean

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

OptionalcanPublishData

canPublishData?: boolean

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

OptionalcanPublishSources

canPublishSources?: TrackSource[]

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

OptionalcanSubscribe

canSubscribe?: boolean

allow participant to subscribe to other tracks

OptionalcanSubscribeMetrics

canSubscribeMetrics?: boolean

allow participant to subscribe to metrics

OptionalcanUpdateOwnMetadata

canUpdateOwnMetadata?: boolean

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

Optionalhidden

hidden?: boolean

participant isn't visible to others

OptionalingressAdmin

ingressAdmin?: boolean

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

Optionalrecorder

recorder?: boolean

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

Optionalroom

room?: string

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

OptionalroomAdmin

roomAdmin?: boolean

permission to control a specific room, room must be set

OptionalroomCreate

roomCreate?: boolean

permission to create a room

OptionalroomJoin

roomJoin?: boolean

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

OptionalroomList

roomList?: boolean

permission to list rooms

OptionalroomRecord

roomRecord?: boolean

permission to start a recording

Settings

Member Visibility

On This Page

Properties