Class LiveKitAuthorizerOptions

What LiveKitAuthorizer needs: the LiveKit server, its API key, and whose users may start calls.

Inheritance

object

LiveKitAuthorizerOptions

Implements

IEquatable<LiveKitAuthorizerOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.LiveKit.Authorization

Assembly: Uniform.LiveKit.Authorization.dll

Syntax

public sealed record LiveKitAuthorizerOptions : IEquatable<LiveKitAuthorizerOptions>

Properties

ApiKey

The API key of LiveKit.

Declaration

public string ApiKey { get; init; }

Property Value

Type	Description
string

ApiSecret

The API secret of the key.

Declaration

public string ApiSecret { get; init; }

Property Value

Type	Description
string

CanUpdateOwnMetadata

Whether participants may change their own name and metadata.

Declaration

public bool CanUpdateOwnMetadata { get; init; }

Property Value

Type	Description
bool

FullAccessHomeservers

Homeservers whose users may create rooms and publish; * for every homeserver. Users of others only join calls that exist, as LiveKit does not create rooms on their join.

Declaration

public IReadOnlyList<string> FullAccessHomeservers { get; init; }

Property Value

Type	Description
IReadOnlyList<string>

TokenLifetime

Lifetime of the issued tokens, which only limits joining: LiveKit keeps a joined participant.

Declaration

public TimeSpan TokenLifetime { get; init; }

Property Value

Type	Description
TimeSpan

Url

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

Declaration

public string Url { get; init; }

Property Value

Type	Description
string

Methods

HasFullAccess(string)

Return whether users of serverName have full access.

Declaration

public bool HasFullAccess(string serverName)

Parameters

Type	Name	Description
string	serverName

Returns

Type	Description
bool

Implements

IEquatable<T>