CreateSound: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Plays a local audio file or over http. Also supports playing .pls network streams.}}


{{FuncSyntax|CreateSound(SoundFile)}}
{{FuncSyntax|CreateSound(SoundFile)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|SoundFile |__EDIT_ME__}}
{{FuncParam|SoundFile|The path to the file to play. Or a HTTP network stream or file.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==

Revision as of 11:35, 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 true on success.

Example

__EDIT_ME__

See also

__EDIT_ME__