CreateSound: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 8: Line 8:
{{FuncParam|SoundFile|The path to the file to play. Or a HTTP network stream or file.}}
{{FuncParam|SoundFile|The path to the file to play. Or a HTTP network stream or file.}}


{{FuncReturnValue|Returns '''true''' on success.}}
{{FuncReturnValue|Returns the sound identifier. Returns '''false''' on error. Once the playback has finished the sound identifier will be destroyed automatically.}}


== Example ==
== Example ==

Revision as of 11:37, 23 October 2019

CreateSound

Type: Function
Context: Client
Introduced: v1.0

Description

Plays a local audio file or over http. Also supports playing .pls network streams.

Syntax

CreateSound(SoundFile)

Parameters

  • SoundFile
    The path to the file to play. Or a HTTP network stream or file.

Return Value

  • Returns the sound identifier. Returns false on error. Once the playback has finished the sound identifier will be destroyed automatically.

Example

__EDIT_ME__

See also

__EDIT_ME__