oa::AudioPlayer

AudioPlayer class in the OA Audio public surface.

ClC++ public headers

Public Methods

oa::U32 oa::AudioPlayer::channelCount()

oa::Status oa::AudioPlayer::close()

oa::U64 oa::AudioPlayer::durationUs()

bool oa::AudioPlayer::isEos()

bool oa::AudioPlayer::isOpen()

bool oa::AudioPlayer::isPlaying()

void oa::AudioPlayer::pause()

oa::Status oa::AudioPlayer::play()

oa::U64 oa::AudioPlayer::positionUs()

oa::U32 oa::AudioPlayer::sampleRate()

oa::Status oa::AudioPlayer::seek(oa::U64 inTimestampUs)

void oa::AudioPlayer::setLoop(bool inLoop)

oa::U64 oa::AudioPlayer::underrunFrameCount()

Static Public Methods

static oa::Result<AudioPlayer> oa::AudioPlayer::open(Engine & inEngine, const AudioPlayerConfig & inConfig)

static oa::Result<AudioPlayer> oa::AudioPlayer::open(Engine & inEngine, oa::StringView inUri)

Constructor & Destructor Documentation

oa::AudioPlayer::AudioPlayer()

No public source comment is attached to this declaration.

void oa::AudioPlayer::~AudioPlayer()

No public source comment is attached to this declaration.

Public Method Documentation

oa::U32 oa::AudioPlayer::channelCount()

No public source comment is attached to this declaration.

Returns

oa::U32

The declared return value.

oa::Status oa::AudioPlayer::close()

Stops playback, joins decoding, and releases codec/device state.

Returns

oa::Status

The declared return value.

oa::U64 oa::AudioPlayer::durationUs()

No public source comment is attached to this declaration.

Returns

oa::U64

The declared return value.

bool oa::AudioPlayer::isEos()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::AudioPlayer::isOpen()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::AudioPlayer::isPlaying()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

void oa::AudioPlayer::pause()

No public source comment is attached to this declaration.

Returns

void

The declared return value.

oa::Status oa::AudioPlayer::play()

No public source comment is attached to this declaration.

Returns

oa::Status

The declared return value.

oa::U64 oa::AudioPlayer::positionUs()

No public source comment is attached to this declaration.

Returns

oa::U64

The declared return value.

oa::U32 oa::AudioPlayer::sampleRate()

No public source comment is attached to this declaration.

Returns

oa::U32

The declared return value.

oa::Status oa::AudioPlayer::seek(
	oa::U64 inTimestampUs
)

No public source comment is attached to this declaration.

Parameters

inTimestampUs

oa::U64

—

Returns

oa::Status

The declared return value.

void oa::AudioPlayer::setLoop(
	bool inLoop
)

No public source comment is attached to this declaration.

Parameters

inLoop

bool

—

Returns

void

The declared return value.

oa::U64 oa::AudioPlayer::underrunFrameCount()

No public source comment is attached to this declaration.

Returns

oa::U64

The declared return value.

static oa::Result<AudioPlayer> oa::AudioPlayer::open(
	Engine & inEngine,
	const AudioPlayerConfig & inConfig
)

No public source comment is attached to this declaration.

Parameters

inEngine

Engine &

—

inConfig

const AudioPlayerConfig &

—

Returns

oa::Result<AudioPlayer>

The declared return value.

static oa::Result<AudioPlayer> oa::AudioPlayer::open(
	Engine & inEngine,
	oa::StringView inUri
)

No public source comment is attached to this declaration.

Parameters

inEngine

Engine &

—

inUri

oa::StringView

—

Returns

oa::Result<AudioPlayer>

The declared return value.