API Reference / Audio / audSetMusicPan

audSetMusicPan

Sets the stereo panning of playing music. Takes music (music handle from audLoadMusic), pan (-1.0 left to 1.0 right). Returns nothing.

Audio

Parameters & Returns

Parameters

music Int
pan Double

Returns

Void

Quick Summary

Sets the stereo panning of playing music. Takes music (music handle from audLoadMusic), pan (-1.0 left to 1.0 right). Returns nothing.

Technical Exegesis...

Sets the music's stereo position, from -1.0 (left) through 0.0 (centre) to 1.0 (right). It takes effect straight away.

The music functions (audStopMusic, audPauseMusic, audResumeMusic, audSetMusicVolume, audSetMusicPan, audMusicPlaying) take the music handle from audLoadMusic and act on that music's latest audPlayMusic or audPlayMusic3D. The channel audPlayMusic returned works too. This is the same on every target.

Example

Example.bam 
audSetMusicPan(music, -0.5)
Since: 1.0 Status: Stable
← Back to Audio