Difference between revisions of "SetSoundVolume"

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetSoundVolume(sound, volume)}} {{FuncParameters}} {{FuncParam|sound|__EDIT_ME__}} {{FuncParam|vol...")
 
 
Line 1: Line 1:
 
{{Info|Function|Client|1.0}}
 
{{Info|Function|Client|1.0}}
  
{{FuncDescription|__EDIT_ME__}}
+
{{FuncDescription|Set the specified sound's volume.}}
  
 
{{FuncSyntax|SetSoundVolume(sound, volume)}}
 
{{FuncSyntax|SetSoundVolume(sound, volume)}}
  
 
{{FuncParameters}}
 
{{FuncParameters}}
{{FuncParam|sound|__EDIT_ME__}}
+
{{FuncParam|sound|The location of the audio file that you want to stream or the .pls audio stream link.}}
{{FuncParam|volume|__EDIT_ME__}}
+
{{FuncParam|volume|A float modifier between 0 to 2, where 1 is 100% volume and 2 is the 200% volume.}}
  
 
{{FuncReturnValue|__EDIT_ME__}}
 
{{FuncReturnValue|__EDIT_ME__}}

Latest revision as of 15:26, 10 November 2019

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

  • __EDIT_ME__

Example

__EDIT_ME__

See also

__EDIT_ME__