Amend documentation of audio.coreaudio.channel-map

This commit is contained in:
derselbst 2022-04-21 13:22:24 +02:00
parent 486e3f34d7
commit cd0b3ce0c5

View file

@ -457,24 +457,25 @@ Developers:
<type>str</type>
<def>(empty string)</def>
<desc>
This setting is a comma-separated integer list that maps CoreAudio channels
to output device channels. The value of each position in the list, up to the number of
output channels available on your device, is the zero-based index of the fluidsynth
output channel to route there. Additionally, the special value of -1 will turn off
an output.
This setting is a comma-separated integer list that maps fluidsynth mono-channels
to CoreAudio device output channels. Each position in the list represents the output channel
of the CoreAudio device.
The value of each position indicates the zero-based index of the fluidsynth
output mono-channel to route there (i.e. the buffer index used for fluid_synth_process()).
Additionally, the special value of -1 will turn off an output.
<br /><br />
For example, the default map for a single stereo output is "0,1". A value of "0,0" will
copy the left channel to the right, a value of "1,0" will flip left and right, and a
value of "-1,1" will play only the right channel.
<br /><br />
With a six-channel output device, and the synth.audio-channels and synth.audio-groups
settings both set to "2", a channel map of "-1,-1,0,1,2,3" will result in notes from odd
MIDI channels (audible on the first stereo channel, i.e. mono-indices 0,1) being sent to
outputs 3 and 4, and even MIDI channels (audible on the second stereo channel, i.e. mono-indices 2,3)
being sent to outputs 5 and 6.
If the list specifies fewer than the number of available outputs channels, outputs
beyond those specified will maintain the default channel mapping.
<br /><br />
If the list specifies less than the number of available outputs channels, outputs
beyond those specified will maintain the default channel mapping given by the CoreAudio driver.
</desc>
</setting>
<setting>