CriAtomExPlaybackDebug Class Reference

A class that contains the APIs for debugging the CriAtomExPlayback application. More...

Static Public Member Functions
static bool	GetParameter (CriAtomExPlayback playback, CriAtomEx.Parameter parameterId, out float value)
	Gets parameters More...
static bool	GetParameter (CriAtomExPlayback playback, CriAtomEx.Parameter parameterId, out uint value)
	Gets parameters More...
static bool	GetParameter (CriAtomExPlayback playback, CriAtomEx.Parameter parameterId, out int value)
	Gets parameters More...
static bool	GetAisacControl (CriAtomExPlayback playback, uint controlId, out float value)
	Gets the AISAC control value (specifying the control ID) More...
static bool	GetAisacControl (CriAtomExPlayback playback, string controlName, out float value)
	Gets the AISAC control value (specifying the control name) More...

Detailed Description

A class that contains the APIs for debugging the CriAtomExPlayback application.

Member Function Documentation

static bool GetParameter ( CriAtomExPlayback  playback, CriAtomEx.Parameter  parameterId, out float  value  )

inlinestatic

Gets parameters

Parameters

playback	CriAtomExPlayback
parameterId	Parameter ID
value	Parameter value (output)

Returns

Whether the parameter could be get successfully

Description:

Gets the values of various parameters of CriAtomExPlayback.
If the parameters could successfully be acquired, this function returns true.
If the specified voice has already been deleted, this function returns false.

static bool GetParameter ( CriAtomExPlayback  playback, CriAtomEx.Parameter  parameterId, out uint  value  )

inlinestatic

Gets parameters

Parameters

playback	CriAtomExPlayback
parameterId	Parameter ID
value	Parameter value (output)

Returns

Whether the parameter could be get successfully

Description:

Gets the values of various parameters of CriAtomExPlayback.
If the parameters could successfully be acquired, this function returns true.
If the specified voice has already been deleted, this function returns false.

static bool GetParameter ( CriAtomExPlayback  playback, CriAtomEx.Parameter  parameterId, out int  value  )

inlinestatic

Gets parameters

Parameters

playback	CriAtomExPlayback
parameterId	Parameter ID
value	Parameter value (output)

Returns

Whether the parameter could be get successfully

Description:

Gets the values of various parameters of CriAtomExPlayback.
If the parameters could successfully be acquired, this function returns true.
If the specified voice has already been deleted, this function returns false.

static bool GetAisacControl ( CriAtomExPlayback  playback, uint  controlId, out float  value  )

inlinestatic

Gets the AISAC control value (specifying the control ID)

Parameters

playback	Playback
controlId	Control ID
value	Control value (0.0f to 1.0f), -1.0f when not set

Returns

Whether the AISAC control value was obtained

Description:

Returns the AISAC control value by specifying the control ID (for the audio played by CriWare.CriAtomExPlayer::Start).
Returns true if the AISAC control value was successfully acquired (the value will be -1.0f if no value was set).
If the specified voice has already been removed, this function returns false.

Note:

This function can get the AISAC control value only during sound playback.
Getting the AISAC control value fails after the playback ends or when the Voice is erased by the Voice control.

static bool GetAisacControl ( CriAtomExPlayback  playback, string  controlName, out float  value  )

inlinestatic

Gets the AISAC control value (specifying the control name)

Parameters

playback	Playback
controlName	Control name
value	Control value (0.0f to 1.0f), -1.0f when not set

Returns

Whether the AISAC control value was obtained

Description:

Returns the AISAC control value by specifying the control ID (for the audio played by CriWare.CriAtomExPlayer::Start).
Returns true if the AISAC control value was successfully acquired (the value will be -1.0f if no value was set).
If the specified voice has already been removed, this function returns false.

Note:

This function can get the AISAC control value only during sound playback.
Getting the AISAC control value fails after the playback ends or when the Voice is erased by the Voice control.

---

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

• CriAtomDebug.cs