Class VideoGrant

Namespace

LiveKit.Authentication

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

Video grant containing room permissions and participant capabilities.

Room permissions are specified in the video field of a decoded join token. See Video Grant Documentation for details on available permissions.

public sealed class VideoGrant

Inheritance

object

VideoGrant

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

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?

CanPublish

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

public bool? CanPublish { get; set; }

Property Value

bool?

CanPublishData

Allow participants to publish data, defaults to true if not set.

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. TrackSource

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

Property Value

List<string>

CanSubscribe

Allow participant to subscribe to other tracks.

public bool? CanSubscribe { get; set; }

Property Value

bool?

CanSubscribeMetrics

Allow participant to subscribe to metrics.

public bool? CanSubscribeMetrics { get; set; }

Property Value

bool?

CanUpdateOwnMetadata

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

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

Hide participant from others in the room.

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 admin or join 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 or delete rooms.

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 available rooms.

public bool? RoomList { get; set; }

Property Value

bool?

RoomRecord

Permission to start a recording. Permissions to use Egress service.

public bool? RoomRecord { get; set; }

Property Value

bool?