Class VideoGrant

What an access token lets its holder do in LiveKit rooms, the video claim; unset permissions are left out of the token, and LiveKit reads a missing publish or subscribe permission as allowed.

Inheritance

object

VideoGrant

Implements

IEquatable<VideoGrant>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.LiveKit.Protocol

Assembly: Uniform.LiveKit.Protocol.dll

Syntax

public sealed record VideoGrant : IEquatable<VideoGrant>

Properties

| Edit this page View Source

CanPublish

Allow publishing audio and video.

Declaration

[JsonPropertyName("canPublish")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? CanPublish { get; init; }

Property Value

Type	Description
bool?

| Edit this page View Source

CanPublishData

Allow sending data messages.

Declaration

[JsonPropertyName("canPublishData")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? CanPublishData { get; init; }

Property Value

Type	Description
bool?

| Edit this page View Source

CanSubscribe

Allow subscribing to others' tracks.

Declaration

[JsonPropertyName("canSubscribe")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? CanSubscribe { get; init; }

Property Value

Type	Description
bool?

| Edit this page View Source

CanUpdateOwnMetadata

Allow changing one's own name and metadata.

Declaration

[JsonPropertyName("canUpdateOwnMetadata")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? CanUpdateOwnMetadata { get; init; }

Property Value

Type	Description
bool?

| Edit this page View Source

Hidden

Hide the participant from others.

Declaration

[JsonPropertyName("hidden")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? Hidden { get; init; }

Property Value

Type	Description
bool?

| Edit this page View Source

Room

Name of the room the grant is for.

Declaration

[JsonPropertyName("room")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Room { get; init; }

Property Value

Type	Description
string

| Edit this page View Source

RoomAdmin

Allow managing Room, e.g. removing participants.

Declaration

[JsonPropertyName("roomAdmin")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? RoomAdmin { get; init; }

Property Value

Type	Description
bool?

| Edit this page View Source

RoomCreate

Allow creating rooms.

Declaration

[JsonPropertyName("roomCreate")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? RoomCreate { get; init; }

Property Value

Type	Description
bool?

| Edit this page View Source

RoomJoin

Allow joining Room.

Declaration

[JsonPropertyName("roomJoin")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? RoomJoin { get; init; }

Property Value

Type	Description
bool?

| Edit this page View Source

RoomList

Allow listing rooms.

Declaration

[JsonPropertyName("roomList")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? RoomList { get; init; }

Property Value

Type	Description
bool?

Implements

IEquatable<T>