Class ParticipantPermission

Inheritance

object

ParticipantPermission

Implements

IMessage<ParticipantPermission>

IEquatable<ParticipantPermission>

IDeepCloneable<ParticipantPermission>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: LiveKit.Proto

Assembly: Uniform.LiveKit.Protocol.dll

Syntax

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

Constructors

ParticipantPermission()

Declaration

public ParticipantPermission()

ParticipantPermission(ParticipantPermission)

Declaration

public ParticipantPermission(ParticipantPermission other)

Parameters

Type	Name	Description
ParticipantPermission	other

Fields

AgentFieldNumber

Field number for the "agent" field.

Declaration

public const int AgentFieldNumber = 11

Field Value

Type	Description
int

CanManageAgentSessionFieldNumber

Field number for the "can_manage_agent_session" field.

Declaration

public const int CanManageAgentSessionFieldNumber = 13

Field Value

Type	Description
int

CanPublishDataFieldNumber

Field number for the "can_publish_data" field.

Declaration

public const int CanPublishDataFieldNumber = 3

Field Value

Type	Description
int

CanPublishFieldNumber

Field number for the "can_publish" field.

Declaration

public const int CanPublishFieldNumber = 2

Field Value

Type	Description
int

CanPublishSourcesFieldNumber

Field number for the "can_publish_sources" field.

Declaration

public const int CanPublishSourcesFieldNumber = 9

Field Value

Type	Description
int

CanSubscribeFieldNumber

Field number for the "can_subscribe" field.

Declaration

public const int CanSubscribeFieldNumber = 1

Field Value

Type	Description
int

CanSubscribeMetricsFieldNumber

Field number for the "can_subscribe_metrics" field.

Declaration

public const int CanSubscribeMetricsFieldNumber = 12

Field Value

Type	Description
int

CanUpdateMetadataFieldNumber

Field number for the "can_update_metadata" field.

Declaration

public const int CanUpdateMetadataFieldNumber = 10

Field Value

Type	Description
int

HiddenFieldNumber

Field number for the "hidden" field.

Declaration

public const int HiddenFieldNumber = 7

Field Value

Type	Description
int

RecorderFieldNumber

Field number for the "recorder" field.

Declaration

public const int RecorderFieldNumber = 8

Field Value

Type	Description
int

Properties

Agent

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

Declaration

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

Property Value

Type	Description
bool

CanManageAgentSession

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

Declaration

public bool CanManageAgentSession { get; set; }

Property Value

Type	Description
bool

CanPublish

allow participant to publish new tracks to room

Declaration

public bool CanPublish { get; set; }

Property Value

Type	Description
bool

CanPublishData

allow participant to publish data

Declaration

public bool CanPublishData { get; set; }

Property Value

Type	Description
bool

CanPublishSources

sources that are allowed to be published

Declaration

public RepeatedField<TrackSource> CanPublishSources { get; }

Property Value

Type	Description
RepeatedField<TrackSource>

CanSubscribe

allow participant to subscribe to other tracks in the room

Declaration

public bool CanSubscribe { get; set; }

Property Value

Type	Description
bool

CanSubscribeMetrics

if a participant can subscribe to metrics

Declaration

public bool CanSubscribeMetrics { get; set; }

Property Value

Type	Description
bool

CanUpdateMetadata

indicates that participant can update own metadata and attributes

Declaration

public bool CanUpdateMetadata { get; set; }

Property Value

Type	Description
bool

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

Hidden

indicates that it's hidden to others

Declaration

public bool Hidden { get; set; }

Property Value

Type	Description
bool

Parser

Declaration

public static MessageParser<ParticipantPermission> Parser { get; }

Property Value

Type	Description
MessageParser<ParticipantPermission>

Recorder

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

Declaration

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

Property Value

Type	Description
bool

Methods

CalculateSize()

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

Declaration

public int CalculateSize()

Returns

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

Clone()

Creates a deep clone of this object.

Declaration

public ParticipantPermission Clone()

Returns

Type	Description
ParticipantPermission	A deep clone of this object.

Equals(ParticipantPermission)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(ParticipantPermission other)

Parameters

Type	Name	Description
ParticipantPermission	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

MergeFrom(CodedInputStream)

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

Declaration

public void MergeFrom(CodedInputStream input)

Parameters

Type	Name	Description
CodedInputStream	input

Remarks

See the user guide for precise merge semantics.

MergeFrom(ParticipantPermission)

Merges the given message into this one.

Declaration

public void MergeFrom(ParticipantPermission other)

Parameters

Type	Name	Description
ParticipantPermission	other

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

Declaration

public void WriteTo(CodedOutputStream output)

Parameters

Type	Name	Description
CodedOutputStream	output	Coded output stream to write the data to. Must not be null.

Implements

Google.Protobuf.IMessage<T>

IEquatable<T>

Google.Protobuf.IDeepCloneable<T>

Google.Protobuf.IBufferMessage

Google.Protobuf.IMessage