class SequenceSoundHandle
A handle class used to control sequence sounds that are played back.
If the sound is bound to the general-purpose sound handle SoundHandle at time of playback, unique processing for the sequence sound is not implemented for the general-purpose handle.
If you want to execute a unique process for the sequence sound, be sure to use a sequence sound handle created using a contructor that takes the general-purpose sound handle as an argument.
Handles are used like the general-purpose sound handle SoundHandle.
| Constructors/Destructors | ||
|---|---|---|
| SequenceSoundHandle | Constructor. | |
| ~SequenceSoundHandle | Destructor. | |
| Play, Stop, Pause, Resume | ||
| StartPrepared | Waits for playback preparations to complete, and plays the sound. | |
Stop
|
Stops the sound. | |
| Pause | Pauses or restarts a sound. | |
| IsPrepared | Checks whether preparation for sound playback is complete. | |
| IsPause | Checks whether the sound is currently paused. | |
| FadeIn | Fades in the sound when playback starts. | |
| Updating Parameters | ||
| SetVolume | Changes the volume of the sound. | |
| SetPitch | Changes the pitch of the sound. | |
| SetPan | Changes the pan (right/left location) of the sound. | |
| SetPlayerPriority | Changes the player priority. | |
| SetMainSend | Changes the main send volume of the sound. | |
| SetFxSend | Changes the effect send volume of the sound. | |
| SetChannelPriority | Changes the voicing priority. | |
| SetTempoRatio | Changes the ratio of the tempo of the sequence sound. | |
| Sequence Variables | ||
| ReadVariable | Reads sequence local variables. | |
| ReadTrackVariable | Reads sequence command track variables. | |
| WriteVariable | Writes the sequence local variable. | |
| WriteTrackVariable | Writes the sequence track variable. | |
| S | ReadGlobalVariable | Reads sequence global variables. |
| S | WriteGlobalVariable | Writes the sequence global variable. |
| track parameter settings | ||
| SetTrackMute | Mutes sequence sound tracks. Or cancels mute. | |
| SetTrackSilence | Places a sequence sound track in silent status, or cancels silent status. | |
| SetTrackVolume | Changes the volume of a track in a sequence sound. | |
| SetTrackPitch | Changes the track pitch of the sequence sound. | |
| SetTrackPan | Changes the sequence sound's track pan (lateral localization). | |
| SetTrackBankIndex | Changes the track bank of the sequence sound. | |
| Handle Operations | ||
| IsAttachedSound | Checks whether there is a sound associated with the handle. | |
| DetachSound | Frees sounds from handles. | |
| Get/Set Information | ||
| SetId | Sets the ID of a sound. | |
GetId
|
Gets the sound's ID. | |
| GetTick | Obtains the number of ticks since playback started. | |
SoundHandle Class
CONFIDENTIAL