yocto_audioout.h File Reference

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

Include dependency graph for yocto_audioout.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	YAudioOut

Macros
#define	_Y_MUTE_ENUM
#define	Y_NOSIGNALFOR_INVALID   (YAPI_INVALID_INT)
#define	Y_SIGNAL_INVALID   (YAPI_INVALID_INT)
#define	Y_VOLUME_INVALID   (YAPI_INVALID_UINT)
#define	Y_VOLUMERANGE_INVALID   (YAPI_INVALID_STRING)

Typedefs
typedef void(*	YAudioOutValueCallback) (YAudioOut *func, const string &functionValue)

Enumerations
enum	Y_MUTE_enum {   Y_MUTE_FALSE = 0, Y_MUTE_TRUE = 1, Y_MUTE_INVALID = -1, Y_MUTE_FALSE = 0,   Y_MUTE_TRUE = 1, Y_MUTE_INVALID = -1, Y_MUTE_FALSE = 0, Y_MUTE_TRUE = 1,   Y_MUTE_INVALID = -1 }

Functions
YAudioOut *	yFindAudioOut (const string &func)
YAudioOut *	yFirstAudioOut (void)

Macro Definition Documentation

#define _Y_MUTE_ENUM

Definition at line 56 of file yocto_audioout.h.

#define Y_NOSIGNALFOR_INVALID   (YAPI_INVALID_INT)

Definition at line 66 of file yocto_audioout.h.

#define Y_SIGNAL_INVALID   (YAPI_INVALID_INT)

Definition at line 65 of file yocto_audioout.h.

#define Y_VOLUME_INVALID   (YAPI_INVALID_UINT)

Definition at line 63 of file yocto_audioout.h.

#define Y_VOLUMERANGE_INVALID   (YAPI_INVALID_STRING)

Definition at line 64 of file yocto_audioout.h.

Typedef Documentation

typedef void(* YAudioOutValueCallback) (YAudioOut *func, const string &functionValue)

Definition at line 54 of file yocto_audioout.h.

Enumeration Type Documentation

enum Y_MUTE_enum

Enumerator
Y_MUTE_FALSE
Y_MUTE_TRUE
Y_MUTE_INVALID
Y_MUTE_FALSE
Y_MUTE_TRUE
Y_MUTE_INVALID
Y_MUTE_FALSE
Y_MUTE_TRUE
Y_MUTE_INVALID

Definition at line 57 of file yocto_audioout.h.

Function Documentation

YAudioOut* yFindAudioOut ( const string &  func )

inline

Retrieves an audio output for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the audio output is online at the time it is invoked. The returned object is nevertheless valid. Use the method YAudioOut.isOnline() to test if the audio output is indeed online at a given time. In case of ambiguity when looking for an audio output by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Parameters

func	: a string that uniquely characterizes the audio output

Returns

a YAudioOut object allowing you to drive the audio output.

Definition at line 309 of file yocto_audioout.h.

YAudioOut* yFirstAudioOut ( void  )

inline

Starts the enumeration of audio outputs currently accessible. Use the method YAudioOut.nextAudioOut() to iterate on next audio outputs.

Returns

a pointer to a YAudioOut object, corresponding to the first audio output currently online, or a NULL pointer if there are none.

Definition at line 320 of file yocto_audioout.h.