Class LiveKitOptions

Settings of the MatrixRTC authorization service in section LiveKit, e.g. --LiveKit:Enabled=true --LiveKit:Url=wss://livekit.example.org; changes apply at the next request.

Inheritance

object

LiveKitOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.LiveKit.Hosting

Assembly: Uniform.LiveKit.Hosting.dll

Syntax

public sealed class LiveKitOptions

Fields

Section

Configuration section.

Declaration

public const string Section = "LiveKit"

Field Value

Type	Description
string

Properties

ApiKey

The API key of LiveKit, a key of its keys setting.

Declaration

public string? ApiKey { get; set; }

Property Value

Type	Description
string

ApiSecret

The API secret of the key.

Declaration

public string? ApiSecret { get; set; }

Property Value

Type	Description
string

CanUpdateOwnMetadata

Whether participants may change their own name and metadata.

Declaration

public bool CanUpdateOwnMetadata { get; set; }

Property Value

Type	Description
bool

Enabled

Whether to serve the authorization service.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
bool

FullAccessHomeservers

Homeservers whose users may start calls and publish, separated by commas, or * for every homeserver; users of others only join calls that exist. The homeserver's own name when embedded.

Declaration

public string? FullAccessHomeservers { get; set; }

Property Value

Type	Description
string

TokenLifetime

Lifetime of the issued tokens, which only limits joining.

Declaration

public TimeSpan TokenLifetime { get; set; }

Property Value

Type	Description
TimeSpan

Url

LiveKit's WebSocket URL that clients join, e.g. wss://livekit.example.org.

Declaration

public string? Url { get; set; }

Property Value

Type	Description
string

Methods

ToAuthorizer()

Return what the authorizer needs.

Declaration

public LiveKitAuthorizerOptions ToAuthorizer()

Returns

Type	Description
LiveKitAuthorizerOptions