Enumerations | Functions | Variables

fancy_audio_2 Namespace Reference
[Third Fancy Device API]

Provides ResamplerState and ChannelMode2 enumeration types. More...

Enumerations

enum  SamplerState { S_OK, S_NEED_INPUT_BUF, S_NEED_OUTPUT_BUF }
enum  ChannelMode2 { MONO = 1, STEREO = 2 }

Functions

virtual int CDECL NDQueryInterface (FANCYCLSIDRQ idReq, IQI **ppIface)
FancyResult NameThread ()
 FancyInterfere (FANCYCLSID clsid, IEnv *pEnvironment, int &result)

Variables

GenericSamplerLib * m_pResampler
uint32 m_uiInpBufferSize
boolean m_fSampTypeSet
bool m_Enabled
bool m_EnabledRead
ISignalQ * m_pEventSignalQ
std::queue< FancyCommand * > m_fancyRxBufferQueue
std::queue< FancyCommand * > m_fancyTxBufferQueue
 DECLARE_IQI

Detailed Description

This is the detailed fancy audio namespace.


Enumeration Type Documentation

Sample comment for enum inside a namespace.

Enumerator:
S_OK 

Resampler state is in OK mode.

S_NEED_INPUT_BUF 

Resampler state needs an input buffer.

S_NEED_OUTPUT_BUF 

Resampler state needs an output buffer.

Another sample comment for enum inside a namespace.

Enumerator:
MONO 

Channel Mode 2 is in mono mode.

STEREO 

Channel Mode 2 is in stereo mode.


Function Documentation

virtual int CDECL fancy_audio_2::NDQueryInterface ( FANCYCLSIDRQ  idReq,
IQI **  ppIface 
) [virtual]

Provides an interface to support the FancyInterface module.

This method must be implemented if the FancyInterfere module supports any interfaces not handled by its base classes.

Parameters:
[in] idReq Unique ID of the requested interface.
[out] ppIface Interface pointer of the requested interface.
Returns:
SUCCESS -- Interface is returned successfully.
ECLASSNOTSUPPORT -- Interface is not supported.
FancyResult fancy_audio_2::NameThread (  ) 

Overrides a generic name.

The deriving class may override this method to provide a descriptive name for the optional output thread to help distinguish it in debugging applications. The default implementation provides a generic name.

Returns:
SUCCESS -- Initialization was successful.
FAILURE -- Initialization failed.
fancy_audio_2::FancyInterfere ( FANCYCLSID  clsid,
IEnv *  pEnvironment,
int &  result 
)

Provides a class constructor.

This is the component constructor, meant to be called by the class factory of the component.

Parameters:
[in] clsid Class ID of the module.
[in] pEnvironment Interface to the component services environment.
[out] result Result of the function.
Returns:
New class object.

Variable Documentation

GenericSamplerLib* fancy_audio_2::m_pResampler

Generic Sampler library object.

Size of the input buffer delivered to the sampler.

SamplerType Set flag.

Enables the flag master for FancyInterfere.

Enables FancyInterfere on the Read channel.

Signal queue for blocking events.

std::queue<FancyCommand*> fancy_audio_2::m_fancyRxBufferQueue

Rx queues for Fancy Device buffers received from the application.

std::queue<FancyCommand*> fancy_audio_2::m_fancyTxBufferQueue

Tx queues for Fancy Device buffers received from the application.

Pulls in IQueryInterface method definitions.