oa::AudioEncoder

AudioEncoder class in the OA Audio public surface.

Public Methods

oa::Status oa::AudioEncoder::close()
oa::Status oa::AudioEncoder::encode(oa::Span<const oa::F32> inInterleaved, oa::Vector<EncodedAudioPacket> & outPackets)
oa::Status oa::AudioEncoder::flush(oa::Vector<EncodedAudioPacket> & outPackets)
oa::Span<const oa::U8> oa::AudioEncoder::getCodecConfig()
oa::U32 oa::AudioEncoder::getPrimingFrames()
const AudioEncodeProfile & oa::AudioEncoder::getProfile()
bool oa::AudioEncoder::isOpen()

Static Public Methods

static oa::Result<AudioEncoder> oa::AudioEncoder::create(const AudioEncodeProfile & inProfile)

Constructor & Destructor Documentation

oa::AudioEncoder::AudioEncoder()
No public source comment is attached to this declaration.
void oa::AudioEncoder::~AudioEncoder()
No public source comment is attached to this declaration.

Public Method Documentation

oa::Status oa::AudioEncoder::close()
Discards any unflushed partial packet and closes the session.

Returns

oa::Status

The declared return value.

oa::Status oa::AudioEncoder::encode( oa::Span<const oa::F32> inInterleaved, oa::Vector<EncodedAudioPacket> & outPackets )
No public source comment is attached to this declaration.

Parameters

inInterleaved
oa::Span<const oa::F32>

outPackets
oa::Vector<EncodedAudioPacket> &

Returns

oa::Status

The declared return value.

oa::Status oa::AudioEncoder::flush( oa::Vector<EncodedAudioPacket> & outPackets )
No public source comment is attached to this declaration.

Parameters

outPackets
oa::Vector<EncodedAudioPacket> &

Returns

oa::Status

The declared return value.

oa::Span<const oa::U8> oa::AudioEncoder::getCodecConfig()
No public source comment is attached to this declaration.

Returns

oa::Span<const oa::U8>

The declared return value.

oa::U32 oa::AudioEncoder::getPrimingFrames()
No public source comment is attached to this declaration.

Returns

oa::U32

The declared return value.

const AudioEncodeProfile & oa::AudioEncoder::getProfile()
No public source comment is attached to this declaration.

Returns

const AudioEncodeProfile &

The declared return value.

bool oa::AudioEncoder::isOpen()
No public source comment is attached to this declaration.

Returns

bool

The declared return value.

static oa::Result<AudioEncoder> oa::AudioEncoder::create( const AudioEncodeProfile & inProfile )
No public source comment is attached to this declaration.

Parameters

inProfile
const AudioEncodeProfile &

Returns

oa::Result<AudioEncoder>

The declared return value.