CFx SDK Documentation
2022 SP0
|
#include <FxAVAudioInput.h>
Public Types | |
enum class | State { ActiveState , SuspendedState , StoppedState , IdleState , InterruptedState } |
Public Member Functions | |
CFxAVAudioInput () | |
virtual | ~CFxAVAudioInput () |
void | start (std::vector< unsigned char > *buffer) |
void | stop () |
void | suspend () |
void | resume () |
State | state () |
CFxUISignal< void(void)> & | stopped () |
Public Member Functions inherited from CFxUIObject | |
CFxUIObject () | |
virtual | ~CFxUIObject () |
FxNativeHandle | getHandle () const |
void | setHandle (FxNativeHandle handle) |
void | setParent (CFxUIObject *parent) |
CFxUIObject * | parent () |
const CFxUIObject * | parent () const |
void | setObjectName (const CFxUIString &objectName) |
CFxUIString | objectName () const |
bool | setProperty (const char *name, const CFxUIVariant &value) |
CFxUIVariant | property (const char *name) |
CFxUIList< CFxUIObject * > | children () const |
template<typename T > | |
CFxUIList< T > | findChildren (const CFxUIString &name=CFxUIString()) |
void | blockSignals (bool block) |
bool | signalsBlocked () const |
Additional Inherited Members | |
Protected Member Functions inherited from CFxUIObject | |
CFxUIObject * | sender () |
Protected Attributes inherited from CFxUIObject | |
CFxUIObjectImpl * | m_pImpl |
CFxUIObjectData * | m_pData |
Class CFxAVAudioInput provides support for audio recording.
Definition at line 28 of file FxAVAudioInput.h.
|
strong |
This enum indicates the state of the recording process.
Enumerator | |
---|---|
ActiveState | |
SuspendedState | |
StoppedState | |
IdleState | |
InterruptedState |
Definition at line 34 of file FxAVAudioInput.h.
CFxAVAudioInput::CFxAVAudioInput | ( | ) |
Constructor
|
virtual |
Destructor
void CFxAVAudioInput::resume | ( | ) |
Resume recording if it was suspended.
void CFxAVAudioInput::start | ( | std::vector< unsigned char > * | buffer | ) |
Start recording. Recorded data is written to the buffer.
[in] | buffer | Recording is stored in the provided buffer. |
State CFxAVAudioInput::state | ( | ) |
Returns current state of the process
void CFxAVAudioInput::stop | ( | ) |
Stop recording.
CFxUISignal<void(void)>& CFxAVAudioInput::stopped | ( | ) |
Signal that is emitted when the playback stops.
void CFxAVAudioInput::suspend | ( | ) |
Suspend (pause) recording.