Class FrameCryptor

Namespace

LiveKit.Rtc

Assembly

LivekitRtc.dll

Frame cryptor for a specific participant.

public class FrameCryptor

Inheritance

object

FrameCryptor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FrameCryptor(ulong, string, int, bool)

Used by the SDK. Get the cryptors from GetFrameCryptors() instead: a cryptor created without a track SID cannot be addressed by SetEnabled(bool) and SetKeyIndex(int).

public FrameCryptor(ulong roomHandle, string participantIdentity, int keyIndex, bool enabled)

Parameters

roomHandle ulong

Native handle of the room, which the public API does not expose.

participantIdentity string

The participant identity.

keyIndex int

The key index.

enabled bool

Whether encryption is enabled.

FrameCryptor(ulong, string, string, int, bool)

Used by the SDK. Get the cryptors from GetFrameCryptors() instead of constructing them.

public FrameCryptor(ulong roomHandle, string participantIdentity, string trackSid, int keyIndex, bool enabled)

Parameters

roomHandle ulong

Native handle of the room, which the public API does not expose.

participantIdentity string

The participant identity.

trackSid string

The SID of the track the cryptor encrypts or decrypts.

keyIndex int

The key index.

enabled bool

Whether encryption is enabled.

Properties

Enabled

Gets whether encryption is enabled.

public bool Enabled { get; }

Property Value

bool

KeyIndex

Gets the key index.

public int KeyIndex { get; }

Property Value

int

ParticipantIdentity

Gets the participant identity.

public string ParticipantIdentity { get; }

Property Value

string

TrackSid

Gets the SID of the track this cryptor encrypts or decrypts.

public string TrackSid { get; }

Property Value

string

Methods

SetEnabled(bool)

Sets whether encryption is enabled.

public void SetEnabled(bool enabled)

Parameters

enabled bool

True to enable, false to disable.

SetKeyIndex(int)

Sets the key index.

public void SetKeyIndex(int keyIndex)

Parameters

keyIndex int

The key index.