A class for controlling parameters for each Category. More...

Classes
struct	ReactAisacModulationParameter
	AISAC modulation trigger parameter structure More...

struct	ReactDuckerParameter
	Ducker parameter structure by REACT More...

struct	ReactFadeParameter
	REACT fade parameter structure More...

struct	ReactParameter
	REACT drive parameter structure More...

Public Types
enum	ReactType : int { Ducker = 0, AisacModulationTrigger }
	REACT type More...

enum	ReactDuckerTargetType : int { Volume = 0, AisacControlValue }
	Ducking target by REACT More...

enum	ReactDuckerCurveType : int { Linear = CriAtomEx.CurveType.Linear, Square = CriAtomEx.CurveType.Square, SquareReverse = CriAtomEx.CurveType.SquareReverse, SCurve = CriAtomEx.CurveType.SCurve, FlatAtHalf = CriAtomEx.CurveType.FlatAtHalf }

enum	ReactHoldType { WhilePlaying, FixedTime }
	REACT hold type More...

enum	ReactStatus { Stop = 0, FadeOut, Hold, FadeIn, Error }
	Execution status of REACT More...

Static Public Member Functions
static void	SetVolume (string name, float volume)
	Sets volume for the Category by specifying the name More...

static void	SetVolume (int id, float volume)
	Sets volume for the Category by specifying the ID More...

static float	GetVolume (string name)
	Gets the Category volume by specifying the name More...

static float	GetVolume (int id)
	Gets the Category volume by specifying the ID More...

static void	Mute (string name, bool mute)
	Sets the Category mute status by specifying the name More...

static void	Mute (int id, bool mute)
	Sets the Category mute status by specifying the ID More...

static bool	IsMuted (string name)
	Gets the Category mute status by specifying the name More...

static bool	IsMuted (int id)
	Gets the Category mute status by specifying the ID More...

static void	Solo (string name, bool solo, float muteVolume)
	Sets the solo status of the Category by specifying the name More...

static void	Solo (int id, bool solo, float muteVolume)
	Sets the solo status of the Category by specifying the ID More...

static bool	IsSoloed (string name)
	Gets the solo status of the Category by specifying the name More...

static bool	IsSoloed (int id)
	Gets the solo status of the Category by specifying the ID More...

static void	Pause (string name, bool pause)
	Pauses/unpauses the Category by specifying the name More...

static void	Pause (int id, bool pause)
	Pauses/unpauses the Category by specifying the ID More...

static bool	IsPaused (string name)
	Gets the pause status of the Category by specifying the ID More...

static bool	IsPaused (int id)
	Pauses/unpauses the Category by specifying the name More...

static void	SetAisacControl (string name, string controlName, float value)
	Sets the AISAC control value for the Category by specifying the name More...

static void	SetAisac (string name, string controlName, float value)

static void	SetAisacControl (int id, int controlId, float value)
	Sets the AISAC control value for the Category by specifying the ID More...

static void	SetAisac (int id, int controlId, float value)

static void	SetReactParameter (string name, ReactParameter parameter)
	Sets the REACT drive parameter More...

static bool	GetReactParameter (string name, out ReactParameter parameter)
	Gets the REACT drive parameters More...

static bool	GetAttachedAisacInfoById (uint id, int aisacAttachedIndex, out CriAtomEx.AisacInfo aisacInfo)
	Gets the AISAC information by specifying the ID More...

static bool	GetAttachedAisacInfoByName (string name, int aisacAttachedIndex, out CriAtomEx.AisacInfo aisacInfo)
	Gets the AISAC information by specifying the name More...

static bool	GetCurrentAisacControlValue (string categoryName, string aisacControlName, out float controlValue)
	Gets the AISAC information by specifying the name More...

static ReactStatus	GetReactStatus (string reactName)
	Gets the execution status of REACT More...

static void	Stop (int id)
	Stop the playback of the Cues belonging to a Category by specifying its ID More...

static void	Stop (string name)
	Stop the current Cue playbacks of the Category by specifying the name More...

static void	StopWithoutReleaseTime (int id)
	Immediately stop the playback of the Cues belonging to a Category by specifying its ID More...

static void	StopWithoutReleaseTime (string name)
	Immediate stop the current Cue playbacks of the Category by specifying the name More...

static float	GetTotalVolume (int id)
	Obtaining the final Category volume via ID More...

static float	GetTotalVolume (string name)
	Immediate stop the current Cue playbacks of the Category by specifying the name More...

static void	SetFadeInTime (int id, ushort ms)
	Setting the Fade-in Time via ID More...

static void	SetFadeInTime (string name, ushort ms)
	Fade-in time setting by name More...

static void	SetFadeOutTime (int id, ushort ms)
	Setting the Fade-out Time via ID More...

static void	SetFadeOutTime (string name, ushort ms)
	Fade-out time setting by name More...

static bool	ResetAllAisacControl (int id)
	Set all AISAC control values attached to a Category to default values, by specifying its ID More...

static bool	ResetAllAisacControl (string name)
	Set all the AISACs attached to the Category specified by name to their default values More...

static void	AttachAisac (int id, string globalAisacName)
	Attach an AISAC to a Category by specifying its ID More...

static void	AttachAisac (string name, string globalAisacName)
	Attach an AISAC to the Category specified by name More...

static void	DetachAisac (int id, string globalAisacName)
	Remove an AISAC from a Category via ID More...

static void	DetachAisac (string name, string globalAisacName)
	Remove an AISAC from the Category specified by name More...

static void	DetachAisacAll (int id)
	Remove all AISACs from Category via ID More...

static void	DetachAisacAll (string name)
	Remove all AISACs from the Category specified by name More...

static int	GetNumAttachedAisacs (int id)
	Get the number of AISAC attached to the Category by specifying its ID More...

static int	GetNumAttachedAisacs (string name)
	Get the number of AISAC attached to the Category specified by name More...

static int	GetNumCuePlayingCount (int id)
	Get the number of Cues belonging to a Category that are being played back by specifying its ID More...

static int	GetNumCuePlayingCount (string name)
	Get the number of the current Cue playbacks of the Category by specifying the name More...

Detailed Description

A class for controlling parameters for each Category.

Description:: A class for controlling parameters for each Category.

Member Enumeration Documentation

enum ReactType : int

strong

REACT type

Description:: The type of REACT.

See also: CriAtomExCategory::GetReactParameter, CriAtomExCategory::SetReactParameter

Enumerator
Ducker	Ducker
AisacModulationTrigger	AISAC modulation trigger

enum ReactDuckerTargetType : int

strong

Ducking target by REACT

Description:: Ducking target type by REACT.

See also: CriAtomExCategory::GetReactParameter, CriAtomExCategory::SetReactParameter

Enumerator
Volume	Volume ducker
AisacControlValue	Ducker of the AISAC control value

enum ReactDuckerCurveType : int

strong

Deprecated:: This is a deprecated API that will be removed. Please consider using CriWare.CriAtomEx.CurveType instead.

Enumerator
Linear	straight line
Square	Slow transition
SquareReverse	high speed change
SCurve	S curve
FlatAtHalf	Inverted S curve

enum ReactHoldType

strong

REACT hold type

Description:: REACT hold type (for maintaining the decay time).

See also: CriAtomExCategory::GetReactParameter, CriAtomExCategory::SetReactParameter

Enumerator
WhilePlaying	Do holding while playing
FixedTime	Hold for a fixed time

enum ReactStatus

strong

Execution status of REACT

Description:: This is the value indicating the execution status of REACT

See also: CriAtomExCategory::GetReactStatus

Enumerator
Stop	Stopped
FadeOut	Execution starting
Hold	Executing
FadeIn	Execution ending
Error	Error

Member Function Documentation

static void SetVolume	(	string	name,
		float	volume
	)

inlinestatic

Sets volume for the Category by specifying the name

Parameters

name	Category name
volume	Volume value

Description:: Sets the volume for the Category by specifying the name.

static void SetVolume	(	int	id,
		float	volume
	)

inlinestatic

Sets volume for the Category by specifying the ID

Parameters

id	Category ID
volume	Volume value

Description:: Sets the volume for the Category by specifying the ID.

static float GetVolume ( string name )

inlinestatic

Gets the Category volume by specifying the name

Parameters

name	Category name

Returns: Category volume

Description:: Gets the volume value applied to the Category by specifying the name.

static float GetVolume ( int id )

inlinestatic

Gets the Category volume by specifying the ID

Parameters

id	Category ID

Returns: Category volume

Description:: Gets the volume value applied to the Category by specifying the ID.

static void Mute	(	string	name,
		bool	mute
	)

inlinestatic

Sets the Category mute status by specifying the name

Parameters

name	Category name
mute	Mute status (False = unmute, True = mute)

Description:: Sets the mute status of the Category by specifying the name.

static void Mute	(	int	id,
		bool	mute
	)

inlinestatic

Sets the Category mute status by specifying the ID

Parameters

id	Category ID
mute	Mute status (False = unmute, True = mute)

Description:: Sets the mute status of the Category by specifying the ID.

static bool IsMuted ( string name )

inlinestatic

Gets the Category mute status by specifying the name

Parameters

name	Category name

Returns: Mute status (False = not muted, True = muted)

Description:: Gets the mute status of the Category by specifying the name.

static bool IsMuted ( int id )

inlinestatic

Gets the Category mute status by specifying the ID

Parameters

id	Category ID

Returns: Mute status (False = not muted, True = muted)

Description:: Gets the mute status of the Category by specifying the ID.

static void Solo	(	string	name,
		bool	solo,
		float	muteVolume
	)

inlinestatic

Sets the solo status of the Category by specifying the name

Parameters

name	Category name
solo	Solo status (False = un-solo, True = solo)
muteVolume	The mute volume value applied to other Categories

Description:: Set the Category solo status by specifying the name.
The volume specified by muteVolume is applied to the Categories belonging to the same Category group.

static void Solo	(	int	id,
		bool	solo,
		float	muteVolume
	)

inlinestatic

Sets the solo status of the Category by specifying the ID

Parameters

id	Category ID
solo	Solo status (False = un-solo, True = solo)
muteVolume	The mute volume value applied to other Categories

Description:: Sets the solo status of the Category by specifying the ID.
The volume specified by muteVolume is applied to the Categories belonging to the same Category group.

static bool IsSoloed ( string name )

inlinestatic

Gets the solo status of the Category by specifying the name

Parameters

name	Category name

Returns: Solo status (False = not solo, True = solo)

Description:: Gets the solo status of the Category by specifying the name.

static bool IsSoloed ( int id )

inlinestatic

Gets the solo status of the Category by specifying the ID

Parameters

id	Category ID

Returns: Solo status (False = not solo, True = solo)

Description:: Gets the solo status of the Category by specifying the ID.

static void Pause	(	string	name,
		bool	pause
	)

inlinestatic

Pauses/unpauses the Category by specifying the name

Parameters

name	Category name
pause	Switch (False = unpause, True = pause)

Description:: Pauses/unpauses the Category by specifying the name.
The specification is the same as the CriWare.CriAtomExCategory::Pause(int, bool) function, except that the Category is specified by the name.

See also: CriAtomExCategory::Pause(int, bool)

static void Pause	(	int	id,
		bool	pause
	)

inlinestatic

Pauses/unpauses the Category by specifying the ID

Parameters

id	Category ID
pause	Switch (False = unpause, True = pause)

Description:: Pauses/unpauses the Category by specifying the ID.

Note:: Pausing a Category is treated independently of pausing the AtomExPlayer or playback sound (pause with CriWare.CriAtomExPlayer::Pause or CriWare.CriAtomExPlayback::Pause function), and the final pause status of a sound is determined by considering these pause states.
In other words, paused if either of them is paused, and unpaused if all of the are unpaused.

See also: CriAtomExCategory::Pause(string, bool)

static bool IsPaused ( string name )

inlinestatic

Gets the pause status of the Category by specifying the ID

Parameters

name	Category ID

Returns: Paused status (False = not paused, True = paused)

Description:: Gets the pause status of the Category by specifying the ID.

static bool IsPaused ( int id )

inlinestatic

Pauses/unpauses the Category by specifying the name

Parameters

id	Category name

Returns: Paused status (False = not paused, True = paused)

Description:: Gets the pause status of the Category by specifying the name.

static void SetAisacControl	(	string	name,
		string	controlName,
		float	value
	)

inlinestatic

Sets the AISAC control value for the Category by specifying the name

Parameters

name	Category name
controlName	AISAC control name
value	AISAC control value

Description:: Sets the AISAC control value for the Category by specifying the name.
The specification is the same as the CriWare.CriAtomExCategory::SetAisacControl function, except that the Category and AISAC control are specified by the name.

See also: CriAtomExCategory::SetAisacControl(int, int, float)

static void SetAisac	(	string	name,
		string	controlName,
		float	value
	)

inlinestatic

Deprecated:: This is a deprecated API that will be removed. Please consider using CriWare.CriAtomExCategory.SetAisacControl instead.

static void SetAisacControl	(	int	id,
		int	controlId,
		float	value
	)

inlinestatic

Sets the AISAC control value for the Category by specifying the ID

Parameters

id	Category ID
controlId	AISAC control ID
value	AISAC control value

Description:: Sets the AISAC control value for the Category by specifying the ID.

Note:: For the AISACs set to a Cue or Track, the AISAC control value set to the Category is given priority over the AISAC control value setting to the player
For the AISACs attached to the Category, only the AISACcontrol value set to the Category is always referenced.

See also: CriAtomExCategory::SetAisacControl(string, string, float)

static void SetAisac	(	int	id,
		int	controlId,
		float	value
	)

inlinestatic

Deprecated:: This is a deprecated API that will be removed. Please consider using CriWare.CriAtomExCategory.SetAisacControl instead.

static void SetReactParameter	(	string	name,
		ReactParameter	parameter
	)

inlinestatic

Sets the REACT drive parameter

Parameters

name	REACT name
parameter	REACT drive parameter structure

Description:: Sets the parameters that drive REACT.

Note:: Parameters cannot be set while REACT is running (warning is issued).
If you specify a REACT name that does not exist, an error callback is returned.

See also: CriAtomExCategory::GetReactParameter, CriAtomExCategory::GetReactStatus

static bool GetReactParameter	(	string	name,
		out ReactParameter	parameter
	)

inlinestatic

Gets the REACT drive parameters

Parameters

name	REACT name
parameter	REACT drive parameter structure

Description:: Gets the current value of the parameter that drives REACT.

Note:: If you specify a REACT name that does not exist, an error callback is called and CRI_False is returned.
If you specify a REACT name that does not exist, an error callback is returned.

See also: CriAtomExCategory::SetReactParameter

static bool GetAttachedAisacInfoById	(	uint	id,
		int	aisacAttachedIndex,
		out CriAtomEx.AisacInfo	aisacInfo
	)

inlinestatic

Gets the AISAC information by specifying the ID

Parameters

id	Category ID
aisacAttachedIndex	Index of the attached AISAC
aisacInfo	A structure for getting the AISAC information

Description:: Gets the information on the AISAC attached to the Category by specifying the ID.

Note:: If you specify a Category that does not exist, or if you specify an invalid index, False is returned.

See also: CriAtomExCategory::GetNumAttachedAisacs

static bool GetAttachedAisacInfoByName	(	string	name,
		int	aisacAttachedIndex,
		out CriAtomEx.AisacInfo	aisacInfo
	)

inlinestatic

Gets the AISAC information by specifying the name

Parameters

name	Category name
aisacAttachedIndex	Index of the attached AISAC
aisacInfo	A structure for getting the AISAC information

Description:: Gets the information on the AISAC attached to the Category by specifying the name.

Note:: If you specify a Category that does not exist, or if you specify an invalid index, False is returned.

See also: CriAtomExCategory::GetNumAttachedAisacs

static bool GetCurrentAisacControlValue	(	string	categoryName,
		string	aisacControlName,
		out float	controlValue
	)

inlinestatic

Gets the AISAC information by specifying the name

Parameters

categoryName	Category name
aisacControlName	AISAC control name
controlValue	Current value of the AISAC control

Returns: Was the current value acquired? (Acquired: true / Unable to acquire: false)

Description:: Get the current value of the AISAC control attached to a Category.

Note:: If you specify a Category that does not exist, or if you specify an invalid index, False is returned.

See also: CriAtomExCategory::GetNumAttachedAisacs

static ReactStatus GetReactStatus ( string reactName )

inlinestatic

Gets the execution status of REACT

Parameters

reactName REACT name

Returns: Execution status of REACT

Description:: Gets the execution status of REACT

Note:: If a non-existing REACT name is specified, an error callback will be triggered and ReactStatus.Error will be returned.

static void Stop ( int id )

inlinestatic

Stop the playback of the Cues belonging to a Category by specifying its ID

Parameters

id	Category ID

Description:: Stop the playback of the Cues from the specified Category.

static void Stop ( string name )

inlinestatic

Stop the current Cue playbacks of the Category by specifying the name

Parameters

name	Category name

Description:: Stop the playback of the Cues from the specified Category.

static void StopWithoutReleaseTime ( int id )

inlinestatic

Immediately stop the playback of the Cues belonging to a Category by specifying its ID

Parameters

id	Category ID

Description:: Immediately stop the playback of the Cues from the specified Category.

static void StopWithoutReleaseTime ( string name )

inlinestatic

Immediate stop the current Cue playbacks of the Category by specifying the name

Parameters

name	Category name

Description:: Immediately stop the playback of the Cues from the specified Category.

static float GetTotalVolume ( int id )

inlinestatic

Obtaining the final Category volume via ID

Parameters

id	Category ID

Returns: Category volume

Description:: Get the final volume value of the Category specified by ID, as calculated from REACT, AISAC, etc...

Note:: This function may incur a heavy load as it needs to calculate the final category volume value based on parameters.

static float GetTotalVolume ( string name )

inlinestatic

Immediate stop the current Cue playbacks of the Category by specifying the name

Parameters

name	Category name

Returns: Category volume

Description:: Get the final volume value of the Category specified by ID, as calculated from REACT, AISAC, etc...

Note:: This function may incur a heavy load as it needs to calculate the final category volume value based on parameters.

static void SetFadeInTime	(	int	id,
		ushort	ms
	)

inlinestatic

Setting the Fade-in Time via ID

Parameters

id	Category ID
ms	Fade-in time (in milliseconds)

Description:: Set the fade-in time for the category.
The fade-in time is used when resuming.

static void SetFadeInTime	(	string	name,
		ushort	ms
	)

inlinestatic

Fade-in time setting by name

Parameters

name	Category name
ms	Fade-in time (in milliseconds)

Description:: Set the fade-in time for the category.
The fade-in time is used when resuming.

static void SetFadeOutTime	(	int	id,
		ushort	ms
	)

inlinestatic

Setting the Fade-out Time via ID

Parameters

id	Category ID
ms	Fade-out time (in milliseconds)

Description:: Set the fade-out time for the category.
The fade-out time is used when pausing.

static void SetFadeOutTime	(	string	name,
		ushort	ms
	)

inlinestatic

Fade-out time setting by name

Parameters

name	Category name
ms	Fade-out time (in milliseconds)

Description:: Set the fade-out time for the category.
The fade-out time is used when pausing.

static bool ResetAllAisacControl ( int id )

inlinestatic

Set all AISAC control values attached to a Category to default values, by specifying its ID

Parameters

id	Category ID

Returns: Whether the setting was successful (true: success, false: failure)

Description:: Set all the AISAC controls attached to the category to their default values.
If a nonexistent category is specified, false will be returned.

static bool ResetAllAisacControl ( string name )

inlinestatic

Set all the AISACs attached to the Category specified by name to their default values

Parameters

name	Category name

Returns: Whether the setting was successful (true: success, false: failure)

Description:: Set all the AISAC controls attached to the category to their default values.
If a nonexistent category is specified, false will be returned.

See also: CriAtomExCategory::GetNumAttachedAisacs

static void AttachAisac	(	int	id,
		string	globalAisacName
	)

inlinestatic

Attach an AISAC to a Category by specifying its ID

Parameters

id	Category ID
globalAisacName	Global AISAC name to attach

Description:: Attach an AISAC to a category.
By attaching an AISAC, it is possible to implement AISAC parameter control even if the Cue or track does not include AISAC settings.

An error callback will be triggered if the attachment fails.
Check the message in the error callback for the reason of the failure.

Note:: Only a global AISAC included in the global settings (ACF file) can be attached.
To take advantage of an AISAC, you need to set the appropriate AISAC control values just like setting AISAC on a Cue or track.

Note:: Even if an AISAC is set for a Cue or track with the goal of changing the AISAC control value, the AISAC control value will not affect the AISAC attached to the category.
For an AISAC attached to a category, only the AISAC control value set for the category is referenced.
Attaching an AISAC control whose type is "automodulation" or "random" is currently not supported.
Currently, the maximum number of AISACs that can be attached to a category is fixed at 8.

See also: CriAtomExCategory::DetachAisac

static void AttachAisac	(	string	name,
		string	globalAisacName
	)

inlinestatic

Attach an AISAC to the Category specified by name

Parameters

name	Category name
globalAisacName	Global AISAC name to attach

Description:: Attach an AISAC to a category.
By attaching an AISAC, it is possible to implement AISAC parameter control even if the Cue or track does not include AISAC settings.

An error callback will be triggered if the attachment fails.
Check the message in the error callback for the reason of the failure.

Note:: Only a global AISAC included in the global settings (ACF file) can be attached.
To take advantage of an AISAC, you need to set the appropriate AISAC control values just like setting AISAC on a Cue or track.

Note:: Even if an AISAC is set for a Cue or track with the goal of changing the AISAC control value, the AISAC control value will not affect the AISAC attached to the category.
For an AISAC attached to a category, only the AISAC control value set for the category is referenced.
Attaching an AISAC control whose type is "automodulation" or "random" is currently not supported.
Currently, the maximum number of AISACs that can be attached to a category is fixed at 8.

See also: CriAtomExCategory::DetachAisac

static void DetachAisac	(	int	id,
		string	globalAisacName
	)

inlinestatic

Remove an AISAC from a Category via ID

Parameters

id	Category ID
globalAisacName	Global AISAC name to detach

Description:: Detach (remove) an AISAC from a category.

An error callback will be triggered if the detachment fails.
Check the message in the error callback for the reason of the failure.

See also: CriAtomExCategory::AttachAisac

static void DetachAisac	(	string	name,
		string	globalAisacName
	)

inlinestatic

Remove an AISAC from the Category specified by name

Parameters

name	Category name
globalAisacName	Global AISAC name to detach

Description:: Detach (remove) an AISAC from a category.

An error callback will be triggered if the detachment fails.
Check the message in the error callback for the reason of the failure.

See also: CriAtomExCategory::AttachAisac

static void DetachAisacAll ( int id )

inlinestatic

Remove all AISACs from Category via ID

Parameters

id	Category ID

Description:: Detach (remove) all AISACs from a Category.

static void DetachAisacAll ( string name )

inlinestatic

Remove all AISACs from the Category specified by name

Parameters

name	Category name

Description:: Detach (remove) all AISACs from a Category.

static int GetNumAttachedAisacs ( int id )

inlinestatic

Get the number of AISAC attached to the Category by specifying its ID

Parameters

id	Category ID

Returns: Number of AISACs attached to the Category

Description:: Get the number of AISACs attached to a category.
If a nonexistent category is specified, a negative value will be returned.

static int GetNumAttachedAisacs ( string name )

inlinestatic

Get the number of AISAC attached to the Category specified by name

Parameters

name	Category name

Returns: Number of AISACs attached to the Category

Description:: Get the number of AISACs attached to a category.
If a nonexistent category is specified, a negative value will be returned.

static int GetNumCuePlayingCount ( int id )

inlinestatic

Get the number of Cues belonging to a Category that are being played back by specifying its ID

Parameters

id	Category ID

Returns: Number of Cues currently played back by the Category specified by ID

Description:: Get the number of Cues being played within a category.
If a nonexistent category is specified, a negative value will be returned.

static int GetNumCuePlayingCount ( string name )

inlinestatic

Get the number of the current Cue playbacks of the Category by specifying the name

Parameters

name	Category name

Returns: Number of Cues currently played back by the Category specified by ID

Description:: Get the number of Cues being played within a category.
If a nonexistent category is specified, a negative value will be returned.

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

CriAtomEx.cs

Classes

Public Types

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation