Class TransferSIPParticipantRequest

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

Inheritance

object

TransferSIPParticipantRequest

Implements

IMessage<TransferSIPParticipantRequest>

IEquatable<TransferSIPParticipantRequest>

IDeepCloneable<TransferSIPParticipantRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

TransferSIPParticipantRequest()

public TransferSIPParticipantRequest()

TransferSIPParticipantRequest(TransferSIPParticipantRequest)

public TransferSIPParticipantRequest(TransferSIPParticipantRequest other)

Parameters

other TransferSIPParticipantRequest

Fields

HeadersFieldNumber

Field number for the "headers" field.

public const int HeadersFieldNumber = 5

Field Value

int

ParticipantIdentityFieldNumber

Field number for the "participant_identity" field.

public const int ParticipantIdentityFieldNumber = 1

Field Value

int

PlayDialtoneFieldNumber

Field number for the "play_dialtone" field.

public const int PlayDialtoneFieldNumber = 4

Field Value

int

RingingTimeoutFieldNumber

Field number for the "ringing_timeout" field.

public const int RingingTimeoutFieldNumber = 6

Field Value

int

RoomNameFieldNumber

Field number for the "room_name" field.

public const int RoomNameFieldNumber = 2

Field Value

int

TransferToFieldNumber

Field number for the "transfer_to" field.

public const int TransferToFieldNumber = 3

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Headers

Add the following headers to the REFER SIP request.

public MapField<string, string> Headers { get; }

Property Value

MapField<string, string>

Parser

public static MessageParser<TransferSIPParticipantRequest> Parser { get; }

Property Value

MessageParser<TransferSIPParticipantRequest>

ParticipantIdentity

public string ParticipantIdentity { get; set; }

Property Value

string

PlayDialtone

Optionally play dialtone to the SIP participant as an audible indicator of being transferred

public bool PlayDialtone { get; set; }

Property Value

bool

RingingTimeout

Max time for the transfer destination to answer the call.

public Duration RingingTimeout { get; set; }

Property Value

Duration

RoomName

public string RoomName { get; set; }

Property Value

string

TransferTo

public string TransferTo { get; set; }

Property Value

string

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 TransferSIPParticipantRequest Clone()

Returns

TransferSIPParticipantRequest

A deep clone of this object.

Equals(TransferSIPParticipantRequest)

public bool Equals(TransferSIPParticipantRequest other)

Parameters

other TransferSIPParticipantRequest

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(TransferSIPParticipantRequest)

Merges the given message into this one.

public void MergeFrom(TransferSIPParticipantRequest other)

Parameters

other TransferSIPParticipantRequest

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.