Table of Contents

Class KeyProviderOptions

Namespace
LiveKit.Proto
public sealed class KeyProviderOptions : Google.Protobuf.IMessage<KeyProviderOptions>, Google.Protobuf.IBufferMessage
Inheritance
KeyProviderOptions
Implements
IBufferMessage
Extension Methods

Constructors

KeyProviderOptions()

public KeyProviderOptions()

KeyProviderOptions(KeyProviderOptions)

public KeyProviderOptions(KeyProviderOptions other)

Parameters

other KeyProviderOptions

Fields

FailureToleranceFieldNumber

Field number for the "failure_tolerance" field.

public const int FailureToleranceFieldNumber = 4

Field Value

int

KeyDerivationFunctionFieldNumber

Field number for the "key_derivation_function" field.

public const int KeyDerivationFunctionFieldNumber = 6

Field Value

int

KeyRingSizeFieldNumber

Field number for the "key_ring_size" field.

public const int KeyRingSizeFieldNumber = 5

Field Value

int

RatchetSaltFieldNumber

Field number for the "ratchet_salt" field.

public const int RatchetSaltFieldNumber = 3

Field Value

int

RatchetWindowSizeFieldNumber

Field number for the "ratchet_window_size" field.

public const int RatchetWindowSizeFieldNumber = 2

Field Value

int

SharedKeyFieldNumber

Field number for the "shared_key" field.

public const int SharedKeyFieldNumber = 1

Field Value

int

Properties

Descriptor

public static Google.Protobuf.Reflection.MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

FailureTolerance

-1 = no tolerance

public int FailureTolerance { get; set; }

Property Value

int

HasFailureTolerance

Gets whether the "failure_tolerance" field is set

public bool HasFailureTolerance { get; }

Property Value

bool

HasKeyDerivationFunction

Gets whether the "key_derivation_function" field is set

public bool HasKeyDerivationFunction { get; }

Property Value

bool

HasKeyRingSize

Gets whether the "key_ring_size" field is set

public bool HasKeyRingSize { get; }

Property Value

bool

HasRatchetSalt

Gets whether the "ratchet_salt" field is set

public bool HasRatchetSalt { get; }

Property Value

bool

HasRatchetWindowSize

Gets whether the "ratchet_window_size" field is set

public bool HasRatchetWindowSize { get; }

Property Value

bool

HasSharedKey

Gets whether the "shared_key" field is set

public bool HasSharedKey { get; }

Property Value

bool

KeyDerivationFunction

public KeyDerivationFunction KeyDerivationFunction { get; set; }

Property Value

KeyDerivationFunction

KeyRingSize

public int KeyRingSize { get; set; }

Property Value

int

Parser

public static Google.Protobuf.MessageParser<KeyProviderOptions> Parser { get; }

Property Value

MessageParser<KeyProviderOptions>

RatchetSalt

public Google.Protobuf.ByteString RatchetSalt { get; set; }

Property Value

ByteString

RatchetWindowSize

public int RatchetWindowSize { get; set; }

Property Value

int

SharedKey

Only specify if you want to use a shared_key

public Google.Protobuf.ByteString SharedKey { get; set; }

Property Value

ByteString

Methods

CalculateSize()

public int CalculateSize()

Returns

int

ClearFailureTolerance()

Clears the value of the "failure_tolerance" field

public void ClearFailureTolerance()

ClearKeyDerivationFunction()

Clears the value of the "key_derivation_function" field

public void ClearKeyDerivationFunction()

ClearKeyRingSize()

Clears the value of the "key_ring_size" field

public void ClearKeyRingSize()

ClearRatchetSalt()

Clears the value of the "ratchet_salt" field

public void ClearRatchetSalt()

ClearRatchetWindowSize()

Clears the value of the "ratchet_window_size" field

public void ClearRatchetWindowSize()

ClearSharedKey()

Clears the value of the "shared_key" field

public void ClearSharedKey()

Clone()

public KeyProviderOptions Clone()

Returns

KeyProviderOptions

Equals(KeyProviderOptions)

public bool Equals(KeyProviderOptions other)

Parameters

other KeyProviderOptions

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

public void MergeFrom(Google.Protobuf.CodedInputStream input)

Parameters

input CodedInputStream

MergeFrom(KeyProviderOptions)

public void MergeFrom(KeyProviderOptions other)

Parameters

other KeyProviderOptions

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

public void WriteTo(Google.Protobuf.CodedOutputStream output)

Parameters

output CodedOutputStream