Audio Object Layer API

Collaboration diagram for Audio Object Layer API:

Files
file	audio_object_common_api.h
	CXD5602 Audio Object Layer API.

Classes
struct	AudioObjReply

Enumerations
enum	AudioObjReplyType_e { AS_OBJ_REPLY_TYPE_REQ = 0 , AS_OBJ_REPLY_TYPE_EVT , AS_OBJ_REPLY_TYPE_FREE }

Functions
template<typename T >
bool	AS_ReceiveObjectReply (MsgQueId msgq_id, T *reply)
	Wait until an asynchronous event is received from the object layer. More...
bool	AS_ReceiveObjectReply (MsgQueId msgq_id, AudioObjReply *reply)
template<typename T >
bool	AS_ReceiveObjectReply (MsgQueId msgq_id, uint32_t ms, T *reply)
	Wait for the specified time until an asynchronous event is received from the object layer. More...
bool	AS_ReceiveObjectReply (MsgQueId msgq_id, uint32_t ms, AudioObjReply *reply)

Detailed Description

Function Documentation

AS_ReceiveObjectReply() [1/2]

bool AS_ReceiveObjectReply	(	MsgQueId	msgq_id,
		T *	reply
	)

Wait until an asynchronous event is received from the object layer.

Parameters

[in]	msgq_id	: ID of message queue to receive
[out]	reply	: information of replay message

Return values

true	: success
false	: failure

AS_ReceiveObjectReply() [2/2]

bool AS_ReceiveObjectReply	(	MsgQueId	msgq_id,
		uint32_t	ms,
		T *	reply
	)

Wait for the specified time until an asynchronous event is received from the object layer.

Parameters

[in]	msgq_id	: ID of message queue to receive
[in]	ms	: Wait time(ms)
[out]	reply	: information of replay message

Return values

true	: success
false	: failure