Table of Contents

Class StartSession

Namespace
LiveKit.Proto
Assembly
LiveKit.AspNetCore.ServerSdk.Abstractions.dll
public sealed class StartSession : IMessage<StartSession>, IEquatable<StartSession>, IDeepCloneable<StartSession>, IBufferMessage, IMessage
Inheritance
StartSession
Implements
IMessage<StartSession>
IDeepCloneable<StartSession>
IBufferMessage
IMessage
Inherited Members

Constructors

StartSession() 

public StartSession()

StartSession(StartSession) 

public StartSession(StartSession other)

Parameters

other StartSession

Fields

AdaptiveStreamFieldNumber

Field number for the "adaptive_stream" field.

public const int AdaptiveStreamFieldNumber = 15

Field Value

int

AddTrackRequestsFieldNumber

Field number for the "add_track_requests" field.

public const int AddTrackRequestsFieldNumber = 21

Field Value

int

AutoSubscribeDataTrackFieldNumber

Field number for the "auto_subscribe_data_track" field.

public const int AutoSubscribeDataTrackFieldNumber = 25

Field Value

int

AutoSubscribeFieldNumber

Field number for the "auto_subscribe" field.

public const int AutoSubscribeFieldNumber = 9

Field Value

int

ClientFieldNumber

Field number for the "client" field.

public const int ClientFieldNumber = 11

Field Value

int

ConnectionIdFieldNumber

Field number for the "connection_id" field.

public const int ConnectionIdFieldNumber = 3

Field Value

int

CreateRoomFieldNumber

Field number for the "create_room" field.

public const int CreateRoomFieldNumber = 20

Field Value

int

DisableIceLiteFieldNumber

Field number for the "disable_ice_lite" field.

public const int DisableIceLiteFieldNumber = 19

Field Value

int

GrantsJsonFieldNumber

Field number for the "grants_json" field.

public const int GrantsJsonFieldNumber = 14

Field Value

int

HiddenFieldNumber

Field number for the "hidden" field.

public const int HiddenFieldNumber = 10

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 2

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 13

Field Value

int

ParticipantIdFieldNumber

Field number for the "participant_id" field.

public const int ParticipantIdFieldNumber = 16

Field Value

int

PublisherOfferFieldNumber

Field number for the "publisher_offer" field.

public const int PublisherOfferFieldNumber = 22

Field Value

int

ReconnectFieldNumber

Field number for the "reconnect" field.

public const int ReconnectFieldNumber = 4

Field Value

int

ReconnectReasonFieldNumber

Field number for the "reconnect_reason" field.

public const int ReconnectReasonFieldNumber = 17

Field Value

int

RecorderFieldNumber

Field number for the "recorder" field.

public const int RecorderFieldNumber = 12

Field Value

int

RoomNameFieldNumber

Field number for the "room_name" field.

public const int RoomNameFieldNumber = 1

Field Value

int

SubscriberAllowPauseFieldNumber

Field number for the "subscriber_allow_pause" field.

public const int SubscriberAllowPauseFieldNumber = 18

Field Value

int

SyncStateFieldNumber

Field number for the "sync_state" field.

public const int SyncStateFieldNumber = 23

Field Value

int

UseSinglePeerConnectionFieldNumber

Field number for the "use_single_peer_connection" field.

public const int UseSinglePeerConnectionFieldNumber = 24

Field Value

int

Properties

AdaptiveStream 

public bool AdaptiveStream { get; set; }

Property Value

bool

AddTrackRequests 

public RepeatedField<AddTrackRequest> AddTrackRequests { get; }

Property Value

RepeatedField<AddTrackRequest>

AutoSubscribe 

public bool AutoSubscribe { get; set; }

Property Value

bool

AutoSubscribeDataTrack 

public bool AutoSubscribeDataTrack { get; set; }

Property Value

bool

Client 

public ClientInfo Client { get; set; }

Property Value

ClientInfo

ConnectionId 

public string ConnectionId { get; set; }

Property Value

string

CreateRoom 

public CreateRoomRequest CreateRoom { get; set; }

Property Value

CreateRoomRequest

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

DisableIceLite 

public bool DisableIceLite { get; set; }

Property Value

bool

GrantsJson

A user's ClaimGrants serialized in JSON

public string GrantsJson { get; set; }

Property Value

string

HasAutoSubscribeDataTrack

Gets whether the "auto_subscribe_data_track" field is set

public bool HasAutoSubscribeDataTrack { get; }

Property Value

bool

HasSubscriberAllowPause

Gets whether the "subscriber_allow_pause" field is set

public bool HasSubscriberAllowPause { get; }

Property Value

bool

Hidden 

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

Property Value

bool

Identity 

public string Identity { get; set; }

Property Value

string

Name 

public string Name { get; set; }

Property Value

string

Parser 

public static MessageParser<StartSession> Parser { get; }

Property Value

MessageParser<StartSession>

ParticipantId

if reconnect, client will set current sid

public string ParticipantId { get; set; }

Property Value

string

PublisherOffer 

public SessionDescription PublisherOffer { get; set; }

Property Value

SessionDescription

Reconnect

if a client is reconnecting (i.e. resume instead of restart)

public bool Reconnect { get; set; }

Property Value

bool

ReconnectReason 

public ReconnectReason ReconnectReason { get; set; }

Property Value

ReconnectReason

Recorder 

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

Property Value

bool

RoomName 

public string RoomName { get; set; }

Property Value

string

SubscriberAllowPause 

public bool SubscriberAllowPause { get; set; }

Property Value

bool

SyncState 

public SyncState SyncState { get; set; }

Property Value

SyncState

UseSinglePeerConnection 

public bool UseSinglePeerConnection { 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.

ClearAutoSubscribeDataTrack()

Clears the value of the "auto_subscribe_data_track" field

public void ClearAutoSubscribeDataTrack()

ClearSubscriberAllowPause()

Clears the value of the "subscriber_allow_pause" field

public void ClearSubscriberAllowPause()

Clone()

Creates a deep clone of this object.

public StartSession Clone()

Returns

StartSession

A deep clone of this object.

Equals(StartSession) 

public bool Equals(StartSession other)

Parameters

other StartSession

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

Merges the given message into this one.

public void MergeFrom(StartSession other)

Parameters

other StartSession

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.

Edit this page