Class ParticipantPermission

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

public sealed class ParticipantPermission : IMessage<ParticipantPermission>, IEquatable<ParticipantPermission>, IDeepCloneable<ParticipantPermission>, IBufferMessage, IMessage

Inheritance

object

ParticipantPermission

Implements

IMessage<ParticipantPermission>

IEquatable<ParticipantPermission>

IDeepCloneable<ParticipantPermission>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ParticipantPermission()

public ParticipantPermission()

ParticipantPermission(ParticipantPermission)

public ParticipantPermission(ParticipantPermission other)

Parameters

other ParticipantPermission

Fields

AgentFieldNumber

Field number for the "agent" field.

public const int AgentFieldNumber = 11

Field Value

int

CanManageAgentSessionFieldNumber

Field number for the "can_manage_agent_session" field.

public const int CanManageAgentSessionFieldNumber = 13

Field Value

int

CanPublishDataFieldNumber

Field number for the "can_publish_data" field.

public const int CanPublishDataFieldNumber = 3

Field Value

int

CanPublishFieldNumber

Field number for the "can_publish" field.

public const int CanPublishFieldNumber = 2

Field Value

int

CanPublishSourcesFieldNumber

Field number for the "can_publish_sources" field.

public const int CanPublishSourcesFieldNumber = 9

Field Value

int

CanSubscribeFieldNumber

Field number for the "can_subscribe" field.

public const int CanSubscribeFieldNumber = 1

Field Value

int

CanSubscribeMetricsFieldNumber

Field number for the "can_subscribe_metrics" field.

public const int CanSubscribeMetricsFieldNumber = 12

Field Value

int

CanUpdateMetadataFieldNumber

Field number for the "can_update_metadata" field.

public const int CanUpdateMetadataFieldNumber = 10

Field Value

int

HiddenFieldNumber

Field number for the "hidden" field.

public const int HiddenFieldNumber = 7

Field Value

int

RecorderFieldNumber

Field number for the "recorder" field.

public const int RecorderFieldNumber = 8

Field Value

int

Properties

Agent

indicates that participant is an agent deprecated: use ParticipantInfo.kind instead

[Obsolete]
public bool Agent { get; set; }

Property Value

bool

CanManageAgentSession

if a participant can manage an agent session via RemoteSession (control and access state)

public bool CanManageAgentSession { get; set; }

Property Value

bool

CanPublish

allow participant to publish new tracks to room

public bool CanPublish { get; set; }

Property Value

bool

CanPublishData

allow participant to publish data

public bool CanPublishData { get; set; }

Property Value

bool

CanPublishSources

sources that are allowed to be published

public RepeatedField<TrackSource> CanPublishSources { get; }

Property Value

RepeatedField<TrackSource>

CanSubscribe

allow participant to subscribe to other tracks in the room

public bool CanSubscribe { get; set; }

Property Value

bool

CanSubscribeMetrics

if a participant can subscribe to metrics

public bool CanSubscribeMetrics { get; set; }

Property Value

bool

CanUpdateMetadata

indicates that participant can update own metadata and attributes

public bool CanUpdateMetadata { get; set; }

Property Value

bool

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Hidden

indicates that it's hidden to others

public bool Hidden { get; set; }

Property Value

bool

Parser

public static MessageParser<ParticipantPermission> Parser { get; }

Property Value

MessageParser<ParticipantPermission>

Recorder

indicates it's a recorder instance deprecated: use ParticipantInfo.kind instead

[Obsolete]
public bool Recorder { get; set; }

Property Value

bool

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public ParticipantPermission Clone()

Returns

ParticipantPermission

A deep clone of this object.

Equals(ParticipantPermission)

public bool Equals(ParticipantPermission other)

Parameters

other ParticipantPermission

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(ParticipantPermission)

Merges the given message into this one.

public void MergeFrom(ParticipantPermission other)

Parameters

other ParticipantPermission

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.