SetSoundPan

This function is used to change the pan level of the specified sound element.

Syntax

bool setSoundPan ( element theSound, float pan )

OOP Syntax Help! I don't understand this!

Method: sound:setPan(...)

Variable: .pan

Counterpart: getSoundPan

Required Arguments

• theSound: The sound element which pan you want to modify.
• pan: A floating point number representing the desired pan level. Range is from -1.0 (left) to 1.0 (right)

Returns

Returns true if the sound element pan was successfully changed, false otherwise.

Example

Click to collapse [-]

Client

function playMusic ()
        local left = playSFX("genrl", 75, 6, true)    -- Play loading theme music
        local right = playSFX("genrl", 75, 7, true)
        setSoundPan(left, -1)                         -- switch the first music to left channel
        setSoundPan(right, 1)                         -- switch the second music to right channel
end

addCommandHandler("music", playMusic)                 -- add the command handler

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