GetRadioChannel: Difference between revisions
Jump to navigation
Jump to search
No edit summary Tag: Reverted |
Tag: Rollback |
||
Line 1: | Line 1: | ||
' | __NOTOC__ | ||
{{Client function}} | |||
[ | The function is used to retrieve the ID of the current radio channel. | ||
==Syntax== | |||
<syntaxhighlight lang="lua"> | |||
int getRadioChannel ( ) | |||
</syntaxhighlight> | |||
===Returns=== | |||
Returns the ID of the radio channel. | |||
{{SoundID}} | |||
==Example== | |||
This example prints out the name of your current radio station to the chat box. | |||
<syntaxhighlight lang="lua"> | |||
addCommandHandler ( "getradio", | |||
function () | |||
outputChatBox ( "You're currently listening to " .. getRadioChannelName ( getRadioChannel() ) .. "!" ) | |||
end | |||
) | |||
</syntaxhighlight> | |||
==See Also== | |||
{{Client_audio_functions}} | |||
[[EN:GetRadioChannel]] | |||
[[HU:GetRadioChannel]] | |||
[[AR:getRadioChannel]] | |||
[[RU:GetRadioChannel]] | |||
[[PL:GetRadioChannel]] | |||
[[RO:GetRadioChannel]] | |||
[[PT-BR:GetRadioChannel]] |
Revision as of 16:37, 26 September 2021
The function is used to retrieve the ID of the current 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.
addCommandHandler ( "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