CreateSound

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.
CreateSound

Type: Function
Context: Client
Introduced: v1.0

Description

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

See packages what audio file types are supported.

Syntax

CreateSound(SoundFile [, bLooping])

Parameters

  • SoundFile
    The path to the file to play. Or a HTTP network stream or file.
  • bLooping (optional)
    Whether this sound should loop. Default: false.

Return Value

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

Example

-- Load sound from some package
CreateSound("testpackage/sounds/mysound.mp3")

-- Load sound from current package
CreateSound("sounds/mysound.mp3")

-- Play HTTP network stream
CreateSound("http://us4.internet-radio.com:8258/listen.pls&t=.pls")

See also