CriAtomExAcb API

Data Structures
struct	CriAtomExAcbInfoTag
	ACB information. More...
struct	CriAtomExWaveformInfoTag
	Audio waveform information. More...
struct	CriAtomExCuePos3dInfoTag
	Cue 3D information. More...
struct	CriAtomExCueInfoTag
	Cue information. More...

Typedefs
typedef CriAtomExAcbObj *	CriAtomExAcbHn
	ACB handle. More...
typedef CriSint32	CriAtomExCueId
	Cue ID. More...
typedef CriSint32	CriAtomExCueIndex
	Cue index. More...
typedef struct CriAtomExAcbInfoTag	CriAtomExAcbInfo
	ACB information. More...
typedef struct CriAtomExWaveformInfoTag	CriAtomExWaveformInfo
	Audio waveform information. More...
typedef enum CriAtomExAcbCueTypeTag	CriAtomExAcbCueType
	Cue type. More...
typedef struct CriAtomExCuePos3dInfoTag	CriAtomExCuePos3dInfo
	Cue 3D information. More...
typedef struct CriAtomExCueInfoTag	CriAtomExCueInfo
	Cue information. More...
typedef CriBool(*	CriAtomExAcbHandleCbFunc) (void *obj, CriAtomExAcbHn acb_hn)
	Type of the ACB handle callback function. More...
typedef void(*	CriAtomExAcbDetectionInGamePreviewDataCbFunc) (void *obj, const CriChar8 *acb_name)
	Type of the callback function used to notify of in-game preview data loading. More...
typedef void(*	CriAtomExMonitoringVoiceStopCbFunc) (void *obj, CriAtomExMonitoringVoiceStopInfo *voice_stop)
	Callback function type for monitoring a voice stop. More...
typedef void(*	CriAtomExMonitorDataUpdateNotificationCbFunc) (void *obj, const CriAtomExMonitorDataUpdateNotificationInfo *info)
	Get the data update notification information by authoring tool Callback function. More...

Enumerations
enum	CriAtomExAcbCueTypeTag {   CRIATOMEXACB_CUE_TYPE_POLYPHONIC = (0) , CRIATOMEXACB_CUE_TYPE_SEQUENTIAL , CRIATOMEXACB_CUE_TYPE_SHUFFLE , CRIATOMEXACB_CUE_TYPE_RANDOM ,   CRIATOMEXACB_CUE_TYPE_RANDOM_NO_REPEAT , CRIATOMEXACB_CUE_TYPE_SWITCH_GAME_VARIABLE , CRIATOMEXACB_CUE_TYPE_COMBO_SEQUENTIAL , CRIATOMEXACB_CUE_TYPE_SWITCH_SELECTOR ,   CRIATOMEXACB_CUE_TYPE_TRACK_TRANSITION_BY_SELECTOR , CRIATOMEXACB_CUE_TYPE_ENUM_SIZE_IS_4BYTES = 0x7FFFFFFF }
	Cue type. More...

Functions
CriSint32	criAtomExAcb_CalculateWorkSizeForLoadAcbData (void *acb_data, CriSint32 acb_data_size, CriFsBinderHn awb_binder, const CriChar8 *awb_path)
	Calculate the size of the work buffer required to load ACB data. More...
CriSint32	criAtomExAcb_CalculateWorkSizeForLoadAcbDataById (void *acb_data, CriSint32 acb_data_size, CriFsBinderHn awb_binder, CriUint16 awb_id)
	Calculate the size of the work buffer required to load ACB data (specifying a CPK content ID) More...
CriAtomExAcbHn	criAtomExAcb_LoadAcbData (void *acb_data, CriSint32 acb_data_size, CriFsBinderHn awb_binder, const CriChar8 *awb_path, void *work, CriSint32 work_size)
	Load ACB data in memory. More...
CriAtomExAcbHn	criAtomExAcb_LoadAcbDataById (void *acb_data, CriSint32 acb_data_size, CriFsBinderHn awb_binder, CriUint16 awb_id, void *work, CriSint32 work_size)
	Load ACB data in memory (specifying a CPK content ID) More...
CriSint32	criAtomExAcb_CalculateWorkSizeForLoadAcbFile (CriFsBinderHn acb_binder, const CriChar8 *acb_path, CriFsBinderHn awb_binder, const CriChar8 *awb_path)
	Calculate the size of the work buffer required to load an ACB file. More...
CriSint32	criAtomExAcb_CalculateWorkSizeForLoadAcbFileById (CriFsBinderHn acb_binder, CriUint16 acb_id, CriFsBinderHn awb_binder, CriUint16 awb_id)
	Calculate the size of the work buffer required to load an ACB file (specifying a CPK content ID) More...
CriAtomExAcbHn	criAtomExAcb_LoadAcbFile (CriFsBinderHn acb_binder, const CriChar8 *acb_path, CriFsBinderHn awb_binder, const CriChar8 *awb_path, void *work, CriSint32 work_size)
	Load an ACB file. More...
CriAtomExAcbHn	criAtomExAcb_LoadAcbFileById (CriFsBinderHn acb_binder, CriUint16 acb_id, CriFsBinderHn awb_binder, CriUint16 awb_id, void *work, CriSint32 work_size)
	Load an ACB file (specifying a CPK content ID) More...
void	criAtomExAcb_Release (CriAtomExAcbHn acb_hn)
	Release an ACB handle. More...
void	criAtomExAcb_ReleaseAll (void)
	Release all the ACB handles. More...
CriSint32	criAtomExAcb_EnumerateHandles (CriAtomExAcbHandleCbFunc func, void *obj)
	ACB handle enumerator. More...
CriUint32	criAtomExAcb_GetVersion (void *acb_data, CriSint32 acb_data_size, void *flag)
	Get the version of the ACB data in memory. More...
CriUint32	criAtomExAcb_GetVersionFromFile (CriFsBinderHn acb_binder, const CriChar8 *acb_path, void *work, CriSint32 work_size, CriBool *flag)
	Get the version of an ACB file. More...
void	criAtomExAcb_GetSupportedVersion (CriUint32 *version_low, CriUint32 *version_high)
	Get information about what ACB file versions can be loaded. More...
CriSint32	criAtomExAcb_GetNumCues (CriAtomExAcbHn acb_hn)
	Get the number of Cues in the ACB. More...
CriBool	criAtomExAcb_ExistsId (CriAtomExAcbHn acb_hn, CriAtomExCueId id)
	Check if a Cue with a specific ID exists. More...
CriBool	criAtomExAcb_ExistsName (CriAtomExAcbHn acb_hn, const CriChar8 *name)
	Check if a Cue with a specific name exists. More...
CriBool	criAtomExAcb_ExistsIndex (CriAtomExAcbHn acb_hn, CriAtomExCueIndex index)
	Check if a Cue with a specific index exists. More...
CriAtomExCueId	criAtomExAcb_GetCueIdByIndex (CriAtomExAcbHn acb_hn, CriAtomExCueIndex index)
	Get the ID of a Cue from its index. More...
CriAtomExCueId	criAtomExAcb_GetCueIdByName (CriAtomExAcbHn acb_hn, const CriChar8 *name)
	Get the ID of a Cue from its name. More...
const CriChar8 *	criAtomExAcb_GetCueNameByIndex (CriAtomExAcbHn acb_hn, CriAtomExCueIndex index)
	Get the name of a Cue from its index. More...
const CriChar8 *	criAtomExAcb_GetCueNameById (CriAtomExAcbHn acb_hn, CriAtomExCueId id)
	Get the name of a Cue from its ID. More...
CriAtomExCueIndex	criAtomExAcb_GetCueIndexById (CriAtomExAcbHn acb_hn, CriAtomExCueId id)
	Get the index of a Cue from its ID. More...
CriAtomExCueIndex	criAtomExAcb_GetCueIndexByName (CriAtomExAcbHn acb_hn, const CriChar8 *name)
	Get the index of a Cue from its name. More...
const CriChar8 *	criAtomExAcb_GetUserDataById (CriAtomExAcbHn acb_hn, CriAtomExCueId id)
	Get the user data string of a Cue from its ID. More...
const CriChar8 *	criAtomExAcb_GetUserDataByName (CriAtomExAcbHn acb_hn, const CriChar8 *name)
	Get the user data string of a Cue from its name. More...
CriSint64	criAtomExAcb_GetLengthById (CriAtomExAcbHn acb_hn, CriAtomExCueId id)
	Get the length of a Cue from its ID. More...
CriSint64	criAtomExAcb_GetLengthByName (CriAtomExAcbHn acb_hn, const CriChar8 *name)
	Get the length of a Cue from its name. More...
CriSint32	criAtomExAcb_GetNumUsableAisacControlsById (CriAtomExAcbHn acb_hn, CriAtomExCueId id)
	Get the number of AISAC Controls assigned to a Cue (specifying its ID) More...
CriSint32	criAtomExAcb_GetNumUsableAisacControlsByName (CriAtomExAcbHn acb_hn, const CriChar8 *name)
	Get the number of AISAC Controls assigned to a Cue (specifying its name) More...
CriBool	criAtomExAcb_GetUsableAisacControlById (CriAtomExAcbHn acb_hn, CriAtomExCueId id, CriUint16 index, CriAtomExAisacControlInfo *info)
	Get information about an AISAC Control assigned to a Cue (specifying the Cue's ID) More...
CriBool	criAtomExAcb_GetUsableAisacControlByName (CriAtomExAcbHn acb_hn, const CriChar8 *name, CriUint16 index, CriAtomExAisacControlInfo *info)
	Get information about an AISAC Control assigned to a Cue (specifying the Cue's name) More...
CriBool	criAtomExAcb_IsUsingAisacControlById (CriAtomExAcbHn acb_hn, CriAtomExCueId id, CriAtomExAisacControlId aisac_control_id)
	Determine if a Cue (whose ID is specified) can be controlled by a specific AISAC Control. More...
CriBool	criAtomExAcb_IsUsingAisacControlByName (CriAtomExAcbHn acb_hn, const CriChar8 *name, const CriChar8 *aisac_control_name)
	Determine if a Cue (whose name is specified) can be controlled by a specific AISAC Control. More...
CriSint32	criAtomExAcb_GetCuePriorityById (CriAtomExAcbHn acb_hn, CriAtomExCueId id)
	Get the priority of the Cue with the given ID. More...
CriSint32	criAtomExAcb_GetCuePriorityByName (CriAtomExAcbHn acb_hn, const CriChar8 *name)
	Get the priority of the Cue with the given name. More...
CriBool	criAtomExAcb_GetWaveformInfoById (CriAtomExAcbHn acb_hn, CriAtomExCueId id, CriAtomExWaveformInfo *waveform_info)
	Get information about the waveform played by the Cue whose ID is given. More...
CriBool	criAtomExAcb_GetWaveformInfoByName (CriAtomExAcbHn acb_hn, const CriChar8 *name, CriAtomExWaveformInfo *waveform_info)
	Get information about the waveform played by the Cue whose name is given. More...
CriAtomAwbHn	criAtomExAcb_GetOnMemoryAwbHandle (CriAtomExAcbHn acb_hn)
	Get an AWB handle from an ACB handle (for in-memory playback) More...
CriAtomAwbHn	criAtomExAcb_GetStreamingAwbHandle (CriAtomExAcbHn acb_hn)
	Get an AWB handle from an ACB handle (for streaming playback) More...
CriAtomAwbHn	criAtomExAcb_GetStreamingAwbHandleBySlotName (CriAtomExAcbHn acb_hn, const CriChar8 *awb_slot_name)
	Get AWB handle for stream playback of specified AWB slot name. More...
CriAtomAwbHn	criAtomExAcb_GetStreamingAwbHandleBySlotIndex (CriAtomExAcbHn acb_hn, CriUint16 awb_slot_index)
	Get AWB handle for stream playback of specified AWB slot index. More...
CriBool	criAtomExAcb_GetCueInfoByName (CriAtomExAcbHn acb_hn, const CriChar8 *name, CriAtomExCueInfo *info)
	Get cue information (cue name specified) More...
CriBool	criAtomExAcb_GetCueInfoById (CriAtomExAcbHn acb_hn, CriAtomExCueId id, CriAtomExCueInfo *info)
	Get information about the Cue whose ID is specified. More...
CriBool	criAtomExAcb_GetCueInfoByIndex (CriAtomExAcbHn acb_hn, CriAtomExCueIndex index, CriAtomExCueInfo *info)
	Get information about the Cue whose index is specified. More...
CriSint32	criAtomExAcb_GetNumCuePlayingCountByName (CriAtomExAcbHn acb_hn, const CriChar8 *name)
	Get the number of playing voices for a Cue with Cue limits (specifying the Cue name) More...
CriSint32	criAtomExAcb_GetNumCuePlayingCountById (CriAtomExAcbHn acb_hn, CriAtomExCueId id)
	Get the number of playing voices for a Cue with Cue limits (specifying the Cue ID) More...
CriSint32	criAtomExAcb_GetNumCuePlayingCountByIndex (CriAtomExAcbHn acb_hn, CriAtomExCueIndex index)
	Get the number of playing voices for a Cue with Cue limits (specifying the Cue index) More...
CriAtomExBlockIndex	criAtomExAcb_GetBlockIndexByIndex (CriAtomExAcbHn acb_hn, CriAtomExCueIndex index, const CriChar8 *block_name)
	Get the index of a block (specifying a Cue index) More...
CriAtomExBlockIndex	criAtomExAcb_GetBlockIndexById (CriAtomExAcbHn acb_hn, CriAtomExCueId id, const CriChar8 *block_name)
	Get the index of a block (specifying a Cue ID) More...
CriAtomExBlockIndex	criAtomExAcb_GetBlockIndexByName (CriAtomExAcbHn acb_hn, const CriChar8 *name, const CriChar8 *block_name)
	Get the index of a block (specifying a Cue name) More...
void	criAtomExAcb_SetDetectionInGamePreviewDataCallback (CriAtomExAcbDetectionInGamePreviewDataCbFunc func, void *obj)
	Registration of the loading detection callback function for in-game preview data. More...
CriBool	criAtomExAcb_GetAcbInfo (CriAtomExAcbHn acb_hn, CriAtomExAcbInfo *acb_info)
	Get information about the ACB. More...
void	criAtomExAcb_ResetCueTypeStateByName (CriAtomExAcbHn acb_hn, const CriChar8 *name)
	Reset the type-based state of the Cue (specifying its name) More...
void	criAtomExAcb_ResetCueTypeStateById (CriAtomExAcbHn acb_hn, CriAtomExCueId id)
	Reset the type-based state of the Cue (specifying its ID) More...
void	criAtomExAcb_ResetCueTypeStateByIndex (CriAtomExAcbHn acb_hn, CriAtomExCueIndex index)
	Reset the type-based state of the Cue (specifying its index) More...
void	criAtomExAcb_AttachAwbFile (CriAtomExAcbHn acb_hn, CriFsBinderHn awb_binder, const CriChar8 *awb_path, const CriChar8 *awb_name, void *work, CriSint32 work_size)
	Attaching an AWB file for streaming. More...
void	criAtomExAcb_DetachAwbFile (CriAtomExAcbHn acb_hn, const CriChar8 *awb_name)
	Detaching an AWB file for streaming. More...
CriSint32	criAtomExAcb_CalculateWorkSizeForAttachAwbFile (CriFsBinderHn awb_binder, const CriChar8 *awb_path)
	Acquiring the size of the work area required to attach an AWB file for streaming. More...
CriSint32	criAtomExAcb_GetNumAwbFileSlots (CriAtomExAcbHn acb_hn)
	Acquiring the number of AWB slots for streaming. More...
const CriChar8 *	criAtomExAcb_GetAwbFileSlotName (CriAtomExAcbHn acb_hn, CriUint16 index)
	Acquiring the AWB slot for streaming. More...
CriBool	criAtomExAcb_IsAttachedAwbFile (CriAtomExAcbHn acb_hn, const CriChar8 *awb_name)
	Acquiring the attaching status of an AWB file for streaming. More...

Detailed Description

Typedef Documentation

CriAtomExAcbHn

typedef CriAtomExAcbObj* CriAtomExAcbHn

ACB handle.

Description:

Handle used to manage CueSheet information.
To play back the audio data from a CueSheet file (loaded by using the criAtomExAcb_LoadAcbFile function) specify this handle and a Cue ID to a player.

See also

criAtomExAcb_LoadAcbFile, criAtomExPlayer_SetCueId

CriAtomExCueId

typedef CriSint32 CriAtomExCueId

Cue ID.

Description:

A unique ID assigned to a Cue by the user in an authoring tool.
It is used to reference a specifc Cue across the application.

See also

criAtomExPlayer_SetCueId

CriAtomExCueIndex

typedef CriSint32 CriAtomExCueIndex

Cue index.

Description:

A number indicating the position of the Cue in the ACB file.
(The index is 0-based and the values are assigned sequentially: t he first Cue is at index 0, the second Cue at index 1, and so on...)
The index can be used to reference a specifc Cue of an ACB file across the application.

See also

criAtomExPlayer_SetCueIndex

CriAtomExAcbInfo

typedef struct CriAtomExAcbInfoTag CriAtomExAcbInfo

ACB information.

Description:

ACB data information.

See also

criAtomExAcb_GetAcbInfo

CriAtomExWaveformInfo

typedef struct CriAtomExWaveformInfoTag CriAtomExWaveformInfo

Audio waveform information.

Description:

Detailed information about an audio waveform played back in a Cue.

See also

criAtomExAcb_GetWaveformInfoById, criAtomExAcb_GetWaveformInfoByName

CriAtomExAcbCueType

typedef enum CriAtomExAcbCueTypeTag CriAtomExAcbCueType

Cue type.

See also

CriAtomExCueInfo

CriAtomExCuePos3dInfo

typedef struct CriAtomExCuePos3dInfoTag CriAtomExCuePos3dInfo

Cue 3D information.

Description:

Detailed 3D information associated to a Cue.

See also

CriAtomExCueInfo

CriAtomExCueInfo

typedef struct CriAtomExCueInfoTag CriAtomExCueInfo

Cue information.

Description:

Detailed Cue information.

See also

criAtomExAcb_GetCueInfoByName, criAtomExAcb_GetCueInfoById, criAtomExAcb_GetCueInfoByIndex

CriAtomExAcbHandleCbFunc

typedef CriBool( * CriAtomExAcbHandleCbFunc) (void *obj, CriAtomExAcbHn acb_hn)

Type of the ACB handle callback function.

Parameters

[in]	obj	User-specified object
[in]	acb_hn	ACB handle

Returns

CriBool Continue enumeration (CRI_TRUE: Continue, CRI_FALSE: Stop)

Description:

The type of the callback function used to get ACB handle notifications.
You can register a callback function of this type by calling criAtomExAcb_EnumerateHandles . It will allow you to receive the ACB handles via callback.

Attention

Do not destroy an ACB handle inside the callback function.

See also

criAtomExAcb_EnumerateHandles, CriAtomExAcbHn

CriAtomExAcbDetectionInGamePreviewDataCbFunc

typedef void( * CriAtomExAcbDetectionInGamePreviewDataCbFunc) (void *obj, const CriChar8 *acb_name)

Type of the callback function used to notify of in-game preview data loading.

Description:

Parameters

[in]	obj	User-specified object
[in]	acb_name	ACB name

Returns

None

Description:

This callback function is called whenever the loading of in-game preview data is detected.
Use this to determine whether in-game preview data is being used or not.

Call criAtomExAcb_SetDetectionInGamePreviewDataCallback to register the callback function.
The registered callback function is executed whenever the ACB content is parsed in an ACB load function.

Attention

Generally, you should not use Atom library APIs within a callback function.
Note that if process is blocked in a callback function for a long time, problems -such as the audio breaking up- may occur.

See also

criAtomExAcb_SetDetectionInGamePreviewDataCallback

CriAtomExMonitoringVoiceStopCbFunc

typedef void( * CriAtomExMonitoringVoiceStopCbFunc) (void *obj, CriAtomExMonitoringVoiceStopInfo *voice_stop)

Callback function type for monitoring a voice stop.

Parameters

[in]	obj	User specified object
[in]	voice_stop	Details of the voice stop

Description:

This callback function type is used when a played voice is stopped in the monitored playback ID.

Attention

Basically, do not use Atom library APIs in a callback function.
Note that if processes are blocked in the callback function for a long time, some problems, such as a playback interruption may occur.

See also

criAtomEx_SetMonitoringVoiceStopCallback

CriAtomExMonitorDataUpdateNotificationCbFunc

typedef void( * CriAtomExMonitorDataUpdateNotificationCbFunc) (void *obj, const CriAtomExMonitorDataUpdateNotificationInfo *info)

Get the data update notification information by authoring tool Callback function.

Description:

Parameters

[in]	obj	User specified object
[in]	info	Data update notification information

Returns

None

Description:

This is a callback function to be called when data update processing from the authoring tool occurs during in-game preview.
Use this when you want to obtain the data update status on the application side during in-game preview.

Use the criAtomExMonitor_SetDataUpdateNotificationCallback function to register the callback function.
The registered callback function is executed at the timing before and after data update from the authoring tool during in-game preview.

Attention

Basically, please do not use the Atom API within the callback function.
If you block long processing within this callback function, problems such as out of sound will occur, so please be careful.
Please refer to the CriAtomExMonitorDataUpdateNotificationInfo structure passed as an argument to the callback function only within the callback function.
Before referring outside the callback function, save the contents in a separate area beforehand.

See also

criAtomExMonitor_SetDataUpdateNotificationCallback, CriAtomExMonitorDataUpdateNotificationInfo

Enumeration Type Documentation

CriAtomExAcbCueTypeTag

enum CriAtomExAcbCueTypeTag

Cue type.

See also

CriAtomExCueInfo

Enumerator
CRIATOMEXACB_CUE_TYPE_POLYPHONIC	Polyphonic
CRIATOMEXACB_CUE_TYPE_SEQUENTIAL	Sequential
CRIATOMEXACB_CUE_TYPE_SHUFFLE	Shuffle
CRIATOMEXACB_CUE_TYPE_RANDOM	Random
CRIATOMEXACB_CUE_TYPE_RANDOM_NO_REPEAT	Random without repetition (play sounds randomly but not the same twice in a row)
CRIATOMEXACB_CUE_TYPE_SWITCH_GAME_VARIABLE	Switch playback (the value of a game variable determines what track to play)
CRIATOMEXACB_CUE_TYPE_COMBO_SEQUENTIAL	Combo Sequential (If you get a combo within the "Combo Time", it's sequential, and if you get to the end, you'll return to the "Combo Loop Back" point)
CRIATOMEXACB_CUE_TYPE_SWITCH_SELECTOR	Switch playback (the value of a selector determines what track to play)
CRIATOMEXACB_CUE_TYPE_TRACK_TRANSITION_BY_SELECTOR	Track transition playback (reference a selector to change the track to play)

Function Documentation

criAtomExAcb_CalculateWorkSizeForLoadAcbData()

CriSint32 criAtomExAcb_CalculateWorkSizeForLoadAcbData	(	void *	acb_data,
		CriSint32	acb_data_size,
		CriFsBinderHn	awb_binder,
		const CriChar8 *	awb_path
	)

Calculate the size of the work buffer required to load ACB data.

Parameters

[in]	acb_data	ACB data address
[in]	acb_data_size	ACB data size
[in]	awb_binder	handle to a binder including an AWB file
[in]	awb_path	path to an AWB file

Returns

CriSint32 work buffer size

Return values

>=	0 successfully completed
-1	error occurred

Description:

Calculates the size of the work buffer required to execute the criAtomExAcb_LoadAcbData function. When the criAtomExAcb_LoadAcbData function is used to load the AWB data without having registered a user allocator using the criAtomEx_SetUserAllocator macro, a memory buffer of the size returned by this function must be passed.

If this function fails to calculate the size of the work buffer, it returns -1.
To know the reason of the failure, refer to the error callback message.

Remarks:

Specify NULL when the data is not packed to CPK.

Attention

The size of the work buffer depends on the values of the parameters specified when the library is initialized (by calling the criAtomEx_Initialize function).
Therefore, the library must be initialized before this function is executed.

See also

criAtomExAcb_LoadAcbData

criAtomExAcb_CalculateWorkSizeForLoadAcbDataById()

CriSint32 criAtomExAcb_CalculateWorkSizeForLoadAcbDataById	(	void *	acb_data,
		CriSint32	acb_data_size,
		CriFsBinderHn	awb_binder,
		CriUint16	awb_id
	)

Calculate the size of the work buffer required to load ACB data (specifying a CPK content ID)

Parameters

[in]	acb_data	ACB data address
[in]	acb_data_size	ACB data size
[in]	awb_binder	handle to a binder including an AWB file
[in]	awb_id	ID of the AWB data in a CPK file

Returns

CriSint32 work buffer size

Return values

>=	0 successfully completed
-1	error occurred

Description:

Calculates the size of the work buffer required to execute the criAtomExAcb_LoadAcbDataById function. Beside the fact that a CPK content ID is specified instead of a file path, this function works in the same way than the criAtomExAcb_CalculateWorkSizeForLoadAcbData function.

Remarks:

Specify NULL when the data is not packed to CPK.

See also

criAtomExAcb_CalculateWorkSizeForLoadAcbData, criAtomExAcb_LoadAcbDataById

criAtomExAcb_LoadAcbData()

CriAtomExAcbHn criAtomExAcb_LoadAcbData	(	void *	acb_data,
		CriSint32	acb_data_size,
		CriFsBinderHn	awb_binder,
		const CriChar8 *	awb_path,
		void *	work,
		CriSint32	work_size
	)

Load ACB data in memory.

Parameters

[in]	acb_data	ACB data address
[in]	acb_data_size	ACB data size
[in]	awb_binder	handle to a binder including an AWB file
[in]	awb_path	path to an AWB file
[in]	work	work buffer
[in]	work_size	work buffer size

Returns

CriAtomExAcbHn ACB handle

Description:

Loads ACB data and gets the information required for Cue playback.
The size of the work buffer required to load the ACB data is calculated by the criAtomExAcb_CalculateWorkSizeForLoadAcbData function.

For the third argument (awb_binder) and the fourth argument (awb_path), specify an AWB file used for streaming playback.
If the ACB data only concerns in-memory playback, the values specified for awb_binder and awb_path are ignored.)

Once the ACB data is loaded, the function returns an ACB handle ( CriAtomExAcbHn ) to access that ACB data.
By using the criAtomExPlayer_SetCueId function to assign both the ACB handle and the ID of a Cue to be played to an AtomEx Player, the Cue in the ACB data can be played back.

If this function loads the ACB file successfully, it returns an ACB handle.
If it fails to load the ACB file, for example due to a reading error, it returns CRI_NULL.

Remarks:

If a user allocator was registered by using the criAtomEx_SetUserAllocator macro, it is not necessary to pass a work buffer to this function.
(By passing NULL for work and 0 for work_size, the amount of memory required will be allocated by the user allocator.)
This is a non-blocking function.
By loading an ACB file in memory and then executing this function, it is possible to create an ACB handle without blocking the processes.
If the data is not packed into a CPK, specify NULL for the binder argument.

Attention

Both the data and the work buffers passed to this function must be maintained by the application until the ACB handle is destroyed.
(Do not write in the work buffer and do not release its memory.)
Part of the data buffer is also used as a work buffer.

The ACB data also includes a work area.
Therefore, the ACB data buffer cannot be used for other ACBs.
(Sharing the ACB handle that was created between AtomEx players is possible though.)

An ACB handle internally allocates a binder ( CriFsBinderHn ).
When ACB files are loaded, the Atom library (or CRI File System library) must be initialized with settings that allow to allocate as many binders as the number of ACB handles.

The library must be initialized before this function is called.

See also

criAtomExAcb_CalculateWorkSizeForLoadAcbData, CriAtomExAcbHn, criAtomExPlayer_SetCueId

criAtomExAcb_LoadAcbDataById()

CriAtomExAcbHn criAtomExAcb_LoadAcbDataById	(	void *	acb_data,
		CriSint32	acb_data_size,
		CriFsBinderHn	awb_binder,
		CriUint16	awb_id,
		void *	work,
		CriSint32	work_size
	)

Load ACB data in memory (specifying a CPK content ID)

Parameters

[in]	acb_data	ACB data address
[in]	acb_data_size	ACB data size
[in]	awb_binder	handle to a binder including the AWB file
[in]	awb_id	ID of the AWB data in a CPK file
[in]	work	work buffer
[in]	work_size	work buffer size

Returns

CriAtomExAcbHn ACB handle

Description:

Loads ACB data and gets the information required for Cue playback.
Beside the fact that a CPK content ID is specified instead of a file path, this function works in the same way than the criAtomExAcb_LoadAcbData function.

Remarks:

Specify NULL when the data is not packed to CPK.

See also

criAtomExAcb_LoadAcbData

criAtomExAcb_CalculateWorkSizeForLoadAcbFile()

CriSint32 criAtomExAcb_CalculateWorkSizeForLoadAcbFile	(	CriFsBinderHn	acb_binder,
		const CriChar8 *	acb_path,
		CriFsBinderHn	awb_binder,
		const CriChar8 *	awb_path
	)

Calculate the size of the work buffer required to load an ACB file.

Parameters

[in]	acb_binder	handle to a binder including an ACB file
[in]	acb_path	path to an ACB file
[in]	awb_binder	handle to a binder including an AWB file
[in]	awb_path	path to an AWB file

Returns

CriSint32 work buffer size

Return values

>=	0 successfully completed
-1	error occurred

Description:

Calculates the size of the work buffer required to execute the criAtomExAcb_LoadAcbFile function. When the criAtomExAcb_LoadAcbFile function is used to load ACB data and no user allocator was registered (using the criAtomEx_SetUserAllocator macro), a memory buffer of the size returned by this function must be passed.

If this function fails to calculate the size, it returns -1.
To know the reason of the failure, refer to the error callback message.

Attention

The size of the work buffer depends on the value of the parameters specified when the library was initialized (by calling the criAtomEx_Initialize function).
Therefore, the library must be initialized before this function is called.

This function allocates a loader with the criFsLoader_Create function when it begins its execution and destroys that loader with the criFsLoader_Destroy function when it finishes its execution.
Therefore, before calling this function, make sure to adjust the number of loaders so that there is at least one free load handle.

This is a blocking function.
The time required to load an ACB file varies depending on the platform.
If this function is executed during a game loop or at any time requiring screen updates, since the processing is blocked in the order of the millisecond, frames may be dropped.
Load ACB files only when a fluctuation in load is acceptable, for example when loading a new level.

See also

criAtomExAcb_LoadAcbFile

criAtomExAcb_CalculateWorkSizeForLoadAcbFileById()

CriSint32 criAtomExAcb_CalculateWorkSizeForLoadAcbFileById	(	CriFsBinderHn	acb_binder,
		CriUint16	acb_id,
		CriFsBinderHn	awb_binder,
		CriUint16	awb_id
	)

Calculate the size of the work buffer required to load an ACB file (specifying a CPK content ID)

Parameters

[in]	acb_binder	handle to a binder including an ACB file
[in]	acb_id	ID of the ACB data in the CPK file
[in]	awb_binder	handle to a binder including an AWB file
[in]	awb_id	ID of the AWB data in the CPK file

Returns

CriSint32 work area size

Return values

>=	0 successfully completed
-1	error occurred

Description:

Calculates the size of the work buffer required to execute the criAtomExAcb_LoadAcbFileById function. Beside the fact that a CPK content ID is specified instead of a file path, this function works in the same way than the criAtomExAcb_CalculateWorkSizeForLoadAcbFile function.

Remarks:

Specify NULL when the data is not packed to CPK.

See also

criAtomExAcb_CalculateWorkSizeForLoadAcbFile, criAtomExAcb_LoadAcbFileById

criAtomExAcb_LoadAcbFile()

CriAtomExAcbHn criAtomExAcb_LoadAcbFile	(	CriFsBinderHn	acb_binder,
		const CriChar8 *	acb_path,
		CriFsBinderHn	awb_binder,
		const CriChar8 *	awb_path,
		void *	work,
		CriSint32	work_size
	)

Load an ACB file.

Parameters

[in]	acb_binder	handle to a binder including an ACB file
[in]	acb_path	path to an ACB file
[in]	awb_binder	handle to a binder including an AWB file
[in]	awb_path	path to an AWB file
[in]	work	work buffer
[in]	work_size	work buffer size

Returns

CriAtomExAcbHn ACB handle

Description:

Loads an ACB file and gets the information required for Cue playback.
The size of the work buffer required to load the ACB file is calculated by the criAtomExAcb_CalculateWorkSizeForLoadAcbFile function.

For the third argument (awb_binder) and the fourth argument (awb_path), specify an AWB file for streaming playback.
(When the ACB data is only for in-memory playback (i.e. no streaming involved), the values specified for awb_binder and awb_path are ignored.)

When an ACB file is loaded, this function returns an ACB handle ( CriAtomExAcbHn ) to access the ACB data.
By using the criAtomExPlayer_SetCueId function to assign both the ACB handle and the ID of a Cue to be played to an AtomEx Player, the Cue in the ACB data can be played back.

If this function loads the ACB file successfully, it returns an ACB handle.
If it fails to load the ACB file, for example due to a reading error, it returns CRI_NULL.

Remarks:

If a user allocator was registered by using the criAtomEx_SetUserAllocator macro, it is not necessary to pass a work buffer to this function.
(By passing NULL for work and 0 for work_size, the amount of memory required will be allocated by the user allocator.)

Remarks:

Specify NULL when the data is not packed to CPK.

Attention

The library must be initialized before this function is called.

If a work buffer was passed to this function it must be maintained by the application until the ACB handle is destroyed.
(Do not write in the work buffer and do not release its memory.)

ACB handles internally allocate a binder ( CriFsBinderHn ) and a loader ( CriFsLoaderHn ).
When loading an ACB file, you must initialize the Atom library (or CRI File System library) with the proper settings so that enough binders and loaders can be allocated for the number of ACB handles.

This is a blocking function.
The time required to load an ACB file varies depending on the platform.
If this function is executed during a game loop or at any time requiring screen updates, since the processing is blocked in the order of the millisecond, frames may be dropped.
Load ACB files only when a fluctuation in load is acceptable, for example when loading a new level.

See also

criAtomExAcb_CalculateWorkSizeForLoadAcbFile, CriAtomExAcbHn, criAtomExPlayer_SetCueId

criAtomExAcb_LoadAcbFileById()

CriAtomExAcbHn criAtomExAcb_LoadAcbFileById	(	CriFsBinderHn	acb_binder,
		CriUint16	acb_id,
		CriFsBinderHn	awb_binder,
		CriUint16	awb_id,
		void *	work,
		CriSint32	work_size
	)

Load an ACB file (specifying a CPK content ID)

Parameters

[in]	acb_binder	handle to a binder including an ACB file
[in]	acb_id	ID of an ACB data in a CPK file
[in]	awb_binder	handle to a binder including an AWB file
[in]	awb_id	ID of an AWB data in a CPK file
[in]	work	work buffer
[in]	work_size	work buffer size

Returns

CriAtomExAcbHn ACB handle

Description:

Loads an ACB file and gets the information required for Cue playback.
Beside the fact that a CPK content ID is specified instead of a file path, this function works in the same way than the criAtomExAcb_LoadAcbFile function.

Remarks:

Specify NULL when the data is not packed to CPK.

See also

criAtomExAcb_LoadAcbFile

criAtomExAcb_Release()

void criAtomExAcb_Release

(

CriAtomExAcbHn

acb_hn

)

Release an ACB handle.

Parameters

[in]

acb_hn

ACB handle

Description:

Releases an ACB handle.
If an allocator was registered using the criAtomEx_SetUserAllocator macro, this function releases the memory allocated when the ACB handle was created.
(If a work buffer was passed when the ACB handle was created, the work buffer can be released after this function is executed.)

Remarks:

When destroying an ACB handle with this function, all the Cues referenced by the ACB handle are stopped.
The work buffer used to create the ACB handle and the memory used to store the ACB data will not be referenced after executing this function.

Attention

When this function is executed, it searches the library for an Atom Player referring to the ACB data to be destroyed.
Therefore, if an Atom Player is created/destroyed on another thread while this function is in progress, a serious problem such as an access violation or a deadlock may occur.
If you need to create/destroy an Atom Player on another thread while this function is in progress, create/destroy the Atom Player after locking the operation by calling the criAtomEx_Lock function.

See also

criAtomExAcb_LoadAcbData, criAtomExAcb_LoadAcbFile

criAtomExAcb_ReleaseAll()

void criAtomExAcb_ReleaseAll

(

void

)

Release all the ACB handles.

Description:

Releases all the ACB handles already loaded.
If a user allocator was registered by using the criAtomEx_SetUserAllocator macro, this function releases the memory allocated when the ACB handles were created.
(If work buffers were passed when the ACB handles were created, these work buffers can be released after the execution of this function.)

Remarks:

When this function is executed, all cue playback will stop at that point.
The work buffers used to create the ACB handles and the memory buffers used to store the ACB data will not be referenced anymore after executing this function.

Attention

When this function is executed, Atom Players referring to the specified ACB data are searched for in the library.
Therefore, if an Atom Player is created/destroyed on another thread while this function is in progress, a serious problem such as an access violation or a deadlock may occur.
If you need to create/destroy an Atom Player on another thread while this function is in progress, create/destroy an Atom Player after locking the operation by calling the criAtomEx_Lock function.

See also

criAtomExAcb_LoadAcbData, criAtomExAcb_LoadAcbFile

criAtomExAcb_EnumerateHandles()

CriSint32 criAtomExAcb_EnumerateHandles	(	CriAtomExAcbHandleCbFunc	func,
		void *	obj
	)

ACB handle enumerator.

Parameters

[in]	func	ACB handle callback function
[in]	obj	User-specified object

Returns

CriSint32 Number of enumerated ACB handles

Description:

Enumerates ACB handles.

When this function is executed, the callback function passed in the first argument ( func ) is called as many times as there are ACB handles.
Each ACB handle is passed as an argument to the callback function.

Remarks:

The value set in the second argument (obj) is passed as an argument to the callback function.
For other arguments to the callback function, please refer to the separate explanation of CriAtomExAcbHandleCbFunc .

The return value is the number of enumerated ACB handles (which corresponds to the number of times the callback function was called).
(If the enumeration is stopped during the first callback, 1 will still be returned.)
If no ACB handle exists, this function returns 0.
If an error occurs (such as an invalid argument), this function returns -1.

Attention

Do not destroy an ACB handle within the callback function.
To destroy all ACB handles at once, use the criAtomExAcb_ReleaseAll function instead.

See also

CriAtomExAcbHandleCbFunc, criAtomExAcb_ReleaseAll

criAtomExAcb_GetVersion()

CriUint32 criAtomExAcb_GetVersion	(	void *	acb_data,
		CriSint32	acb_data_size,
		void *	flag
	)

Get the version of the ACB data in memory.

Parameters

[in]	acb_data	ACB data address
[in]	acb_data_size	ACB data size
[out]	flag	flag that indicates whether the ACB can be loaded or not

Returns

CriUint2 ACB format version

Description:

Gets the format version of the ACB data in memory.
This function also uses the flag argument to indicate whether the data corresponding to this version can be loaded or not.

criAtomExAcb_GetVersionFromFile()

CriUint32 criAtomExAcb_GetVersionFromFile	(	CriFsBinderHn	acb_binder,
		const CriChar8 *	acb_path,
		void *	work,
		CriSint32	work_size,
		CriBool *	flag
	)

Get the version of an ACB file.

Parameters

[in]	acb_binder	handle to a binder including an ACB file
[in]	acb_path	path to an ACB file
[in]	work	work buffer
[in]	work_size	work buffer size
[out]	flag	flag that indicates whether the ACB can be loaded or not

Returns

CriUint2 ACB format version

Description:

Loads an ACB file in memory and gets the version of the format of the ACB data.
The size of the work buffer required to register the ACB information is calculated by the criAtomExAcb_CalculateWorkSizeForLoadAcbFile function.

This function also uses the flag argument to indicate whether the data corresponding to this version can be loaded or not.

Remarks:

If an allocator has already been registered by using the criAtomEx_SetUserAllocator macro, it is not necessary to pass a work buffer to this function.
(By passing NULL for work and 0 for work_size, the amount of memory required will be allocated by the user allocator.)

Remarks:

Specify NULL when the data is not packed to CPK.

Attention

The application does not need to keep the work buffer set in this function.
(When the function is finished, the data loaded in memory is released.)

When this function is started, a loader is allocated with the criFsLoader_Create function. When it is finished, the loader is destroyed with the criFsLoader_Destroy function.
When you execute this function, adjust the number of loaders so that one or more loader handles are available.

criAtomExAcb_GetSupportedVersion()

void criAtomExAcb_GetSupportedVersion	(	CriUint32 *	version_low,
		CriUint32 *	version_high
	)

Get information about what ACB file versions can be loaded.

Parameters

[out]	version_low	lowest version that can be loaded
[out]	version_high	highest version that can be loaded

Description:

Gets information about what ACB file versions can be loaded.
Since the highest version correspond to the version when the library was built, an ACB with a version higher than this value may be loadable.

criAtomExAcb_GetNumCues()

CriSint32 criAtomExAcb_GetNumCues

(

CriAtomExAcbHn

acb_hn

)

Get the number of Cues in the ACB.

Parameters

[in]

acb_hn

ACB handle

Returns

CriSint32 number of Cues

Description:

Gets the number of Cues contained in an ACB data.

Remarks:

If NULL is specified for the acb_hn argument, the last ACB data loaded is used.

criAtomExAcb_ExistsId()

CriBool criAtomExAcb_ExistsId	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id
	)

Check if a Cue with a specific ID exists.

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID

Returns

CriBool whether the Cue exists or not (if exists: CRI_TRUE/if does not exist: CRI_FALSE)

Description:

Checks whether a Cue with the specified Cue ID exists or not .
If it exists, this function returns CRI_TRUE.

Remarks:

If NULL is specified for the first argument (ach_hn), all ACBs will be searched.
(In that case, even if a single ACB contains a Cue with the specified ID, this function will return CRI_TRUE.)

criAtomExAcb_ExistsName()

CriBool criAtomExAcb_ExistsName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name
	)

Check if a Cue with a specific name exists.

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name

Returns

CriBool whether the Cue exists or not (if exists: CRI_TRUE/if does not exist: CRI_FALSE)

Description:

Checks whether a Cue with the specified name exists or not.
If it exists, this function returns CRI_TRUE.

Remarks:

If NULL is specified for the first argument (ach_hn), all ACBs will be searched.
(In that case, even if a single ACB contains a Cue with the specified name, this function will return CRI_TRUE.)

criAtomExAcb_ExistsIndex()

CriBool criAtomExAcb_ExistsIndex	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueIndex	index
	)

Check if a Cue with a specific index exists.

Parameters

[in]	acb_hn	ACB handle
[in]	index	Cue index

Returns

CriBool whether the Cue exists or not (if exists: CRI_TRUE/if does not exist: CRI_FALSE)

Description:

Checks whether a Cue with the specified index exists or not.
If it exists, this function returns CRI_TRUE.

Remarks:

If NULL is specified for the first argument (ach_hn), all ACBs will be searched.
(In that case, even if a single ACB contains a Cue with the specified index, this function will return CRI_TRUE.)

criAtomExAcb_GetCueIdByIndex()

CriAtomExCueId criAtomExAcb_GetCueIdByIndex	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueIndex	index
	)

Get the ID of a Cue from its index.

Parameters

[in]	acb_hn	ACB handle
[in]	index	Cue index

Returns

CriAtomExCueId Cue ID

Description:

Gets the ID of a Cue from its index.
If no Cue with that index exists, this function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue index.
(When this function finds an ACB containing a Cue with the specified index, it returns the ID of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetCueIdByName()

CriAtomExCueId criAtomExAcb_GetCueIdByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name
	)

Get the ID of a Cue from its name.

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name

Returns

CriAtomExCueId Cue ID

Description:

Gets the ID of a Cue from its name.
If no Cue with that name exists, this function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified name, it returns the ID of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetCueNameByIndex()

const CriChar8* criAtomExAcb_GetCueNameByIndex	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueIndex	index
	)

Get the name of a Cue from its index.

Parameters

[in]	acb_hn	ACB handle
[in]	index	Cue index

Returns

const CriChar8* Cue name

Description:

Gets the name of a Cue from its index.
If no Cue with that index exists, this function returns NULL.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue index.
(When this function finds an ACB containing a Cue with the specified index, it returns the name of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetCueNameById()

const CriChar8* criAtomExAcb_GetCueNameById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id
	)

Get the name of a Cue from its ID.

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID

Returns

const CriChar8* Cue name

Description:

Gets the name of a Cue from its ID.
If no Cue with that ID exists, this function returns NULL.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue ID.
(When this function finds an ACB containing a Cue with the specified ID, it returns the name of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetCueIndexById()

CriAtomExCueIndex criAtomExAcb_GetCueIndexById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id
	)

Get the index of a Cue from its ID.

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID

Returns

CriAtomExCueIndex Cue index

Description:

Gets the index of a Cue from its ID.
If no Cue with that ID exists, this function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue ID.
(When this function finds an ACB containing a Cue with the specified ID, it returns the index of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetCueIndexByName()

CriAtomExCueIndex criAtomExAcb_GetCueIndexByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name
	)

Get the index of a Cue from its name.

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name

Returns

CriAtomExCueIndex Cue index

Description:

Gets the index of a Cue from its name.
If no Cue with that name exists, this function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified name, it returns the index of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetUserDataById()

const CriChar8* criAtomExAcb_GetUserDataById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id
	)

Get the user data string of a Cue from its ID.

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID

Returns

const CriChar8 * user data string

Description:

Gets the user data string of a Cue from its ID.
If no Cue with that ID exists, this function returns NULL.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue ID.
(When this function finds an ACB containing a Cue with the specified ID, it returns the user data string of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetUserDataByName()

const CriChar8* criAtomExAcb_GetUserDataByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name
	)

Get the user data string of a Cue from its name.

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name

Returns

const CriChar8 * user data string

Description:

Gets the user data string of a Cue from its name.
If no Cue with that name exists, this function returns NULL.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified name, it returns the user data string of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetLengthById()

CriSint64 criAtomExAcb_GetLengthById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id
	)

Get the length of a Cue from its ID.

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID

Returns

CriSint64 Cue length (in milliseconds)

Description:

Gets the length of the Cue with the specified ID. The Cue length is given in milliseconds.
If no Cue with the specified ID exists or if the Cue has an infinite loop, this function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue ID.
(When this function finds an ACB containing a Cue with the specified ID, it returns the length of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetLengthByName()

CriSint64 criAtomExAcb_GetLengthByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name
	)

Get the length of a Cue from its name.

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name

Returns

CriSint64 Cue length (in milliseconds)

Description:

Gets the length of the Cue with the specified name. The Cue length is given in milliseconds.
If no Cue with the specified name exists or if the Cue has an infinite loop, this function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified name, it returns the length of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetNumUsableAisacControlsById()

CriSint32 criAtomExAcb_GetNumUsableAisacControlsById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id
	)

Get the number of AISAC Controls assigned to a Cue (specifying its ID)

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID

Returns

CriSint32 number of AISAC Controls

Description:

Get the number of AISAC Controls assigned to a Cue specified by its ID.
If no Cue with the specified ID exists, this function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue ID.
(When this function finds an ACB containing a Cue with the specified ID, it returns the number of AISAC controls assigned to the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetNumUsableAisacControlsByName, criAtomExAcb_GetUsableAisacControlById, criAtomExAcb_GetUsableAisacControlByName

criAtomExAcb_GetNumUsableAisacControlsByName()

CriSint32 criAtomExAcb_GetNumUsableAisacControlsByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name
	)

Get the number of AISAC Controls assigned to a Cue (specifying its name)

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name

Returns

CriSint32 number of AISAC Controls

Description:

Get the number of AISAC Controls assigned to a Cue specified by its name.
If no Cue with the specified name exists, this function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified name, it returns the number of AISAC controls assigned to the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetNumUsableAisacControlsById, criAtomExAcb_GetUsableAisacControlById, criAtomExAcb_GetUsableAisacControlByName

criAtomExAcb_GetUsableAisacControlById()

CriBool criAtomExAcb_GetUsableAisacControlById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id,
		CriUint16	index,
		CriAtomExAisacControlInfo *	info
	)

Get information about an AISAC Control assigned to a Cue (specifying the Cue's ID)

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID
[in]	index	AISAC Control index
[out]	info	AISAC Control information

Returns

CriBool did we get the information? (if succeeded: CRI_TRUE, if failed: CRI_FALSE)

Description:

Gets information about an AISAC Control based on its index in the Cue of the specified ID.
If no Cue with the specified ID exists, this function returns CRI_FALSE.
Otherwise, if the AISAC Control with the given index is found in the Cue, the function passes the information back in the info argument.

Remarks:

If NULL is specified for the first argument (ach_hn), all ACBs will be searched.
(When this function finds an ACB containing a Cue with the specified ID, it returns the information about the AISAC control of the given index, assigned to the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetNumUsableAisacControlsById, criAtomExAcb_GetNumUsableAisacControlsByName, criAtomExAcb_GetUsableAisacControlByName

criAtomExAcb_GetUsableAisacControlByName()

CriBool criAtomExAcb_GetUsableAisacControlByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name,
		CriUint16	index,
		CriAtomExAisacControlInfo *	info
	)

Get information about an AISAC Control assigned to a Cue (specifying the Cue's name)

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name
[in]	index	AISAC Control index
[out]	info	AISAC Control information

Returns

CriBool did we get the information? (if succeeded: CRI_TRUE, if failed: CRI_FALSE)

Description:

Gets information about an AISAC Control based on its index in the Cue of the specified name.
If no Cue with the specified name exists, this function returns CRI_FALSE.
Otherwise, if the AISAC Control with the given index is found in the Cue, the function passes the information back in the info argument.

Remarks:

If NULL is specified for the first argument (ach_hn), all ACBs will be searched.
(When this function finds an ACB containing a Cue with the specified name, it returns the information about the AISAC control of the given index, assigned to the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetNumUsableAisacControlsById, criAtomExAcb_GetNumUsableAisacControlsByName, criAtomExAcb_GetUsableAisacControlById

criAtomExAcb_IsUsingAisacControlById()

CriBool criAtomExAcb_IsUsingAisacControlById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id,
		CriAtomExAisacControlId	aisac_control_id
	)

Determine if a Cue (whose ID is specified) can be controlled by a specific AISAC Control.

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID
[in]	aisac_control_id	AISAC Control ID

Returns

CriBool Is control possible? (Possible: CRI_TRUE, Not possible: CRI_FALSE)

Description:

Determines if the Cue (whose ID is specified) can be controlled by a specific AISAC Control.
If no Cue with the specified ID exists, this function returns CRI_FALSE.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified ID, it determines if the AISAC control of the given ID can control the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_IsUsingAisacControlByName

criAtomExAcb_IsUsingAisacControlByName()

CriBool criAtomExAcb_IsUsingAisacControlByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name,
		const CriChar8 *	aisac_control_name
	)

Determine if a Cue (whose name is specified) can be controlled by a specific AISAC Control.

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name
[in]	aisac_control_name	AISAC Control name

Returns

CriBool Is control possible? (Possible: CRI_TRUE, Not possible: CRI_FALSE)

Description:

Determines if the Cue (whose name is specified) can be controlled by a specific AISAC Control.
If no Cue with the specified name exists, this function returns CRI_FALSE.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified name, it determines if the AISAC control of the given ID can control the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_IsUsingAisacControlById

criAtomExAcb_GetCuePriorityById()

CriSint32 criAtomExAcb_GetCuePriorityById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id
	)

Get the priority of the Cue with the given ID.

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID

Returns

CriSint32 priority (-1 is returned if the function fails)

Description:

Gets the priority of the Cue with the given ID.
If no Cue with the specified ID exists, this function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue ID.
(When this function finds an ACB containing a Cue with the specified ID, it returms the priority of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetCuePriorityByName

criAtomExAcb_GetCuePriorityByName()

CriSint32 criAtomExAcb_GetCuePriorityByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name
	)

Get the priority of the Cue with the given name.

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name

Returns

CriSint32 priority (-1 is returned if the function fails)

Description:

Gets the priority of the Cue with the given name.
If no Cue with the specified name exists, this function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified name, it returms the priority of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetCuePriorityById

criAtomExAcb_GetWaveformInfoById()

CriBool criAtomExAcb_GetWaveformInfoById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id,
		CriAtomExWaveformInfo *	waveform_info
	)

Get information about the waveform played by the Cue whose ID is given.

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID
[out]	waveform_info	waveform information

Returns

CriBool did we get the information? (if succeeded: CRI_TRUE, if failed: CRI_FALSE)

Description:

Gets the information about the waveform played back by the Cue whose ID is given.
If there are multiple waveforms in the Cue, this function get the information about the first waveform in the first Track. If no Cue with the specified ID exists, this function returns CRI_FALSE.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue ID.
(When this function finds an ACB containing a Cue with the specified ID, it gets the information about the waveform of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetWaveformInfoByName()

CriBool criAtomExAcb_GetWaveformInfoByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name,
		CriAtomExWaveformInfo *	waveform_info
	)

Get information about the waveform played by the Cue whose name is given.

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name
[out]	waveform_info	waveform information

Returns

CriBool did we get the information? (if succeeded: CRI_TRUE, if failed: CRI_FALSE)

Description:

Gets the information about the waveform played back by the Cue whose name is given.
If there are multiple waveforms in the Cue, this function get the information about the first waveform in the first Track. If no Cue with the specified name exists, this function returns CRI_FALSE.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified name, it gets the information about the waveform of the Cue in that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetOnMemoryAwbHandle()

CriAtomAwbHn criAtomExAcb_GetOnMemoryAwbHandle

(

CriAtomExAcbHn

acb_hn

)

Get an AWB handle from an ACB handle (for in-memory playback)

Parameters

[in]

acb_hn

ACB handle

Returns

CriAtomAwbHn AWB handle

Description:

Get an AWB handle for in-memory playback from an ACB handle.

Remarks:

The ACB data contains waveform data that is stored in the AWB format.
When creating an ACB handle, the Atom library loads the AWB data for in-memory playback and creates a playback handle (AWB handle).

This function can retrieve the AWB handle created internally by the Atom library.
By using this AWB handle, the waveform data in the ACB can be directly played on the application side by using the criAtomExPlayer_SetWaveId function.
(This can be used when seamless concatenated playback is performed for the waveform data contained in a Cue, or when in-memory waveform data contained in an ACB data is played for debugging purposes.)

Attention

An AWB handle depending on an ACB handle is destroyed when the ACB handle is released.
If the AWB handle retrieved by this function is destroyed separately, or if it is accessed after the ACB handle is released, a serious problem such as an access violation may occur.

See also

criAtomExAcb_GetStreamingAwbHandle

criAtomExAcb_GetStreamingAwbHandle()

CriAtomAwbHn criAtomExAcb_GetStreamingAwbHandle

(

CriAtomExAcbHn

acb_hn

)

Get an AWB handle from an ACB handle (for streaming playback)

Parameters

[in]

acb_hn

ACB handle

Returns

CriAtomAwbHn AWB handle

Description:

Obtains the AWB handle for streaming playback from the ACB data.
Note that this function can only obtain the AWB handle at the beginning of a slot.
To obtain the AWB handle at a slot other than the beginning, use the following function.

• criAtomExAcb_GetStreamingAwbHandleBySlotName
• criAtomExAcb_GetStreamingAwbHandleBySlotIndex

Remarks:

An AWB file for streaming playback is associated with the ACB data.
When creating an ACB handle, the Atom library reads the AWB data for streaming playback and creates a handle for playback (AWB handle).

By using this function, it is possible to obtain the AWB handle created internally by the Atom library.
By using the obtained AWB handle, it is possible to play waveform data for streaming playback from the application side using the criAtomExPlayer_SetWaveId function.
(This can be used for seamlessly connecting and playing waveform data included in the cue, or for playing waveform data for streaming playback associated with the ACB data for debugging purposes.)

Attention

The AWB handle held by the ACB handle is discarded when the ACB handle is released.
If you individually discard the AWB handle obtained by this function, or if you access an already obtained AWB handle after releasing the ACB handle, serious problems such as access violations may occur.

See also

criAtomExAcb_GetOnMemoryAwbHandle

criAtomExAcb_GetStreamingAwbHandleBySlotName()

CriAtomAwbHn criAtomExAcb_GetStreamingAwbHandleBySlotName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	awb_slot_name
	)

Get AWB handle for stream playback of specified AWB slot name.

Parameters

[in]	acb_hn	ACB handle
[in]	awb_slot_name	AWB slot name

Returns

CriAtomAwbHn AWB handle

Description:

Obtains the AWB handle for stream playback of the specified AWB slot name from the ACB data.

Remarks:

An AWB file for streaming playback is associated with the ACB data.
When creating an ACB handle, the Atom library reads the AWB data for streaming playback and creates a handle for playback (AWB handle).

By using this function, it is possible to obtain the AWB handle created internally by the Atom library.
By using the obtained AWB handle, it is possible to play waveform data for streaming playback from the application side using the criAtomExPlayer_SetWaveId function.
(This can be used for seamlessly connecting and playing waveform data included in the cue, or for playing waveform data for streaming playback associated with the ACB data for debugging purposes.)

Attention

The AWB handle held by the ACB handle is discarded when the ACB handle is released.
If you individually discard the AWB handle obtained by this function, or if you access an already obtained AWB handle after releasing the ACB handle, serious problems such as access violations may occur.

See also

criAtomExAcb_GetOnMemoryAwbHandle

criAtomExAcb_GetStreamingAwbHandleBySlotIndex()

CriAtomAwbHn criAtomExAcb_GetStreamingAwbHandleBySlotIndex	(	CriAtomExAcbHn	acb_hn,
		CriUint16	awb_slot_index
	)

Get AWB handle for stream playback of specified AWB slot index.

Parameters

[in]	acb_hn	ACB handle
[in]	awb_slot_index	AWB slot Index

Returns

CriAtomAwbHn AWB handle

Description:

Gets the AWB handle for stream playback of the specified AWB slot index from the ACB data.

Remarks:

An AWB file for streaming playback is associated with the ACB data.
When creating an ACB handle, the Atom library reads the AWB data for streaming playback and creates a handle for playback (AWB handle).

By using this function, it is possible to obtain the AWB handle created internally by the Atom library.
By using the obtained AWB handle, it is possible to play waveform data for streaming playback from the application side using the criAtomExPlayer_SetWaveId function.
(This can be used for seamlessly connecting and playing waveform data included in the cue, or for playing waveform data for streaming playback associated with the ACB data for debugging purposes.)

Attention

The AWB handle held by the ACB handle is discarded when the ACB handle is released.
If you individually discard the AWB handle obtained by this function, or if you access an already obtained AWB handle after releasing the ACB handle, serious problems such as access violations may occur.

See also

criAtomExAcb_GetOnMemoryAwbHandle

criAtomExAcb_GetCueInfoByName()

CriBool criAtomExAcb_GetCueInfoByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name,
		CriAtomExCueInfo *	info
	)

Get cue information (cue name specified)

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name
[out]	info	Cue information

Returns

CriBool did we get the information? (if succeeded: CRI_TRUE, if failed: CRI_FALSE)

Description:

Gets information about the Cue whose name is specified .
If no Cue with that name exists, the function returns CRI_FALSE.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified name, it gets the information about the Cue of that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetCueInfoById, criAtomExAcb_GetCueInfoByIndex

criAtomExAcb_GetCueInfoById()

CriBool criAtomExAcb_GetCueInfoById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id,
		CriAtomExCueInfo *	info
	)

Get information about the Cue whose ID is specified.

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID
[out]	info	Cue information

Returns

CriBool did we get the information? (if succeeded: CRI_TRUE, if failed: CRI_FALSE)

Description:

Gets information about the Cue whose ID is specified .
If no Cue with that ID exists, the function returns CRI_FALSE.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified ID, it gets the information about the Cue of that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetCueInfoByName, criAtomExAcb_GetCueInfoByIndex

criAtomExAcb_GetCueInfoByIndex()

CriBool criAtomExAcb_GetCueInfoByIndex	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueIndex	index,
		CriAtomExCueInfo *	info
	)

Get information about the Cue whose index is specified.

Parameters

[in]	acb_hn	ACB handle
[in]	index	Cue index
[out]	info	Cue information

Returns

CriBool did we get the information? (if succeeded: CRI_TRUE, if failed: CRI_FALSE)

Description:

Gets information about the Cue whose index is specified .
If no Cue with that index exists, the function returns CRI_FALSE.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified index, it gets the information about the Cue of that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetCueInfoByName, criAtomExAcb_GetCueInfoById

criAtomExAcb_GetNumCuePlayingCountByName()

CriSint32 criAtomExAcb_GetNumCuePlayingCountByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name
	)

Get the number of playing voices for a Cue with Cue limits (specifying the Cue name)

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name

Returns

CriSint32 number of voices (returns -1 if the specified Cue has no Cue limits)

Description:

Gets the number of playing voices for a Cue (specified by its name) for which the Cue limits are set.
If no Cue with that name exists or if the Cue limits are not set for that Cue, the function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified name, it gets the the number of playing voices for the Cue of that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetNumCuePlayingCountById, criAtomExAcb_GetNumCuePlayingCountByIndex

criAtomExAcb_GetNumCuePlayingCountById()

CriSint32 criAtomExAcb_GetNumCuePlayingCountById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id
	)

Get the number of playing voices for a Cue with Cue limits (specifying the Cue ID)

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID

Returns

CriSint32 number of voices (returns -1 if the specified Cue has no Cue limits)

Description:

Gets the number of playing voices for a Cue (specified by its ID) for which the Cue limits are set.
If no Cue with that ID exists or if the Cue limits are not set for that Cue, the function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified ID, it gets the the number of playing voices for the Cue of that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetNumCuePlayingCountByName, criAtomExAcb_GetNumCuePlayingCountByIndex

criAtomExAcb_GetNumCuePlayingCountByIndex()

CriSint32 criAtomExAcb_GetNumCuePlayingCountByIndex	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueIndex	index
	)

Get the number of playing voices for a Cue with Cue limits (specifying the Cue index)

Parameters

[in]	acb_hn	ACB handle
[in]	index	Cue index

Returns

CriSint32 number of voices (returns -1 if the specified Cue has no Cue limits)

Description:

Gets the number of playing voices for a Cue (specified by its index) for which the Cue limits are set.
If no Cue with that index exists or if the Cue limits are not set for that Cue, the function returns -1.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue name.
(When this function finds an ACB containing a Cue with the specified index, it gets the the number of playing voices for the Cue of that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

See also

criAtomExAcb_GetNumCuePlayingCountByName, criAtomExAcb_GetNumCuePlayingCountById

criAtomExAcb_GetBlockIndexByIndex()

CriAtomExBlockIndex criAtomExAcb_GetBlockIndexByIndex	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueIndex	index,
		const CriChar8 *	block_name
	)

Get the index of a block (specifying a Cue index)

Parameters

[in]	acb_hn	ACB handle
[in]	index	Cue index
[in]	block_name	block name

Returns

CriAtomExBlockIndex block index

Description:

Gets the index of a block, given the index of the Cue and the block name.
If no Cue with this index exists or if the block name does not exist, CRIATOMEX_INVALID_BLOCK_INDEX is returned.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue index.
(When this function finds an ACB containing a Cue with the specified index, it gets the index of the block for the Cue of that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetBlockIndexById()

CriAtomExBlockIndex criAtomExAcb_GetBlockIndexById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id,
		const CriChar8 *	block_name
	)

Get the index of a block (specifying a Cue ID)

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID
[in]	block_name	block name

Returns

CriAtomExBlockIndex block index

Description:

Gets the index of a block, given the ID of the Cue and the block name.
If no Cue with this ID exists or if the block name does not exist, CRIATOMEX_INVALID_BLOCK_INDEX is returned.

Remarks:

If you specify NULL for the first argument (ach_hn), the process will search all ACB data for data that matches the specified cue index.
(When this function finds an ACB containing a Cue with the specified ID, it gets the index of the block for the Cue of that ACB.)
The order of the search is the reverse of the ACB data loading order.
(Search is performed starting from the last data loaded.)

criAtomExAcb_GetBlockIndexByName()

CriAtomExBlockIndex criAtomExAcb_GetBlockIndexByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name,
		const CriChar8 *	block_name
	)

Get the index of a block (specifying a Cue name)

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name
[in]	block_name	block name

Returns

CriAtomExBlockIndex block index

Description:

Gets the index of a block, given the name of the Cue and the block name.
If no Cue with this name exists or if the block name does not exist, CRIATOMEX_INVALID_BLOCK_INDEX is returned.

Remarks:

When specifying NULL for the first argument (ach_hn), the search for the data specified by the Cue index among all the ACB data is performed within the library.
(Once the ACB data with the specified Cue name is found, the block index in the Cue within the ACB data is returned.)
Search is performed in the reverse order of the ACB data loading.
(Search is performed preferentially from the last loaded data.)

criAtomExAcb_SetDetectionInGamePreviewDataCallback()

void criAtomExAcb_SetDetectionInGamePreviewDataCallback	(	CriAtomExAcbDetectionInGamePreviewDataCbFunc	func,
		void *	obj
	)

Registration of the loading detection callback function for in-game preview data.

Parameters

[in]	func	Loading detection callback function
[in]	obj	User-specified object

Description:

Registers a callback function that is called whenever the loading of in-game preview data is detected.
The registered callback function is executed when the ACB content is parsed in an ACB loading function.

Attention

Generally, you should not call the Atom library APIs within a callback function.
Note that if the process is blocked in the callback function for a long time, some problems such as audio dropout may occur.

Only one such callback function can be registered.
If you attempt to register multiple callback functions, the last registration will always overwrite the previous one.

By specifying NULL for func, you can unregister the current callback function.

See also

CriAtomExAcbDetectionInGamePreviewDataCbFunc

criAtomExAcb_GetAcbInfo()

CriBool criAtomExAcb_GetAcbInfo	(	CriAtomExAcbHn	acb_hn,
		CriAtomExAcbInfo *	acb_info
	)

Get information about the ACB.

Parameters

[in]	acb_hn	ACB handle
[out]	acb_info	ACB information

Returns

CriBool did we get the information? (if succeeded: CRI_TRUE, if failed: CRI_FALSE)

Description:

Get the information about the ACB data.

Remarks:

If NULL is specified for the acb_hn argument, information about the last ACB data that was loaded is returned.

See also

CriAtomExAcbInfo

criAtomExAcb_ResetCueTypeStateByName()

void criAtomExAcb_ResetCueTypeStateByName	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	name
	)

Reset the type-based state of the Cue (specifying its name)

Parameters

[in]	acb_hn	ACB handle
[in]	name	Cue name

Description:

Resets the type-based state of the Cue with the specified name.

Attention

Only the state of the specified Cue is reset. The states of any SubSynths or CueLinks in the Cue will not be reset.

Remarks:

The state is used to store the tracks previously played back. It is type-based and does not apply to the Cues of polyphonic type.
This function resets the state management and reverts the Cue to its state just after the ACB data was loaded.

See also

criAtomExAcb_ResetCueTypeStateById, criAtomExAcb_ResetCueTypeStateByIndex

criAtomExAcb_ResetCueTypeStateById()

void criAtomExAcb_ResetCueTypeStateById	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueId	id
	)

Reset the type-based state of the Cue (specifying its ID)

Parameters

[in]	acb_hn	ACB handle
[in]	id	Cue ID

Description:

Resets the type-based state of the Cue with the specified ID.

Attention

Only the state of the specified Cue is reset. The states of any SubSynths or CueLinks in the Cue will not be reset.

Remarks:

The state is used to store the tracks previously played back. It is type-based and does not apply to the Cues of polyphonic type.
This function resets the state management and reverts the Cue to its state just after the ACB data was loaded.

See also

criAtomExAcb_ResetCueTypeStateByName, criAtomExAcb_ResetCueTypeStateByIndex

criAtomExAcb_ResetCueTypeStateByIndex()

void criAtomExAcb_ResetCueTypeStateByIndex	(	CriAtomExAcbHn	acb_hn,
		CriAtomExCueIndex	index
	)

Reset the type-based state of the Cue (specifying its index)

Parameters

[in]	acb_hn	ACB handle
[in]	index	Cue index

Description:

Resets the type-based state of the Cue with the specified index.

Attention

Only the state of the specified Cue is reset. The states of any SubSynths or CueLinks in the Cue will not be reset.

Remarks:

The state is used to store the tracks previously played back. It is type-based and does not apply to the Cues of polyphonic type.
This function resets the state management and reverts the Cue to its state just after the ACB data was loaded.

See also

criAtomExAcb_ResetCueTypeStateByName, criAtomExAcb_ResetCueTypeStateById

criAtomExAcb_AttachAwbFile()

void criAtomExAcb_AttachAwbFile	(	CriAtomExAcbHn	acb_hn,
		CriFsBinderHn	awb_binder,
		const CriChar8 *	awb_path,
		const CriChar8 *	awb_name,
		void *	work,
		CriSint32	work_size
	)

Attaching an AWB file for streaming.

Parameters

[in]	acb_hn	ACB handle
[in]	awb_binder	Handle of the binder that contains the AWB file
[in]	awb_path	Path to the AWB file
[in]	awb_name	AWB name
[in]	work	Additional work area required for attaching
[in]	work_size	Additional work area size

Description:

Attaches an AWB file for streaming to the ACB handle. Use the second argument, awb_binder, and the third argument, awb_path, to specify the AWB file for stream playback.
Use the fifth argument, awb_name, to specify the slot to which the AWB is attached. Therefore, if you have changed the AWB name (file name before the extension) that was output from AtomCraft, specify the original AWB name.
To attach an AWB file, you must allocate a memory area (work area) that is internally used by the library.
If the function fails to attach an AWB file, an error callback occurs.
For the reason of the failure, refer to the error callback message.

Remarks:

You can allocate a work area in the two ways below.
(a) User Allocator: A user provided function is used to allocate/release memory.
(b) Fixed Memory: A required memory area is passed directly to the library.

When you use the User Allocator method, you do not need to provide a work area.
You can allocate the required memory with the registered memory allocation function simply by specifying NULL for "work" and 0 for "work_size".
The memory allocated when the file was attached is released when the file is detached (the criAtomExAcb_DetachAwbFile function is executed) or when the ACB handle is released (the criAtomExAcb_Release function is executed).

When you use the Fixed Memory method, you must set a pre-allocated memory area separately for this function as a work area.
The size of the work area can be acquired by using the criAtomExAcb_CalculateWorkSizeForAttachAwbFile function.
When you call this function, allocate as large memory as the size acquired with criAtomExAcb_CalculateWorkSizeForAttachAwbFile function and set it for this function.
If you use the Fixed Memory method, the work area continues to be used in the library until the file is detached (the criAtomExAcb_DetachAwbFile function is executed) or until the ACB handle is released (the criAtomExAcb_Release function is executed).
When an AWB file is attached, a binder (CriFsBinderHn) and a loader (CriFsLoaderHn) are allocated internally in the library.
To attach additional AWB files, you must allocate as many binders and loaders as the number of the additional files and then initialize the Atom library (or the CRI File System library).

Remarks:

Specify NULL when the data is not packed in a CPK file.

See also

criAtomExAcb_DetachAwbFile, criAtomExAcb_Release, criAtomExAcb_CalculateWorkSizeForAttachAwbFile

criAtomExAcb_DetachAwbFile()

void criAtomExAcb_DetachAwbFile	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	awb_name
	)

Detaching an AWB file for streaming.

Parameters

[in]	acb_hn	ACB handle
[in]	awb_name	AWB name

Description:

Detaches the AWB file for streaming that is attached to the ACB handle. For the second argument, awb_name, specify the same AWB name as specified when the file was attached.
When the User Allocator method was used to allocate the work area when the file was attached, it is released when this function is executed.

See also

criAtomExAcb_AttachAwbFile

criAtomExAcb_CalculateWorkSizeForAttachAwbFile()

CriSint32 criAtomExAcb_CalculateWorkSizeForAttachAwbFile	(	CriFsBinderHn	awb_binder,
		const CriChar8 *	awb_path
	)

Acquiring the size of the work area required to attach an AWB file for streaming.

Parameters

[in]	awb_binder	Handle of the binder that contains the AWB file
[in]	awb_path	Path to the AWB file

Returns

CriSint32 Work area size

Return values

0	or larger Processing is completed successfully
-1	An error occurred

Description:

Calculates the work area size required for executing the criAtomExAcb_LoadAcbFileById function.

Remarks:

Specify NULL when the data is not packed in a CPK file.

See also

criAtomExAcb_AttachAwbFile

criAtomExAcb_GetNumAwbFileSlots()

CriSint32 criAtomExAcb_GetNumAwbFileSlots

(

CriAtomExAcbHn

acb_hn

)

Acquiring the number of AWB slots for streaming.

Parameters

[in]

acb_hn

ACB handle

Returns

CriSint32 Number of AWB slots for streaming

Description:

Acquires the number of stream AWBs required by the ACB handle.

criAtomExAcb_GetAwbFileSlotName()

const CriChar8* criAtomExAcb_GetAwbFileSlotName	(	CriAtomExAcbHn	acb_hn,
		CriUint16	index
	)

Acquiring the AWB slot for streaming.

Parameters

[in]	acb_hn	ACB handle
[in]	index	Slot index

Returns

const CriChar8* Stream AWB port name

Description:

Acquires the name of the stream AWB slot in the ACB handle. It is specified with its index.
The acquired slot name is used as the fourth argument of the criAtomExAcb_AttachAwbFile function. It is also used to specify a slot for the second argument of the criAtomExAcb_DetachAwbFile function.

criAtomExAcb_IsAttachedAwbFile()

CriBool criAtomExAcb_IsAttachedAwbFile	(	CriAtomExAcbHn	acb_hn,
		const CriChar8 *	awb_name
	)

Acquiring the attaching status of an AWB file for streaming.

Parameters

[in]	acb_hn	ACB handle
[in]	awb_name	AWB name

Description:

Indicates whether the AWB file is attached to the ACB handle. The second argument, awb_name, is the name of the slot to which the AWB is attached. Specify the AWB name of the slot that you are interested in.