Skip to content


YaSoundHandle created with YaSoundAPI, represents an interface responsible for controlling and managing the sound.


number Volume

Returns the volume of the sound. It's 1 by default.

YaSoundSetting SoundSetting

Returns properties of the sound.

Ya3DSoundPositionData SoundPosInfo

Returns the position of the 3D sound.

boolean IsPlaying

Returns true if the sound is being played.


boolean IsValid()

Returnswhether it is valid or not
Checks if the SoundHandle is still valid. True if it's valid, or false if it's invalid. When the SoundHandle becomes invalid, it can no longer control the current sound.

void Stop()

Stops playing the sound.

boolean Play()

Returnstrue if the playback is successful
Starts playing the sound.