Class SpeakerInfo
Inherited Members
Namespace: LiveKit.Proto
Assembly: Uniform.LiveKit.Protocol.dll
Syntax
public sealed class SpeakerInfo : IMessage<SpeakerInfo>, IEquatable<SpeakerInfo>, IDeepCloneable<SpeakerInfo>, IBufferMessage, IMessage
Constructors
SpeakerInfo()
Declaration
public SpeakerInfo()
SpeakerInfo(SpeakerInfo)
Declaration
public SpeakerInfo(SpeakerInfo other)
Parameters
| Type | Name | Description |
|---|---|---|
| SpeakerInfo | other |
Fields
ActiveFieldNumber
Field number for the "active" field.
Declaration
public const int ActiveFieldNumber = 3
Field Value
| Type | Description |
|---|---|
| int |
LevelFieldNumber
Field number for the "level" field.
Declaration
public const int LevelFieldNumber = 2
Field Value
| Type | Description |
|---|---|
| int |
SidFieldNumber
Field number for the "sid" field.
Declaration
public const int SidFieldNumber = 1
Field Value
| Type | Description |
|---|---|
| int |
Properties
Active
true if speaker is currently active
Declaration
public bool Active { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Descriptor
Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
| Type | Description |
|---|---|
| MessageDescriptor |
Level
audio level, 0-1.0, 1 is loudest
Declaration
public float Level { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
Parser
Declaration
public static MessageParser<SpeakerInfo> Parser { get; }
Property Value
| Type | Description |
|---|---|
| MessageParser<SpeakerInfo> |
Sid
Declaration
public string Sid { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
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 SpeakerInfo Clone()
Returns
| Type | Description |
|---|---|
| SpeakerInfo | A deep clone of this object. |
Equals(SpeakerInfo)
Indicates whether the current object is equal to another object of the same type.
Declaration
public bool Equals(SpeakerInfo other)
Parameters
| Type | Name | Description |
|---|---|---|
| SpeakerInfo | other | An object to compare with this object. |
Returns
| Type | Description |
|---|---|
| bool | true if the current object is equal to the |
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
GetHashCode()
Serves as the default hash function.
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| int | A hash code for the current object. |
Overrides
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(SpeakerInfo)
Merges the given message into this one.
Declaration
public void MergeFrom(SpeakerInfo other)
Parameters
| Type | Name | Description |
|---|---|---|
| SpeakerInfo | 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
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. |