SetSoundVolume

From Onset Developer Wiki
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
SetSoundVolume

Type: Function
Context: Client
Introduced: v1.0

Description

Set the specified sound's volume.

Syntax

SetSoundVolume(sound, volume)

Parameters

  • sound
    The location of the audio file that you want to stream or the .pls audio stream link.
  • volume
    A float modifier between 0 to 2, where 1 is 100% volume and 2 is the 200% volume.

Return Value

  • Returns true on success.

Example

local soundId = CreateSound("link")
SetSoundVolume(soundId, 1.0)

See also