AtomExPlayer More...

Inherits CriDisposable.

Public Types
enum	Status { Stop = 0, Prep, Playing, PlayEnd, Error }
	Player status More...

enum	TimeStretchParameterId : int { Ratio = 0, FrameTime = 1, Quality = 2 }
	Parameters for time stretch More...

enum	PitchShifterParameterId : int { Pitch = 0, Formant = 1, Mode = 2 }
	Parameters for pitch shifter More...

Public Member Functions
	CriAtomExPlayer ()
	Creates an AtomExPlayer More...

	CriAtomExPlayer (int maxPath, int maxPathStrings)
	Creates an AtomExPlayer (for single file playback) More...

	CriAtomExPlayer (bool enableAudioSyncedTimer)
	Creates an AtomExPlayer (using sound synchronization timer) More...

	CriAtomExPlayer (int maxPath, int maxPathStrings, bool enableAudioSyncedTimer)
	Creates an AtomExPlayer (single file playback, using sound synchronization timer) More...

override void	Dispose ()
	Discards an AtomExPlayer More...

void	SetCue (CriAtomExAcb acb, string name)
	Sets the sound data (Cue name specified) More...

void	SetCue (CriAtomExAcb acb, int id)
	Sets the sound data (Cue ID specified) More...

void	SetCueIndex (CriAtomExAcb acb, int index)
	Sets the sound data (Cue index specified) More...

void	SetContentId (CriFsBinder binder, int contentId)
	Sets the sound data (CPK content ID specified) More...

void	SetFile (CriFsBinder binder, string path)
	Sets the sound data (file name specified) More...

void	SetData (byte[] buffer, int size)
	Sets the sound data (on-memory byte array specified) More...

void	SetData (IntPtr buffer, int size)
	Sets the sound data (on-memory buffer address specified) More...

void	SetFormat (CriAtomEx.Format format)
	Specifies the format More...

void	SetNumChannels (int numChannels)
	Specifies the number of channels More...

void	SetSamplingRate (int samplingRate)
	Specifies the sampling rate More...

void	PrepareEntryPool (int capacity, bool stopOnEmpty)
	Creates an entry pool for concatenated playback More...

int	GetNumEntries ()
	The number of concatenated playback data entries More...

int	GetNumConsumedEntries ()
	Number of entries consumed by the playback process More...

bool	EntryFile (CriFsBinder binder, string path, bool repeat)
	Inputs the data for linked playback (file name specified) More...

bool	EntryContentId (CriFsBinder binder, int contentId, bool repeat)
	Inputs the data for linked playback (CPK content ID specified) More...

bool	EntryData (byte[] buffer, int size, bool repeat)
	Enters the concatenated playback data (on-memory byte array specified) More...

bool	EntryData (IntPtr buffer, int size, bool repeat)
	Enters the concatenated playback data (on-memory buffer address specified) More...

bool	EntryCue (CriAtomExAcb acb, string name, bool repeat)
	Inputs the data for linked playback (Cue name specified) More...

CriAtomExPlayback	Start ()
	Starts playback More...

CriAtomExPlayback	Prepare ()
	Prepare for playback More...

void	Stop (bool ignoresReleaseTime)
	Stop playing More...

void	Pause ()
	Pause More...

void	Resume (CriAtomEx.ResumeMode mode)
	Cancels the pausing More...

bool	IsPaused ()
	Gets the pausing status More...

void	SetVolume (float volume)
	Sets the volume More...

void	SetPitch (float pitch)
	Sets the pitch More...

void	SetPlaybackRatio (float ratio)
	Sequence playback ratio setting More...

void	SetPan3dAngle (float angle)
	Sets the Panning 3D angle More...

void	SetPan3dInteriorDistance (float distance)
	Sets the Panning 3D distance More...

void	SetPan3dVolume (float volume)
	Sets the Panning 3D volume More...

void	SetPanType (CriAtomEx.PanType panType)
	Sets the Panning type More...

void	SetSendLevel (int channel, CriAtomEx.Speaker id, float level)
	Sets the send level More...

void	SetBiquadFilterParameters (CriAtomEx.BiquadFilterType type, float frequency, float gain, float q)
	Sets the parameters of the Biquad Filter More...

void	SetBandpassFilterParameters (float cofLow, float cofHigh)
	Sets BandPass Filter parameters More...

void	SetBusSendLevel (string busName, float level)
	Sets the Bus Send Level (bus name specified) More...

bool	GetBusSendLevel (string busName, out float level)
	Obtaining the bus send level (specifying the bus name) More...

void	SetBusSendLevel (int busId, float level)

void	SetBusSendLevelOffset (string busName, float levelOffset)
	Sets the Bus Send Level by offset (bus name specified) More...

bool	GetBusSendLevelOffset (string busName, out float level)
	Obtaining the offset of the bus send level (specifying the bus name) More...

void	SetBusSendLevelOffset (int busId, float levelOffset)

void	AttachAisac (string globalAisacName)
	Attaches AISAC to the player More...

void	DetachAisac (string globalAisacName)
	Separates AISAC from the player More...

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

void	SetAisac (string controlName, float value)

void	SetAisacControl (uint controlId, float value)
	Sets the AISAC control value (specifying the control ID) More...

void	SetAisac (uint controlId, float value)

bool	GetAttachedAisacInfo (int aisacAttachedIndex, out CriAtomEx.AisacInfo aisacInfo)
	Gets information on AISAC attached to the player More...

void	Set3dSource (CriAtomEx3dSource source)
	Sets a 3D sound source object More...

void	Set3dListener (CriAtomEx3dListener listener)
	Sets the 3D listener object More...

void	SetStartTime (long startTimeMs)
	Specifies the playback start position More...

void	SetFirstBlockIndex (int index)
	Sets the playback start Block (Block index specified) More...

void	SetSelectorLabel (string selector, string label)
	Sets the selector information More...

void	UnsetSelectorLabel (string selector)
	Removes the selector information that is set. More...

void	ClearSelectorLabels ()
	Deletes all selector information More...

void	SetCategory (int categoryId)
	Sets the Category (ID specified) More...

void	SetCategory (string categoryName)
	Sets Category (Category name specified) More...

void	UnsetCategory ()
	Removes Category More...

void	SetCuePriority (int priority)
	Sets the Cue priority More...

void	SetVoicePriority (int priority)
	Sets the Voice Priority More...

void	SetVoiceControlMethod (CriAtomEx.VoiceControlMethod method)
	Specifies the Voice control method More...

void	SetPreDelayTime (float time)
	Set the pre-delay time More...

void	SetEnvelopeAttackTime (float time)
	Sets the Envelope Attack Time More...

void	SetEnvelopeHoldTime (float time)
	Sets the envelope hold time More...

void	SetEnvelopeDecayTime (float time)
	Sets the envelope decay time More...

void	SetEnvelopeReleaseTime (float time)
	Sets the envelope release time More...

void	SetEnvelopeSustainLevel (float level)
	Sets the envelope sustain level More...

void	AttachFader ()
	Attach a fader to a player More...

void	DetachFader ()
	Remove a fader from a player More...

void	SetFadeOutTime (int ms)
	Sets the Fade-out time More...

void	SetFadeInTime (int ms)
	Sets the Fade-in time More...

void	SetFadeInStartOffset (int ms)
	Sets the Fade-in start offset More...

void	SetFadeOutEndDelay (int ms)
	Sets the delay time after Fade-out More...

bool	IsFading ()
	Gets whether the fading is in process More...

void	ResetFaderParameters ()
	Initializes the fader parameters More...

void	SetGroupNumber (int group_no)
	Specifies the group number More...

void	Update (CriAtomExPlayback playback)
	Updates the playback parameters (by CriAtomExPlayback object) More...

void	UpdateAll ()
	Updates the playback parameters (for all sounds being played) More...

void	ResetParameters ()
	Initializes the playback parameters More...

long	GetTime ()
	Gets the playback time More...

Status	GetStatus ()
	Gets the status More...

float	GetParameterFloat32 (CriAtomEx.Parameter id)
	Gets parameters (floating point numbers) More...

uint	GetParameterUint32 (CriAtomEx.Parameter id)
	Gets parameters (unsigned integer) More...

int	GetParameterSint32 (CriAtomEx.Parameter id)
	Gets parameters (signed integer) More...

void	SetSoundRendererType (CriAtomEx.SoundRendererType type)
	Sets the output sound renderer type More...

void	SetRandomSeed (uint seed)
	Sets the random number seed More...

void	Loop (bool sw)
	Switches on/off the loop playback More...

void	SetAsrRackId (int asr_rack_id)
	Specification of ASR Rack ID More...

void	SetVoicePoolIdentifier (uint identifier)
	Sets the Voice Pool identifier More...

void	SetDspTimeStretchRatio (float ratio)
	Sets the DSP time stretch ratio More...

void	SetDspPitchShifterPitch (float pitch)
	Sets the pitch shift amount of the DSP pitch shifter More...

void	SetDspParameter (int id, float value)
	Sets the DSP parameter More...

void	AttachTween (CriAtomExTween tween)
	Attaches an AtomExTween More...

void	DetachTween (CriAtomExTween tween)
	Detaches an AtomExTween More...

void	DetachTweenAll ()
	Detaches all AtomExTween More...

void	SetEnvelopeAttackCurve (CriAtomEx.CurveType curveType, float strength)
	Setting the Attack curve of EG More...

void	SetEnvelopeDecayCurve (CriAtomEx.CurveType curveType, float strength)
	Setting the Decay curve of EG More...

void	SetEnvelopeReleaseCurve (CriAtomEx.CurveType curveType, float strength)
	Setting the Release curve of EG More...

void	AddOutputPort (CriAtomExOutputPort outputPort)
	Adding the output port object More...

void	RemoveOutputPort (CriAtomExOutputPort outputPort)
	Removing the output port object More...

void	ClearOutputPorts ()
	Clearing the output port object More...

void	AddPreferredOutputPort (CriAtomExOutputPort outputPort)
	Adding the preferred output port object More...

void	RemovePreferredOutputPort (CriAtomExOutputPort outputPort)
	Removing the preferred output port object More...

void	RemovePreferredOutputPort (string name)
	Removing the preferred output port object by name More...

void	ClearPreferredOutputPorts ()
	Clearing the preferred output port object More...

void	SetScheduleTime (System.Int64 scheduleTime)
	Schedule playback time More...

Static Public Attributes
static readonly uint	MaxOutputPorts = 8
	Maximum number of output ports that can be specified per player More...

Properties
CriAtomExBeatSync.CbFunc	OnBeatSyncCallback
	Registers the Sequence event callback More...

CriAtomExSequencer.EventCallback	OnSequenceCallback
	Registers the beat synchronization callback More...

int	entryPoolCapacity `[get]`
	The number of concatenated playback data that can be input

Detailed Description

AtomExPlayer

Description:: A player class used for sound playback control.
Performs control such as setting data, starting playback and getting status.

Member Enumeration Documentation

enum Status

strong

Player status

Description:

A value indicating the playback status of the AtomExPlayer.
It can get using the CriWare.CriAtomExPlayer::GetStatus function.

The playback status usually changes in the following order.

Stop
Prep
Playing
PlayEnd

The status immediately after creating the AtomExPlayer is Stop.
When you set the data using the CriWare.CriAtomExPlayer::SetCue function etc., and call the CriWare.CriAtomExPlayer::Start function, the status changes to playback preparation state ( Prep ) to prepare playback.
When enough data is supplied and the playback is ready, the status changes to ( Playing ) and the sound output starts.
When all the data set was played back, the status changes to playback completed ( PlayEnd ).

Note:: One AtomExPlayer can play multiple sounds.
If you call the CriWare.CriAtomExPlayer::Start function for the AtomExPlayer being played, the two sounds are played back at the same time.
If the CriWare.CriAtomExPlayer::Stop function is called during playback, all sounds currently being played in the AtomExPlayer are stopped and the status returns to Stop.
(Depending on the timing of calling the CriWare.CriAtomExPlayer::Stop function, it may take some time to change to Stop.)

When the CriWare.CriAtomExPlayer::Start function is called multiple times for one AtomExPlayer, the status changes to Prep if at least one sound is being prepared.
(The status does not change to Playing until all the sounds are playing.)
If you call the CriWare.CriAtomExPlayer::Start function again for the player in Playing state, the status temporarily returns to Prep.

If invalid data is read during playback or file access fails, the status changes to Error.
If an error occurs in a sound while playing multiple sounds, the player status changes to Error regardless of the status of other sounds.

See also: CriAtomExPlayer::GetStatus, CriAtomExPlayer::Start, CriAtomExPlayer

Enumerator
Stop	Stopped
Prep	Preparing for playback
Playing	Playing
PlayEnd	Playback completed
Error	Error occurred

enum TimeStretchParameterId : int

strong

Parameters for time stretch

Description:: The parameter specified for the time stretch DSP.

See also: CriAtomExVoicePool.AttachDspTimeStretch, CriAtomExPlayer.SetDspParameter

Enumerator
Ratio	Stretch ratio
FrameTime	Frame time
Quality	Processing quality

enum PitchShifterParameterId : int

strong

Parameters for pitch shifter

Description:: The parameter specified for the pitch shifter DSP.

See also: CriAtomExVoicePool.AttachDspPitchShifter, CriAtomExPlayer.SetDspParameter

Enumerator
Pitch	Pitch
Formant	Formant
Mode	Pitch shift mode

Constructor & Destructor Documentation

CriAtomExPlayer ( )

inline

Creates an AtomExPlayer

Returns: AtomExPlayer

Description:

Creates an AtomExPlayer.

The steps for playing back the sound data using the created AtomExPlayer are as follows:

Use the CriWare.CriAtomExPlayer::SetCue function to set the data to be played in the AtomExPlayer.
Call the CriWare.CriAtomExPlayer::Start function to start playback.

Note:: The library must be initialized before calling this function.

When playing back a sound file that is not packed by specifying it in the CriWare.CriAtomExPlayer::SetFile function, CriWare.CriAtomExPlayer::CriAtomExPlayer(int, int) function must be used instead of this function.

This function is a return-on-complete function.
The time it takes for creating the AtomExPlayer depends on the platform.
If this function is called at a timing when the screen needs to be updated such as in a game loop, the process is blocked in the unit of milliseconds, resulting in dropped frames.
Create/discard AtomExPlayers at a timing when load fluctuations is accepted such as when switching scenes.

See also: CriAtomExPlayer::Dispose, CriAtomExPlayer::SetCue, CriAtomExPlayer::Start, CriAtomExPlayer::CriAtomExPlayer(int, int), CriAtomExPlayer::CriAtomExPlayer(bool), CriAtomExPlayer::CriAtomExPlayer(int, int, bool)

CriAtomExPlayer	(	int	maxPath,
		int	maxPathStrings
	)

inline

Creates an AtomExPlayer (for single file playback)

Parameters

maxPath	Maximum path string length
maxPathStrings	The number of files that can be played simultaneously

Returns: AtomExPlayer

Description:: Create an AtomExPlayer for single file playback.
The basic specification is the same as the CriWare.CriAtomExPlayer::CriAtomExPlayer() function, except that a single file can be played.

Note:: The AtomExPlayer created by this function allocates maxPathxmaxPathStrings memory areas for single file playback.
This area is not used when playing back ACB or AWB files.
When the CriWare.CriAtomExPlayer::SetFile function is not used, it is possible to save memory usage by using the CriWare.CriAtomExPlayer::CriAtomExPlayer() function instead of this function.

See also: CriAtomExPlayer::CriAtomExPlayer()

CriAtomExPlayer ( bool enableAudioSyncedTimer )

inline

Creates an AtomExPlayer (using sound synchronization timer)

Parameters

enableAudioSyncedTimer Sound synchronization timer enabled flag

Returns: AtomExPlayer

Description:: Create an AtomExPlayer which supports sound synchronization.
The basic specification is the same as the CriWare.CriAtomExPlayer::CriAtomExPlayer() function except that the playback time synchronized with the sound can be obtained.

Note:: For the sound played using the AtomExPlayer created by specifying true for the argument of this function, the time is updated in sync with the number of played samples
When the CriWare.CriAtomExPlayback::GetTimeSyncedWithAudio function is not used, it is possible to suppress the increase in load by specifying false in the argument of this function or by using CriWare.CriAtomExPlayer::CriAtomExPlayer() instead of this function.

Note:: For the AtomExPlayer created by specifying true for the argument of this function, the playback pitch cannot be changed using the CriWare.CriAtomExPlayer::SetPitch function.

See also: CriAtomExPlayer::CriAtomExPlayer(), CriAtomExPlayback::GetTimeSyncedWithAudio()

CriAtomExPlayer	(	int	maxPath,
		int	maxPathStrings,
		bool	enableAudioSyncedTimer
	)

inline

Creates an AtomExPlayer (single file playback, using sound synchronization timer)

Parameters

maxPath	Maximum path string length
maxPathStrings	The number of files that can be played simultaneously
enableAudioSyncedTimer	Sound synchronization timer enabled flag

Returns: AtomExPlayer

Description:: Create an AtomExPlayer for single file playback.
By specifying the flag to enableAudioSyncedTimer, it is possible to get the playback time synchronized with the sound.
Basic specification is the same as the CriWare.CriAtomExPlayer::CriAtomExPlayer() function.

See also: CriAtomExPlayer::CriAtomExPlayer(), CriAtomExPlayer::CriAtomExPlayer(int, int), CriAtomExPlayer::CriAtomExPlayer(bool)

Member Function Documentation

override void Dispose ( )

inline

Discards an AtomExPlayer

Description:: Discards the AtomExPlayer.
When this function is called, all the resources allocated in the DLL when creating the AtomExPlayer are released.

Note:: This function is a return-on-complete function.
If you try to discard an AtomExPlayer that is playing sound, this function waits for the playback to be stopped and then releases the resources.
(If the playback is from a file, it also waits for the completion of reading.)
Therefore, the process may be blocked in this function for a long time (for several frames).
Create/discard AtomExPlayers at a timing when load fluctuations is accepted such as when switching scenes.

See also: CriAtomExPlayer::CriAtomExPlayer

void SetCue	(	CriAtomExAcb	acb,
		string	name
	)

inline

Sets the sound data (Cue name specified)

Parameters

acb	ACB object
name	Cue name

Description:: Associates the Cue name with the AtomExPlayer.
After specifying the Cue name using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the specified Cue is played.

Note:

When specifying the Cue to play with the CriWare.CriAtomExPlayer::SetCue function, the parameters set by the following functions are ignored:

(The audio format, number of channels, sampling rate, etc. are automatically set based on the information in the ACB file.)

Example:: :

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

// ACFファイルの登録

CriAtomEx.RegisterAcf(null, "sample.acf");

// ACBファイルのロード

CriAtomExAcb acb = CriAtomExAcb.LoadAcbFile(null, "sample.acb", "sample.awb");

// 再生するキューの名前を指定

player.SetCue(acb, "gun_shot");

// セットされた音声データを再生

player.Start();

:

Once set, the information on the data is retained in the AtomExPlayer until other data is set.
Therefore, when playing the same data many times, it is not necessary to reset the data for each playback.
(You can call the CriWare.CriAtomExPlayer::Start function repeatedly.)

See also: CriAtomExPlayer::Start

void SetCue	(	CriAtomExAcb	acb,
		int	id
	)

inline

Sets the sound data (Cue ID specified)

Parameters

acb	ACB object
id	Cue ID

Description:: Associates the Cue ID with the AtomExPlayer.
After specifying the Cue ID using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the specified Cue is played.

Note:

When specifying the Cue to play with the CriWare.CriAtomExPlayer::SetCue function, the parameters set by the following functions are ignored:

(The audio format, number of channels, sampling rate, etc. are automatically set based on the information in the ACB file.)

Example:: :

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

// ACFファイルの登録

CriAtomEx.RegisterAcf(null, "sample.acf");

// ACBファイルのロード

CriAtomExAcb acb = CriAtomExAcb.LoadAcbFile(null, "sample.acb", "sample.awb");

// 再生するキューのIDを指定

player.SetCue(acb, 100);

// セットされた音声データを再生

player.Start();

:

Once set, the information on the data is retained in the AtomExPlayer until other data is set.
Therefore, when playing the same data many times, it is not necessary to reset the data for each playback.
(You can call the CriWare.CriAtomExPlayer::Start function repeatedly.)

See also: CriAtomExPlayer::Start

void SetCueIndex	(	CriAtomExAcb	acb,
		int	index
	)

inline

Sets the sound data (Cue index specified)

Parameters

acb	ACB object
index	Cue index

Description:: Associates the Cue index with the AtomExPlayer.
After specifying the Cue index using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the specified Cue is played.

Note:

When specifying the Cue to play with the CriWare.CriAtomExPlayer::SetCueIndex function, the parameters set by the following functions are ignored:

(The audio format, number of channels, sampling rate, etc. are automatically set based on the information in the ACB file.)

This function can be used to set the audio to play on a player without specifying the Cue name or the Cue ID.
(This function can be used for debugging purposes, since the contents in the ACB file can be played without specifying a Cue name or Cue ID.)

Example:: :

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

// ACFファイルの登録

CriAtomEx.RegisterAcf(null, "sample.acf");

// ACBファイルのロード

CriAtomExAcb acb = CriAtomExAcb.LoadAcbFile(null, "sample.acb", "sample.awb");

// 再生するキューのインデックスを指定

player.SetCueIndex(acb, 300);

// セットされた音声データを再生

player.Start();

:

Once set, the information on the data is retained in the AtomExPlayer until other data is set.
Therefore, when playing the same data many times, it is not necessary to reset the data for each playback.
(You can call the CriWare.CriAtomExPlayer::Start function repeatedly.)

See also: CriAtomExPlayer::Start

void SetContentId	(	CriFsBinder	binder,
		int	contentId
	)

inline

Sets the sound data (CPK content ID specified)

Parameters

binder	Binder
contentId	Content ID

Description:: Associates the content with the AtomExPlayer.
Used to play the content file in the CPK file by specifying the ID using the CRI File System library.
By specifying the binder and content ID for the player using this function and calling the CriWare.CriAtomExPlayer::Start function, the specified content file is streamed.
Note that the file is not loaded when this function is called.
Loading of the file starts after calling the CriWare.CriAtomExPlayer::Start function.

Note:

When specifying the audio data to play with the CriWare.CriAtomExPlayer::SetContentId function, it is necessary to provide information about the data by calling the following functions:

Example:: :

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

// バインダの作成

CriFsBinder binder = new CriFsBinder();

// CPKファイルのバインドを開始

CriFsBindRequest bindRequest = CriFsUtility.BindCpk(binder, "sample.cpk");

// バインドの完了を待つ

yield return bindRequest.WaitForDone(this);

// 音声ファイルをセット

// sample.cpk内の1番のコンテンツをセット

player.SetContentId(binder, 1);

// 再生する音声データのフォーマットを指定

player.SetFormat(CriAtomEx.Format.ADX);

player.SetNumChannels(2);

player.SetSamplingRate(44100);

// セットされた音声データを再生

plaeyr.Start();

:

Once set, the information on the file is retained in the AtomExPlayer until other data is set.
Therefore, when playing the same data many times, it is not necessary to reset the data for each playback.
(You can call the CriWare.CriAtomExPlayer::Start function repeatedly.)

See also: CriAtomExPlayer::Start, CriAtomExPlayer::SetFormat, CriAtomExPlayer::SetNumChannels, CriAtomExPlayer::SetSamplingRate

void SetFile	(	CriFsBinder	binder,
		string	path
	)

inline

Sets the sound data (file name specified)

Parameters

binder	Binder object
path	File path

Description:: Associates the sound file with the AtomExPlayer.
After specifying a file using this function, the file is streamed by calling the CriWare.CriAtomExPlayer::Start function to start playback.
Note that the file is not loaded when this function is called.
Loading of the file starts after calling the CriWare.CriAtomExPlayer::Start function.

Note:

When using this function, it is necessary to create an AtomExPlayer for single file playback.
Specifically, CriWare.CriAtomExPlayer::CriAtomExPlayer(int, int) must be used instead of CriWare.CriAtomExPlayer::CriAtomExPlayer().

When setting the sound data using the CriWare.CriAtomExPlayer::SetFile function, it is necessary to separately specify the information of the sound data to be played using the following functions.

Example:: :

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

// 音声ファイルをセット

player.SetFile(null, "sample.hca");

// 再生する音声データのフォーマットを指定

player.SetFormat(CriAtomEx.Format.HCA);

player.SetNumChannels(2);

player.SetSamplingRate(48000);

// セットされた音声データを再生

player.Start();

:

Once the file information has been set, it is stored in the AtomEx player.
Therefore, there is no need to set it again when playing the same file again.
(The CriWare.CriAtomExPlayer::Start function can be executed repeatedly.)

If the target is WebGL and the file to be played is a .wav file,
CriAtomEx.Format.AUDIO_BUFFER must be specified as the format.

player = new CriAtomExPlayer(256, 8);

player.SetFile(null, System.IO.Path.Combine(Common.streamingAssetsPath, "sample_se.wav"));

player.SetFormat(CriAtomEx.Format.AUDIO_BUFFER);

See also: CriAtomExPlayer::CriAtomExPlayer(int, int), CriAtomExPlayer::Start, CriAtomExPlayer::SetFormat, CriAtomExPlayer::SetNumChannels, CriAtomExPlayer::SetSamplingRate

void SetData	(	byte[]	buffer,
		int	size
	)

inline

Sets the sound data (on-memory byte array specified)

Parameters

buffer	Byte array
size	Buffer size

Description:: Associates the sound data placed on the memory with the AtomExPlayer.
After specifying the memory address and size using this function, when you start playback using the CriWare.CriAtomExPlayer::Start function, the specified data is played.

Note:

When using this function, it is necessary to create an AtomExPlayer for single file playback.
Specifically, CriWare.CriAtomExPlayer::CriAtomExPlayer(int, int) must be used instead of CriWare.CriAtomExPlayer::CriAtomExPlayer().

When setting the sound data using the CriWare.CriAtomExPlayer::SetData function, it is necessary to separately specify the information of the sound data to be played using the following functions.

Note:: The buffer address passed to SetData should be fixed beforehand by the application so that it is not moved by the garbage collector.

Example:: :

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

// 音声ファイルをセット

player.SetData(null, buffer, size);

// 再生する音声データのフォーマットを指定

player.SetFormat(CriAtomEx.Format.HCA);

player.SetNumChannels(2);

player.SetSamplingRate(48000);

// セットされた音声データを再生

player.Start();

:

Once set, the information on the file is retained in the AtomExPlayer until other data is set.
Therefore, when playing the same data many times, it is not necessary to reset the data for each playback.
(You can call the CriWare.CriAtomExPlayer::Start function repeatedly.)

See also: CriAtomExPlayer::CriAtomExPlayer(int, int), CriAtomExPlayer::Start, CriAtomExPlayer::SetFormat, CriAtomExPlayer::SetNumChannels, CriAtomExPlayer::SetSamplingRate

void SetData	(	IntPtr	buffer,
		int	size
	)

inline

Sets the sound data (on-memory buffer address specified)

Parameters

buffer	Buffer address
size	Buffer size

Description:: For details, refer to CriWare.CriAtomExPlayer::SetData(byte[], int) .

See also: CriAtomExPlayer::SetData(byte[], int)

void SetFormat ( CriAtomEx.Format format )

inline

Specifies the format

Parameters

format Format

Description:: Specifies the sound format to be played by the AtomExPlayer.
When the sound is played using the CriWare.CriAtomExPlayer::Start function, the AtomExPlayer gets a Voice that can play the data with the format specified by this function from the Voice Pool.
The default before calling the function is the ADX format.

Note:: This function needs to be set only when playing sound without using the ACB file.
When playing a Cue, the format is automatically acquired from the Cue Sheet, so it is not necessary to call this function separately.

void SetNumChannels ( int numChannels )

inline

Specifies the number of channels

Parameters

numChannels The number of channels

Description:: Specifies the number of sound channels to be played by the AtomExPlayer.
When the sound is played using the CriWare.CriAtomExPlayer::Start function, the AtomExPlayer gets a Voice that can play the data with the channel count specified by this function from the Voice Pool.
The default before calling the function is 2 channels.

Note:: This function needs to be set only when playing sound without using the ACB file.
When playing a Cue, the format is automatically acquired from the Cue Sheet, so it is not necessary to call this function separately.

void SetSamplingRate ( int samplingRate )

inline

Specifies the sampling rate

Parameters

samplingRate Sampling rate

Description:: Specifies the sampling rate of the sound played by the AtomExPlayer.
When the sound is played using the CriWare.CriAtomExPlayer::Start function, the AtomExPlayer gets a Voice that can play the data with the sampling rate specified by this function from the Voice Pool.
The default before calling the function is 32000Hz.

Note:: This function needs to be set only when playing sound without using the ACB file.
When playing a Cue, the format is automatically acquired from the Cue Sheet, so it is not necessary to call this function separately.

void PrepareEntryPool	(	int	capacity,
		bool	stopOnEmpty
	)

inline

Creates an entry pool for concatenated playback

Parameters

capacity	The number of data that can be input
stopOnEmpty	Whether to stop if the entry pool is empty

Description:: Create an entry pool for concatenated playback using CriWare.CriAtomExPlayer::EntryData etc.

Note:: Calling this function puts the player in linked playback mode.
If the stopOnEmpty flag is set to false, even if the data supplied by the CriWare.CriAtomExPlayer::SetData or CriWare.CriAtomExPlayer::EntryData reached its end, the player stays in playback state and waits for the next data input.
If set to true, the player stops playback when the supplied data is exhausted, so make sure to feed data with a margin.

int GetNumEntries ( )

inline

The number of concatenated playback data entries

Returns: Number of entries

Description:: Gets the number of entries entered for concatenated playback.

See also: CriAtomExPlayer::PrepareEntryPool, CriAtomExPlayer::EntryData

int GetNumConsumedEntries ( )

inline

Number of entries consumed by the playback process

Returns: Number of entries

Description:: Gets the number of entries consumed by the playback process when fetching concatenated playback data to the player.
This number will increase each time an entry is consumed during playback, and it will be reset when CriAtomExPlayer::Start is called.
It does not increase if the same entry is being played in a loop.

See also: CriAtomExPlayer::PrepareEntryPool, CriAtomExPlayer::EntryData

bool EntryFile	(	CriFsBinder	binder,
		string	path,
		bool	repeat
	)

inline

Inputs the data for linked playback (file name specified)

Parameters

binder	Binder object
path	File path
repeat	Whether to repeat playback when the next data is not entered

Returns: Whether the data was successfully entered.

Description:: Inputs a sound file for linked playback.
When performing linked playback, set the start data using the CriWare.CriAtomExPlayer::SetData function etc. start playback, then input additional playback data using this function.

See also: CriAtomExPlayer::PrepareEntryPool, CriAtomExPlayer::EntryContentId, CriAtomExPlayer::EntryData

bool EntryContentId	(	CriFsBinder	binder,
		int	contentId,
		bool	repeat
	)

inline

Inputs the data for linked playback (CPK content ID specified)

Parameters

binder	Binder object
contentId	Content ID
repeat	Whether to repeat playback when the next data is not entered

Returns: Whether the data was successfully entered.

Description:: Enter the content for linked playback.
Used to play the content file in the CPK file by specifying the ID using the CRI File System library.
When performing linked playback, set the start data using the CriWare.CriAtomExPlayer::SetData function etc. start playback, then input additional playback data using this function.

See also: CriAtomExPlayer::PrepareEntryPool, CriAtomExPlayer::EntryFile, CriAtomExPlayer::EntryData

bool EntryData	(	byte[]	buffer,
		int	size,
		bool	repeat
	)

inline

Enters the concatenated playback data (on-memory byte array specified)

Parameters

buffer	On-memory byte array
size	Buffer size
repeat	Whether to repeat playback when the next data is not entered

Returns: Whether the data was successfully entered.

Description:: Inputs the data for linked playback.
When performing linked playback, set the start data using the CriWare.CriAtomExPlayer::SetData function etc. start playback, then input data using this function.

See also: CriAtomExPlayer::PrepareEntryPool, CriAtomExPlayer::EntryFile, CriAtomExPlayer::EntryContentId

bool EntryData	(	IntPtr	buffer,
		int	size,
		bool	repeat
	)

inline

Enters the concatenated playback data (on-memory buffer address specified)

Parameters

buffer	Buffer address
size	Buffer size
repeat	Whether to repeat playback when the next data is not entered

Returns: Whether the data was successfully entered.

Description:: Inputs the data for linked playback.
When performing linked playback, set the start data using the CriWare.CriAtomExPlayer::SetData function etc. start playback, then input data using this function.

See also: CriAtomExPlayer::PrepareEntryPool

bool EntryCue	(	CriAtomExAcb	acb,
		string	name,
		bool	repeat
	)

inline

Inputs the data for linked playback (Cue name specified)

Parameters

acb	ACB handle
name	Cue name
repeat	Whether to repeat playback when the next data is not entered

Returns: Whether the data was successfully entered.

Description:: Inputs the data for linked playback.
When performing linked playback, set the start data using the CriWare.CriAtomExPlayer::SetData function etc. start playback, then input data using this function.

See also: CriAtomExPlayer::PrepareEntryPool

CriAtomExPlayback Start ( )

inline

Starts playback

Returns: CriAtomExPlayback object

Description:

Starts playing the sound data.
Before calling this function, it is necessary to set the sound data to be played to the AtomExPlayer in advance using the functions such as CriWare.CriAtomExPlayer::SetCue .
For example, when playing a Cue, it is necessary to set the sound data as follows using the CriWare.CriAtomExPlayer::SetCue function in advance, before calling this function.

    :
// ACFファイルの登録
CriAtomEx.RegisterAcf(null, "sample.acf");
// ACBファイルのロード
CriAtomExAcb acb = CriAtomExAcb.LoadAcbFile(null, "sample.acb", "sample.awb");
// プレーヤの作成
CriAtomExPlayer player = new CriAtomExPlayer();
// 再生するキューの名前を指定
player.SetCue(acb, "gun_shot");
// セットされた音声データを再生
player.Start();
    :

本関数実行後、再生の進み具合（発音が開始されたか、再生が完了したか等）がどうなっているかは、ステータスを取得することで確認が可能です。
ステータスの取得には、 CriWare.CriAtomExPlayer::GetStatus 関数を使用します。
CriWare.CriAtomExPlayer::GetStatus 関数は以下の5通りのステータスを返します。
-# Stop

Prep
Playing
PlayEnd
Error

When you create an AtomExPlayer, the AtomExPlayer's status is Stop.
By calling this function after setting the sound data to be played, the status of the AtomExPlayer changes to ready ( Prep ).
(Prep is the status waiting for the data to be supplied or start of decoding.)
When enough data is supplied for starting playback, the AtomExPlayer changes the status to Playing and starts to output sound.
When all the set data have been played back, AtomExPlayer changes its status to PlayEnd.
If an error occurs during playback, AtomExPlayer changes the status to Error.

By checking the status of AtomExPlayer and switching the processing depending on the status, it is possible to create a program linked to the sound playback status.
For example, if you want to wait for the completion of sound playback before proceeding, use the following code.

    :
// プレーヤの作成
CriAtomExPlayer player = new CriAtomExPlayer();
// 再生するキューの名前を指定
player.SetCue(acb, "gun_shot");
// セットされた音声データを再生
player.Start();
// 再生完了待ち
while (player.GetStatus() != CriAtomExPlayer.Status.PlayEnd) {
    yield return null;
}
    :

See also: CriAtomExPlayer::SetCue, CriAtomExPlayer::GetStatus

CriAtomExPlayback Prepare ( )

inline

Prepare for playback

Returns: CriAtomExPlayback object

Description:: Prepares for playing sound data.
Before calling this function, it is necessary to set the sound data to be played to the AtomExPlayer in advance using the functions such as CriWare.CriAtomExPlayer::SetData .

When this function is called, the sound playback starts in the paused state.
When the function is called, the resources required for sound playback are allocated and the data starts to be buffered (reading the streamed file), but the sound is not played after finished buffering.
(It stands by in paused state even if it is ready to be played.)

In the case of playing only one sound, this function behaves the same as the code below.

：

// プレーヤをポーズ状態に設定

player.Pause();

// 音声の再生を開始

CriAtomExPlayback playback = player.Start();

：

本関数で再生準備を行った音声を発音するには、本関数が返すCriAtomExPlaybackオブジェクトに対し、 CriWare.CriAtomExPlayback::Resume を実行する必要があります。

Note:

In streaming playback, there is a time lag after starting playback using the CriWare.CriAtomExPlayer::Start function before the sound playback actually starts.
(Because it takes time to buffer the sound data.)

By performing the following operations, it is possible to control the timing of sound playback even for sound in stream playback.

Call the CriWare.CriAtomExPlayer::Prepare function to start preparation.
Check the status of the CriAtomExPlayback obtained acquired in step 1. using the CriWare.CriAtomExPlayback::GetStatus function.
When the status becomes Playing, unpause the playback using the CriWare.CriAtomExPlayback::Resume function.
After unpausing, the sound starts at the next server processing timing.

The specific code is as follows.

    :
// プレーヤの作成
CriAtomExPlayer player = new CriAtomExPlayer();
// 再生するキューの名前を指定
player.SetCue(acb, "gun_shot");
// セットされた音声データの再生準備を開始
CriAtomExPlayback playback = player.Prepare();
// 再生準備完了待ち
while (playback.GetStatus() != CriAtomExPlayback.Status.Playing) {
    yield return null;
}
// ポーズを解除
playback.Resume(CriAtomEx.ResumeMode.PreparedPlayback);
    :

Note:: If PausedPlayback is specified when unpausing, both the pausing for preparing playback by this function and the pausing by the CriWare.CriAtomExPlayer::Pause function are canceled.
If you want to play the sound prepared for playback using this function while stopping the sound paused by the CriWare.CriAtomExPlayer::Pause function, specify PreparedPlayback when unpausing.

See also: CriAtomExPlayback::GetStatus, CriAtomExPlayback::Resume

void Stop ( bool ignoresReleaseTime )

inline

Stop playing

Parameters

ignoresReleaseTime Whether to ignore release time (False = perform release process, True = ignore release time and stop immediately)

Description:: Issues a request to stop playback.
If this function is called for the AtomExPlayer that is playing sound, the AtomExPlayer stops playing (stops reading files or playback), and transitions to the Stop state.

If the argument is set to True, the release time is ignored and the sound is stopped immediately, even if the sound being played has an envelope release time.

Note:: If this function is called for an AtomExPlayer that has already stopped (AtomExPlayer whose status is PlayEnd or Error), the status of the AtomExPlayer is changed to Stop.

Note:: If this function is called for the AtomExPlayer that is playing sound, the status may not change to Stop immediately.
(It may take some time for it to change to Stop.)

See also: CriAtomExPlayer::Start, CriAtomExPlayer::GetStatus

void Pause ( )

inline

Pause

Description:: Pauses playback.

Note:: In the default state (state immediately after creating the player), the player is not paused.

Note:: When this function is called, "all" the sounds being played by the player are paused.
Use the CriWare.CriAtomExPlayback::Pause function to pause each sound being played separately.

See also: CriAtomExPlayer::Resume, CriAtomExPlayer::IsPaused, CriAtomExPlayback::Pause

void Resume ( CriAtomEx.ResumeMode mode )

inline

Cancels the pausing

Parameters

mode	Unpausing target

Description:: Cancels the suspended state.

When this function is called by specifying PausedPlayback in the argument (mode), the playback of the sound paused by the user using the CriWare.CriAtomExPlayer::Pause function (or the CriWare.CriAtomExPlayback::Pause function) is resumed.
When this function is called by specifying PreparedPlayback in the argument (mode), the playback of the sound prepared by the user using the CriWare.CriAtomExPlayer::Prepare starts.

Note:: If the player paused by the CriWare.CriAtomExPlayer::Pause function is prepared for playback with the CriWare.CriAtomExPlayer::Prepare function, the playback will not start until the unpausing processing triggered by both PausedPlayback and PreparedPlayback is completed.

To always start playback, even if the player is processed by the CriWare.CriAtomExPlayer::Pause or CriWare.CriAtomExPlayer::Prepare functions, please call this function with the "mode" argument set to "AllPlayback".

Note:: When this function is called, "all" the sounds being played by the player are unpaused.
Use the CriWare.CriAtomExPlayback::Resume function to unpause each sound being played separately.

See also: CriAtomExPlayer::Pause, CriAtomExPlayback::Resume

bool IsPaused ( )

inline

Gets the pausing status

Returns: Whether the playback is paused (False = not paused, True = paused)

Description:: Returns whether the player is paused.

Note:: This function returns true only when "all sounds are paused".
After calling the CriWare.CriAtomExPlayer::Pause function, if the sounds were unpaused by specifying the playback ID (the CriWare.CriAtomExPlayback::Pause function was called), this function returns false.

This function does not distinguish between the sounds paused by the CriWare.CriAtomExPlayer::Pause function and the those paused by the CriWare.CriAtomExPlayer::Prepare function.
(Regardless of the pausing method, it only determines whether all the Voices are paused.)

See also: CriAtomExPlayer::Pause, CriAtomExPlayback::Pause

void SetVolume ( float volume )

inline

Sets the volume

Parameters

volume Volume value

Description:: Specify the output sound volume.
After setting the volume using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played with the specified volume.
It is also possible to update the volume of the sound already played by calling the CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll function after setting the volume.

The volume value is a scale factor for the amplitude of the sound data (the unit is not decibel).
For example, if you specify 1.0f, the original sound is played at its unmodified volume.
If you specify 0.5f, the sound is played at the volume by halving the amplitude (-6dB) of the original waveform.
If you specify 0.0f, the sound is muted (silent).
The default value for volume is 1.0f.

Note:: You can set the volume value to 0.0f or higher.
If you set a value higher than 1.0f, the waveform data may be played at a louder volume than the original Material depending on the platform.
If you specify a volume value lower than 0.0f, the value is clipped to 0.0f.
(Even if you set a negative volume value, the phase of the waveform data is not inverted.)

When playing a Cue, if this function is called when the volume is set on the data, the value set on the data and the setting in this function is multiplied and the result is applied.
For example, if the volume on the data is 0.8f and the volume of the AtomExPlayer is 0.5f, the volume actually applied is 0.4f.

If you want to set it in decibel, convert it with the following formula before setting it.

volume = Math.Pow(10.0f, db_vol / 20.0f);

※db_volがデシベル値、volumeがボリューム値です。

Note:

When specifying a volume larger than 1.0f, note the followings:

Behavior may differ depending on the platform.
Clipping sound may be heard.

Even if a volume value exceeding 1.0f is set in this function, whether the sound is played back at a volume higher than the original waveform data depends on the platform and the sound compression codec type.
Therefore, it is recommended that you do not use volume values higher than 1.0f when adjusting volume for multi-platform titles.
(If you specify a volume value higher than 1.0f, the sound may be played back at a different volume depending on the model even if the same waveform data is played back.)

Even on models in which volume can be raised, there is a limit to the volume that can be output by hardware, so noise may occur due to clicking sound.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// ボリュームの設定

player.SetVolume(0.5f);

// 再生の開始

// 備考）ボリュームはプレーヤに設定された値（＝0.5f）で再生される。

CriAtomExPlayback playback = player.Start();

：

// ボリュームの変更

// 注意）この時点では再生中の音声のボリュームは変更されない。

player.SetVolume(0.3f);

// プレーヤに設定されたボリュームを再生中の音声にも反映

player.Update(playback);

：

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll

void SetPitch ( float pitch )

inline

Sets the pitch

Parameters

pitch Pitch (in cents)

Description:: Specifies the pitch of the output sound.
After setting the pitch using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played with the specified pitch.
It is possible to update the pitch of the sound already played by calling the CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll function after setting the pitch.

The pitch is specified in cents.
One cent is 1/1200 of one octave. A semitone is 100 cents.
For example, if you specify 100.0f, the pitch increases by a semitone. If you specify -100.0f, the pitch decreases by a semitone.
The default pitch is 0.0f.

Note:: When playing a Cue, if this function is called when the pitch is set on the data, the value set on the data and the setting in this function is added and the result is applied.
For example, if the pitch on the data is -100.0f and the pitch of the AtomExPlayer is 200.0f, the actual pitch applied is 100.0f.
If you want to set the frequency ratio of the sampling rate, convert it with the following formula before setting it.

pitch = 1200.0 * Math.Log(freq_ratio, 2.0);

※freq_ratioが周波数比率、pitchがピッチの値です。

Note:: The pitch of the sound data encoded for HCA-MX cannot be changed.
(The pitch does not change even if you call this function.)
For the sound whose pitch you want to change, encode it with a different codec such as ADX or HCA.

The maximum pitch that can be set depends on the sampling rate of the sound data and the maximum sampling rate of the Voice Pool.
For example, if the sampling rate of the sound data is 24kHz and the maximum sampling rate of the Voice Pool is 48kHz, the maximum pitch that can be set is 1200(double frequency ratio).

Since the pitch is implemented by increasing or decreasing the playback sampling rate, changing the pitch also changes the playback speed along with the pitch.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// ピッチの設定

player.SetPitch(100.0f);

// 再生の開始

// 備考）ピッチはプレーヤに設定された値（＝100セント）で再生される。

CriAtomExPlayback playback = player.Start();

：

// ピッチの変更

// 注意）この時点では再生中の音声のピッチは変更されない。

player.SetPitch(-200.0f);

// プレーヤに設定されたピッチを再生中の音声にも反映

player.Update(playback);

：

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll

void SetPlaybackRatio ( float ratio )

inline

Sequence playback ratio setting

Parameters

ratio Sequence playback ratio

Description:: Sets the playback ratio of the player's playing sequence.
Playback ratio can be set between 0.0f ~ 2.0f.
If the input value is outside the range, the lower or upper limit will be set.
After specifying playback ratio with this function, start with CriWare.CriAtomExPlayer::Start to play back at the specified ratio. If you want to change the playback ratio during the playback, please call CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll function.

Note:: The value set by this function is applied only when playing a sequence type Cue.
It cannot be used for the playback ratio of waveform data in a sequence.
If you want to change the playback ratio of waveform, use the time stretch function.

See also: CriAtomPlayer::Update, CriAtomPlayer::UpdateAll

void SetPan3dAngle ( float angle )

inline

Sets the Panning 3D angle

Parameters

angle Panning 3D angle (-180.0f to 180.0f: in degrees)

Description:: Specifies the Panning 3D angle.
After setting the Panning 3D angle using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified Panning 3D angle.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can update the Panning 3D angle of the sound already played.

The angle is specified in degrees.
With front being 0 degree, you can set up to 180.0f in the right direction (clockwise) and -180.0f in the left direction (counterclockwise).
For example, if you specify 45.0f, the localization will be 45 degrees to the front right. If you specify -45.0f, the localization will be 45 degree to the front left.

Note:: When playing a Cue, if this function is called when the Panning 3D angle is set on the data, the value set on the data and the setting in this function is added and the result is applied.
For example, if the Panning 3D angle on the data is 15.0f and the Panning 3D angle on the AtomExPlayer is 30.0f, the actual Panning 3D angle applied will be 45.0f.
If the actual applied Panning 3D angle exceeds 180.0f, -360.0f is added to the value so that it is within the range.
Similarly, if the actual applied volume value is less than -180.0f, +360.0f is add so that it is within the range.
(Since the localization does not change even when +360.0f, or -360.0f is added, you can effectively set a value outside the range of -180.0f to 180.0f.)

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// パンニング3D角度の設定

player.SetPan3dAngle(45.0f);

// 再生の開始

// 備考）パンニング3D角度はプレーヤに設定された値（＝45.0f）で再生される。

CriAtomExPlayback playback = player.Start();

：

// パンニング3D角度の変更

// 注意）この時点では再生中の音声のパンニング3D角度は変更されない。

player.SetPan3dAngle(-45.0f);

// プレーヤに設定されたパンニング3D角度を再生中の音声にも反映

player.Update(playback);

：

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll

void SetPan3dInteriorDistance ( float distance )

inline

Sets the Panning 3D distance

Parameters

distance Panning 3D distance (-1.0f to 1.0f)

Description:: Specifies the distance for doing interior Panning in Panning 3D.
After setting the Panning 3D distance using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified Panning 3D distance.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can update the Panning 3D distance of the sound already played.

The distance is specified in the range of -1.0f to 1.0f, with the listener position being 0.0f and the circumference of the speaker position being 1.0f.
If you specify a negative value, the Panning 3D angle inverts 180 degrees and the localization is reversed.

Note:: When playing a Cue, if this function is called when the Panning 3D distance is set on the data, the value set on the data and the setting in this function is multiplied and the result is applied.
For example, if the Panning 3D distance on the data is 0.8f and the Panning 3D distance on the AtomExPlayer is 0.5f, the actual Panning 3D distance applied will be 0.4f.
If the actual applied Panning 3D distance exceeds 1.0f, the value is clipped to 1.0f.
Similarly, if the actual applied Panning 3D distance is smaller than -1.0f, the value is clipped to -1.0f.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// パンニング3D距離の設定

player.SetPan3dInteriorDistance(0.5f);

// 再生の開始

// 備考）パンニング3D距離はプレーヤに設定された値（＝0.5f）で再生される。

CriAtomExPlayback playback = player.Start();

：

// パンニング3D距離の変更

// 注意）この時点では再生中の音声のパンニング3D距離は変更されない。

// 備考）以下の処理はパン3D角度を180度反転するのと等価

player.SetPan3dInteriorDistance(-0.5f);

// プレーヤに設定されたパンニング3D距離を再生中の音声にも反映

player.Update(playback);

：

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll

void SetPan3dVolume ( float volume )

inline

Sets the Panning 3D volume

Parameters

volume Panning 3D volume (0.0f to 1.0f)

Description:: Specifies the volume of the Panning 3D.
After setting the Panning 3D volume using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified Panning 3D volume.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can update the Panning 3D volume of the sound already played.

The Panning 3D volume is used when controlling the Panning 3D component and the output level to the center/LFE separately.
For example, when outputting a sound from LFE using the send level at a fixed volume, and Panning is controlled by Panning 3D.
The range and handling of the value are the same as for normal volume. Refer to the CriWare.CriAtomExPlayer::SetVolume function.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// パンニング3Dボリュームの設定

player.SetPan3dVolume(0.8f);

// 再生の開始

// 備考）パンニング3Dボリュームはプレーヤに設定された値（＝0.5f）で再生される。

CriAtomExPlayback playback = player.Start();

：

// パンニング3Dボリュームの変更

// 注意）この時点では再生中の音声のパンニング3Dボリュームは変更されない。

player.SetPan3dVolume(0.7f);

// プレーヤに設定されたパンニング3Dボリュームを再生中の音声にも反映

player.Update(playback);

：

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll, CriAtomExPlayer::SetVolume

void SetPanType ( CriAtomEx.PanType panType )

inline

Sets the Panning type

Parameters

panType Panning type

Description:: Specifies Panning type.
After setting the Panning type using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified Panning type.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can update the Panning type of the sound already played.

Note:: When playing a Cue, if this function is called, the Panning type set on the data is overridden (the setting on the data is ignored).
Normally, it is not necessary to call this function because the Panning type is set on the data.
To enable 3D Positioning when playing back sound without using an ACB file, set Pos3d using this function.

Note:: An Error will occur if CriAtomEx.PanType.Unknown is specified when executing.

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll, CriAtomEx.PanType

void SetSendLevel	(	int	channel,
		CriAtomEx.Speaker	id,
		float	level
	)

inline

Sets the send level

Parameters

channel	Channel number
id	Speaker ID
level	Send level value (0.0f to 1.0f)

Description:: Specifies the send level.
The send level is a mechanism for specifying which speaker outputs the sound of each channel of the sound data at which volume.
After setting the send level using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified send level.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can update the send level of the sound already played.

The first argument, the channel number, specifies the "channel number of the sound data".
The second argument, the speaker ID, specifies which speaker outputs the data of the specified channel number, and the third argument specifies the level (volume) when sending data.
For example, if you want to output the sound data of channel 0 from the right speaker with full volume (1.0f), specify as follows:
player.SetSendLevel(0, CriAtomEx.Speaker.FrontRight, 1.0f);

センドレベル値の範囲や扱いは、ボリュームと同等です。 CriWare.CriAtomExPlayer::SetVolume 関数を参照してください。

Note:: There are two types of send level settings: "automatic setting" and "manual setting".
Immediately after creating the AtomExPlayer, or when the parameters are cleared using the CriWare.CriAtomExPlayer::ResetParameters function, the send level setting becomes "automatic setting".
But when this function is called, the send level setting becomes "manual setting".
(The user must control the send level to each speaker and perform Panning.)

In the "automatic setting", the AtomExPlayer routes sound as follows:

[When playing mono sound]
The sound from channel 0 is output from the left and right speakers at the volume of about 0.7f (-3dB).

[When playing stereo sound]
The sound from channel 0 is output from the left speaker, and the sound from channel 1 is output from the right speaker.

[When playing 4ch sound]
The sound from channel 0 is output from the left speaker, the sound from channel 1 is output from the right speaker, the sound from channel 2 is output from the surround left speaker, and the sound from channel 3 is output from the surround right speaker.

[When playing 5.1ch sound]
The sound from channel 0 is output from the left speaker, the sound from channel 1 is output from the right speaker, the sound from channel 2 is output from the center speaker, the sound from channel 3 is output from LFE, the sound from channel 4 is output from the surround left speaker, and the sound from channel 5 is output from the surround right speaker.

[When playing 7.1ch sound]
The sound from channel 0 is output from the left speaker, the sound from channel 1 is output from the right speaker, the sound from channel 2 is output from the center speaker, the sound from channel 3 is output from LFE, the sound from channel 4 is output from the surround left speaker, and the sound from channel 5 is output from the surround right speaker.
The sound from channel 6 is output from the surround back left speaker, and the sound from channel 7 is output from the surround back right speaker.

On the other hand, when "manual setting" is selected using this function, the sound is output with the specified send level setting regardless of the number of channels in the sound data.
(It is necessary to switch the send level setting appropriately according to the number of channels in the sound data.)

If you want to clear the send level specified previously and return to the "automatic setting" routing, call the CriWare.CriAtomExPlayer::ResetParameters function.

This parameter cannot be set on the data, so the setting in this function is always applied.

Note:: Sound is not output for channels for which the send level is not set.
For example, if the sound data to be played is stereo, but the send level is set only for one of the channels, the sound of the channel for which the send level is not set is muted.
When controlling the send level, be sure to set the send level for all channels you want to output.

Example:: CriSint32 ch = 0; // channel number 0

CriAtomEx.Speaker spk = CriAtomEx.Speaker.FrontCenter;

CriFloat32 level = 1.0f;

// Set send level(ch0 to center)

player.SetSendLevel(ch, spk, level);

// Start playback

CriAtomExPlayback playback = player.Start();

:

// Change send level

level = 0.7f;

player.SetSendLevel(ch, spk, level);

player.Update(playback);

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll, CriAtomExPlayer::SetVolume

void SetBiquadFilterParameters	(	CriAtomEx.BiquadFilterType	type,
		float	frequency,
		float	gain,
		float	q
	)

inline

Sets the parameters of the Biquad Filter

Parameters

type	Filter type
frequency	Normalized frequency (0.0f to 1.0f)
gain	Gain (decibels)
q	Q value

Description:

Specifies various parameters of the Biquad Filter.
After setting the parameters using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the Biquad Filter is activated using the specified parameters.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can update the Biquad Filter parameters for the sound already played.

The normalized frequency is a value obtained by normalizing 24Hz to 24000Hz on the logarithmic axis to 0.0f to 1.0f.
The gain is specified in decibels.
Gain is valid only when the filter type is either of the following types.

LowShelf : Low shelf filter
HighShelf : High shelf filter
Peaking : Peaking filter .

Note:

- type
Overwrites the value set in the data.

frequency
Added to the value set in the data.
gain
The value set in the data is multiplied.
q
Added to the value set in the data.

If the normalization cutoff frequency which is actually applied exceeds 1.0f, the value is clipped to 1.0f.
Similarly, if the normalization cutoff frequency actually applied is less than 0.0f, the value is clipped to 0.0f.

Note:: The Biquad Filter is not applied to the sound data encoded for HCA-MX.
If you want to use the Biquad Filter for a sound, encode it with a different codec such as ADX or HCA.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// フィルタのパラメータを設定

CriAtomEx.BiquadFilterType type = CriAtomEx.BiquadFilterType.LowPass;

float frequency = 0.5f;

float gain = 1.0f;

float q = 3.0f;

player.SetBiquadFilterParameters(type, frequency, gain, q);

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

// パラメータの変更

// 注意）この時点では再生中の音声のパラメータは変更されない。

frequency = 0.7f;

player.SetBiquadFilterParameters(type, frequency, gain, q);

// プレーヤに設定されたパラメータを再生中の音声にも反映

player.Update(playback);

：

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll

void SetBandpassFilterParameters	(	float	cofLow,
		float	cofHigh
	)

inline

Sets BandPass Filter parameters

Parameters

cofLow	Normalized low frequency cutoff frequency (0.0f to 1.0f)
cofHigh	Normalized high frequency cutoff frequency (0.0f to 1.0f)

Description:: Specifies the cutoff frequency of the BandPass Filter.
After setting the cutoff frequency using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the BandPass Filter is activated using the specified cutoff frequency.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can update the cutoff frequency of the BandPass Filter for the sound already played.

The normalized cutoff frequency is a value obtained by normalizing 24Hz to 24000Hz on the logarithmic axis to 0.0f to 1.0f.
For example, if the normalized low cutoff frequency is specified as 0.0f and the normalized high cutoff frequency as 1.0f, the BandPass Filter will pass the entire range, and the higher the normalized low cutoff frequency, or the lower the normalized high cutoff frequency, the narrower the passband.

Note:

When playing a Cue, if the function is called when the bandpass filter parameter is set on the data, the settings will be as follows.

cofLow
The value set on the data is multiplied after calculating "cofLowRev = 1.0f - cofLow", and the result of calculating "cofLow = 1.0f - cofLowRev" is applied.
In other words, 0.0f is considered as "the filter is opened most to the low frequency side", and the degree of opening is multiplied and applied.
cofHigh
The value set in the data is multiplied and applied.
In other words, 1.0f is considered as "the filter is opened most to the high frequency side", and the degree of opening is multiplied and applied.

If the normalization cutoff frequency which is actually applied exceeds 1.0f, the value is clipped to 1.0f.
Similarly, if the normalization cutoff frequency actually applied is less than 0.0f, the value is clipped to 0.0f.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// フィルタのパラメータを設定

float cof_low = 0.0f;

float cof_high = 0.3f;

player.SetBandpassFilterParameter(cof_low, cof_high);

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

// パラメータの変更

// 注意）この時点では再生中の音声のパラメータは変更されない。

cof_low = 0.7f;

cof_high = 1.0f;

player.SetBandpassFilterParameter(cof_low, cof_high);

// プレーヤに設定されたパラメータを再生中の音声にも反映

player.Update(playback);

：

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll

void SetBusSendLevel	(	string	busName,
		float	level
	)

inline

Sets the Bus Send Level (bus name specified)

Parameters

busName	Bus name
level	Send level value (0.0f to 1.0f)

Description:: Specifies the Bus Send Level.
The Bus Send Level is a mechanism for specifying how much sound should be sent to which bus.
After setting the Bus Send Level using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified Bus Send Level.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can update the Bus Send Level of the sound already played.

The first argument, the bus ID, specifies the "channel number of the sound data".
The third argument specifies the level (volume) when sending.

The range and handling of the send level values are the same as for volume. Refer to CriWare.CriAtomExPlayer::SetVolume function.

Note:: By calling this function multiple times, you can send sound to multiple buses.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// バスセンドレベルを設定

int bus_id = 1; // ex. reverb, etc...

float level = 0.3f;

player.SetBusSendLevel(bus_id, level);

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

// パラメータの変更

// 注意）この時点では再生中の音声のパラメータは変更されない。

level = 0.5f;

player.SetBusSendLevel(bus_id, level);

// プレーヤに設定されたパラメータを再生中の音声にも反映

player.Update(playback);

：

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll, CriAtomExPlayer::SetVolume

bool GetBusSendLevel	(	string	busName,
		out float	level
	)

inline

Obtaining the bus send level (specifying the bus name)

Parameters

busName	Bus name
level	Send level value (0.0f to 1.0f)

Returns: Whether obtained or not (Obtained: TRUE / Unable to obtain: FALSE)

Description:

Gets the specific bus send level set for the player.
In the following cases, the acquisition of the bus send level will fail.

A bus with the specified name does not exist in the current DSP bus configuration.
The send level has not been set for the bus specified by the player.

See also: CriAtomExPlayer::SetBusSendLevel

void SetBusSendLevel	(	int	busId,
		float	level
	)

inline

Deprecated:: This is a deprecated API that will be removed. Please consider using CriAtomExPlayer.SetBusSendLevel(string busName, float level) instead.

void SetBusSendLevelOffset	(	string	busName,
		float	levelOffset
	)

inline

Sets the Bus Send Level by offset (bus name specified)

Parameters

busName	Bus name
levelOffset	Send level value (0.0f to 1.0f)

Description:: Specifies the Bus Send Level as an offset.
When playing a Cue, if this function is called when the Bus Send Level is set on the data, the value set on the data and the setting in this function is added and the result is applied.
Other specifications are the same as the CriWare.CriAtomExPlayer::SetBusSendLevel function.

Note:: By calling the CriWare.CriAtomExPlayer::SetBusSendLevel function with a level of 0.0f and setting an offset value with this function,
it is possible to set an arbitrary value (the offset value) as the send level, ignoring the value specified on the data side. (Overwrite setting)

See also: CriAtomExPlayer::SetBusSendLevel

bool GetBusSendLevelOffset	(	string	busName,
		out float	level
	)

inline

Obtaining the offset of the bus send level (specifying the bus name)

Parameters

busName	Bus name
level	Send level offset value (0.0f to 1.0f)

Returns: Whether obtained or not (Obtained: TRUE / Unable to obtain: FALSE)

Description:

Gets the offset for a particular bus send level set on the player.
In the following cases, the acquisition of the bus send level will fail.

A bus with the specified name does not exist in the current DSP bus configuration.
The send level has not been set for the bus specified by the player.

See also: CriAtomExPlayer::SetBusSendLevelOffset

void SetBusSendLevelOffset	(	int	busId,
		float	levelOffset
	)

inline

Deprecated:: This is a deprecated API that will be removed. Please consider using CriAtomExPlayer.SetBusSendLevelOffset(int busId, float levelOffset) instead.

void AttachAisac ( string globalAisacName )

inline

Attaches AISAC to the player

Parameters

globalAisacName Global AISAC name to attach

Description:: Attaches AISAC to the player. By attaching AISAC, you can get AISAC effect even if you didn't set AISAC for the Cue or the Track.
After the AISAC is attached using this function, when the playback is started using the CriWare.CriAtomExPlayer::Start function , various parameters are applied considering the attached AISAC.
After attachment, by calling the CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll function, you can apply various parameter settings by the attached AISAC to the sound already played.

Note:: Only the global ACF included in the global settings (AISAC file) can be attached.
To get the effect of AISAC , it is necessary to set the appropriate AISAC control value in the same way as the AISAC set for Cues or Tracks.
This parameter is cleared using the CriWare.CriAtomExPlayer::ResetParameters function.

Note:: Even if "an AISAC to change AISAC control value" is set for the Cue or Track, the applied AISAC control value does not affect the AISAC attached to the player. Currently, it does not support the AISAC attachment of control type "Automodulation" or "Random".
Currently, the maximum number of AISACs that can be attached to a player is fixed to 8.

void DetachAisac ( string globalAisacName )

inline

Separates AISAC from the player

Parameters

globalAisacName Global AISAC name to detach

Description:: Detach (separate) AISAC from the player.
After detaching AISAC using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the detached AISAC has no effect.
After detachment, by calling the CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll function, the detached AISAC has no effect on the sound already played.

void SetAisacControl	(	string	controlName,
		float	value
	)

inline

Sets the AISAC control value (specifying the control name)

Parameters

controlName	Control name
value	Control value (0.0f to 1.0f)

Description:: Specifies the AISAC control value by specifying the control name.
Up to eight AISAC control values can be set for one player.
After setting the AISAC control value using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified AISAC control value.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can update the AISAC control value of the sound already played.

The AISAC control value is handled in the same way as in the CriWare.CriAtomExPlayer::SetAisacControl function.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// AISACコントロール値の設定

float control_value = 0.5f;

player.SetAisacControl("Any", control_value);

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

// パラメータの変更

// 注意）この時点では再生中の音声のパラメータは変更されない。

control_value = 0.3f;

player.SetAisacControl("Any", control_value);

// プレーヤに設定されたパラメータを再生中の音声にも反映

player.Update(playback);

：

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll, CriAtomExPlayer::SetAisacControl(uint, float)

void SetAisac	(	string	controlName,
		float	value
	)

inline

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

void SetAisacControl	(	uint	controlId,
		float	value
	)

inline

Sets the AISAC control value (specifying the control ID)

Parameters

controlId	Control ID
value	Control value (0.0f to 1.0f)

Description:: Specifies the AISAC control value by specifying the control ID.
Up to eight AISAC control values can be set for one player.
After setting the AISAC control value using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified AISAC control value.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can update the AISAC control value of the sound already played.

Specify a real value in the range of 0.0f to 1.0f for the AISAC control value.

Note:

The behavior changes as follows depending on the control type of AISAC.

Off
- If the AISAC control value is not set using this function, the AISAC is not activated.
Automatic modulation
- The AISAC control value changes automatically over time without being affected by the setting in this function.
Random
- With the AISAC control value set by this function etc. as the median value, the final AISAC control value is determined by randomizing it with the random width set to the data.
- The randomization is done only by applying parameters when starting playback, and the AISAC control value cannot be changed for the sound being played.
- If the AISAC control value is not set when starting playback, randomization is done using 0.0f as the median value.
.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// AISACコントロール値の設定

CriAtomExAisacControlId control_id = 0;

float control_value = 0.5f;

player.SetAisacControl(control_id, control_value);

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

// パラメータの変更

// 注意）この時点では再生中の音声のパラメータは変更されない。

control_value = 0.3f;

player.SetAisacControl(control_id, control_value);

// プレーヤに設定されたパラメータを再生中の音声にも反映

player.Update(playback);

：

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll, CriAtomExPlayer::SetAisacControl(string, float)

void SetAisac	(	uint	controlId,
		float	value
	)

inline

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

bool GetAttachedAisacInfo	(	int	aisacAttachedIndex,
		out CriAtomEx.AisacInfo	aisacInfo
	)

inline

Gets information on AISAC attached to the player

Parameters

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

Description:: Gets information on AISAC attached to the player.

Note:: Returns False if you specify an invalid index.

void Set3dSource ( CriAtomEx3dSource source )

inline

Sets a 3D sound source object

Parameters

source CriAtomEx3dSource object

Description:: Set the 3D sound source object to realize the 3D Positioning.
By setting the 3D listener object and the 3D sound source object, localization, volume, pitch, etc. are automatically applied based on the positional relationship between the 3D listener object and 3D sound source object.
After setting the 3D sound source object using this function, if you start playback using the CriWare.CriAtomExPlayer::Start function, the 3D sound source object that has been set will be referenced for playback.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can change the 3D sound source object referenced by the already played sound.
If source is set to null, the 3D sound source object already set is cleared.

Note:: To change or update the parameters of the 3D sound source object, use the functions of the 3D sound source object instead of the functions of the AtomExPlayer.
By default, 3D Positioning calculations are done in the left-handed coordinate system.

Example:: ：

// リスナの作成

CriAtomEx3dListener listener = new CriAtomEx3dListener();

// ソースの作成

CriAtomEx3dSource source = new CriAtomEx3dSource();

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

// ソース、リスナをプレーヤに設定

player.Set3dListener(listener);

player.Set3dSource(source);

：

// 音源の位置を初期化

source.SetPosition(0.0f, 0.0f, 0.0f);

source.Update();

：

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

// 音源の位置を変更

source.SetPosition(10.0f, 0.0f, 0.0f);

source.Update();

：

See also: CriAtomEx3dListener, CriAtomExPlayer::Set3dSource, CriAtomExPlayer::Update

void Set3dListener ( CriAtomEx3dListener listener )

inline

Sets the 3D listener object

Parameters

listener 3D listener object

Description:: Sets the 3D listener object for realizing the 3D Positioning.
By setting the 3D listener object and the 3D sound source object, localization, volume, pitch, etc. are automatically applied based on the positional relationship between the 3D listener and 3D sound source.
After setting the 3D listener object using this function, if you start playback using the CriWare.CriAtomExPlayer::Start function, the 3D listener object that has been set will be referenced for playback.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can change the 3D listener object referenced by the already played sound.
If listener is set to null, the 3D listener object already set is cleared.

Note:: To change or update the parameters of the 3D listener object, use the functions of the 3D listener object instead of the functions of the AtomExPlayer.
By default, 3D Positioning calculations are done in the left-handed coordinate system.

Example:: ：

// リスナの作成

CriAtomEx3dListener listener = new CriAtomEx3dListener();

// ソースの作成

CriAtomEx3dSource source = new CriAtomEx3dSource();

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

// ソース、リスナをプレーヤに設定

player.Set3dListener(listener);

player.Set3dSource(source);

：

// 音源の位置を初期化

source.SetPosition(0.0f, 0.0f, 0.0f);

source.Update();

：

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

// リスナの位置を変更

listener.SetPosition(-10.0f, 0.0f, 0.0f);

listener.Update();

：

See also: CriAtomEx3dListener, CriAtomExPlayer::Set3dSource, CriAtomExPlayer::Update

void SetStartTime ( long startTimeMs )

inline

Specifies the playback start position

Parameters

startTimeMs Playback start position (in milliseconds)

Description:: Specifies the position to start playing the sound played by the AtomExPlayer.
If you want to play the sound data from the middle, you need to specify the playback start position using this function before starting playback.

The playback start position is specified in milliseconds.
For example, if you set start_time_ms to 10000 and call this function, the sound data to be played next will be played from the position of 10 seconds.

Note:: When playing a sound from the middle of the data, the play timing delays compared to when playing it from the beginning.
This is because the system must analyze the header of the sound data, jump to the specified position, and rereads the data to start playback.

Note:

A 64bit value can be set for startTimeMs, but currently it is not possible to specify a playback time exceeding 32bit value.

When the Sequence is played back specifying the playback start position, the waveform data placed before the specified position is not played.
(Individual waveforms in the Sequence are not played from the middle.)

void SetFirstBlockIndex ( int index )

inline

Sets the playback start Block (Block index specified)

Parameters

index Block index

Description:: Associates the playback start Block index with the AtomExPlayer.
After specifying the playback start Block index with this function, when the Block Sequence Cue is started using the CriWare.CriAtomExPlayer::Start function, playback starts from the specified Block.

Note:: The default Block index of the AtomExPlayers is 0.
If the Cue set in the player at the start of playback by the CriWare.CriAtomExPlayer::Start function is not a Block sequence, the value set by this function is not used.
If there is no Block corresponding to the specified index, playback starts from the first Block.
At this time, a warning is issued indicating that there is no Block at the specified index.

Note:: Use the CriWare.CriAtomExPlayback::SetNextBlockIndex function to move Block after starting playback, and use the CriWare.CriAtomExPlayback::GetCurrentBlockIndex function to get the Block index during playback.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// 音声データをセット

player.SetCue(acb, 300);

// 開始ブロックをセット

player.SetFirstBlockIndex(1);

// セットされた音声データを再生

player.Start();

：

See also: CriAtomExPlayer::Start, CriAtomExPlayback::SetNextBlockIndex, CriAtomExPlayback::GetCurrentBlockIndex

void SetSelectorLabel	(	string	selector,
		string	label
	)

inline

Sets the selector information

Parameters

selector	Selector name
label	Label name

Description:: Assigns the Selector name and Label name to the player. Up to 8 can be assigned to each player.
If a Cue that has Selector Labels assigned to its tracks is played, only the track that matches the Selector Label specified with this function will be played.
Call CriWare.CriAtomExPlayer::UnsetSelectorLabel to unassign a specific label from the player.
Call CriWare.CriAtomExPlayer::ClearSelectorLabels to unassign all labels.
Call CriWare.CriAtomExPlayer::ResetParameters to remove all the player's settings, including label information.

See also: CriAtomExPlayer::UnsetSelectorLabel, CriAtomExPlayer::ClearSelectorLabels, CriAtomExPlayer::ResetParameters

void UnsetSelectorLabel ( string selector )

inline

Removes the selector information that is set.

Parameters

selector Selector name

Description:: Removes the information related to a selector name from the player, as well as any label names associated with it.
After removal, you can call CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll , to also remove the selector information from voices that are already playing. However, the voices themselves will not stop.

See also: CriAtomExPlayer::SetSelectorLabel, CriAtomExPlayer::ClearSelectorLabels

void ClearSelectorLabels ( )

inline

Deletes all selector information

Description:: Delete all selector name and label name information set in the player.
Also, after deleting, by calling CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll , you can delete the selector information for the sound that is already being played, but the sound does not stop.

See also: CriAtomExPlayer::ResetParameters

void SetCategory ( int categoryId )

inline

Sets the Category (ID specified)

Parameters

categoryId Category ID

Description:: Sets the Category by specifying the Category ID.
To remove the configured Category information, the CriWare.CriAtomExPlayer::UnsetCategory function.

Note:: When playing a Cue, if this function is called, the Category setting set on the data is overridden (the setting on the data is ignored).
The Category information set by this function is cleared when ACF is registered and unregistered.
The default Category is available when ACF is not registered.

Note:: Make the Category settings before starting playback. If you update the Category settings for the sound being played, the playback count of the Category may be incorrect.

See also: CriAtomExPlayer::UnsetCategory, CriAtomExPlayer::SetCategory(string)

void SetCategory ( string categoryName )

inline

Sets Category (Category name specified)

Parameters

categoryName Category name

Description:: Set the Category by specifying the Category name.
To remove the configured Category information, the CriWare.CriAtomExPlayer::UnsetCategory function.

Note:: The basic specification is the same as the CriWare.CriAtomExPlayer::SetCategory(int) function, except that the Category is specified by name.

See also: CriAtomExPlayer::UnsetCategory, CriAtomExPlayer::SetCategory(int)

void UnsetCategory ( )

inline

Removes Category

Description:: Deletes the Category information set in the player handle.

See also: CriAtomExPlayer::SetCategory

void SetCuePriority ( int priority )

inline

Sets the Cue priority

Parameters

priority Cue priority

Description:: Sets the Cue priority to the AtomExPlayer.
After setting the Cue priority using this function, when a sound is played using the CriWare.CriAtomExPlayer::Start function, the sound is played with the Cue priority set in this function.
The default before calling the function is 0.

Note:: When the AtomExPlayer plays a Cue, if the category to which the Cue belongs has already reached its Voice count limit, Voice control is done based on the priority.
Specifically, if the AtomExPlayer's play request has higher priority than that of the Cue being played, the AtomExPlayer stops the Cue being played and starts playing the requested Cue.
(The sound being played is stopped and another sound is played.)
Conversely, if the AtomExPlayer's playback request is lower than the priority of the Cue currently being played, the AtomExPlayer's playback request is rejected.
(The requested Cue will not be played.)
When the playback request of the AtomExPlayer is equal to the priority of the Cue currently being played, the AtomExPlayer controls the Voice with the last-arrival priority.

See also: CriAtomExPlayer::Start, CriAtomExPlayer::ResetParameters

void SetVoicePriority ( int priority )

inline

Sets the Voice Priority

Parameters

priority Voice Priority (-255 to 255)

Description:: Sets the Voice Priority to the AtomExPlayer.
After setting the priority using this function, when a sound is played using the CriWare.CriAtomExPlayer::Start function, the sound is played with the priority set in this function.
In addition, by calling the CriWare.CriAtomExPlayer::Update and CriWare.CriAtomExPlayer::UpdateAll functions after setting, you can update the priority of the sound already played.

For Voice Priority, specify an integer in the range of -255 to 255.
If you set a value outside the range, it will be clipped to fit the range.
The default before calling the function is 0.

Note:

When the AtomExPlayer tries to play waveform data, if the number of Voices in the Voice limit group to which the waveform data belongs has reached the upper limit, or if all the Voices in the Voice Pool are in use, the Voices are controlled based on the priority.
(The Voice Priority is used to determine whether to play the specified waveform data.)

Specifically, if the priority of the waveform data to be played is higher than that of the waveform data currently being played in the Voice, the AtomExPlayer steals the Voice being played and starts playing the requested waveform data.
(The sound being played is stopped and another sound is played.)

Conversely, if the priority of the waveform data to be played is lower than that of the waveform data currently being played in the Voice, the AtomExPlayer does not play the requested waveform data.
(The requested sound is not played, and the sound being played continues to be played.)

If the priority of the waveform data to be played is the same as that of the waveform data currently being played in the Voice, the AtomExPlayer performs the following control according to the Voice control method (first-priority or last-priority).

When in the first-priority mode, the priority is given to the waveform data being played, and the requested waveform data is not played.
When in the last-priority mode, the priority is given to the requested waveform data and the Voice is stolen.

When playing a Cue, if this function is called when the Voice Priority is set on the data, the sum of the value set on the data and the setting in this function is applied.
For example, if the priority of the data is 255 and the priority of the AtomExPlayer is 45, the priority actually applied is 300.
The range of values that can be set using this function is -255 to 255, but since the calculation inside the library is done within the range of int, the result of adding the values on data may exceed the range of -255 to 255.

Note:: This function controls the Voice Priority set in the waveform data.
Note that it does not affect the Category Cue Priority set for the Cue on Atom Craft.

See also: CriAtomExPlayer::Start, CriAtomExPlayer::Update, CriAtomExPlayer::UpdateAll, CriAtomExPlayer::SetVoiceControlMethod

void SetVoiceControlMethod ( CriAtomEx.VoiceControlMethod method )

inline

Specifies the Voice control method

Parameters

method Voice control method

Description:: Sets the Voice control method to the AtomExPlayer.
After setting the Voice control method using this function, when you play a sound using the CriWare.CriAtomExPlayer::Start function, the control method specified by this function is applied to the waveform data played by the player.
The default before calling the function is last-priority ( PreferLast ).

Note:: When the AtomExPlayer tries to play waveform data, if the number of Voices in the Voice limit group to which the waveform data belongs has reached the upper limit, or if all the Voices in the Voice Pool are in use, the Voices are controlled based on the Voice Priority.

The Voice control method set by this function is considered in the Voice control when the priority of the waveform data to be played back is the same as that of the waveform data being played back.
(For details on the Voice control by Voice Priority, see the Description of the CriWare.CriAtomExPlayer::SetVoicePriority function.)

Known defects:: Currently, even if a Voice control method is specified using this function, the Voice control method set on the authoring tool is applied preferentially when playing a Cue.

See also: CriAtomExPlayer::Start, CriAtomExPlayer::SetVoicePriority, CriAtomEx.VoiceControlMethod

void SetPreDelayTime ( float time )

inline

Set the pre-delay time

Parameters

time	Pre-delay time (0.0f to 2000.0f)

Description:: Sets the pre-delay time.
After setting the pre-delay time using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the system waits for the pre-delay time before playback.

For the pre-delay time, specify a real value in the range of 0.0f to 10000.0f. The unit is ms (millisecond).
The default for pre-delay time is 0.0f.

Note:: When playing a Cue, if this function is called when the pre-delay time is set on the data, the value set on the data and the setting in this function is added and the result is applied.

Note:: Pre-delay is not applied to HCA-MX-encoded audio data.
Audio data to which you wish to apply envelopes should be encoded with other codecs such as ADX or HCA.

See also: CriAtomExPlayer::Start

void SetEnvelopeAttackTime ( float time )

inline

Sets the Envelope Attack Time

Parameters

time	Attack time (0.0f to 2000.0f)

Description:: Sets the attack time of the envelope.
After setting the attack time using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified attack time.

For the attack time, specify a real value from 0.0f to 2000.0f. The unit is ms (millisecond).
The default attack time is 0.0f.

Note:: When playing a Cue, if this function is called when the attack time is set on the data, the value set on the data is overridden (the setting on the data is ignored).

Note:: It cannot be updated using CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll function during playback.

The envelope is not applied to the sound data encoded for HCA-MX.
If you want to use the envelope, encode the data using another codec such as ADX or HCA.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// エンベロープの設定

player.SetEnvelopeAttackTime(10.0f);

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

See also: CriAtomExPlayer::Start

void SetEnvelopeHoldTime ( float time )

inline

Sets the envelope hold time

Parameters

time	Hold time (0.0f to 2000.0f)

Description:: Sets the hold time of the envelope.
After setting the hold time using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified hold time.

For the hold time, specify a real value in the range of 0.0f to 2000.0f. The unit is ms (millisecond).
The default hold time is 0.0f.

Note:: When playing a Cue, if this function is called when the hold time is set on the data, the value set on the data is overridden (the setting on the data is ignored).

Note:: It cannot be updated using CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll function during playback.

Envelope is not applied to the sound data encoded for HCA-MX.
If you want to use envelope, encode the data using another codec such as ADX or HCA.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// エンベロープの設定

player.SetEnvelopeHoldTime(player, 20.0f);

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

See also: CriAtomExPlayer::Start

void SetEnvelopeDecayTime ( float time )

inline

Sets the envelope decay time

Parameters

time	Decay time (0.0f to 2000.0f)

Description:: Sets the decay time of the envelope.
After setting the decay time using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified decay time.

For the decay time, specify a real value in the range of 0.0f to 2000.0f. The unit is ms (millisecond).
The default decay time is 0.0f.

Note:: When playing a Cue, if this function is called when the decay time is set on the data, the value set on the data is overridden (the setting on the data is ignored).

Note:: It cannot be updated using CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll function during playback.

Envelope is not applied to the sound data encoded for HCA-MX.
If you want to use envelope, encode the data using another codec such as ADX or HCA.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// エンベロープの設定

player.SetEnvelopeDecayTime(player, 10.0f);

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

See also: CriAtomExPlayer::Start

void SetEnvelopeReleaseTime ( float time )

inline

Sets the envelope release time

Parameters

time	Release time (0.0f to 10000.0f)

Description:: Sets the release time of the envelope.
After setting the release time using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified release time.

For the release time, specify a real value in the range of 0.0f to 10000.0f. The unit is ms (millisecond).
The default release time value is 0.0f.

Note:: When playing a Cue, if this function is called when the release time is set on the data, the value set on the data is overridden (the setting on the data is ignored).

Note:: It cannot be updated using CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll function during playback.

Envelope is not applied to the sound data encoded for HCA-MX.
If you want to use envelope, encode the data using another codec such as ADX or HCA.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// エンベロープの設定

player.SetEnvelopeReleaseTime(player, 3000.0f);

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

See also: CriAtomExPlayer::Start

void SetEnvelopeSustainLevel ( float level )

inline

Sets the envelope sustain level

Parameters

level Sustain level (0.0f to 2000.0f)

Description:: Sets the sustain level of the envelope.
After setting the sustain level using this function, when you start the playback using the CriWare.CriAtomExPlayer::Start function, the sound is played back using the specified sustain level.

Specify a real value in the range of 0.0f to 1.0f for the sustain level.
The default sustain level is 0.0f.

Note:: When playing a Cue, if this function is called when the sustain level is set on the data, the value set on the data is overridden (the setting on the data is ignored).

Note:: It cannot be updated using CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll function during playback.

Envelope is not applied to the sound data encoded for HCA-MX.
If you want to use envelope, encode the data using another codec such as ADX or HCA.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// エンベロープの設定

player.SetEnvelopeSustainLevel(0.5f);

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

See also: CriAtomExPlayer::Start

void AttachFader ( )

inline

Attach a fader to a player

Description:

Attach a fader to a player and turn the CriAtomExPlayer into a player dedicated to crossfade.
(Some functions of conventional CriAtomExPlayer such as simultaneous playback of multiple sounds will not be available.)

The player to which the fader is attached by this function performs the following control every time the sound playback is started (every time the CriWare.CriAtomExPlayer::Start or CriWare.CriAtomExPlayer::Prepare function is called).

Forcibly stops sounds being faded out if any.
Fades out the sound currently being played (or faded in).
Fades in the sound newly started to be played.

The following controls are performed when stopping playback (when the CriWare.CriAtomExPlayer::Stop function is called).

Forcibly stops sounds being faded out if any.
Fades out the sound currently being played (or faded in).

Note:

If the player to attach the fader is playing sounds, all the sounds being played by the player stops when this function is called.

Each time the function CriWare.CriAtomExPlayer::Start or CriWare.CriAtomExPlayer::Stop is called for the player a fader is attached to, the fader does the following control for the sound being played by the player.

If there are any sounds already faded out, it stops it immediately.
If there are any sounds being faded in (or sounds being played), it fades out the sounds from the current volume over the time specified in the CriWare.CriAtomExPlayer::SetFadeOutTime function.
When the CriWare.CriAtomExPlayer::Start function is called, the fader starts playing the sound data set to the player at volume 0, and fades it in over the time specified in the CriWare.CriAtomExPlayer::SetFadeInTime function.

(When the CriWare.CriAtomExPlayer::Prepare function is used instead of the CriWare.CriAtomExPlayer::Start function, the above control is performed when unpaused.)

Note:: When this function is called, the play/stop operation for CriAtomExPlayer changes significantly.
(The behavior changes significantly before/after attaching a fader.)
Specifically, the number of Voices that can be played simultaneously is limited to 1 (2 only during crossfading), and the control using CriWare.CriAtomExPlayback will not be available.

This function is necessary only when you want to perform crossfading.
Use envelope or Tween for Fade-in/out of only one sound.

Due to the operational specifications of the fader, the Fade-in/out process is only applicable to the past two sound playbacks.
Sound played before that is forcibly stopped when the CriWare.CriAtomExPlayer::Start or CriWare.CriAtomExPlayer::Stop function is called.
Unintended noise may occur at the timing of forced stop, so be careful that the number of simultaneous playbacks does not exceed 3 sounds.

Fade-in/out works only for the "operation on the AtomExPlayer".
If you call the CriWare.CriAtomExPlayback::Stop function for the playback ID obtained by calling CriWare.CriAtomExPlayer::Start function, Fade-out is not activated.
(Fader settings are ignored and the playback stops immediately.)

See also: CriAtomExPlayer::DetachFader

void DetachFader ( )

inline

Remove a fader from a player

Description:: Detaches (remove) the fader from the player.
Fade-in/out process is no longer performed on the player whose fader is detached using this function.

Note:: If the player to detach the fader is playing sounds, all the sounds being played by the player stops when this function is called.

See also: CriAtomExPlayer::AttachFader

void SetFadeOutTime ( int ms )

inline

Sets the Fade-out time

Parameters

ms	Fade out time (in milliseconds)

Description:: Specifies the Fade-out time for players with faders attached.
The next time a sound is played back (when the CriWare.CriAtomExPlayer::Start function is called), the sound being played is faded out over the time set in this function.

The default for Fade-out time is 500 milliseconds.

Note:

If the Fade-out time is set, CriAtomExPlayer stops the playback in the following order:

Lowers the volume of the sound to 0 over the specified time.
Continues the playback until delay time elapses with volume set to 0.
Stops the playback after the delay time elapses.

The volume control during Fade-out is performed before the sound playback is stopped.
Therefore, the envelope release time preset in the waveform data is ignored.
(Strictly speaking, the envelope release process is applied after the volume reaches 0.)

The behavior differs in the case where the second argument ( ms ) is set to 0 from the case where it is set to -1 as follows:

When 0 is specified: The volume is immediately lowered to 0 and the sound is stopped.
When -1 is specified: The sound is stopped without changing the volume.

If you want to enable the envelope release process preset in the waveform without performing Fade-out process when stopping playback, specify -1 for the second argument ( ms ).
By specifying -1, volume control by Fade-out process will not be done, so after calling the CriWare.CriAtomExPlayer::Stop function, normal stopping process is done.
(If the envelope release is set to the waveform data, the release process is performed.)

Note:: Before calling this function, you need to attach faders to the player in advance using the CriWare.CriAtomExPlayer::AttachFader function.

The value set by this function does not affect the sounds that being played.
The fade time set by this function is applied when the CriWare.CriAtomExPlayer::Start or CriWare.CriAtomExPlayer::Stop function is called after calling this function.
(For the sound that is being faded out, it is not possible to change Fade-out time afterward using this function.)

See also: CriAtomExPlayer::AttachFader, CriAtomExPlayer::SetFadeInTime

void SetFadeInTime ( int ms )

inline

Sets the Fade-in time

Parameters

ms	Fade-in time (in millisecond)

Description:: Specifies the Fade-in time for players with faders attached.
The next time a sound is played back (when the CriWare.CriAtomExPlayer::Start function is called), it is newly faded in over the time set in this function.

The default for Fade-in time is 0 second.
Therefore, if this function is not used, Fade-in does not occur, and the playback of the sound starts immediately at full volume.

Note:: Before calling this function, you need to attach faders to the player in advance using the CriWare.CriAtomExPlayer::AttachFader function.

The value set by this function does not affect the sounds that being played.
The fade time set by this function is applied when the CriWare.CriAtomExPlayer::Start function is called after calling this function.
(For the sound that is being faded in, it is not possible to change Fade-in time afterward using this function.)

See also: CriAtomExPlayer::AttachFader, CriAtomExPlayer::SetFadeInTime

void SetFadeInStartOffset ( int ms )

inline

Sets the Fade-in start offset

Parameters

ms	Fade-in start offset (in millisecond)

Description:: Specifies the Fade-in start offset for players with faders attached.
By using this function, the timing to start the Fade-in can be advanced or delayed for any time with respect to the Fade-out.
For example, if you set the Fade-out time to 5 seconds and the Fade-in start offset to 5 seconds, you can fade in the next sound immediately after the Fade-out completes in 5 seconds.
Conversely, if you set the Fade-in time to 5 seconds and the Fade-in start offset to -5 seconds, it is possible to start the Fade-out of the sound being played immediately after the Fade-in completes in 5 seconds.

The default Fade-in start offset is 0 second.
(Fade-in and Fade-out start at the same time.)

Note:: The Fade-in starts when the sound to be faded in is ready to be played back.
Therefore, even if the Fade-in start offset is set to 0 second, if it takes time to buffer the Fade-in sound, (such as in stream playback), it may take some time before the Fade-out starts.
(This parameter is a relative value for adjusting the timing of Fade-in and Fade-out.)

Note:: Before calling this function, you need to attach faders to the player in advance using the CriWare.CriAtomExPlayer::AttachFader function.

The value set by this function does not affect the sounds that being played.
The fade time set by this function is applied when the CriWare.CriAtomExPlayer::Start or CriWare.CriAtomExPlayer::Stop function is called after calling this function.
(For a Voice that has already started fading, the fading timing cannot be changed later with this function.)

See also: CriAtomExPlayer::AttachFader, CriAtomExPlayer::SetFadeInTime

void SetFadeOutEndDelay ( int ms )

inline

Sets the delay time after Fade-out

Parameters

ms	Delay time after Fade-out (in milliseconds)

Description:: You can set the delay time before discarding the Voice after the Fade-out completes.
By using this function, you can set the timing when the Voice that was faded out is discarded.

The default delay time is 500 milliseconds.
(The Voices playing a Fade-out sound are discarded 500 milliseconds after the volume is set to 0.)

Note:: It is not necessary to use this function except on platforms where the Voice is stopped before the sound is stopped before finishing Fade-out.

Note:: Before calling this function, you need to attach faders to the player in advance using the CriWare.CriAtomExPlayer::AttachFader function.

The value set by this function does not affect the sounds that are being played.
The fade time set by this function is applied when the CriWare.CriAtomExPlayer::Start or CriWare.CriAtomExPlayer::Stop function is called after calling this function.
(For the sound that is being faded out, it is not possible to change delay time after Fade-out afterward using this function.)

The timing when volume control and Voice stop are reflected depends on the platform.
Therefore, if 0 is specified in this function, the Voice may be stopped before the volume change takes effect depending on the platform.

See also: CriAtomExPlayer::AttachFader

bool IsFading ( )

inline

Gets whether the fading is in process

Returns: Whether the fading is in progress

Description:: Gets whether the fading process is in progress.

Note:

This function returns True during the following processing period.

Waiting for synchronization for starting crossfade.
During Fade-in/Fade-out process (while changing volume).
During the delay period after completing Fade-out.

void ResetFaderParameters ( )

inline

Initializes the fader parameters

Description:: Clears various parameters set in the fader and returns them to the initial values.

Note:: Before calling this function, you need to attach faders to the player in advance using the CriAtomExPlayer::AttachFader function.

Clearing the fader parameter using this function does not affect the sound that is being played.
The fader parameters cleared by this function is applied when the CriAtomExPlayer::Start or CriAtomExPlayer::Stop function is called after calling this function.
(For a Voice that has already started fading, the fader parameters cleared by this function cannot be changed)

void SetGroupNumber ( int group_no )

inline

Specifies the group number

Description:: Specifies from which Voice limit group the Voice is taken when playing.

If group_no is set to -1, the player will not be restricted by the Voice limit group.
(If there are any free Voices or Voices with a lower priority,
the Voice is taken regardless of Voice Limit group.)

Note:: When playback starts and all the Voices in the specified Voice limit group are in use, whether or not the sound is played is determined by the Voice Priority control.
(For details on the Voice control by Voice Priority, see the Description of the CriWare.CriAtomExPlayer::SetVoicePriority function.

When playing a Cue, if this function is called, the Voice limit group setting
set on the data is overridden (the setting on the data is ignored).
However, if -1 is specified for group_no, the Voice limit group set on data is referenced.

void Update ( CriAtomExPlayback playback )

inline

Updates the playback parameters (by CriAtomExPlayback object)

Parameters

playback CriAtomExPlayback object

Description:: Updates the parameters of the CriAtomExPlayback object using the playback parameters set in the AtomExPlayer (including the AISAC control values).

Note:: The CriAtomExPlayer object used for parameter update must be the player that generated the CriAtomExPlayback object.

Example:: ：

// プレーヤの作成

CriAtomExPlayer player = new CriAtomExPlayer();

：

// 再生の開始

CriAtomExPlayback playback = player.Start();

：

// ボリュームの変更

// 注意）この時点では再生中の音声のパラメータは変更されない。

player.SetVolume(volume);

// プレーヤに設定されたパラメータを再生中の音声にも反映

player.Update(playback);

：

See also: CriAtomExPlayer::UpdateAll

void UpdateAll ( )

inline

Updates the playback parameters (for all sounds being played)

Description:: Updates the playback parameters for all sounds being played by this AtomExPlayer using the playback parameters set in the AtomExPlayer (including the AISAC control values).

Example:

： // プレーヤの作成 CriAtomExPlayer player = new CriAtomExPlayer(); ： // 再生の開始 CriAtomExPlayback playback = player.Start(); ： // ボリュームの変更 // 注意）この時点では再生中の音声のパラメータは変更されない。 player.SetVolume(volume);

// プレーヤに設定されたパラメータを再生中の全ての音声に反映 player.UpdateAll(); ：

See also: CriAtomExPlayer::Update

void ResetParameters ( )

inline

Initializes the playback parameters

Description:: Resets the playback parameters (including AISAC control values) set in the AtomExPlayer to the initial state (unset state).
After calling this function, if you start playback using the CriWare.CriAtomExPlayer::Start function, the sound is played using the default playback parameters.

Note:

Even if the CriWare.CriAtomExPlayer::Update or CriWare.CriAtomExPlayer::UpdateAll function is called after calling this function, the parameters of the sound already being played does not return to the initial values.
If you want to change the parameters of the sound that is already being played, call the CriWare.CriAtomExPlayer::SetVolume function explicitly.

The following parameters are reset by this function.

Parameters defined in CriWare.CriAtomEx::Parameter
AISAC control value (set by the CriWare.CriAtomExPlayer::SetAisacControl function)
Cue priority (set by the CriWare.CriAtomExPlayer::SetCuePriority function)
3D sound source handle (set by the CriWare.CriAtomExPlayer::Set3dSource function)
3D listener handle (set by the CriWare.CriAtomExPlayer::Set3dListener function)
Category setting (set by the CriWare.CriAtomExPlayer::SetCategory function)
Playback starting Block (set by the CriWare.CriAtomExPlayer::SetFirstBlockIndex function)

Note that this function does not reset the parameters (position etc.) held by the 3D sound source handle or 3D listener handle itself. It only resets "What handle is set on the AtomExPlayer". If you want to reset the parameters of these handles themselves, call the parameter reset function of each handle.

Example:

： // プレーヤの作成 CriAtomExPlayer player = new CriAtomExPlayer(); ： // ボリュームの変更 player.SetVolume(0.5f);

// 音声を再生 // 備考）ここで再生された音声は0.5fのボリュームで出力される。 CriAtomExPlayback playback1 = player.Start();

// プレーヤに設定されたパラメータをリセット // 備考）プレーヤのボリューム設定がデフォルト値（1.0f）に戻される。 player.ResetParameters();

// 別の音を再生 // 備考）ここで再生された音声は1.0fのボリュームで出力される。 CriAtomExPlayback playback2 = player.Start(); ：

See also: CriAtomEx3dSource::ResetParameters, CriAtomEx3dListener::ResetParameters

long GetTime ( )

inline

Gets the playback time

Returns: Playback time (in milliseconds)

Description:: Gets the playback time of the sound that was played last by the AtomExPlayer.

This function returns a value of 0 or greater if the playback time can be obtained.
This function returns a negative value when the playback time cannot be obtained (when the Voice cannot be obtained).

Note:: When multiple sounds are played in a player and this function is called, this function returns the time of the "last" played sound.
If you need to check the playback time for multiple sounds, create as many players as the number of sounds to play, or use the CriWare.CriAtomExPlayback::GetTime function.

The playback time returned by this function is "the elapsed time from the start of playback".
The time does not rewind depending on the playback position, even during loop playback or seamless linked playback.

When the playback is paused using the CriWare.CriAtomExPlayer::Pause function, the playback time count-up also stops.
(If you unpause the playback, the count-up resumes.)
The accuracy of the time that can be obtained by this function depends on the frequency of the server processing.
(The time is updated for each server process.)
If you need to get more accurate time, use the CriWare.CriAtomExPlayback::GetNumPlayedSamples function instead of this function to get the number of samples played.

Note:: The return type is long, but currently there is no precision over 32bit.
When performing control based on the playback time, it should be noted that the playback time becomes incorrect in about 24 days.
(The playback time overflows and becomes a negative value when it exceeds 2147483647 milliseconds.)

If the sound being played is erased by the Voice control, the playback time count-up also stops at that point.
In addition, if Voice couldn't be allocated by the Voice control at the start of playback, this function does not return the correct time.
(Negative value is returned.)

Even if the sound data supply is temporarily interrupted due to read retry etc. on the drive, the playback time count-up is not interrupted.
(The time progresses even if the playback is stopped due to the stop of data supply.)
Therefore, when synchronizing sound with the source video based on the time acquired by this function, the synchronization may be greatly deviated each time a read retry occurs.
If it is necessary to strictly synchronize the waveform data and video, use the CriWare.CriAtomExPlayback::GetNumPlayedSamples function instead of this function to synchronize with the number of played samples.

See also: CriAtomExPlayback::GetTime, CriAtomExPlayback::GetNumPlayedSamples

Status GetStatus ( )

inline

Gets the status

Returns: Status

Description:

Gets the status of the AtomExPlayer.
The status is one of following 5 values of type CriWare.CriAtomExPlayer::Status indicating the playback status of the AtomExPlayer.

Stop
Prep
Playing
PlayEnd
Error

When you create an AtomExPlayer, the AtomExPlayer's status is Stop.
By calling the CriWare.CriAtomExPlayer::Start function after setting the sound data to be played, the status of the AtomExPlayer changes to ready ( Prep ).
(Prep is the status waiting for the data to be supplied or start of decoding.)
When enough data is supplied for starting playback, the AtomExPlayer changes the status to Playing and starts to output sound.
When all the set data have been played back, the AtomExPlayer changes the status to PlayEnd.
If an error occurs during playback, the AtomExPlayer changes the status to Error.

By checking the status of AtomExPlayer and switching the processing depending on the status, it is possible to create a program linked to the sound playback status.
For example, if you want to wait for the completion of sound playback before proceeding, use the following code.

 ：
// プレーヤの作成
CriAtomExPlayer player = new CriAtomExPlayer();
 ：
// 音声データをセット
player.SetCue(acb, cueId);
// セットされた音声データを再生
player.Start();
// 再生完了待ち
while (player.GetStatus() != CriAtomExPlayer.Status.PlayEnd) {
 yield return null;
}
 :

See also: CriAtomExPlayer::Start

float GetParameterFloat32 ( CriAtomEx.Parameter id )

inline

Gets parameters (floating point numbers)

Parameters

id	Parameter ID

Returns: Parameter setting

Description:: Gets the values of various parameters set in the AtomExPlayer.
The value is obtained as a floating point number.

See also: CriAtomEx.Parameter, CriAtomExPlayer::GetParameterUint32, CriAtomExPlayer::GetParameterSint32

uint GetParameterUint32 ( CriAtomEx.Parameter id )

inline

Gets parameters (unsigned integer)

Parameters

id	Parameter ID

Returns: Parameter setting

Description:: Gets the values of various parameters set in the AtomExPlayer.
The value is obtained as an unsigned integer.

See also: CriAtomEx.Parameter, CriAtomExPlayer::GetParameterFloat32, CriAtomExPlayer::GetParameterSint32

int GetParameterSint32 ( CriAtomEx.Parameter id )

inline

Gets parameters (signed integer)

Parameters

id	Parameter ID

Returns: Parameter setting

Description:: Gets the values of various parameters set in the AtomExPlayer.
The value is obtained as a signed integer.

See also: CriAtomEx.Parameter, CriAtomExPlayer::GetParameterFloat32, CriAtomExPlayer::GetParameterUint32

void SetSoundRendererType ( CriAtomEx.SoundRendererType type )

inline

Sets the output sound renderer type

Parameters

type	Output destination sound renderer type

Description:: Sets the type of sound renderer used to play the AtomExPlayer.
If you start playback after making this setting, a playable Voice is acquired from the Voice Pool created with the specified sound renderer type.
The sound renderer type can be set for each Cue playback unit.

See also: CriAtomEx.SoundRendererType

void SetRandomSeed ( uint seed )

inline

Sets the random number seed

Parameters

seed	Random number seed

Description:: Sets the random number seed in the pseudo random number generator in the AtomExPlayer.
By setting the random number seed, it is possible to add reproducibility to various random playback processes.

See also: CriAtomEx.SetRandomSeed

void Loop ( bool sw )

inline

Switches on/off the loop playback

Parameters

sw	Loop switch (True: loop mode, False: cancel loop mode)

Description:: Switches the loop playback ON/OFF for the waveform data that does not have a loop point.
By default, loop is OFF.
When loop playback is turned ON, the playback does not end at the end of the sound, and the playback is repeated from the beginning.

Note:: The setting in this function is applied to the waveform data.
When this function is called for Sequence data, the individual waveform data in the Sequence data is played back in a loop.

The specification by this function is valid only for waveform data that does not have loop points.
When playing back waveform data with loop points, loop playback is performed according to the loop position of the waveform data regardless of the specification of this function.

This function internally uses the seamless link playback feature.
Therefore, if you use an format that does not support seamless linked playback (such as HCA-MX), some amount of silence is inserted at the loop position.

You can change the loop switch only before starting playback.
You cannot change the loop switch for the player that is playing sound.

void SetAsrRackId ( int asr_rack_id )

inline

Specification of ASR Rack ID

Parameters

asr_rack_id ASR Rack ID

Description:: Specifies the Voice destination ASR Rack ID.

Note:: This function is effective only when ASR is used as the sound renderer type of the Voice.
(When using other Voices, the setting in this function is ignored.)

The ASR Rack ID must be set before starting playback.
The ASR Rack ID cannot be changed later for the sound already being played.

The setting in this function is not applied to the sound data encoded for HCA-MX.

void SetVoicePoolIdentifier ( uint identifier )

inline

Sets the Voice Pool identifier

Parameters

identifier Voice Pool identifier

Description:: Specifies from which Voice Pool the Voice is taken when playing.
When this function is called, the player will get Voices only from the Voice Pool that matches the specified Voice Pool identifier.

See also: CriAtomExStandardVoicePool, CriAtomExWaveVoicePool

void SetDspTimeStretchRatio ( float ratio )

inline

Sets the DSP time stretch ratio

Parameters

ratio Stretch ratio

Description:: Sets the scale factor for the playback time of the DSP time stretch.
The value obtained by multiplying the playback time of the original data by ratio is the playback time of the stretch result.
Acceptable value is between 0.25f to 3.0f.

Note:: The value to be set is not the playback speed but the scale factor for the "playback time".
When specifying the stretch rate by the playback speed, set the reciprocal of the playback speed scale factor.

See also: CriAtomExVoicePool.AttachDspTimeStretch, CriAtomExPlayer.SetVoicePoolIdentifier

void SetDspPitchShifterPitch ( float pitch )

inline

Sets the pitch shift amount of the DSP pitch shifter

Parameters

pitch Pitch shift amount

Description:: Sets the pitch shift amount of the DSP pitch shifter.
The unit is cents.
Acceptable value is between -2400 to 2400.
1200 means 2 times and -1200 means 1/2 times pitch shift compared to the original sound.

See also: CriAtomExVoicePool.AttachDspPitchShifter, CriAtomExPlayer.SetVoicePoolIdentifier

void SetDspParameter	(	int	id,
		float	value
	)

inline

Sets the DSP parameter

Parameters

id	Parameter ID
value	Parameter value

Description:: Sets the parameters of the DSP attached to the Voice.

See also: CriAtomExVoicePool.AttachDspTimeStretch, CriAtomExVoicePool.AttachDspPitchShifter, SetVoicePoolIdentifier

void AttachTween ( CriAtomExTween tween )

inline

Attaches an AtomExTween

Description:: Simple parameter animation is possible by attaching AtomExTween to the player.
If you want to apply the AtomExTween animation to the audio that started playing before the attachment,
You need to call CriAtomExPlayer.Update or CriAtomExPlayer.UpdateAll .

Parameters

tween AtomExTween Object

See also: CriAtomExTween

void DetachTween ( CriAtomExTween tween )

inline

Detaches an AtomExTween

Parameters

tween AtomExTween Object

See also: CriAtomExTween

void DetachTweenAll ( )

inline

Detaches all AtomExTween

See also: CriAtomExTween

void SetEnvelopeAttackCurve	(	CriAtomEx.CurveType	curveType,
		float	strength
	)

inline

Setting the Attack curve of EG

Parameters

curveType	Curve Type
strength	Curve Strength

Description:: Set the envelope's attack curve.
Players whose curve setting is enabled will apply the attack curve.

The curve type should be set to one of the types defined in CriAtomEx.CurveType.
The default curve type is LINEAR.

The strength of the curve should to set to a floating point value between 0.0f and 2.0f.
The default curve strength is 1.0f.

Updating by calling CriAtomExPlayer.Update or CriAtomExPlayer.UpdateAll is not available during playback.

If an attack curve was assigned on the data side and this function is called during Cue playback,
the value set on the data side will be overwritten (i.e. the settings from the data will be ignored).

This parameter can be reset by calling CriAtomExPlayer.ResetParameters.

void SetEnvelopeDecayCurve	(	CriAtomEx.CurveType	curveType,
		float	strength
	)

inline

Setting the Decay curve of EG

Parameters

curveType	Curve Type
strength	Curve Strength

Description:: Set the envelope's decay curve.
Players whose curve setting is enabled will apply the decay curve.

The curve type should be set to one of the types defined in CriAtomEx.CurveType.
The default curve type is LINEAR.

The strength of the curve should to set to a floating point value between 0.0f and 2.0f.
The default curve strength is 1.0f.

Updating by calling CriAtomExPlayer.Update or CriAtomExPlayer.UpdateAll is not available during playback.

If a decay curve was assigned on the data side and this function is called during Cue playback,
the value set on the data side will be overwritten (i.e. the settings from the data will be ignored).

This parameter can be reset by calling CriAtomExPlayer.ResetParameters.

void SetEnvelopeReleaseCurve	(	CriAtomEx.CurveType	curveType,
		float	strength
	)

inline

Setting the Release curve of EG

Parameters

curveType	Curve Type
strength	Curve Strength

Description:: Set the envelope's release curve.
Players whose curve setting is enabled will apply the release curve.

The curve type should be set to one of the types defined in CriAtomEx.CurveType.
The default curve type is LINEAR.

The strength of the curve should to set to a floating point value between 0.0f and 2.0f.
The default curve strength is 1.0f.

Updating by calling CriAtomExPlayer.Update or CriAtomExPlayer.UpdateAll is not available during playback.

If a release curve was assigned on the data side and this function is called during Cue playback,
the value set on the data side will be overwritten (i.e. the settings from the data will be ignored).

This parameter can be reset by calling CriAtomExPlayer.ResetParameters.

void AddOutputPort ( CriAtomExOutputPort outputPort )

inline

Adding the output port object

Parameters

outputPort Output port object

Description:: Add an output port to the player.
The maximum number of output port objects that can be specified is CriWare.CriAtomExPlayer.MaxOutputPorts.

Note:

The parameters can be cleared using the following functions:

It is also possible to remove a specific output port with CriWare.CriAtomExPlayer.RemoveOutputPort.

If this function is called during Cue playback, all of the following settings will be ignored.

ASR Rack ID settings in the Parameter Palette of the data
ASR Rack ID specified with CriWare.CriAtomExPlayer.SetAsrRackId
Output port name of tracks set on the data side

All Cues will then be played through the added output ports.

The output port should be set before starting the playback.
It cannot be changed once audio has already started playing.

If you start a player with multiple output ports specified, Voices will be used independently for each output port.
Therefore, it is necessary to reserve a number of Voices which matches the specified number of output ports in advance.

During playback other than Cue playback (e.g., when using CriWare.CriAtomExPlayer.SetData), only the first of the output ports set by this function will be used.

This function does not apply to audio data encoded with HCA-MX.
When setting the output destination for audio data encoded for HCA-MX, please use CriWare.CriAtomExHcaMx.SetAsrRackId and set the output destination ASR Rack ID of the HCA-MX mixer itself.

Note:: This function is effective only when the Voice's sound renderer type is ASR.
(This function will be ignored for other Voice types.)

See also: CriWare.CriAtomExOutputPort.CriAtomExOutputPort, CriWare.CriAtomExPlayer.RemoveOutputPort, CriWare.CriAtomExPlayer.ClearOutputPorts

void RemoveOutputPort ( CriAtomExOutputPort outputPort )

inline

Removing the output port object

Parameters

outputPort Output port object

Description:: Remove the output port assigned to the player.

Note:: Remove a specific output port object added to the player with CriWare.CriAtomExPlayer.RemoveOutputPort.
Use CriWare.CriAtomExPlayer.ClearOutputPorts to remove all output ports set to the player.

Note:: It is not possible to change the output port once audio has started playing back.

See also: CriWare.CriAtomExOutputPort.CriAtomExOutputPort, CriWare.CriAtomExPlayer.AddOutputPort, CriWare.CriAtomExPlayer.ClearOutputPorts

void ClearOutputPorts ( )

inline

Clearing the output port object

Description:: Clear all the added output port to the players.

Note:: Clear all specific output port objects added to the player with CriWare.CriAtomExPlayer.AddOutputPort.
To remove a specific output port, use CriWare.CriAtomExPlayer.RemoveOutputPort.

Note:: It is not possible to change the output port once audio has started playing back.

See also: CriWare.CriAtomExOutputPort.CriAtomExOutputPort, CriWare.CriAtomExPlayer.AddOutputPort, CriWare.CriAtomExPlayer.RemoveOutputPort

void AddPreferredOutputPort ( CriAtomExOutputPort outputPort )

inline

Adding the preferred output port object

Parameters

outputPort Output port object

Description:: Add an output port to the player, to be used preferably to the output port set in the ACF.
The maximum number of output port objects that can be specified is CriWare.CriAtomExPlayer.MaxOutputPorts.

Note:

This parameter can be reset by calling the following functions:

It is also possible to remove a specific output port with CriWare.CriAtomExPlayer.RemovePreferredOutputPort.

By default, when you play a Cue that has a track with an output port name set, the audio will be output from the port that was automatically generated when the ACF was registered.
By adding a preferred output port to the player with this function, you can change the output to the preferred output port.

Note:: This does not affect playback of tracks that do not have an output port name set in the data.

The output port must be set before the playback starts.
You cannot change the output port for audio that has already started playing.

Preferred output ports with the same name cannot be registered for a player.

During playback processing other than Cue playbacks (such as playbacks using CriWare.CriAtomExPlayer.SetData),
only the first output port specified will be used.

If you call this function after calling CriWare.CriAtomExPlayer.SetAsrRackId,
the ASR Rack ID setting set with CriWare.CriAtomExPlayer.SetAsrRackId will be overwritten.

This function will be ignored for HCA-MX encoded audio data.

See also: CriWare.CriAtomExPlayer.RemovePreferredOutputPort, CriWare.CriAtomExPlayer.ClearPreferredOutputPorts

void RemovePreferredOutputPort ( CriAtomExOutputPort outputPort )

inline

Removing the preferred output port object

Parameters

outputPort Output port object

Description:: Remove the preferred output port assigned to the player.

Note:: Remove a specific preferred output port object added to the player with CriWare.CriAtomExPlayer.AddPreferredOutputPort.
To remove all output ports set on the player, use the CriWare.CriAtomExPlayer.ClearOutputPorts function.

Note:: Removing the preferred output port does not affect any audio that has already started playing.

See also: CriWare.CriAtomExPlayer.AddOutputPort, CriWare.CriAtomExPlayer.ClearPreferredOutputPorts

void RemovePreferredOutputPort ( string name )

inline

Removing the preferred output port object by name

Parameters

name	Output port name

Description:: Remove the preferred output port assigned to the player.

Note:: Remove a specific preferred output port object added to the player with CriWare.CriAtomExPlayer.AddPreferredOutputPort.
To remove all output ports set on the player, use the CriWare.CriAtomExPlayer.ClearOutputPorts function.

Note:: Removing the preferred output port does not affect any audio that has already started playing.

See also: CriWare.CriAtomExPlayer.AddOutputPort, CriWare.CriAtomExPlayer.ClearPreferredOutputPorts

void ClearPreferredOutputPorts ( )

inline

Clearing the preferred output port object

Clear all the preferred output ports that were assigned to a player.

Clear all preferred output port objects added to the player with CriWare.CriAtomExPlayer.AddPreferredOutputPort.
To remove a specific preferred output port, use CriWare.CriAtomExPlayer.RemovePreferredOutputPort.

Removing the preferred output port does not affect any audio that has already started playing.

See also: CriWare.CriAtomExPlayer.AddOutputPort, CriWare.CriAtomExPlayer.RemovePreferredOutputPort

void SetScheduleTime ( System.Int64 scheduleTime )

inline

Schedule playback time

Description:: Specify the timing at which to start the playback via AtomExPlayer.

The timing at which to start the playback is expressed as a number of samples. It can be calculated
based on the total rendering time of the ASR Rack obtained using the CriWare.CriAtomExAsrRack.GetNumRenderedSamples function.
To disable this settings, set scheduleTime to -1.

Note:: Scheduled playback is only possible when using a Voice whose sound renderer type is CriWare.CriAtomEx.SoundRendererType.Asr .
If the specified scheduled playback time has already passed, the sound will be played as soon as possible.
Therefore, we recommend to schedule the start of a playback at least 200 milliseconds ahead of time.
The scheduled playback time can be as far in the future as needed, but the playback resources are allocated when the criAtomExPlayer_Start function is called nonetheless.
Therefore, too many scheduled playbacks may use the resources
for playing back other sounds.
(The playback resources here refer to the voices and virtual voices.)

See also: CriWare.CriAtomExAsrRack.GetNumRenderedSamples

Member Data Documentation

readonly uint MaxOutputPorts = 8

static

Maximum number of output ports that can be specified per player

Description:: The maximum number of output ports that can be specified per player.

See also
CriWare.CriAtomExPlayer.AddOutputPort
See also
CriWare.CriAtomExPlayer.AddPreferredOutputPort

Property Documentation

CriAtomExBeatSync.CbFunc OnBeatSyncCallback

addremove

Registers the Sequence event callback

Description:: Registers a callback function to be executed when the callback marker embedded in a Cue is reached (during playback on the player).
The registered callback function is executed when the application's main thread is updated, immediately after processing the callback event.

CriAtomExSequencer.EventCallback OnSequenceCallback

addremove

Registers the beat synchronization callback

Description:: Register a callback function that receives the beat sync position information embedded in the Cue being played by the player.
The registered callback function is executed when the application's main thread is updated, immediately after processing the callback event.

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

CriAtomExPlayer.cs

Public Types

Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation