Class CoreEncoderSettings

The settings of the Core Encoder.

Inheritance
object
CoreEncoderSettings
Implements
Inherited Members
Namespace: UnityEditor.Recorder.Encoder
Assembly: Unity.Recorder.Editor.dll
Syntax
[Serializable]
[EncoderSettings(typeof(CoreEncoder))]
public sealed class CoreEncoderSettings : IEncoderSettings, IEquatable<CoreEncoderSettings>
Remarks

This class is sealed because users shouldn't inherit from it. Instead, create a new encoder along with its settings class.

Constructors

CoreEncoderSettings()

Default constructor.

Declaration
public CoreEncoderSettings()

Properties

Codec

The selected codec of the encoder instance.

Declaration
public CoreEncoderSettings.OutputCodec Codec { get; set; }
Property Value
Type Description
CoreEncoderSettings.OutputCodec

EncodingProfile

The choice of encoding profile for the H.264 codec. Each profile defines a set of capabilities and constraints on which decoders rely.

Declaration
public CoreEncoderSettings.H264EncodingProfile EncodingProfile { get; set; }
Property Value
Type Description
CoreEncoderSettings.H264EncodingProfile

EncodingQuality

Indicates the encoding quality to use for the encoding.

Declaration
public CoreEncoderSettings.VideoEncodingQuality EncodingQuality { get; set; }
Property Value
Type Description
CoreEncoderSettings.VideoEncodingQuality

GopSize

The interval in frames between two full images (I-frames), known as the Group of Pictures (GOP) size for the H.264 codec.

Declaration
public uint GopSize { get; set; }
Property Value
Type Description
uint

KeyframeDistance

The maximum interval in frames between two full images (I-frames), for the VP8 codec.

Declaration
public uint KeyframeDistance { get; set; }
Property Value
Type Description
uint

NumConsecutiveBFrames

The number of consecutive bidirectional predicted pictures (B-frames) for the H.264 codec. The maximum supported value is 2.

Declaration
public uint NumConsecutiveBFrames { get; set; }
Property Value
Type Description
uint

TargetBitRate

The target bitrate, in Mbps, for the H.264 codec.

Declaration
public float TargetBitRate { get; set; }
Property Value
Type Description
float

Methods

Equals(object)

Compares the current object with another one.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare with the current one.
Returns
Type Description
bool

True if the two objects are equal, false otherwise.
Overrides

GetHashCode()

Returns a hash code of all serialized fields.

Declaration
public override int GetHashCode()
Returns
Type Description
int

The hash code.
Overrides

SupportsCurrentPlatform()

Indicates whether the encoder is supported on the current operating system or not.

Declaration
public bool SupportsCurrentPlatform()
Returns
Type Description
bool

True if the encoder works on this platform, False otherwise.

Implements