Allows you to play external sound files, as well as online radio streams.
You can find a list of all error codes here
For offline file playback, see sound.PlayFile.
Due to a bug with BASS, AAC codec streams cannot be played in 3D mode.
Issue Tracker: #2296
The URL of the sound to play
Flags for the sound. Can be one or more of following, separated by a space (" "):
- 3d - Makes the sound 3D, so you can set its position
- mono - Forces the sound to have only one channel
- noplay - Forces the sound not to play as soon as this function is called
- noblock - Disables streaming in blocks. It is more resource-intensive, but it is required for IGModAudioChannel:SetTime.
If you don't want to use any of the above, you can just leave it as "".
Callback function that is called as soon as the the stream is loaded. It has next arguments:
IGModAudioChannel soundchannel - The sound channel
number errorID - ID of an error, if an error has occured
string errorName - Name of an error, if an error has occured
Example usage of the function.
sound.PlayURL ( "URL", "3d", function( station )
if ( IsValid( station ) ) then
station:SetPos( LocalPlayer():GetPos() )
LocalPlayer():ChatPrint( "Invalid URL!" )