GetRadioChannel: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This function retrieves the ID of the currently active radio channel. | |||
== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int getRadioChannel ( ) | int getRadioChannel ( ) | ||
| Line 9: | Line 9: | ||
===Returns=== | ===Returns=== | ||
Returns the ID of the radio channel. | |||
{{SoundID}} | {{SoundID}} | ||
==Example== | ==Example== | ||
This example prints out the name of your current radio station to the chat box. | |||
<section name="Client" class="client" show="true"> | <section name="Client" class="client" show="true"> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addCommandHandler ( "getradio", | addCommandHandler ( "getradio", | ||
function () | function () | ||
outputChatBox ( "You | outputChatBox ( "You're currently listening to " .. getRadioChannelName ( getRadioChannel() ) .. "!" ) | ||
end | end | ||
) | ) | ||
Revision as of 06:45, 24 May 2013
This function retrieves the ID of the currently active radio channel.
Syntax
int getRadioChannel ( )
Returns
Returns the ID of the radio channel.
- 0: Radio Off
- 1: Playback FM
- 2: K-Rose
- 3: K-DST
- 4: Bounce FM
- 5: SF-UR
- 6: Radio Los Santos
- 7: Radio X
- 8: CSR 103.9
- 9: K-Jah West
- 10: Master Sounds 98.3
- 11: WCTR
- 12: User Track Player
Example
This example prints out the name of your current radio station to the chat box.
Click to collapse [-]
ClientaddCommandHandler ( "getradio",
function ()
outputChatBox ( "You're currently listening to " .. getRadioChannelName ( getRadioChannel() ) .. "!" )
end
)
See Also
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd