CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriAtomAcbAsset Class Reference

ACB Asset Class More...

Inheritance diagram for CriAtomAcbAsset:
CriAssetBase

Public Member Functions

void LoadAsync ()
 Loading the Cue Sheet (asynchronously) More...
 
void LoadImmediate ()
 Loading the Cue Sheet (synchronously) More...
 
void Unload ()
 Unloading the Cue Sheet More...
 

Properties

CriAtomExAcb Handle [get]
 ACB instance More...
 
bool LoadRequested [get]
 Whether there was a loading request More...
 
bool Loaded = false [get]
 Whether loading is completed More...
 
CriAtomExAcbLoader.Status Status [get]
 Loading status of the asset More...
 
virtual ICriAssetImpl Implementation [get]
 Actual data deployment destination information More...
 
string FilePath [get, set]
 Path to the data's raw file More...
 
byte[] Data [get, set]
 Serialized data More...
 

Events

Action< CriAtomAcbAssetOnLoaded = null
 Load completion callback More...
 

Detailed Description

ACB Asset Class

Description:
A class that handles ACB files imported as Unity assets.

Member Function Documentation

void LoadAsync ( )
inline

Loading the Cue Sheet (asynchronously)

Description:
Loads the Cue Sheet asynchronously.
When loading data with this method, the Cue Sheet will be available once the CriAtomAcbAsset.Loaded becomes true.
void LoadImmediate ( )
inline

Loading the Cue Sheet (synchronously)

Description:
Loads the Cue Sheet.
This method is synchronous and may block the calling thread for a long time.
void Unload ( )
inline

Unloading the Cue Sheet

Description:
Unloading the Cue Sheet.

Property Documentation

CriAtomExAcb Handle
get

ACB instance

Description:
Gets an instance of the loaded ACB.
Returns null if the loading is not complete.
bool LoadRequested
get

Whether there was a loading request

Description:
Whether loading is requested (by calling CriAtomAcbAsset.LoadAsync etc.).
bool Loaded = false
get

Whether loading is completed

Description:
True when the loading initiated by calling CriAtomAcbAsset.LoadAsync has completed.

Loading status of the asset

Description:
Returns the loading status of an asset.
Check this status to determine if the asset requested by LoadAsync has been entirely loaded, etc.
virtual ICriAssetImpl Implementation
getinherited

Actual data deployment destination information

Description:
A field that shows how the actual data is stored.
The way to store the actual data depends on the inherited type.
string FilePath
getsetinherited

Path to the data's raw file

Description:
Gets the path of the file containing the streaming playback data.
Returns null if the actual data is stored in the asset.
byte [] Data
getsetinherited

Serialized data

Description:
Gets the actual data stored in the asset.
Returns null if the actual data is in a non-asset file.

Event Documentation

Action<CriAtomAcbAsset> OnLoaded = null

Load completion callback

Description:
Called when the ACB file has been loaded by the library.
All registered callbacks will be unregistered after a loading operation is completed.

The documentation for this class was generated from the following file: