Class VideoGrants

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.dll

The video grant of an access token: what its holder may do in rooms.

public class VideoGrants

Inheritance

object

VideoGrants

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Agent

Participant allowed to connect to LiveKit as Agent Framework worker.

public bool Agent { get; set; }

Property Value

bool

CanManageAgentSession

Allow participant to manage an agent session via RemoteSession.

public bool CanManageAgentSession { get; set; }

Property Value

bool

CanPublish

Permission to publish tracks. Defaults to true.

public bool CanPublish { get; set; }

Property Value

bool

CanPublishData

Permission to publish data messages. Defaults to true.

public bool CanPublishData { get; set; }

Property Value

bool

CanPublishSources

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

public List<string> CanPublishSources { get; set; }

Property Value

List<string>

CanSubscribe

Permission to subscribe to the tracks of other participants. Defaults to true.

public bool CanSubscribe { get; set; }

Property Value

bool

CanSubscribeMetrics

Allow participant to subscribe to metrics.

public bool CanSubscribeMetrics { get; set; }

Property Value

bool

CanUpdateOwnMetadata

Permission to update its own name, metadata and attributes. Defaults to false.

public bool CanUpdateOwnMetadata { get; set; }

Property Value

bool

DestinationRoom

Destination room which this participant can forward to.

public string DestinationRoom { get; set; }

Property Value

string

Hidden

Participant isn't visible to others.

public bool Hidden { get; set; }

Property Value

bool

IngressAdmin

Permissions to control ingress, not specific to any room or ingress.

public bool IngressAdmin { get; set; }

Property Value

bool

Recorder

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

public bool Recorder { get; set; }

Property Value

bool

Room

Name of the room, must be set for RoomAdmin or RoomJoin permissions.

public string Room { get; set; }

Property Value

string

RoomAdmin

Permission to control a specific room, Room must be set.

public bool RoomAdmin { get; set; }

Property Value

bool

RoomCreate

Permission to create a room.

public bool RoomCreate { get; set; }

Property Value

bool

RoomJoin

Permission to join a room as a participant, Room must be set.

public bool RoomJoin { get; set; }

Property Value

bool

RoomList

Permission to list rooms.

public bool RoomList { get; set; }

Property Value

bool

RoomRecord

Permission to start a recording.

public bool RoomRecord { get; set; }

Property Value

bool