CRI ADX  Last Updated: 2024-07-17 10:48 p
CriAtomExCategory API

结构体

struct  CriAtomExCategoryInfoTag
 Structure used to get information about a category 更多...
 
struct  CriAtomExReactFadeParameterTag
 Curve Type of Ducking by REACT 更多...
 
struct  CriAtomExReactDuckerParameterTag
 REACT ducker parameter structure 更多...
 
struct  CriAtomExReactAisacModulationParameterTag
 AISAC modulation trigger parameter structure 更多...
 
struct  CriAtomExReactParameterTag
 REACT drive parameter structure 更多...
 

宏定义

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

类型定义

typedef CriUint32 CriAtomExCategoryId
 Category ID 更多...
 
typedef struct CriAtomExCategoryInfoTag CriAtomExCategoryInfo
 Structure used to get information about a category 更多...
 
typedef enum CriAtomExReactTypeTag CriAtomExReactType
 REACT Type 更多...
 
typedef enum CriAtomExReactDuckerTargetTypeTag CriAtomExReactDuckerTargetType
 Target of Ducking by REACT 更多...
 
typedef struct CriAtomExReactFadeParameterTag CriAtomExReactFadeParameter
 Curve Type of Ducking by REACT 更多...
 
typedef enum CriAtomExReactHoldTypeTag CriAtomExReactHoldType
 REACT Hold Type 更多...
 
typedef struct CriAtomExReactDuckerParameterTag CriAtomExReactDuckerParameter
 REACT ducker parameter structure 更多...
 
typedef struct CriAtomExReactAisacModulationParameterTag CriAtomExReactAisacModulationParameter
 AISAC modulation trigger parameter structure 更多...
 
typedef struct CriAtomExReactParameterTag CriAtomExReactParameter
 REACT drive parameter structure 更多...
 
typedef enum CriAtomExReactStatusTag CriAtomExReactStatus
 REACT Operation Status 更多...
 

枚举

enum  CriAtomExReactTypeTag { CRIATOMEX_REACT_TYPE_DUCKER = 0 , CRIATOMEX_REACT_TYPE_AISAC_MODULATION_TRIGGER , CRIATOMEX_REACT_TYPE_ENUM_SIZE_IS_4BYTES = 0x7FFFFFFF }
 REACT Type 更多...
 
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 更多...
 
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 更多...
 
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 更多...
 

函数

void criAtomExCategory_SetVolumeById (CriAtomExCategoryId id, CriFloat32 volume)
 Set the volume of a category specified by its ID 更多...
 
CriFloat32 criAtomExCategory_GetVolumeById (CriAtomExCategoryId id)
 Get the volume of a category specified by its ID 更多...
 
CriFloat32 criAtomExCategory_GetTotalVolumeById (CriAtomExCategoryId id)
 Get the final volume of a category specified by its ID 更多...
 
void criAtomExCategory_SetVolumeByName (const CriChar8 *name, CriFloat32 volume)
 Set the volume of a category specified by its name 更多...
 
CriFloat32 criAtomExCategory_GetVolumeByName (const CriChar8 *name)
 Get the volume of a category specified by its name 更多...
 
CriFloat32 criAtomExCategory_GetTotalVolumeByName (const CriChar8 *name)
 Get the final volume of a category specified by its name 更多...
 
void criAtomExCategory_MuteById (CriAtomExCategoryId id, CriBool mute)
 Mute / unmute a category specified by its ID 更多...
 
CriBool criAtomExCategory_IsMutedById (CriAtomExCategoryId id)
 Return whether a category (specified by its ID) is muted or not 更多...
 
void criAtomExCategory_MuteByName (const CriChar8 *name, CriBool mute)
 Mute / unmute a category specified by its name 更多...
 
CriBool criAtomExCategory_IsMutedByName (const CriChar8 *name)
 Return whether a category (specified by its name) is muted or not 更多...
 
void criAtomExCategory_SoloById (CriAtomExCategoryId id, CriBool solo, CriFloat32 mute_volume)
 Solo / unsolo a category specified by its ID 更多...
 
CriBool criAtomExCategory_IsSoloedById (CriAtomExCategoryId id)
 Return whether a category (specified by its ID) is solo'ed or not 更多...
 
void criAtomExCategory_SoloByName (const CriChar8 *name, CriBool solo, CriFloat32 mute_volume)
 Solo / unsolo a category specified by its name 更多...
 
CriBool criAtomExCategory_IsSoloedByName (const CriChar8 *name)
 Return whether a category (specified by its name) is solo'ed or not 更多...
 
void criAtomExCategory_PauseById (CriAtomExCategoryId id, CriBool sw)
 Pause/resume a category specified by its ID 更多...
 
CriBool criAtomExCategory_IsPausedById (CriAtomExCategoryId id)
 Get the pause status of a category specified by its ID 更多...
 
void criAtomExCategory_PauseByName (const CriChar8 *name, CriBool sw)
 Pause/resume category specified by name 更多...
 
CriBool criAtomExCategory_IsPausedByName (const CriChar8 *name)
 Get the pause status of a category specified by its name 更多...
 
void criAtomExCategory_SetFadeInTimeById (CriAtomExCategoryId id, CriUint16 ms)
 Set the fade-in time of a category specified by its ID 更多...
 
void criAtomExCategory_SetFadeInTimeByName (const CriChar8 *name, CriUint16 ms)
 Set the fade-in time of a category specified by its name 更多...
 
void criAtomExCategory_SetFadeOutTimeById (CriAtomExCategoryId id, CriUint16 ms)
 Set the fade-out time of a category specified by its ID 更多...
 
void criAtomExCategory_SetFadeOutTimeByName (const CriChar8 *name, CriUint16 ms)
 Set the fade-out time of a category specified by its name 更多...
 
void criAtomExCategory_SetAisacControlById (CriAtomExCategoryId id, CriAtomExAisacControlId control_id, CriFloat32 control_value)
 Set the AISAC control value of a category specified by its ID 更多...
 
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 更多...
 
CriBool criAtomExCategory_ResetAllAisacControlById (CriAtomExCategoryId category_id)
 All AISAC control values attached to categories by ID designation are set to default values 更多...
 
CriBool criAtomExCategory_ResetAllAisacControlByName (const CriChar8 *category_name)
 All AISAC control values attached to categories by name designation are set to default values 更多...
 
void criAtomExCategory_AttachAisacById (CriAtomExCategoryId id, const CriChar8 *global_aisac_name)
 Attach a global AISAC to a category specified by its ID 更多...
 
void criAtomExCategory_AttachAisacByName (const CriChar8 *name, const CriChar8 *global_aisac_name)
 Attach a global AISAC to a category specified by its name 更多...
 
void criAtomExCategory_DetachAisacById (CriAtomExCategoryId id, const CriChar8 *global_aisac_name)
 Detach an AISAC from a category specified by its ID 更多...
 
void criAtomExCategory_DetachAisacByName (const CriChar8 *name, const CriChar8 *global_aisac_name)
 Detach an AISAC from a category specified by its name 更多...
 
void criAtomExCategory_DetachAisacAllById (CriAtomExCategoryId id)
 Detach all the AISACs from a category specified by its ID 更多...
 
void criAtomExCategory_DetachAisacAllByName (const CriChar8 *name)
 Detach all the AISACs from a category specified by its name 更多...
 
CriSint32 criAtomExCategory_GetNumAttachedAisacsById (CriAtomExCategoryId id)
 Get the number of AISACs attached to a category specified by its ID 更多...
 
CriSint32 criAtomExCategory_GetNumAttachedAisacsByName (const CriChar8 *name)
 Get the number of AISACs attached to a category specified by its name 更多...
 
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) 更多...
 
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) 更多...
 
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 更多...
 
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 更多...
 
void criAtomExCategory_SetReactParameter (const CriChar8 *react_name, const CriAtomExReactParameter *react_parameter)
 Set REACT drive parameter 更多...
 
CriBool criAtomExCategory_GetReactParameter (const CriChar8 *react_name, CriAtomExReactParameter *react_parameter)
 Get REACT drive parameter 更多...
 
CriAtomExReactStatus criAtomExCategory_GetReactStatus (const CriChar8 *react_name)
 Getting the status of REACT 更多...
 
CriSint32 criAtomExCategory_GetNumCuePlayingCountById (CriAtomExCategoryId id)
 Get the number of playing Cues attached to a category (specified by its ID) 更多...
 
CriSint32 criAtomExCategory_GetNumCuePlayingCountByName (const CriChar8 *name)
 Get the number of playing Cues attached to a category (specified by its name) 更多...
 
void criAtomExCategory_StopById (CriAtomExCategoryId id)
 Stop the playing Cues that belong to the category having the given ID 更多...
 
void criAtomExCategory_StopByName (const CriChar8 *name)
 Stop the playing Cues that belong to the category having the given name 更多...
 
void criAtomExCategory_StopWithoutReleaseTimeById (CriAtomExCategoryId id)
 Immediately stop the playing Cues that belong to the category having the given ID 更多...
 
void criAtomExCategory_StopWithoutReleaseTimeByName (const CriChar8 *name)
 Immediately stop the playing Cues that belong to the category having the given name 更多...
 

详细描述

宏定义说明

◆ 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.

参见
CriAtomExCueInfo

类型定义说明

◆ 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.
参见
criAtomExCategory_SetVolumeById, criAtomExCategory_MuteById, criAtomExCategory_SoloById

◆ 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.
参见
criAtomExAcf_GetCategoryInfo

◆ CriAtomExReactType

◆ CriAtomExReactDuckerTargetType

◆ CriAtomExReactFadeParameter

Curve Type of Ducking by REACT

Description:
This is a structure for getting and setting fade drive parameter information of REACT.
参见
CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ CriAtomExReactHoldType

REACT Hold Type

Description:
REACT hold (Attenuation time maintenance) type.
参见
CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ CriAtomExReactDuckerParameter

REACT ducker parameter structure

Description:
This is a structure for getting and setting drive parameter information of ducker by REACT.
参见
CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ CriAtomExReactAisacModulationParameter

AISAC modulation trigger parameter structure

Description:
This is a structure for getting and setting drive parameter information of AISAC modulation trigger.
参见
CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ 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.
参见
criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter

◆ CriAtomExReactStatus

REACT Operation Status

Description:
This value indicates the operating status of REACT.
参见
criAtomExCategory_SetReactParameter

枚举类型说明

◆ CriAtomExReactTypeTag

REACT Type

Description:
REACT Type.
参见
CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter
枚举值
CRIATOMEX_REACT_TYPE_DUCKER 

Ducker

CRIATOMEX_REACT_TYPE_AISAC_MODULATION_TRIGGER 

AISAC Modulation Trigger

◆ CriAtomExReactDuckerTargetTypeTag

Target of Ducking by REACT

Description:
Target type of ducking by REACT.
参见
CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter
枚举值
CRIATOMEX_REACT_DUCKER_TARGET_TYPE_VOLUME 

Ducker of Volume

CRIATOMEX_REACT_DUCKER_TARGET_TYPE_AISAC_CONTROL_VALUE 

Ducker of AISAC Control Value

◆ CriAtomExReactHoldTypeTag

REACT Hold Type

Description:
REACT hold (Attenuation time maintenance) type.
参见
CriAtomExReactParameter, criAtomExCategory_SetReactParameter, criAtomExCategory_GetReactParameter
枚举值
CRIATOMEX_REACT_HOLD_TYPE_WHILE_PLAYING 

Hold during playback

CRIATOMEX_REACT_HOLD_TYPE_FIXED_TIME 

Hold at a fixed time

◆ CriAtomExReactStatusTag

REACT Operation Status

Description:
This value indicates the operating status of REACT.
参见
criAtomExCategory_SetReactParameter
枚举值
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

函数说明

◆ criAtomExCategory_SetVolumeById()

void criAtomExCategory_SetVolumeById ( CriAtomExCategoryId  id,
CriFloat32  volume 
)

Set the volume of a category specified by its ID

参数
[in]idcategory ID
[in]volumevolume value
Description:
Sets the volume of a category specified by its ID.
注意
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

参数
[in]idcategory ID
返回
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

参数
[in]idCategory 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

参数
[in]namecategory name
[in]volumevolume value
Description:
Sets the volume of a category specified by its name.
注意
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

参数
[in]namecategory name
返回
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

参数
[in]nameCategory 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

参数
[in]idcategory ID
[in]muteMute 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

参数
[in]idcategory 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

参数
[in]namecategory name
[in]muteMute 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

参数
[in]namecategory 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

参数
[in]idcategory ID
[in]solosolo status (CRI_TRUE = Solo, CRI_FALSE = Not solo)
[in]mute_volumevolume 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

参数
[in]idcategory 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

参数
[in]namecategory name
[in]solosolo status (CRI_TRUE = Solo, CRI_FALSE = Not solo)
[in]mute_volumevolume 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

参数
[in]namecategory 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

参数
[in]idcategory ID
[in]swswitch (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

参数
[in]idcategory ID
返回
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

参数
[in]namecategory name
[in]swswitch (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.
参见
criAtomExCategory_PauseById

◆ criAtomExCategory_IsPausedByName()

CriBool criAtomExCategory_IsPausedByName ( const CriChar8 *  name)

Get the pause status of a category specified by its name

参数
[in]namecategory name
返回
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

参数
[in]idcategory ID
[in]msfade-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

参数
[in]namecategory name
[in]msfade-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

参数
[in]idcategory ID
[in]msfade-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

参数
[in]namecategory name
[in]msfade-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

参数
[in]idcategory ID
[in]control_idAISAC control ID
[in]control_valueAISAC 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.
注意
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.
参见
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

参数
[in]namecategory name
[in]control_nameAISAC control name
[in]control_valueAISAC 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.
参见
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

参数
[in]idCategory ID
返回值
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.
参见
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

参数
[in]nameCatefory Name
返回值
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.
参见
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

参数
[in]idcategory ID
[in]global_aisac_namename 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.
注意
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.
参见
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

参数
[in]namecategory name
[in]global_aisac_namename 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.
参见
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

参数
[in]idcategory ID
[in]global_aisac_namename 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.
参见
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

参数
[in]namecategory name
[in]global_aisac_namename 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.
参见
criAtomExCategory_DetachAisacById, criAtomExCategory_AttachAisacByName

◆ criAtomExCategory_DetachAisacAllById()

void criAtomExCategory_DetachAisacAllById ( CriAtomExCategoryId  id)

Detach all the AISACs from a category specified by its ID

参数
[in]idcategory 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

参数
[in]namecategory 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

参数
[in]idcategory ID
返回
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

参数
[in]namecategory name
返回
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)

参数
[in]idcategory ID
[in]aisac_attached_indexindex of the attached AISAC
[out]aisac_infoAISAC information
返回值
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.
参见
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)

参数
[in]namecategory name
[in]aisac_attached_indexindex of the attached AISAC
[out]aisac_infoAISAC information
返回值
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.
参见
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

参数
[in]idCategory ID
[in]aisac_control_idAISAC control ID
[out]control_valueAISAC control value
返回值
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.
参见
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

参数
[in]nameCategory Name
[in]aisac_control_nameAISAC control Name
[out]control_valueAISAC control value
返回值
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.
参见
criAtomExCategory_GetNumAttachedAisacsById

◆ criAtomExCategory_SetReactParameter()

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

Set REACT drive parameter

参数
[in]react_nameREACT Name
[in]react_parameterREACT 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.
参见
criAtomExCategory_GetReactParameter

◆ criAtomExCategory_GetReactParameter()

CriBool criAtomExCategory_GetReactParameter ( const CriChar8 *  react_name,
CriAtomExReactParameter react_parameter 
)

Get REACT drive parameter

参数
[in]react_nameREACT Name
[out]react_parameterREACT parameter structure
返回值
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.
参见
criAtomExCategory_SetReactParameter

◆ criAtomExCategory_GetReactStatus()

CriAtomExReactStatus criAtomExCategory_GetReactStatus ( const CriChar8 *  react_name)

Getting the status of REACT

参数
[in]react_nameREACT name
返回
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)

参数
[in]idcategory ID
返回
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)

参数
[in]namecategory name
返回
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

参数
[in]idCategory 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

参数
[in]nameCategory 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

参数
[in]idCategory 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

参数
[in]nameCategory name
Description:
Immediately stops the playing Cues belonging to the specified category.