audio.createSound: Difference between revisions

From GTA Connected
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
Line 1: Line 1:
{{ScriptItem
{{ScriptItem2
|endpoint = client
|name = audio.createSound
|side = client
|type = function
|type = function
|name = audio.createSound
|games = iii vc sa iv
|usage = add a sound that optionally loops
|desc = add a sound that optionally loops
|parameters = Stream audioData, bool loop
|arg1 = Stream audioData The stream of audio data.
|parameter1 = Stream audioData The stream of audio data.
|arg2 = bool loop Whether to play the sound repeatedly.
|parameter2 = bool loop Whether to play the sound repeatedly.
|return = Sound a sound object
|returnTypes = Sound
|freturn = void
|returnInfo = a sound object
|returnFail1 = void
}}
}}

Latest revision as of 20:36, 19 November 2022

Function Client Only icon-iii.png icon-vc.png icon-sa.png icon-iv.png Online and Offline

Available since Client 1.0.0

Sound audio.createSound(Stream audioData, bool loop)

The audio.createSound function is used to add a sound that optionally loops.

Parameters

1) Stream audioData The stream of audio data.
2) bool loop Whether to play the sound repeatedly.

Return

Sound A sound object.

Notes

There aren't any notes for this function.

Examples

There aren't any examples for this function.

Compatibility

There isn't any compatibility information for this function.