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

<mixer>.getChannelMask

Get mask of output channels

<mixer>.getChannelMask()  

Remarks

This command returns the mask of channels output by the device. The mask indicates the type of speaker represented by each channel. See below for a list of all channel mask values.

Return Value

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

See also

<mixer>.getChannelCount
<mixer>.getChannelVolume
<mixer>.setChannelVolume