IAudioPlayer#

Interface for audio playback.

Header:	`#include <AUI/Audio/IAudioPlayer.h>`
CMake:	`aui_link(my_target PUBLIC aui::audio)`

Detailed Description#

Experimental Feature

This API is experimental. Experimental APIs are likely to contain bugs, might be changed or removed in the future.

enum class IAudioPlayer::PlaybackStatus

Playback status depends on last called function among play(), pause(), stop().

emits<> finished

On playback finished.

emits<> read

On sound stream read.

bool IAudioPlayer::loop()

void IAudioPlayer::onFinished()

Called By AAudioMixer when the playback is finished.

See IAudioPlayer::finished for listening for this event.

void IAudioPlayer::pause()

Pauses audio playback keeping playback progress.

void IAudioPlayer::play()

Starts audio playback, if playback was previously paused, it will continue from where it was paused.

PlaybackStatus IAudioPlayer::playbackStatus()

AAudioResampler& IAudioPlayer::resamplerStream()

Get resampled stream for playback.

void IAudioPlayer::setLoop(bool loop)

Set loop flag, is loop flag is true then audio playback wouldn't be stopped after it ends and sound stream would be rewind.

void IAudioPlayer::setVolume(aui::audio::VolumeLevel volume)

Set level of volume.

Arguments: volume
Integer number from 0 to 256 inclusively, works linear

void IAudioPlayer::stop()

Pauses audio playback without keeping playback progress.

aui::audio::VolumeLevel IAudioPlayer::volume()