#include <yocto_audioout.h>

Inheritance diagram for YAudioOut:

Public Member Functions
virtual int	_invokeValueCallback (string value)

Y_MUTE_enum	get_mute (void)

int	get_noSignalFor (void)

int	get_signal (void)

int	get_volume (void)

string	get_volumeRange (void)

Y_MUTE_enum	mute (void)

YAudioOut *	next (void)

YAudioOut *	nextAudioOut (void)

int	noSignalFor (void)

virtual int	registerValueCallback (YAudioOutValueCallback callback)

int	set_mute (Y_MUTE_enum newval)

int	set_volume (int newval)

int	setMute (Y_MUTE_enum newval)

int	setVolume (int newval)

int	signal (void)

int	volume (void)

string	volumeRange (void)

	~YAudioOut ()

Public Member Functions inherited from YFunction
void	_clearDataStreamCache ()

string	_decode_json_string (const string &json)

string	_download (const string &url)

YDataStream *	_findDataStream (YDataSet &dataset, const string &def)

string	_get_json_path (const string &json, const string &path)

vector< string >	_json_get_array (const string &json)

string	_json_get_key (const string &json, const string &data)

string	_json_get_string (const string &json)

int	_parseEx (yJsonStateMachine &j)

virtual int	_parserHelper (void)

string	_parseString (yJsonStateMachine &j)

string	_request (const string &request)

string	_requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context)

void	_throw (YRETCODE errType, string errMsg)

YRETCODE	_upload (const string &path, const string &content)

YRETCODE	_uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context)

string	advertisedValue (void)

void	clearCache ()

string	describe (void)

string	errMessage (void)

string	errorMessage (void)

YRETCODE	errorType (void)

YRETCODE	errType (void)

YFUN_DESCR	functionDescriptor (void)

string	get_advertisedValue (void)

string	get_errorMessage (void)

YRETCODE	get_errorType (void)

virtual string	get_friendlyName (void)

YFUN_DESCR	get_functionDescriptor (void)

string	get_functionId (void)

string	get_hardwareId (void)

string	get_hubSerial ()

string	get_logicalName (void)

YModule *	get_module (void)

void *	get_userData (void)

bool	isOnline (void)

YRETCODE	load (int msValidity)

virtual string	loadAttribute (string attrName)

string	logicalName (void)

YModule *	module (void)

virtual int	muteValueCallbacks (void)

YFunction *	next (void)

YFunction *	nextFunction (void)

virtual int	registerValueCallback (YFunctionValueCallback callback)

int	set_advertisedValue (const string &newval)

int	set_logicalName (const string &newval)

void	set_userData (void *data)

int	setAdvertisedValue (const string &newval)

int	setLogicalName (const string &newval)

void	setUserData (void *data)

virtual int	unmuteValueCallbacks (void)

void *	userData (void)

virtual	~YFunction ()

Static Public Member Functions
static YAudioOut *	Find (string func)

static YAudioOut *	FindAudioOut (string func)

static YAudioOut *	First (void)

static YAudioOut *	FirstAudioOut (void)

Static Public Member Functions inherited from YFunction
static void	_ClearCache (void)

static YFunction *	Find (string func)

static YFunction *	FindFunction (string func)

static YFunction *	First (void)

static YFunction *	FirstFunction (void)

Static Public Attributes
static const Y_MUTE_enum	MUTE_FALSE = Y_MUTE_FALSE

static const Y_MUTE_enum	MUTE_INVALID = Y_MUTE_INVALID

static const Y_MUTE_enum	MUTE_TRUE = Y_MUTE_TRUE

static const int	NOSIGNALFOR_INVALID = YAPI_INVALID_INT

static const int	SIGNAL_INVALID = YAPI_INVALID_INT

static const int	VOLUME_INVALID = YAPI_INVALID_UINT

static const string	VOLUMERANGE_INVALID = YAPI_INVALID_STRING

Static Public Attributes inherited from YFunction
static const string	ADVERTISEDVALUE_INVALID = YAPI_INVALID_STRING

static const string	FRIENDLYNAME_INVALID = YAPI_INVALID_STRING

static const YFUN_DESCR	FUNCTIONDESCRIPTOR_INVALID = Y_FUNCTIONDESCRIPTOR_INVALID

static const string	FUNCTIONID_INVALID = YAPI_INVALID_STRING

static const string	HARDWAREID_INVALID = YAPI_INVALID_STRING

static const string	LOGICALNAME_INVALID = YAPI_INVALID_STRING

Protected Member Functions
virtual int	_parseAttr (YJSONObject *json_val)

	YAudioOut (const string &func)

Protected Member Functions inherited from YFunction
YRETCODE	_buildSetRequest (const string &changeattr, const string *changeval, string &request, string &errmsg)

string	_escapeAttr (const string &changeval)

YRETCODE	_getDescriptor (YFUN_DESCR &fundescr, string &errMsg)

YRETCODE	_getDevice (YDevice *&dev, string &errMsg)

YRETCODE	_load_unsafe (int msValidity)

YRETCODE	_nextFunction (string &hwId)

int	_parse (YJSONObject *j)

YRETCODE	_setAttr (string attrname, string newvalue)

	YFunction (const string &func)

Protected Attributes
Y_MUTE_enum	_mute

int	_noSignalFor

int	_signal

YAudioOutValueCallback	_valueCallbackAudioOut

int	_volume

string	_volumeRange

Protected Attributes inherited from YFunction
string	_advertisedValue

u64	_cacheExpiration

string	_className

std::map< string, YDataStream * >	_dataStreams

string	_func

YFUN_DESCR	_fundescr

string	_funId

string	_hwId

string	_lastErrorMsg

YRETCODE	_lastErrorType

string	_logicalName

string	_serial

yCRITICAL_SECTION	_this_cs

void *	_userData

YFunctionValueCallback	_valueCallbackFunction

Friends
YAudioOut *	yFindAudioOut (const string &func)

YAudioOut *	yFirstAudioOut (void)

Additional Inherited Members
Static Protected Member Functions inherited from YFunction
static void	_AddToCache (const string &classname, const string &func, YFunction *obj)

static YFunction *	_FindFromCache (const string &classname, const string &func)

static void	_UpdateTimedReportCallbackList (YFunction *func, bool add)

static void	_UpdateValueCallbackList (YFunction *func, bool add)

Static Protected Attributes inherited from YFunction
static std::map< string, YFunction * >	_cache

Detailed Description

YAudioOut Class: AudioOut function interface

The Yoctopuce application programming interface allows you to configure the volume of the outout.

Definition at line 75 of file yocto_audioout.h.

Constructor & Destructor Documentation

YAudioOut::YAudioOut ( const string & func )

protected

Definition at line 51 of file yocto_audioout.cpp.

YAudioOut::~YAudioOut ( )

Definition at line 64 of file yocto_audioout.cpp.

Member Function Documentation

int YAudioOut::_invokeValueCallback ( string value )

virtual

Reimplemented from YFunction.

Definition at line 371 of file yocto_audioout.cpp.

int YAudioOut::_parseAttr ( YJSONObject * json_val )

protectedvirtual

Reimplemented from YFunction.

Definition at line 73 of file yocto_audioout.cpp.

static YAudioOut* YAudioOut::Find ( string func )

inlinestatic

Definition at line 248 of file yocto_audioout.h.

YAudioOut * YAudioOut::FindAudioOut ( string func )

static

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 320 of file yocto_audioout.cpp.

static YAudioOut* YAudioOut::First ( void )

inlinestatic

Definition at line 272 of file yocto_audioout.h.

YAudioOut * YAudioOut::FirstAudioOut ( void )

static

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 391 of file yocto_audioout.cpp.

Y_MUTE_enum YAudioOut::get_mute ( void )

Returns the state of the mute function.

Returns: either Y_MUTE_FALSE or Y_MUTE_TRUE, according to the state of the mute function

On failure, throws an exception or returns Y_MUTE_INVALID.

Definition at line 155 of file yocto_audioout.cpp.

int YAudioOut::get_noSignalFor ( void )

Returns the number of seconds elapsed without detecting a signal.

Returns: an integer corresponding to the number of seconds elapsed without detecting a signal

On failure, throws an exception or returns Y_NOSIGNALFOR_INVALID.

Definition at line 271 of file yocto_audioout.cpp.

int YAudioOut::get_signal ( void )

Returns the detected output current level.

Returns: an integer corresponding to the detected output current level

On failure, throws an exception or returns Y_SIGNAL_INVALID.

Definition at line 242 of file yocto_audioout.cpp.

int YAudioOut::get_volume ( void )

Returns audio output volume, in per cents.

Returns: an integer corresponding to audio output volume, in per cents

On failure, throws an exception or returns Y_VOLUME_INVALID.

Definition at line 101 of file yocto_audioout.cpp.

string YAudioOut::get_volumeRange ( void )

Returns the supported volume range. The low value of the range corresponds to the minimal audible value. To completely mute the sound, use set_mute() instead of the set_volume().

Returns: a string corresponding to the supported volume range

On failure, throws an exception or returns Y_VOLUMERANGE_INVALID.

Definition at line 213 of file yocto_audioout.cpp.

Y_MUTE_enum YAudioOut::mute ( void )

inline

Definition at line 146 of file yocto_audioout.h.

YAudioOut* YAudioOut::next ( void )

inline

Definition at line 259 of file yocto_audioout.h.

YAudioOut * YAudioOut::nextAudioOut ( void )

Continues the enumeration of audio outputs started using yFirstAudioOut().

Returns: a pointer to a YAudioOut object, corresponding to an audio output currently online, or a NULL pointer if there are no more audio outputs to enumerate.

Definition at line 381 of file yocto_audioout.cpp.

int YAudioOut::noSignalFor ( void )

inline

Definition at line 199 of file yocto_audioout.h.

int YAudioOut::registerValueCallback ( YAudioOutValueCallback callback )

virtual

Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.

Parameters

callback : the callback function to call, or a NULL pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.

Definition at line 352 of file yocto_audioout.cpp.

int YAudioOut::set_mute ( Y_MUTE_enum newval )

Changes the state of the mute function. Remember to call the matching module saveToFlash() method to save the setting permanently.

Parameters

newval : either Y_MUTE_FALSE or Y_MUTE_TRUE, according to the state of the mute function

Returns: YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 187 of file yocto_audioout.cpp.

int YAudioOut::set_volume ( int newval )

Changes audio output volume, in per cents.

Parameters

newval : an integer corresponding to audio output volume, in per cents

Returns: YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 132 of file yocto_audioout.cpp.

int YAudioOut::setMute ( Y_MUTE_enum newval )

inline

Definition at line 160 of file yocto_audioout.h.

int YAudioOut::setVolume ( int newval )

inline

Definition at line 134 of file yocto_audioout.h.

int YAudioOut::signal ( void )

inline

Definition at line 187 of file yocto_audioout.h.

int YAudioOut::volume ( void )

inline

Definition at line 121 of file yocto_audioout.h.

string YAudioOut::volumeRange ( void )

inline

Definition at line 175 of file yocto_audioout.h.

Friends And Related Function Documentation

YAudioOut* yFindAudioOut ( const string & func )

friend

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 )

friend

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.

Member Data Documentation

Y_MUTE_enum YAudioOut::_mute

protected

Definition at line 84 of file yocto_audioout.h.

int YAudioOut::_noSignalFor

protected

Definition at line 87 of file yocto_audioout.h.

int YAudioOut::_signal

protected

Definition at line 86 of file yocto_audioout.h.

YAudioOutValueCallback YAudioOut::_valueCallbackAudioOut

protected

Definition at line 88 of file yocto_audioout.h.

int YAudioOut::_volume

protected

Definition at line 83 of file yocto_audioout.h.

string YAudioOut::_volumeRange

protected

Definition at line 85 of file yocto_audioout.h.

const Y_MUTE_enum YAudioOut::MUTE_FALSE = Y_MUTE_FALSE

static

Definition at line 105 of file yocto_audioout.h.

const Y_MUTE_enum YAudioOut::MUTE_INVALID = Y_MUTE_INVALID

static

Definition at line 107 of file yocto_audioout.h.

const Y_MUTE_enum YAudioOut::MUTE_TRUE = Y_MUTE_TRUE

static

Definition at line 106 of file yocto_audioout.h.

const int YAudioOut::NOSIGNALFOR_INVALID = YAPI_INVALID_INT

static

Definition at line 110 of file yocto_audioout.h.

const int YAudioOut::SIGNAL_INVALID = YAPI_INVALID_INT

static

Definition at line 109 of file yocto_audioout.h.

const int YAudioOut::VOLUME_INVALID = YAPI_INVALID_UINT

static

Definition at line 104 of file yocto_audioout.h.

const string YAudioOut::VOLUMERANGE_INVALID = YAPI_INVALID_STRING

static

Definition at line 108 of file yocto_audioout.h.

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation