Class StartSession

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.dll

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

Inheritance

object

StartSession

Implements

IMessage<StartSession>

IEquatable<StartSession>

IDeepCloneable<StartSession>

IBufferMessage

IMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

StartSession()

public StartSession()

StartSession(StartSession)

public StartSession(StartSession other)

Parameters

other StartSession

Properties

AdaptiveStream

public bool AdaptiveStream { get; set; }

Property Value

bool

AddTrackRequests

public RepeatedField<AddTrackRequest> AddTrackRequests { get; }

Property Value

RepeatedField<AddTrackRequest>

ApiKey

API key that issued the join token, for correlating sessions with the key

public string ApiKey { get; set; }

Property Value

string

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

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

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

TokenExpiresAt

public long TokenExpiresAt { get; set; }

Property Value

long

UseSinglePeerConnection

public bool UseSinglePeerConnection { get; set; }

Property Value

bool

Methods

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