QAudioStateMachine Class Reference

#include <qaudiostatemachine_p.h>

Collaboration diagram for QAudioStateMachine:

Classes
class	Notifier

Public Types
enum class	RunningState { Active = QtAudio::State::ActiveState , Idle = QtAudio::State::IdleState }
using	RawState = AudioStateMachineUtils::RawState

Public Member Functions
	QAudioStateMachine (QAudioStateChangeNotifier &notifier)
	~QAudioStateMachine ()
QAudio::State	state () const
QAudio::Error	error () const
bool	isActiveOrIdle () const
bool	isDraining () const
std::pair< bool, bool >	getDrainedAndStopped () const
bool	onDrained ()
Notifier	stop (QAudio::Error error=QAudio::NoError, bool shouldDrain=false, bool forceUpdateError=false)
Notifier	stopOrUpdateError (QAudio::Error error=QAudio::NoError)
Notifier	start (RunningState activeOrIdle=RunningState::Active)
Notifier	suspend ()
Notifier	resume ()
Notifier	activateFromIdle ()
Notifier	updateActiveOrIdle (RunningState activeOrIdle, QAudio::Error error=QAudio::NoError)
Notifier	forceSetState (QAudio::State state, QAudio::Error error=QAudio::NoError)
Notifier	setError (QAudio::Error error)

Detailed Description

Definition at line 37 of file qaudiostatemachine_p.h.

Member Typedef Documentation

RawState

using QAudioStateMachine::RawState = AudioStateMachineUtils::RawState

Definition at line 40 of file qaudiostatemachine_p.h.

Member Enumeration Documentation

RunningState

enum class QAudioStateMachine::RunningState

strong

Enumerator
Active
Idle

Definition at line 85 of file qaudiostatemachine_p.h.

Constructor & Destructor Documentation

QAudioStateMachine()

QAudioStateMachine::QAudioStateMachine

(

QAudioStateChangeNotifier &

notifier

)

Definition at line 14 of file qaudiostatemachine.cpp.

~QAudioStateMachine()

QAudioStateMachine::~QAudioStateMachine ( )

default

Member Function Documentation

activateFromIdle()

Notifier QAudioStateMachine::activateFromIdle

(

)

Definition at line 112 of file qaudiostatemachine.cpp.

error()

QAudio::Error QAudioStateMachine::error

(

)

const

Definition at line 25 of file qaudiostatemachine.cpp.

forceSetState()

Notifier QAudioStateMachine::forceSetState	(	QAudio::State	state,
		QAudio::Error	error = QAudio::NoError )

Definition at line 129 of file qaudiostatemachine.cpp.

getDrainedAndStopped()

std::pair< bool, bool > QAudioStateMachine::getDrainedAndStopped

(

)

const

Definition at line 83 of file qaudiostatemachine.cpp.

isActiveOrIdle()

bool QAudioStateMachine::isActiveOrIdle

(

)

const

Definition at line 67 of file qaudiostatemachine.cpp.

isDraining()

bool QAudioStateMachine::isDraining

(

)

const

Definition at line 78 of file qaudiostatemachine.cpp.

onDrained()

bool QAudioStateMachine::onDrained

(

)

Definition at line 73 of file qaudiostatemachine.cpp.

resume()

Notifier QAudioStateMachine::resume

(

)

Definition at line 103 of file qaudiostatemachine.cpp.

setError()

Notifier QAudioStateMachine::setError

(

QAudio::Error

error

)

Definition at line 123 of file qaudiostatemachine.cpp.

start()

Notifier QAudioStateMachine::start

(

RunningState

activeOrIdle = RunningState::Active

)

Definition at line 61 of file qaudiostatemachine.cpp.

state()

QAudio::State QAudioStateMachine::state

(

)

const

Definition at line 20 of file qaudiostatemachine.cpp.

stop()

Notifier QAudioStateMachine::stop	(	QAudio::Error	error = QAudio::NoError,
		bool	shouldDrain = false,
		bool	forceUpdateError = false )

Definition at line 46 of file qaudiostatemachine.cpp.

stopOrUpdateError()

Notifier QAudioStateMachine::stopOrUpdateError ( QAudio::Error error = QAudio::NoError )

inline

Definition at line 114 of file qaudiostatemachine_p.h.

suspend()

Notifier QAudioStateMachine::suspend

(

)

Definition at line 89 of file qaudiostatemachine.cpp.

updateActiveOrIdle()

Notifier QAudioStateMachine::updateActiveOrIdle	(	RunningState	activeOrIdle,
		QAudio::Error	error = QAudio::NoError )

Definition at line 117 of file qaudiostatemachine.cpp.

---

The documentation for this class was generated from the following files:

• qtmultimedia/src/multimedia/audio/qaudiostatemachine_p.h (05d9a7b0f3933d537e3d4cb3c58c3a0b1d3103af)
• qtmultimedia/src/multimedia/audio/qaudiostatemachine.cpp (05d9a7b0f3933d537e3d4cb3c58c3a0b1d3103af)