Vizard 8 » Command Index » Vizard objects » mixer » <mixer>.setChannelVolume
8.1

<mixer>.setChannelVolume

Set volume of an individual output channel

<mixer>.setChannelVolume(  
mask  
volume  
)  
mask
A combination of the following channel mask flags:

Mask

Description

viz.CHANNEL_FRONT_LEFT

Front left channel

viz.CHANNEL_FRONT_RIGHT

Front right channel

viz.CHANNEL_FRONT_CENTER

Front center channel

viz.CHANNEL_LOW_FREQUENCY

Low frequency (bass) channel

viz.CHANNEL_BACK_LEFT

Back left channel

viz.CHANNEL_BACK_RIGHT

Back right channel

viz.CHANNEL_FRONT_LEFT_OF_CENTER

Front left of center channel

viz.CHANNEL_FRONT_RIGHT_OF_CENTER

Front right of center channel

viz.CHANNEL_BACK_CENTER

Back center channel

viz.CHANNEL_SIDE_LEFT

Side left channel

viz.CHANNEL_SIDE_RIGHT

Side right channel

viz.CHANNEL_TOP_CENTER

Top center channel

viz.CHANNEL_TOP_FRONT_LEFT

Top front left channel

viz.CHANNEL_TOP_FRONT_CENTER

Top front center channel

viz.CHANNEL_TOP_FRONT_RIGHT

Top front right channel

viz.CHANNEL_TOP_BACK_LEFT

Top back left channel

viz.CHANNEL_TOP_BACK_CENTER

Top back center channel

viz.CHANNEL_TOP_BACK_RIGHT

Top back right channel

viz.CHANNEL_ALL

Alias for all channels

viz.CHANNEL_ALL_LEFT

Alias for all left channels

viz.CHANNEL_ALL_RIGHT

Alias for all right channels

viz.CHANNEL_ALL_FRONT

Alias for all front channels

viz.CHANNEL_ALL_BACK

Alias for all back channels

volume
Volume level, 0-1. A volume level of 1.0 means there is no gain and 0 means silence.

Remarks

This command sets the volume of an individual output channel. The mask specifies which channels to apply the volume to. The mask must be a valid flag that is set in the mixers output channel mask (<mixer>.getChannelMask). The default volume for each channel is 1.

The overall volume level of the mixer is multiplied with the individual channel volumes.

Return Value

None

See also

<mixer>.getChannelCount
<mixer>.getChannelMask
<mixer>.getVolume
<mixer>.getChannelVolume
<mixer>.setVolume