Interface for audio playback. More...

#include <AUI/Audio/IAudioPlayer.h>

Public Types#
enum class	PlaybackStatus : int8_t { PLAYING , PAUSED , STOPPED }
	Playback status depends on last called function among play(), pause(), stop().

Public Member Functions#
	IAudioPlayer (AUrl url)

	IAudioPlayer (_< ISoundInputStream > stream)

void	play ()
	Starts audio playback, if playback was previously paused, it will continue from where it was paused.

void	pause ()
	Pauses audio playback keeping playback progress.

void	stop ()
	Pauses audio playback without keeping playback progress.

PlaybackStatus	playbackStatus () const noexcept

const _< ASoundResampler > &	resampledStream () const noexcept
	Get resampled stream for playback.

void	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.

bool	loop () const noexcept

void	setVolume (aui::audio::VolumeLevel volume)
	Set level of volume.

aui::audio::VolumeLevel	volume () const noexcept

void	onFinished ()
	Called By AAudioMixer when the playback is finished.

const AUrl &	url () const noexcept

void	rewind ()

Public Member Functions inherited from AObject
_< AObject >	sharedPtr ()

_weak< AObject >	weakPtr ()

template<typename Connectable, ACompatibleSlotFor< Connectable > Function>
decltype(auto)	connect (const Connectable &connectable, Function &&function)
	Connects signal or property to slot of `"this"` object.

void	setSignalsEnabled (bool enabled)

bool	isSignalsEnabled () const noexcept

template<ASignalInvokable T>
void	operator^ (T &&t) noexcept

const _< AAbstractThread > &	getThread () const noexcept

bool	isSlotsCallsOnlyOnMyThread () const noexcept

void	setSlotsCallsOnlyOnMyThread (bool slotsCallsOnlyOnMyThread)

Public Member Functions inherited from AObjectBase
	AObjectBase (AObjectBase &&rhs) noexcept

	AObjectBase (const AObjectBase &rhs) noexcept

AObjectBase &	operator= (const AObjectBase &rhs) noexcept

AObjectBase &	operator= (AObjectBase &&rhs) noexcept

Public Member Functions inherited from aui::noncopyable
	noncopyable (const noncopyable &)=delete

noncopyable &	operator= (const noncopyable &)=delete

Static Public Member Functions#
static _< IAudioPlayer >	fromUrl (AUrl url)

static _< IAudioPlayer >	fromStream (_< ISoundInputStream > stream)

Static Public Member Functions inherited from AObject
static void	disconnect ()

template<AAnySignal Signal, aui::derived_from< AObjectBase > Object, ACompatibleSlotFor< Signal > Function>
static decltype(auto)	connect (const Signal &signal, Object *object, Function &&function)
	Connects signal to the slot of the specified object.

template<AAnyProperty Property, aui::derived_from< AObjectBase > Object, typename Function>
static decltype(auto)	connect (const Property &property, Object *object, Function &&function)
	Connects property to the slot of the specified object.

template<APropertyReadable PropertySource, APropertyWritable PropertyDestination> requires requires { { propertySource } -> aui::convertible_to<std::decay_t<decltype(propertyDestination)>>; }
static void	connect (PropertySource &&propertySource, PropertyDestination &&propertyDestination)
	Connects source property to the destination property.

template<APropertyWritable PropertySource, APropertyWritable PropertyDestination> requires requires { { propertySource } -> aui::convertible_to<std::decay_t<decltype(propertyDestination)>>; { propertyDestination } -> aui::convertible_to<std::decay_t<decltype(propertySource)>>; }
static void	biConnect (PropertySource &&propertySource, PropertyDestination &&propertyDestination)
	Connects source property to the destination property and opposite (bidirectionally).

template<AAnySignalOrProperty Connectable, aui::derived_from< AObjectBase > Object, ACompatibleSlotFor< Connectable > Function>
static decltype(auto)	connect (const Connectable &connectable, Object &object, Function &&function)
	Connects signal or property to the slot of the specified object.

template<AAnySignalOrProperty Connectable, aui::derived_from< AObjectBase > Object, ACompatibleSlotFor< Connectable > Function>
static decltype(auto)	connect (const Connectable &connectable, _< Object > object, Function &&function)
	Connects signal or property to the slot of the specified object.

template<AAnySignalOrProperty Connectable, aui::derived_from< AObjectBase > Object, typename Function>
static decltype(auto)	connect (const Connectable &connectable, ASlotDef< Object *, Function > slotDef)
	Connects signal to the slot of the specified object. Slot is packed to single argument.

template<AAnyProperty Property, typename Object, ACompatibleSlotFor< Property > Function> requires (!aui::derived_from<Object, AObject>)
static void	connect (const Property &property, _< Object > object, Function &&function)
	Connects signal or property to the slot of the specified non-AObject type.

static void	moveToThread (aui::no_escape< AObject > object, _< AAbstractThread > thread)

Signals and public fields#
emits	finished
	On playback finished.

emits	read
	On sound stream read.

Protected Member Functions#
bool	isInitialized () const noexcept

void	initialize ()

void	initializeIfNeeded ()

void	release ()

Protected Member Functions inherited from AObject
void	setThread (_< AAbstractThread > thread)
	Set thread of the object.

Protected Member Functions inherited from AObjectBase
void	clearAllIngoingConnections () noexcept

virtual void	handleSlotException (std::exception_ptr exception)
	Called then an exception has thrown during slot processing of the signal emitted by this object.

Additional Inherited Members#
Static Public Attributes inherited from AObject
static constexpr AObjectBase *	GENERIC_OBSERVER = nullptr
	Indicates that a connection should not be explicitly linked to receiver's lifetime.

Static Public Attributes inherited from AObjectBase
static ASpinlockMutex	SIGNAL_SLOT_GLOBAL_SYNC

Detailed Description#

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

Examples: examples/ui/views/src/ExampleWindow.h.

Member Function Documentation#

◆ loop()#

bool IAudioPlayer::loop ( ) const

inlinenodiscardnoexcept

Returns: Current loop flag

◆ onFinished()#

void IAudioPlayer::onFinished ( )

See IAudioPlayer::finished for listening for this event.

◆ playbackStatus()#

PlaybackStatus IAudioPlayer::playbackStatus ( ) const

inlinenoexcept

Returns: Current playback status.

◆ setLoop()#

void IAudioPlayer::setLoop ( bool loop )

Parameters

loop	New loop flag

◆ setVolume()#

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

Parameters

volume Integer number from 0 to 256 inclusively, works linear

◆ volume()#

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

inlinenodiscardnoexcept

Returns: Current volume level.

Contents

Public Types

Public Member Functions

Static Public Member Functions

Signals and public fields

Protected Member Functions

Additional Inherited Members

Detailed Description

View Page Source Edit Page Source

Public Types#

Public Member Functions#

Static Public Member Functions#

Signals and public fields#

Protected Member Functions#

Additional Inherited Members#