Class AudioEncoder

Interface used for implementations that encodes set of PCM samples into a target audio format.

Inheritance

AudioEncoder

Assembly: FlaxEngine.dll

File: Engine/Tools/AudioTool/AudioEncoder.h

Syntax

public class AudioEncoder

Constructors

~AudioEncoder()

Finalizes an instance of the AudioEncoder class.

Declaration

public virtual ~AudioEncoder()

Methods

Convert(byte* samples, AudioDataInfo& info, BytesContainer& result, float quality = 0.5f)

Converts the input PCM samples buffer into the encoder audio format.

Declaration

public virtual bool Convert(byte* samples, AudioDataInfo& info, BytesContainer& result, float quality = 0.5f) = 0

Parameters

byte samples The buffer containing samples in PCM format. All samples should be in signed integer format.

AudioDataInfo info The input information describing meta-data of the audio in the samples buffer.

BytesContainer result The output data.

float quality The output data compression quality (normalized in range [0;1]).

Returns

bool True if the data is invalid or conversion failed, otherwise false.