Data Structures
struct	CriAtomExCategoryInfoTag
	Structure used to get information about a category. More...

struct	CriAtomExReactFadeParameterTag
	Curve Type of Ducking by REACT. More...

struct	CriAtomExReactDuckerParameterTag
	REACT ducker parameter structure. More...

struct	CriAtomExReactAisacModulationParameterTag
	AISAC modulation trigger parameter structure. More...

struct	CriAtomExReactParameterTag
	REACT drive parameter structure. More...

Macros
#define	CRIATOMEXCATEGORY_MAX_CATEGORIES_PER_PLAYBACK (16)
	Maximum number of category references per playbackThe maximum number of category references per playback. More...

Typedefs
typedef CriUint32	CriAtomExCategoryId
	Category ID. More...

typedef struct CriAtomExCategoryInfoTag	CriAtomExCategoryInfo
	Structure used to get information about a category. More...

typedef enum CriAtomExReactTypeTag	CriAtomExReactType
	REACT Type. More...

typedef enum CriAtomExReactDuckerTargetTypeTag	CriAtomExReactDuckerTargetType
	Target of Ducking by REACT. More...

typedef struct CriAtomExReactFadeParameterTag	CriAtomExReactFadeParameter
	Curve Type of Ducking by REACT. More...

typedef enum CriAtomExReactHoldTypeTag	CriAtomExReactHoldType
	REACT Hold Type. More...

typedef struct CriAtomExReactDuckerParameterTag	CriAtomExReactDuckerParameter
	REACT ducker parameter structure. More...

typedef struct CriAtomExReactAisacModulationParameterTag	CriAtomExReactAisacModulationParameter
	AISAC modulation trigger parameter structure. More...

typedef struct CriAtomExReactParameterTag	CriAtomExReactParameter
	REACT drive parameter structure. More...

typedef enum CriAtomExReactStatusTag	CriAtomExReactStatus
	REACT Operation Status. More...

Enumerations
enum	CriAtomExReactTypeTag { CRIATOMEX_REACT_TYPE_DUCKER = 0 , CRIATOMEX_REACT_TYPE_AISAC_MODULATION_TRIGGER , CRIATOMEX_REACT_TYPE_ENUM_SIZE_IS_4BYTES = 0x7FFFFFFF }
	REACT Type. More...

enum	CriAtomExReactDuckerTargetTypeTag { CRIATOMEX_REACT_DUCKER_TARGET_TYPE_VOLUME = 0 , CRIATOMEX_REACT_DUCKER_TARGET_TYPE_AISAC_CONTROL_VALUE , CRIATOMEX_REACT_DUCKER_TARGET_TYPE_ENUM_SIZE_IS_4BYTES = 0x7FFFFFFF }
	Target of Ducking by REACT. More...

enum	CriAtomExReactHoldTypeTag { CRIATOMEX_REACT_HOLD_TYPE_WHILE_PLAYING , CRIATOMEX_REACT_HOLD_TYPE_FIXED_TIME , CRIATOMEX_REACT_HOLD_TYPE_ENUM_SIZE_IS_4BYTES = 0x7FFFFFFF }
	REACT Hold Type. More...

enum	CriAtomExReactStatusTag { CRIATOMEX_REACT_STATUS_STOP = 0 , CRIATOMEX_REACT_STATUS_FADEOUT , CRIATOMEX_REACT_STATUS_HOLD , CRIATOMEX_REACT_STATUS_FADEIN , CRIATOMEX_REACT_STATUS_ERROR , CRIATOMEX_REACT_STATUS_ENUM_SIZE_IS_4BYTES = 0x7FFFFFFF }
	REACT Operation Status. More...

Functions
void	criAtomExCategory_SetVolumeById (CriAtomExCategoryId id, CriFloat32 volume)
	Set the volume of a category specified by its ID. More...

CriFloat32	criAtomExCategory_GetVolumeById (CriAtomExCategoryId id)
	Get the volume of a category specified by its ID. More...

CriFloat32	criAtomExCategory_GetTotalVolumeById (CriAtomExCategoryId id)
	Get the final volume of a category specified by its ID. More...

void	criAtomExCategory_SetVolumeByName (const CriChar8 *name, CriFloat32 volume)
	Set the volume of a category specified by its name. More...

CriFloat32	criAtomExCategory_GetVolumeByName (const CriChar8 *name)
	Get the volume of a category specified by its name. More...

CriFloat32	criAtomExCategory_GetTotalVolumeByName (const CriChar8 *name)
	Get the final volume of a category specified by its name. More...

void	criAtomExCategory_MuteById (CriAtomExCategoryId id, CriBool mute)
	Mute / unmute a category specified by its ID. More...

CriBool	criAtomExCategory_IsMutedById (CriAtomExCategoryId id)
	Return whether a category (specified by its ID) is muted or not. More...

void	criAtomExCategory_MuteByName (const CriChar8 *name, CriBool mute)
	Mute / unmute a category specified by its name. More...

CriBool	criAtomExCategory_IsMutedByName (const CriChar8 *name)
	Return whether a category (specified by its name) is muted or not. More...

void	criAtomExCategory_SoloById (CriAtomExCategoryId id, CriBool solo, CriFloat32 mute_volume)
	Solo / unsolo a category specified by its ID. More...

CriBool	criAtomExCategory_IsSoloedById (CriAtomExCategoryId id)
	Return whether a category (specified by its ID) is solo'ed or not. More...

void	criAtomExCategory_SoloByName (const CriChar8 *name, CriBool solo, CriFloat32 mute_volume)
	Solo / unsolo a category specified by its name. More...

CriBool	criAtomExCategory_IsSoloedByName (const CriChar8 *name)
	Return whether a category (specified by its name) is solo'ed or not. More...

void	criAtomExCategory_PauseById (CriAtomExCategoryId id, CriBool sw)
	Pause/resume a category specified by its ID. More...

CriBool	criAtomExCategory_IsPausedById (CriAtomExCategoryId id)
	Get the pause status of a category specified by its ID. More...

void	criAtomExCategory_PauseByName (const CriChar8 *name, CriBool sw)
	Pause/resume category specified by name. More...

CriBool	criAtomExCategory_IsPausedByName (const CriChar8 *name)
	Get the pause status of a category specified by its name. More...

void	criAtomExCategory_SetFadeInTimeById (CriAtomExCategoryId id, CriUint16 ms)
	Set the fade-in time of a category specified by its ID. More...

void	criAtomExCategory_SetFadeInTimeByName (const CriChar8 *name, CriUint16 ms)
	Set the fade-in time of a category specified by its name. More...

void	criAtomExCategory_SetFadeOutTimeById (CriAtomExCategoryId id, CriUint16 ms)
	Set the fade-out time of a category specified by its ID. More...

void	criAtomExCategory_SetFadeOutTimeByName (const CriChar8 *name, CriUint16 ms)
	Set the fade-out time of a category specified by its name. More...

void	criAtomExCategory_SetAisacControlById (CriAtomExCategoryId id, CriAtomExAisacControlId control_id, CriFloat32 control_value)
	Set the AISAC control value of a category specified by its ID. More...

void	criAtomExCategory_SetAisacControlByName (const CriChar8 name, const CriChar8 control_name, CriFloat32 control_value)
	Set the AISAC control value of a category specified by its name. More...

CriBool	criAtomExCategory_ResetAllAisacControlById (CriAtomExCategoryId category_id)
	All AISAC control values attached to categories by ID designation are set to default values. More...

CriBool	criAtomExCategory_ResetAllAisacControlByName (const CriChar8 *category_name)
	All AISAC control values attached to categories by name designation are set to default values. More...

void	criAtomExCategory_AttachAisacById (CriAtomExCategoryId id, const CriChar8 *global_aisac_name)
	Attach a global AISAC to a category specified by its ID. More...

void	criAtomExCategory_AttachAisacByName (const CriChar8 name, const CriChar8 global_aisac_name)
	Attach a global AISAC to a category specified by its name. More...

void	criAtomExCategory_DetachAisacById (CriAtomExCategoryId id, const CriChar8 *global_aisac_name)
	Detach an AISAC from a category specified by its ID. More...

void	criAtomExCategory_DetachAisacByName (const CriChar8 name, const CriChar8 global_aisac_name)
	Detach an AISAC from a category specified by its name. More...

void	criAtomExCategory_DetachAisacAllById (CriAtomExCategoryId id)
	Detach all the AISACs from a category specified by its ID. More...

void	criAtomExCategory_DetachAisacAllByName (const CriChar8 *name)
	Detach all the AISACs from a category specified by its name. More...

CriSint32	criAtomExCategory_GetNumAttachedAisacsById (CriAtomExCategoryId id)
	Get the number of AISACs attached to a category specified by its ID. More...

CriSint32	criAtomExCategory_GetNumAttachedAisacsByName (const CriChar8 *name)
	Get the number of AISACs attached to a category specified by its name. More...

CriBool	criAtomExCategory_GetAttachedAisacInfoById (CriAtomExCategoryId id, CriSint32 aisac_attached_index, CriAtomExAisacInfo *aisac_info)
	Get information about an AISAC attached to a category (specified by its ID) More...

CriBool	criAtomExCategory_GetAttachedAisacInfoByName (const CriChar8 name, CriSint32 aisac_attached_index, CriAtomExAisacInfo aisac_info)
	Get information about an AISAC attached to a category (specified by its name) More...

CriBool	criAtomExCategory_GetCurrentAisacControlValueById (CriAtomExCategoryId category_id, CriAtomExAisacControlId aisac_control_id, CriFloat32 *control_value)
	Acquire the current value of the AISAC control attached to the category by ID specification. More...

CriBool	criAtomExCategory_GetCurrentAisacControlValueByName (const CriChar8 category_name, const CriChar8 aisac_control_name, CriFloat32 *control_value)
	Gets current value of AISAC control attached to category by name specification. More...

void	criAtomExCategory_SetReactParameter (const CriChar8 react_name, const CriAtomExReactParameter react_parameter)
	Set REACT drive parameter. More...

CriBool	criAtomExCategory_GetReactParameter (const CriChar8 react_name, CriAtomExReactParameter react_parameter)
	Get REACT drive parameter. More...

CriAtomExReactStatus	criAtomExCategory_GetReactStatus (const CriChar8 *react_name)
	Getting the status of REACT. More...

CriSint32	criAtomExCategory_GetNumCuePlayingCountById (CriAtomExCategoryId id)
	Get the number of playing Cues attached to a category (specified by its ID) More...

CriSint32	criAtomExCategory_GetNumCuePlayingCountByName (const CriChar8 *name)
	Get the number of playing Cues attached to a category (specified by its name) More...

void	criAtomExCategory_StopById (CriAtomExCategoryId id)
	Stop the playing Cues that belong to the category having the given ID. More...

void	criAtomExCategory_StopByName (const CriChar8 *name)
	Stop the playing Cues that belong to the category having the given name. More...

void	criAtomExCategory_StopWithoutReleaseTimeById (CriAtomExCategoryId id)
	Immediately stop the playing Cues that belong to the category having the given ID. More...

void	criAtomExCategory_StopWithoutReleaseTimeByName (const CriChar8 *name)
	Immediately stop the playing Cues that belong to the category having the given name. More...

Detailed Description

Macro Definition Documentation

◆ CRIATOMEXCATEGORY_MAX_CATEGORIES_PER_PLAYBACK

#define CRIATOMEXCATEGORY_MAX_CATEGORIES_PER_PLAYBACK (16)

Maximum number of category references per playbackThe maximum number of category references per playback.

See also: CriAtomExCueInfo

Typedef Documentation

◆ CriAtomExCategoryId

typedef CriUint32 CriAtomExCategoryId

Category ID.

Description:: A unique ID assigned to a category by the user in the authoring tool.
It is used to reference a specific category across the application.

See also: criAtomExCategory_SetVolumeById, criAtomExCategory_MuteById, criAtomExCategory_SoloById

◆ CriAtomExCategoryInfo

typedef struct CriAtomExCategoryInfoTag CriAtomExCategoryInfo

Structure used to get information about a category.

Description:: Structure used to get information about a category.
It is passed to the criAtomExAcf_GetCategoryInfo function which fills it.

See also: criAtomExAcf_GetCategoryInfo

◆ CriAtomExReactType

typedef enum CriAtomExReactTypeTag CriAtomExReactType

REACT Type.

Description:: REACT Type.

See also: CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ CriAtomExReactDuckerTargetType

typedef enum CriAtomExReactDuckerTargetTypeTag CriAtomExReactDuckerTargetType

Target of Ducking by REACT.

Description:: Target type of ducking by REACT.

See also: CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ CriAtomExReactFadeParameter

typedef struct CriAtomExReactFadeParameterTag CriAtomExReactFadeParameter

Curve Type of Ducking by REACT.

Description:: This is a structure for getting and setting fade drive parameter information of REACT.

See also: CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ CriAtomExReactHoldType

typedef enum CriAtomExReactHoldTypeTag CriAtomExReactHoldType

REACT Hold Type.

Description:: REACT hold (Attenuation time maintenance) type.

See also: CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ CriAtomExReactDuckerParameter

typedef struct CriAtomExReactDuckerParameterTag CriAtomExReactDuckerParameter

REACT ducker parameter structure.

Description:: This is a structure for getting and setting drive parameter information of ducker by REACT.

See also: CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ CriAtomExReactAisacModulationParameter

typedef struct CriAtomExReactAisacModulationParameterTag CriAtomExReactAisacModulationParameter

AISAC modulation trigger parameter structure.

Description:: This is a structure for getting and setting drive parameter information of AISAC modulation trigger.

See also: CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ CriAtomExReactParameter

typedef struct CriAtomExReactParameterTag CriAtomExReactParameter

REACT drive parameter structure.

Description:: This is a structure for getting and setting drive parameter information of REACT.
Pass it as an argument to the criAtomExCategory_SetReactParameter function or the criAtomExCategory_GetReactParameter function.

See also: criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ CriAtomExReactStatus

typedef enum CriAtomExReactStatusTag CriAtomExReactStatus

REACT Operation Status.

Description:: This value indicates the operating status of REACT.

See also: criAtomExCategory_SetReactParameter

Enumeration Type Documentation

◆ CriAtomExReactTypeTag

enum CriAtomExReactTypeTag

REACT Type.

Description:: REACT Type.

See also: CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

Enumerator
CRIATOMEX_REACT_TYPE_DUCKER	Ducker
CRIATOMEX_REACT_TYPE_AISAC_MODULATION_TRIGGER	AISAC Modulation Trigger

◆ CriAtomExReactDuckerTargetTypeTag

enum CriAtomExReactDuckerTargetTypeTag

Target of Ducking by REACT.

Description:: Target type of ducking by REACT.

See also: CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

Enumerator
CRIATOMEX_REACT_DUCKER_TARGET_TYPE_VOLUME	Ducker of Volume
CRIATOMEX_REACT_DUCKER_TARGET_TYPE_AISAC_CONTROL_VALUE	Ducker of AISAC Control Value

◆ CriAtomExReactHoldTypeTag

enum CriAtomExReactHoldTypeTag

REACT Hold Type.

Description:: REACT hold (Attenuation time maintenance) type.

See also: CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

Enumerator
CRIATOMEX_REACT_HOLD_TYPE_WHILE_PLAYING	Hold during playback
CRIATOMEX_REACT_HOLD_TYPE_FIXED_TIME	Hold at a fixed time

◆ CriAtomExReactStatusTag

enum CriAtomExReactStatusTag

REACT Operation Status.

Description:: This value indicates the operating status of REACT.

See also: criAtomExCategory_SetReactParameter

Enumerator
CRIATOMEX_REACT_STATUS_STOP	Stopped
CRIATOMEX_REACT_STATUS_FADEOUT	Starting operation
CRIATOMEX_REACT_STATUS_HOLD	Operation continuing
CRIATOMEX_REACT_STATUS_FADEIN	Operation ending
CRIATOMEX_REACT_STATUS_ERROR	Error

Function Documentation

◆ criAtomExCategory_SetVolumeById()

void criAtomExCategory_SetVolumeById	(	CriAtomExCategoryId	id,
		CriFloat32	volume
	)

Set the volume of a category specified by its ID.

Parameters

[in]	id	category ID
[in]	volume	volume value

Description:: Sets the volume of a category specified by its ID.

Attention: The value set by this function overwrites the category volume set in the ACF.
Please note that there is no multiplication between this value and the one set in the ACF.

◆ criAtomExCategory_GetVolumeById()

CriFloat32 criAtomExCategory_GetVolumeById ( CriAtomExCategoryId id )

Get the volume of a category specified by its ID.

Parameters

[in] id category ID

Returns: CriFloat32 category volume

Description:: Gets the volume assigned to a category specified by its ID.

◆ criAtomExCategory_GetTotalVolumeById()

CriFloat32 criAtomExCategory_GetTotalVolumeById ( CriAtomExCategoryId id )

Get the final volume of a category specified by its ID.

Parameters

[in] id Category ID return CriFloat32 Category volume

Description:: Gets the final volume of a category specified by its ID (based on how it has been affected by REACT, AISAC, etc...).

Remarks:: This function is CPU-intensive due to the parameter calculations required to get the final category volume value.

◆ criAtomExCategory_SetVolumeByName()

void criAtomExCategory_SetVolumeByName	(	const CriChar8 *	name,
		CriFloat32	volume
	)

Set the volume of a category specified by its name.

Parameters

[in]	name	category name
[in]	volume	volume value

Description:: Sets the volume of a category specified by its name.

Attention: The setting value by this function overwrites the category volume set by ACF.
Please note that multiplication of setting value by this function and ACF set value is not applied.

◆ criAtomExCategory_GetVolumeByName()

CriFloat32 criAtomExCategory_GetVolumeByName ( const CriChar8 * name )

Get the volume of a category specified by its name.

Parameters

[in] name category name

Returns: CriFloat32 category volume

Description:: Gets the volume applied to a category specified by its name.

◆ criAtomExCategory_GetTotalVolumeByName()

CriFloat32 criAtomExCategory_GetTotalVolumeByName ( const CriChar8 * name )

Get the final volume of a category specified by its name.

Parameters

[in] name Category name return CriFloat32 Category volume

Description:: Gets the final volume of a category specified by its name (based on how it has been affected by REACT, AISAC, etc...).

Remarks:: This function is CPU-intensive due to the parameter calculations required to acquire the final category volume value.

◆ criAtomExCategory_MuteById()

void criAtomExCategory_MuteById	(	CriAtomExCategoryId	id,
		CriBool	mute
	)

Mute / unmute a category specified by its ID.

Parameters

[in]	id	category ID
[in]	mute	Mute status (CRI_TRUE = Mute, CRI_FALSE = Unmute)

Description:: Mutes / unmutes a category specified by its ID.

◆ criAtomExCategory_IsMutedById()

CriBool criAtomExCategory_IsMutedById ( CriAtomExCategoryId id )

Return whether a category (specified by its ID) is muted or not.

Parameters

[in] id category ID return CriBool Mute status (CRI_TRUE = Muted, CRI_FALSE = Not muted)

Description:: Returns whether a category (specified by its name) is muted or not.

◆ criAtomExCategory_MuteByName()

void criAtomExCategory_MuteByName	(	const CriChar8 *	name,
		CriBool	mute
	)

Mute / unmute a category specified by its name.

Parameters

[in]	name	category name
[in]	mute	Mute status (CRI_TRUE = Mute, CRI_FALSE = Unmute)

Description:: Mutes / unmutes a category specified by its name.

◆ criAtomExCategory_IsMutedByName()

CriBool criAtomExCategory_IsMutedByName ( const CriChar8 * name )

Return whether a category (specified by its name) is muted or not.

Parameters

[in] name category name return CriBool Mute status (CRI_TRUE = Muted, CRI_FALSE = Not muted)

Description:: Returns whether a category (specified by its name) is muted or not.

◆ criAtomExCategory_SoloById()

void criAtomExCategory_SoloById	(	CriAtomExCategoryId	id,
		CriBool	solo,
		CriFloat32	mute_volume
	)

Solo / unsolo a category specified by its ID.

Parameters

[in]	id	category ID
[in]	solo	solo status (CRI_TRUE = Solo, CRI_FALSE = Not solo)
[in]	mute_volume	volume applied to the other categories

Description:: Solo / unsolo the category specified by its ID.
The volume specified in mute_volume is applied to the other categories from the same category group.

◆ criAtomExCategory_IsSoloedById()

CriBool criAtomExCategory_IsSoloedById ( CriAtomExCategoryId id )

Return whether a category (specified by its ID) is solo'ed or not.

Parameters

[in] id category ID return CriBool solo status (CRI_TRUE = Solo, CRI_FALSE = Not solo)

Description:: Returns whether a category (specified by its ID) is solo'ed or not.

◆ criAtomExCategory_SoloByName()

void criAtomExCategory_SoloByName	(	const CriChar8 *	name,
		CriBool	solo,
		CriFloat32	mute_volume
	)

Solo / unsolo a category specified by its name.

Parameters

[in]	name	category name
[in]	solo	solo status (CRI_TRUE = Solo, CRI_FALSE = Not solo)
[in]	mute_volume	volume applied to the other categories

Description:: Solo / unsolo the category specified by its name.
The volume specified in mute_volume is applied to the other categories from the same category group.

◆ criAtomExCategory_IsSoloedByName()

CriBool criAtomExCategory_IsSoloedByName ( const CriChar8 * name )

Return whether a category (specified by its name) is solo'ed or not.

Parameters

[in] name category name return CriBool solo status (CRI_TRUE = Solo, CRI_FALSE = Not solo)

Description:: Returns whether a category (specified by its name) is solo'ed or not.

◆ criAtomExCategory_PauseById()

void criAtomExCategory_PauseById	(	CriAtomExCategoryId	id,
		CriBool	sw
	)

Pause/resume a category specified by its ID.

Parameters

[in]	id	category ID
[in]	sw	switch (CRI_FALSE = resume, CRI_TRUE = pause)

Description:: Pauses or resumes a category specified by its ID.
If this function is called when the fade-out time is set by the criAtomExCategory_SetFadeOutTimeById or criAtomExCategory_SetFadeOutTimeByName functions, the category is paused after it has faded-out over the specified time.
If this function is called when the fade-out time is set by the criAtomExCategory_SetFadeInTimeById or criAtomExCategory_SetFadeInTimeByName functions, the category fades-in over the specified time after it has resumed.

Remarks:: Pausing a category is handled independently from pausing an AtomEx player/playback sound (i.e. pausing with the criAtomExPlayer_Pause or criAtomExPlayback_Pause functions). The final pause status is determined based on both these pause statuses.
In short, it is paused when both are paused, or resumed when both are resumed.

◆ criAtomExCategory_IsPausedById()

CriBool criAtomExCategory_IsPausedById ( CriAtomExCategoryId id )

Get the pause status of a category specified by its ID.

Parameters

[in] id category ID

Returns: CriBool pause status

Description:: Gets the pause status of a category specified by its ID.

◆ criAtomExCategory_PauseByName()

void criAtomExCategory_PauseByName	(	const CriChar8 *	name,
		CriBool	sw
	)

Pause/resume category specified by name.

Parameters

[in]	name	category name
[in]	sw	switch (CRI_FALSE = resume, CRI_TRUE = pause)

Description:: Pauses or resumes a category specified by its name.
Equivalent to the criAtomExCategory_PauseById function, except that the category is specified by name.

See also: criAtomExCategory_PauseById

◆ criAtomExCategory_IsPausedByName()

CriBool criAtomExCategory_IsPausedByName ( const CriChar8 * name )

Get the pause status of a category specified by its name.

Parameters

[in] name category name

Returns: CriBool pause status

Description:: Gets the pause status of a category specified by its name.

◆ criAtomExCategory_SetFadeInTimeById()

void criAtomExCategory_SetFadeInTimeById	(	CriAtomExCategoryId	id,
		CriUint16	ms
	)

Set the fade-in time of a category specified by its ID.

Parameters

[in]	id	category ID
[in]	ms	fade-in time (milliseconds)

Description:: Sets the fade-in time of a category specified by its ID.
The fade-in time is used when resuming the category.

◆ criAtomExCategory_SetFadeInTimeByName()

void criAtomExCategory_SetFadeInTimeByName	(	const CriChar8 *	name,
		CriUint16	ms
	)

Set the fade-in time of a category specified by its name.

Parameters

[in]	name	category name
[in]	ms	fade-in time (milliseconds)

Description:: Sets the fade-in time of a category specified by its name.
The fade-in time is used when resuming the category.

◆ criAtomExCategory_SetFadeOutTimeById()

void criAtomExCategory_SetFadeOutTimeById	(	CriAtomExCategoryId	id,
		CriUint16	ms
	)

Set the fade-out time of a category specified by its ID.

Parameters

[in]	id	category ID
[in]	ms	fade-out time (milliseconds)

Description:: Sets the fade-out time of a category specified by its ID.
The fade-out time is used when pausing the category.

◆ criAtomExCategory_SetFadeOutTimeByName()

void criAtomExCategory_SetFadeOutTimeByName	(	const CriChar8 *	name,
		CriUint16	ms
	)

Set the fade-out time of a category specified by its name.

Parameters

[in]	name	category name
[in]	ms	fade-out time (milliseconds)

Description:: Sets the fade-out time of a category specified by its name.
The fade-out time is used when pausing the category.

◆ criAtomExCategory_SetAisacControlById()

void criAtomExCategory_SetAisacControlById	(	CriAtomExCategoryId	id,
		CriAtomExAisacControlId	control_id,
		CriFloat32	control_value
	)

Set the AISAC control value of a category specified by its ID.

Parameters

[in]	id	category ID
[in]	control_id	AISAC control ID
[in]	control_value	AISAC control value

Description:: Sets the AISAC control value of a category specified by its ID

Remarks:: Use the criAtomExAcf_GetAisacControlIdByName function when you want to specify the category by ID and the AISAC control by name.

Attention: For AISACs set to Cues or tracks, higher priority is given to the category's AISAC control value rather than to the player's AISAC control value.
For AISACs attached to categories, only the AISAC control values set to the categories are taken into account.

See also: criAtomExCategory_SetAisacControlByName, criAtomExCategory_AttachAisacById, criAtomExCategory_AttachAisacByName

◆ criAtomExCategory_SetAisacControlByName()

void criAtomExCategory_SetAisacControlByName	(	const CriChar8 *	name,
		const CriChar8 *	control_name,
		CriFloat32	control_value
	)

Set the AISAC control value of a category specified by its name.

Parameters

[in]	name	category name
[in]	control_name	AISAC control name
[in]	control_value	AISAC control value

Description:: Sets the AISAC control value of a category specified by its name.
Equivalent to the criAtomExCategory_SetAisacControlById function, except that category and AISAC control are both specified by name.

Remarks:: Use the criAtomExAcf_GetAisacControlNameById function when you want to specify the category by name and the AISAC control by ID.

See also: criAtomExCategory_SetAisacControlById, criAtomExCategory_AttachAisacById, criAtomExCategory_AttachAisacByName

◆ criAtomExCategory_ResetAllAisacControlById()

CriBool criAtomExCategory_ResetAllAisacControlById ( CriAtomExCategoryId category_id )

All AISAC control values attached to categories by ID designation are set to default values.

Parameters

[in] id Category ID

Return values

CRI_TRUE	= Success
CRI_FALSE	= Failure

Description:: Setting all AISAC control values attached to the category to default values.
If you specify a category that does not exist, CRI_FALSE is returned.

See also: criAtomExCategory_GetNumAttachedAisacsById

◆ criAtomExCategory_ResetAllAisacControlByName()

CriBool criAtomExCategory_ResetAllAisacControlByName ( const CriChar8 * category_name )

All AISAC control values attached to categories by name designation are set to default values.

Parameters

[in] name Catefory Name

Return values

CRI_TRUE	= Success
CRI_FALSE	= Failure

Description:: Setting all AISAC control values attached to the category to default values.
If you specify a category that does not exist, CRI_FALSE is returned.

See also: criAtomExCategory_GetNumAttachedAisacsById

◆ criAtomExCategory_AttachAisacById()

void criAtomExCategory_AttachAisacById	(	CriAtomExCategoryId	id,
		const CriChar8 *	global_aisac_name
	)

Attach a global AISAC to a category specified by its ID.

Parameters

[in]	id	category ID
[in]	global_aisac_name	name of the global AISAC to attach

Description:: Attaches a global AISAC to a category specified by its ID. By attaching a global AISAC at run-time, it is possible to use the AISAC control feature even when there is no AISAC assigned to a Cue or a track in the data.

If the attachment of the AISAC has failed, an error callback is triggered.
To know the reason of the failure, refer to the callback message.

Remarks:: Only global AISACs included in the global settings (ACF file) can be attached.
The relevant AISAC control value must be set like for an AISAC configured for Cues or tracks.

Attention: Even when an AISAC that modifies AISAC control values is set to Cues or tracks, the resulting AISAC control values do not affect the AISACs attached to the categories.
For AISACs attached to categories, only the AISAC control values set to the categories are taken into account.
Currently, attaching an AISAC whose control type is "auto modulation" or "random" is not supported.
The maximum number of AISACs that can be attached to a category is eight.

See also: criAtomExCategory_DetachAisacById

◆ criAtomExCategory_AttachAisacByName()

void criAtomExCategory_AttachAisacByName	(	const CriChar8 *	name,
		const CriChar8 *	global_aisac_name
	)

Attach a global AISAC to a category specified by its name.

Parameters

[in]	name	category name
[in]	global_aisac_name	name of the global AISAC to be attached

Description:: Attaches a global AISAC to a category specified by its name. Equivalent to the criAtomExCategory_AttachAisacById function, except that the category is specified by its name.

See also: criAtomExCategory_AttachAisacById, criAtomExCategory_DetachAisacByName

◆ criAtomExCategory_DetachAisacById()

void criAtomExCategory_DetachAisacById	(	CriAtomExCategoryId	id,
		const CriChar8 *	global_aisac_name
	)

Detach an AISAC from a category specified by its ID.

Parameters

[in]	id	category ID
[in]	global_aisac_name	name of the global AISAC to detach

Description:: Detaches a global AISAC from a category specified by its ID.

If the function fails, an error callback is triggered.
For the reason of the failure, refer to the callback message.

See also: criAtomExCategory_AttachAisacById

◆ criAtomExCategory_DetachAisacByName()

void criAtomExCategory_DetachAisacByName	(	const CriChar8 *	name,
		const CriChar8 *	global_aisac_name
	)

Detach an AISAC from a category specified by its name.

Parameters

[in]	name	category name
[in]	global_aisac_name	name of the global AISAC to detach

Description:: Detaches a global AISAC from a category specified by its name.
Equivalent to the criAtomExCategory_DetachAisacById function, except that the category is specified by its name.

See also: criAtomExCategory_DetachAisacById, criAtomExCategory_AttachAisacByName

◆ criAtomExCategory_DetachAisacAllById()

void criAtomExCategory_DetachAisacAllById ( CriAtomExCategoryId id )

Detach all the AISACs from a category specified by its ID.

Parameters

[in] id category ID

Description:: Detaches all the AISACs from a category.

◆ criAtomExCategory_DetachAisacAllByName()

void criAtomExCategory_DetachAisacAllByName ( const CriChar8 * name )

Detach all the AISACs from a category specified by its name.

Parameters

[in] name category name

Description:: Detaches all the AISACs from a category.

◆ criAtomExCategory_GetNumAttachedAisacsById()

CriSint32 criAtomExCategory_GetNumAttachedAisacsById ( CriAtomExCategoryId id )

Get the number of AISACs attached to a category specified by its ID.

Parameters

[in] id category ID

Returns: number of AISACs attached to the category

Description:: Gets the number of AISACs attached to a category specified by its ID.
If the category does not exist, a negative value is returned.

◆ criAtomExCategory_GetNumAttachedAisacsByName()

CriSint32 criAtomExCategory_GetNumAttachedAisacsByName ( const CriChar8 * name )

Get the number of AISACs attached to a category specified by its name.

Parameters

[in] name category name

Returns: number of AISACs attached to the category

Description:: Gets the number of AISACs attached to a category specified its name. If the category does not exist, a negative value is returned.

◆ criAtomExCategory_GetAttachedAisacInfoById()

CriBool criAtomExCategory_GetAttachedAisacInfoById	(	CriAtomExCategoryId	id,
		CriSint32	aisac_attached_index,
		CriAtomExAisacInfo *	aisac_info
	)

Get information about an AISAC attached to a category (specified by its ID)

Parameters

[in]	id	category ID
[in]	aisac_attached_index	index of the attached AISAC
[out]	aisac_info	AISAC information

Return values

CRI_TRUE	= information successfully acquired
CRI_TRUE	= failed to get information

Description:: Gets information about an AISAC attached to a category.
If the category does not exist or the AISAC index is invalid, CRI_FALSE is returned.

See also: criAtomExCategory_GetNumAttachedAisacsById

◆ criAtomExCategory_GetAttachedAisacInfoByName()

CriBool criAtomExCategory_GetAttachedAisacInfoByName	(	const CriChar8 *	name,
		CriSint32	aisac_attached_index,
		CriAtomExAisacInfo *	aisac_info
	)

Get information about an AISAC attached to a category (specified by its name)

Parameters

[in]	name	category name
[in]	aisac_attached_index	index of the attached AISAC
[out]	aisac_info	AISAC information

Return values

CRI_TRUE	= information successfully acquired
CRI_FALSE	= failed to get information

Description:: Gets information about an AISAC attached to a category.
If the category does not exist or the AISAC index is invalid, CRI_FALSE is returned.

See also: criAtomExCategory_GetNumAttachedAisacsByName

◆ criAtomExCategory_GetCurrentAisacControlValueById()

CriBool criAtomExCategory_GetCurrentAisacControlValueById	(	CriAtomExCategoryId	category_id,
		CriAtomExAisacControlId	aisac_control_id,
		CriFloat32 *	control_value
	)

Acquire the current value of the AISAC control attached to the category by ID specification.

Parameters

[in]	id	Category ID
[in]	aisac_control_id	AISAC control ID
[out]	control_value	AISAC control value

Return values

CRI_TRUE	= Success
CRI_FALSE	= Failure

Description:: Gets the current value of the AISAC control attached to the category.
If you specify a nonexistent category or AISAC control, CRI_FALSE is returned.

See also: criAtomExCategory_GetNumAttachedAisacsById

◆ criAtomExCategory_GetCurrentAisacControlValueByName()

CriBool criAtomExCategory_GetCurrentAisacControlValueByName	(	const CriChar8 *	category_name,
		const CriChar8 *	aisac_control_name,
		CriFloat32 *	control_value
	)

Gets current value of AISAC control attached to category by name specification.

Parameters

[in]	name	Category Name
[in]	aisac_control_name	AISAC control Name
[out]	control_value	AISAC control value

Return values

CRI_TRUE	= Success
CRI_FALSE	= Failure

Description:: Gets the current value of the AISAC control attached to the category.
If you specify a nonexistent category or invalid index, CRI_FALSE is returned.

See also: criAtomExCategory_GetNumAttachedAisacsById

◆ criAtomExCategory_SetReactParameter()

void criAtomExCategory_SetReactParameter	(	const CriChar8 *	react_name,
		const CriAtomExReactParameter *	react_parameter
	)

Set REACT drive parameter.

Parameters

[in]	react_name	REACT Name
[in]	react_parameter	REACT parameter structure

Description:: Set the parameters to drive REACT.
Parameters can not be set while REACT is running (a warning will occur).
If you specify a REACT name that does not exist, an error callback will be returned.

See also: criAtomExCategory_GetReactParameter

◆ criAtomExCategory_GetReactParameter()

CriBool criAtomExCategory_GetReactParameter	(	const CriChar8 *	react_name,
		CriAtomExReactParameter *	react_parameter
	)

Get REACT drive parameter.

Parameters

[in]	react_name	REACT Name
[out]	react_parameter	REACT parameter structure

Return values

CRI_TRUE	= Success
CRI_FALSE	= Failed

Description:: Get the current value of the parameter that drives REACT.
If you specify a REACT name that does not exist, an error callback occurs and CRI_FALSE is returned.

See also: criAtomExCategory_SetReactParameter

◆ criAtomExCategory_GetReactStatus()

CriAtomExReactStatus criAtomExCategory_GetReactStatus ( const CriChar8 * react_name )

Getting the status of REACT.

Parameters

[in] react_name REACT name

Returns: CriAtomExReactStatus Status of REACT

Description:: Gets the operating status of REACT.
If the specified REACT name does not exist, an error callback will be triggered, and CRIATOMEX_REACT_STATUS_ERROR will be returned.

◆ criAtomExCategory_GetNumCuePlayingCountById()

CriSint32 criAtomExCategory_GetNumCuePlayingCountById ( CriAtomExCategoryId id )

Get the number of playing Cues attached to a category (specified by its ID)

Parameters

[in] id category ID

Returns: number of playing Cues attached to the category

Description:: Gets the number of playing Cues attached to a category.
If a non-existent category is specified, a negative value is returned.

◆ criAtomExCategory_GetNumCuePlayingCountByName()

CriSint32 criAtomExCategory_GetNumCuePlayingCountByName ( const CriChar8 * name )

Get the number of playing Cues attached to a category (specified by its name)

Parameters

[in] name category name

Returns: number of playing Cues attached to the category

Description:: Gets the number of playing Cues attached to a category.
If a non-existent category is specified, a negative value is returned.

◆ criAtomExCategory_StopById()

void criAtomExCategory_StopById ( CriAtomExCategoryId id )

Stop the playing Cues that belong to the category having the given ID.

Parameters

[in] id Category ID

Description:: Stops the playing Cues belonging to the specified category.

◆ criAtomExCategory_StopByName()

void criAtomExCategory_StopByName ( const CriChar8 * name )

Stop the playing Cues that belong to the category having the given name.

Parameters

[in] name Category name

Description:: Stops the playing Cues belonging to the specified category.

◆ criAtomExCategory_StopWithoutReleaseTimeById()

void criAtomExCategory_StopWithoutReleaseTimeById ( CriAtomExCategoryId id )

Immediately stop the playing Cues that belong to the category having the given ID.

Parameters

[in] id Category ID

Description:: Immediately stops the playing Cues belonging to the specified category.

◆ criAtomExCategory_StopWithoutReleaseTimeByName()

void criAtomExCategory_StopWithoutReleaseTimeByName ( const CriChar8 * name )

Immediately stop the playing Cues that belong to the category having the given name.

Parameters

[in] name Category name

Description:: Immediately stops the playing Cues belonging to the specified category.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ CRIATOMEXCATEGORY_MAX_CATEGORIES_PER_PLAYBACK

Typedef Documentation

◆ CriAtomExCategoryId

◆ CriAtomExCategoryInfo

◆ CriAtomExReactType

◆ CriAtomExReactDuckerTargetType

◆ CriAtomExReactFadeParameter

◆ CriAtomExReactHoldType

◆ CriAtomExReactDuckerParameter

◆ CriAtomExReactAisacModulationParameter

◆ CriAtomExReactParameter

◆ CriAtomExReactStatus

Enumeration Type Documentation

◆ CriAtomExReactTypeTag

◆ CriAtomExReactDuckerTargetTypeTag

◆ CriAtomExReactHoldTypeTag

◆ CriAtomExReactStatusTag

Function Documentation

◆ criAtomExCategory_SetVolumeById()

◆ criAtomExCategory_GetVolumeById()

◆ criAtomExCategory_GetTotalVolumeById()

◆ criAtomExCategory_SetVolumeByName()

◆ criAtomExCategory_GetVolumeByName()

◆ criAtomExCategory_GetTotalVolumeByName()

◆ criAtomExCategory_MuteById()

◆ criAtomExCategory_IsMutedById()

◆ criAtomExCategory_MuteByName()

◆ criAtomExCategory_IsMutedByName()

◆ criAtomExCategory_SoloById()

◆ criAtomExCategory_IsSoloedById()

◆ criAtomExCategory_SoloByName()

◆ criAtomExCategory_IsSoloedByName()

◆ criAtomExCategory_PauseById()

◆ criAtomExCategory_IsPausedById()

◆ criAtomExCategory_PauseByName()

◆ criAtomExCategory_IsPausedByName()

◆ criAtomExCategory_SetFadeInTimeById()

◆ criAtomExCategory_SetFadeInTimeByName()

◆ criAtomExCategory_SetFadeOutTimeById()

◆ criAtomExCategory_SetFadeOutTimeByName()

◆ criAtomExCategory_SetAisacControlById()

◆ criAtomExCategory_SetAisacControlByName()

◆ criAtomExCategory_ResetAllAisacControlById()

◆ criAtomExCategory_ResetAllAisacControlByName()

◆ criAtomExCategory_AttachAisacById()

◆ criAtomExCategory_AttachAisacByName()

◆ criAtomExCategory_DetachAisacById()

◆ criAtomExCategory_DetachAisacByName()

◆ criAtomExCategory_DetachAisacAllById()

◆ criAtomExCategory_DetachAisacAllByName()

◆ criAtomExCategory_GetNumAttachedAisacsById()

◆ criAtomExCategory_GetNumAttachedAisacsByName()

◆ criAtomExCategory_GetAttachedAisacInfoById()

◆ criAtomExCategory_GetAttachedAisacInfoByName()

◆ criAtomExCategory_GetCurrentAisacControlValueById()

◆ criAtomExCategory_GetCurrentAisacControlValueByName()

◆ criAtomExCategory_SetReactParameter()

◆ criAtomExCategory_GetReactParameter()

◆ criAtomExCategory_GetReactStatus()

◆ criAtomExCategory_GetNumCuePlayingCountById()

◆ criAtomExCategory_GetNumCuePlayingCountByName()

◆ criAtomExCategory_StopById()

◆ criAtomExCategory_StopByName()

◆ criAtomExCategory_StopWithoutReleaseTimeById()

◆ criAtomExCategory_StopWithoutReleaseTimeByName()