CriAtomExSoundObject Class Reference

AtomEx sound object More...

Inherits CriDisposable.

Public Member Functions
	CriAtomExSoundObject (bool enableVoiceLimitScope, bool enableCategoryCueLimitScope)
	Creates a sound object More...
override void	Dispose ()
	Discards a sound object More...
void	AddPlayer (CriAtomExPlayer player)
	Adds an AtomExPlayer More...
void	DeletePlayer (CriAtomExPlayer player)
	Removes an AtomExPlayer More...
void	DeleteAllPlayers ()
	Removes all AtomExPlayers More...

Detailed Description

AtomEx sound object

Description:

A sound object class.
You can control sounds in a batch for the registered players by associating with "object", "space", "situation" etc. in the application.

Constructor & Destructor Documentation

CriAtomExSoundObject ( bool  enableVoiceLimitScope, bool  enableCategoryCueLimitScope  )

inline

Creates a sound object

Parameters

enableVoiceLimitScope	Whether to activate the Voice limit scope
enableCategoryCueLimitScope	Whether to enable the Category Cue limit scope

Returns

Sound object

Description:

Creates a sound object.
If enableVoiceLimitScope is set to True, the Voice count is controlled by the Voice limit group by counting the number of Voices for the sound played back from the Ex player associated with this sound object only inside this sound object.
If enableCategoryCueLimit is set to True, the playback count is controlled by counting the number of Category playbacks for the Cue played back from the Ex player associated with this sound object only inside this sound object.

See also

CriAtomExSoundObject::Dispose

Member Function Documentation

override void Dispose ( )

inline

Discards a sound object

Description:

Discards a sound object.
When this function is called, all the resources allocated in the DLL when creating the sound object are released.

See also

CriAtomExSoundObject::CriAtomExSoundObject

void AddPlayer ( CriAtomExPlayer  player )

inline

Adds an AtomExPlayer

Parameters

player

AtomExPlayer

Description:

Adds an AtomExPlayer to the sound object.
The added AtomExPlayer is associated with the sound object and will be affected by the sound object as follows:

• Limitation on the number of Voices and the range affected by the event function (scope)
  
• Playback control (Stop, Pause etc.)
  
• Parameter control
  If you want to delete the added AtomExPlayer from the sound object, call the CriAtomExSoundObject::DeletePlayer function.
  

Note:

Call this function when the AtomExPlayer you are trying to add is not playing sound.
If an AtomExPlayer that is playing sound is specified, playback is stopped when adding.

See also

CriAtomExSoundObject::DeletePlayer, CriAtomExSoundObject::DeleteAllPlayers, CriAtomExPlayer::nativeHandle

void DeletePlayer ( CriAtomExPlayer  player )

inline

Removes an AtomExPlayer

Parameters

player

Native handle of the AtomExPlayer

Description:

Removes the AtomExPlayer from the sound object.
The removed AtomExPlayer is no longer associated with the sound object and is no longer affected by the sound object.

Note:

Call this function when the AtomExPlayer you are trying to delete is not playing sound.
If an AtomExPlayer that is playing sound is specified, playback is stopped when deleting.

See also

CriAtomExSoundObject::AddPlayer, CriAtomExSoundObject::DeleteAllPlayers, CriAtomExPlayer::nativeHandle

void DeleteAllPlayers ( )

inline

Removes all AtomExPlayers

Description:

Removes all the AtomExPlayers associated with the sound object.
The removed AtomExPlayer is no longer associated with the sound object and is no longer affected by the sound object.

Note:

Call this function when the AtomExPlayer you are trying to delete is not playing sound.
If an AtomExPlayer that is playing sound is specified, playback is stopped when deleting.

See also

CriAtomExSoundObject::AddPlayer, CriAtomExSoundObject::DeletePlayer

---

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

• CriAtomExSoundObject.cs