Garry's Mod Wiki

Home / sound.PlayURL

sound.PlayURL

  sound.PlayURL( string url, string flags, function callback )
Search Github

Description

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

Arguments

1 string url
The URL of the sound to play
2 string flags
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 "".

3 function callback
Callback function that is called as soon as the the stream is loaded.
Function argument(s):
1 IGModAudioChannel channel - The sound channel. Will be nil if an error occurred.
2 number errorID - ID of an error if an error has occurred. Will be nil, otherwise.
3 string errorName - Name of an error if an error has occurred. Will be nil, otherwise.

Example

Example usage of the function.

local g_station = nil sound.PlayURL( "https://radio.plaza.one/mp3", "3d", function( station, errCode, errStr ) if ( IsValid( station ) ) then station:SetPos( LocalPlayer():GetPos() ) station:Play() -- Keep a reference to the audio object, so it doesn't get garbage collected which will stop the sound g_station = station else print( "Error playing sound!", errCode, errStr ) end end )

Account Management

Special Pages

Wiki List