Class EncodingOptions

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

public sealed class EncodingOptions : IMessage<EncodingOptions>, IEquatable<EncodingOptions>, IDeepCloneable<EncodingOptions>, IBufferMessage, IMessage

Inheritance

object

EncodingOptions

Implements

IMessage<EncodingOptions>

IEquatable<EncodingOptions>

IDeepCloneable<EncodingOptions>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

EncodingOptions()

public EncodingOptions()

EncodingOptions(EncodingOptions)

public EncodingOptions(EncodingOptions other)

Parameters

other EncodingOptions

Fields

AudioBitrateFieldNumber

Field number for the "audio_bitrate" field.

public const int AudioBitrateFieldNumber = 6

Field Value

int

AudioCodecFieldNumber

Field number for the "audio_codec" field.

public const int AudioCodecFieldNumber = 5

Field Value

int

AudioFrequencyFieldNumber

Field number for the "audio_frequency" field.

public const int AudioFrequencyFieldNumber = 7

Field Value

int

AudioQualityFieldNumber

Field number for the "audio_quality" field.

public const int AudioQualityFieldNumber = 11

Field Value

int

DepthFieldNumber

Field number for the "depth" field.

public const int DepthFieldNumber = 3

Field Value

int

FramerateFieldNumber

Field number for the "framerate" field.

public const int FramerateFieldNumber = 4

Field Value

int

HeightFieldNumber

Field number for the "height" field.

public const int HeightFieldNumber = 2

Field Value

int

KeyFrameIntervalFieldNumber

Field number for the "key_frame_interval" field.

public const int KeyFrameIntervalFieldNumber = 10

Field Value

int

VideoBitrateFieldNumber

Field number for the "video_bitrate" field.

public const int VideoBitrateFieldNumber = 9

Field Value

int

VideoCodecFieldNumber

Field number for the "video_codec" field.

public const int VideoCodecFieldNumber = 8

Field Value

int

VideoQualityFieldNumber

Field number for the "video_quality" field.

public const int VideoQualityFieldNumber = 12

Field Value

int

WidthFieldNumber

Field number for the "width" field.

public const int WidthFieldNumber = 1

Field Value

int

Properties

AudioBitrate

(default 128)

public int AudioBitrate { get; set; }

Property Value

int

AudioCodec

(default OPUS)

public AudioCodec AudioCodec { get; set; }

Property Value

AudioCodec

AudioFrequency

(default 44100)

public int AudioFrequency { get; set; }

Property Value

int

AudioQuality

--- Deprecated ---

[Obsolete]
public int AudioQuality { get; set; }

Property Value

int

Depth

(default 24)

public int Depth { get; set; }

Property Value

int

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Framerate

(default 30)

public int Framerate { get; set; }

Property Value

int

Height

(default 1080)

public int Height { get; set; }

Property Value

int

KeyFrameInterval

in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)

public double KeyFrameInterval { get; set; }

Property Value

double

Parser

public static MessageParser<EncodingOptions> Parser { get; }

Property Value

MessageParser<EncodingOptions>

VideoBitrate

(default 4500)

public int VideoBitrate { get; set; }

Property Value

int

VideoCodec

(default H264_MAIN)

public VideoCodec VideoCodec { get; set; }

Property Value

VideoCodec

VideoQuality

quality setting on video encoder

[Obsolete]
public int VideoQuality { get; set; }

Property Value

int

Width

(default 1920)

public int Width { get; set; }

Property Value

int

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public EncodingOptions Clone()

Returns

EncodingOptions

A deep clone of this object.

Equals(EncodingOptions)

public bool Equals(EncodingOptions other)

Parameters

other EncodingOptions

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(EncodingOptions)

Merges the given message into this one.

public void MergeFrom(EncodingOptions other)

Parameters

other EncodingOptions

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.