CreateSound3D

From Onset Developer Wiki
Revision as of 18:50, 14 December 2020 by BlueMountains (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
CreateSound3D

Type: Function
Context: Client
Introduced: v1.0

Description

Plays a local audio file or over http. Also supports playing .pls network streams. Sound is played in 3D world space.

See packages what audio file types are supported.

Syntax

CreateSound3D(SoundFile, x, y, z, radius [, bLooping])

Parameters

  • SoundFile
    The path to the file to play. Or a HTTP network stream or file.
  • x
    Location X coordinate
  • y
    Location Y coordinate
  • z
    Location Z coordinate
  • radius
    The radius to where the sound will be heard from.
  • 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

CreateSound3D("http://us4.internet-radio.com:8258/listen.pls&t=.pls", 0.0, 0.0, 0.0, 1000.0)

See also