Class KeyProviderOptions

Namespace

LiveKit.Rtc

Assembly

LivekitRtc.dll

Options for the key provider.

public class KeyProviderOptions

Inheritance

object

KeyProviderOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

FailureTolerance

Number of consecutive decryption failures tolerated before the key is considered invalid; -1 tolerates any number. Defaults to FailureTolerance.

public int FailureTolerance { get; set; }

Property Value

int

KeyDerivationFunction

Key derivation function used to derive the frame keys. Defaults to PBKDF2, the default of every LiveKit SDK, so it only needs changing to interoperate with a client configured otherwise.

public KeyDerivationFunction KeyDerivationFunction { get; set; }

Property Value

KeyDerivationFunction

KeyRingSize

Number of keys kept per participant, addressed by key index. Must be greater than zero. Defaults to KeyRingSize.

public int KeyRingSize { get; set; }

Property Value

int

RatchetSalt

Salt used to ratchet keys. Defaults to RatchetSalt, the value of the other LiveKit SDKs.

public byte[] RatchetSalt { get; set; }

Property Value

byte[]

RatchetWindowSize

Number of ratchet steps tried when a frame does not decrypt with the current key. Defaults to RatchetWindowSize.

public int RatchetWindowSize { get; set; }

Property Value

int

SharedKey

Key shared by every participant. When set, it encrypts and decrypts the media of all participants; when null, set a key per participant with SetKey(string, byte[], int).

public byte[]? SharedKey { get; set; }

Property Value

byte[]