Interface IEncoderSettings

Interface to implement to create settings for an encoder.

Namespace: UnityEditor.Recorder.Encoder

Assembly: Unity.Recorder.Editor.dll

Syntax

public interface IEncoderSettings

Properties

CanCaptureAlpha

Indicates whether this encoder instance can support an alpha channel or not.

Declaration

bool CanCaptureAlpha { get; }

Property Value

Type	Description
bool

CanCaptureAudio

Indicates whether this encoder instance can support an audio signal or not.

Declaration

bool CanCaptureAudio { get; }

Property Value

Type	Description
bool

CoordinateConvention

Indicates where the first pixel of the image will be in the frame.

Declaration

EncoderCoordinateConvention CoordinateConvention { get; }

Property Value

Type	Description
EncoderCoordinateConvention

Extension

Returns the extension of the files to encode, in lowercase, without leading dot.

Declaration

string Extension { get; }

Property Value

Type	Description
string

Methods

GetTextureFormat(bool)

Gets the texture format this encoder requires from the Recorder.

Declaration

TextureFormat GetTextureFormat(bool inputContainsAlpha)

Parameters

Type	Name	Description
bool	inputContainsAlpha	Whether the encoder's input contains an alpha channel or not.

Returns

Type	Description
TextureFormat

RequiresEvenResolution()

Indicates whether this encoder requires the width and height of the image to both be even numbers or not.

Declaration

[Obsolete("RequiresEvenResolution() is no longer used.")]
bool RequiresEvenResolution()

Returns

Type	Description
bool	True if this encoder requires even dimensions, False otherwise.

SupportsCurrentPlatform()

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

Declaration

bool SupportsCurrentPlatform()

Returns

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

ValidateRecording(RecordingContext, List<string>, List<string>)

Populates the lists of errors and warnings for a given encoder context.

Declaration

void ValidateRecording(RecordingContext ctx, List<string> errors, List<string> warnings)

Parameters

Type	Name	Description
RecordingContext	ctx	The context of the current recording.
List<string>	errors	The list of errors to append to.
List<string>	warnings	The list of warnings to append to.