CriAtomExSequencer API

Data Structures
struct	CriAtomExSequenceEventInfoTag
	Information structure used for sequence callback event. More...

Typedefs
typedef enum CriAtomExSequecneEventTypeTag	CriAtomExSequecneEventType
	Type of sequence event callback. More...
typedef struct CriAtomExSequenceEventInfoTag	CriAtomExSequenceEventInfo
	Information structure used for sequence callback event.
typedef CriSint32(*	CriAtomExSequencerEventCbFunc) (void *obj, const CriAtomExSequenceEventInfo *info)
	Sequence callback. More...

Enumerations
enum	CriAtomExSequecneEventTypeTag { CRIATOMEX_SEQUENCE_EVENT_TYPE_CALLBACK = 0 , CRIATOMEX_SEQUENCE_EVENT_TYPE_ENUM_SIZE_IS_4BYTES = 0x7FFFFFFF }
	Type of sequence event callback. More...

Functions
void	criAtomExSequencer_SetEventCallback (CriAtomExSequencerEventCbFunc func, void *obj)
	Register a sequence callback function. More...

Detailed Description

Typedef Documentation

CriAtomExSequecneEventType

typedef enum CriAtomExSequecneEventTypeTag CriAtomExSequecneEventType

Type of sequence event callback.

Description:

Type of sequence event callback for the AtomEx library.

See also

CriAtomExSequenceEventInfo

CriAtomExSequencerEventCbFunc

typedef CriSint32( * CriAtomExSequencerEventCbFunc) (void *obj, const CriAtomExSequenceEventInfo *info)

Sequence callback.

Description:

Parameters

[in]	obj	User-specified object
[in]	info	Sequence event information

Returns

Not used A sequence callback function type from the AtomEx library.
Call criAtomExSequencer_SetEventCallback to register the callback function.
The registered callback function will be executed when the sequence is processed in the server function.
Therefore, if you execute an API that does not take into account interrupts to server processing, This can lead to errors or deadlocks.
Generally, you should not use Atom Library APIs within your callback functions.
Note that if the process is blocked in the callback function for a long time, problems -such as the audio breaking up- may occur.

See also

criAtomExSequencer_SetEventCallback

Enumeration Type Documentation

CriAtomExSequecneEventTypeTag

enum CriAtomExSequecneEventTypeTag

Type of sequence event callback.

Description:

Type of sequence event callback for the AtomEx library.

See also

CriAtomExSequenceEventInfo

Enumerator
CRIATOMEX_SEQUENCE_EVENT_TYPE_CALLBACK	Sequence callback. Description: Callback event information embedded in a sequence data.

Function Documentation

criAtomExSequencer_SetEventCallback()

void criAtomExSequencer_SetEventCallback	(	CriAtomExSequencerEventCbFunc	func,
		void *	obj
	)

Register a sequence callback function.

Parameters

[in]	func	sequence callback function
[in]	obj	user-specified object

Description:

Registers a callback function that receives the information embedded in a sequence data.
It is called when a callback event is processed in the server process.

Attention

Therefore, if an API that does not take into account interrupts to the server process is executed, an error or a deadlock may occur.
Basically, do not use aany Atom library APIs within a callback function.
Note that if processes are blocked in the callback function for a long time, some problems such as a audio breakups may occur.

Only one callback function can be registered.
If perform a registration operation more than once, the already registered callback function will be overwritten by the callback function registered later.

By passing NULL to func, you can unregister the current callback function.

See also

CriAtomExSequencerEventCbFunc