CFx SDK Documentation  2022 SP0
Public Types | Public Member Functions | List of all members
CFxAVAudioInput Class Reference

#include <FxAVAudioInput.h>

Inheritance diagram for CFxAVAudioInput:
CFxUIObject

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)
 
CFxUIObjectparent ()
 
const CFxUIObjectparent () 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
CFxUIObjectsender ()
 
- Protected Attributes inherited from CFxUIObject
CFxUIObjectImpl * m_pImpl
 
CFxUIObjectData * m_pData
 

Detailed Description

Class CFxAVAudioInput provides support for audio recording.

Definition at line 28 of file FxAVAudioInput.h.

Member Enumeration Documentation

◆ State

This enum indicates the state of the recording process.

Enumerator
ActiveState 
SuspendedState 
StoppedState 
IdleState 
InterruptedState 

Definition at line 34 of file FxAVAudioInput.h.

Constructor & Destructor Documentation

◆ CFxAVAudioInput()

CFxAVAudioInput::CFxAVAudioInput ( )

Constructor

◆ ~CFxAVAudioInput()

virtual CFxAVAudioInput::~CFxAVAudioInput ( )
virtual

Destructor

Member Function Documentation

◆ resume()

void CFxAVAudioInput::resume ( )

Resume recording if it was suspended.

◆ start()

void CFxAVAudioInput::start ( std::vector< unsigned char > *  buffer)

Start recording. Recorded data is written to the buffer.

Parameters
[in]bufferRecording is stored in the provided buffer.

◆ state()

State CFxAVAudioInput::state ( )

Returns current state of the process

◆ stop()

void CFxAVAudioInput::stop ( )

Stop recording.

◆ stopped()

CFxUISignal<void(void)>& CFxAVAudioInput::stopped ( )

Signal that is emitted when the playback stops.

◆ suspend()

void CFxAVAudioInput::suspend ( )

Suspend (pause) recording.


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