nw::snd::StreamSoundHandle Classclass StreamSoundHandle
A handle class used to control stream 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 stream sound is not implemented for the general-purpose handle.
If you want to execute a unique process for the stream sound, be sure to use a stream 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 | ||
|---|---|---|
| StreamSoundHandle | Constructor. | |
| ~StreamSoundHandle | Destructor. | |
| Play, Stop, Pause, Resume | ||
| StartPrepared | Plays the sound whose preparation for playback has completed. | |
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. | |
| IsSuspendByLoadingDelay | Checks whether or not streaming has been stopped due to a loading delay. | |
| 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. | |
| Updating Track Parameters | ||
| SetTrackVolume | Changes the volume of streaming sound tracks. | |
| SetTrackPan | Changes the pan (lateral localization) of a streaming sound's tracks. | |
| SetTrackSurroundPan | Changes the surround pan (front-back position) of a track in a stream 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. | |
| ReadStreamDataInfo | Obtains stream data information. | |
| GetPlayLoopCount | Obtains the loop count for the stream data currently playing. | |
| GetPlaySamplePosition | Obtains the playback position for the stream data currently playing. | |
| GetFilledBufferPercentage | Gets the percentage of the stream buffer that has been filled with waveform data. | |
SoundHandle Class
CONFIDENTIAL