VoiceParamBalance

class carb.audio.VoiceParamBalance

Bases: pybind11_object

Non-spatial sound positioning parameters. These provide pan and fade values for the voice to give the impression that the sound is located closer to one of the quadrants of the acoustic space versus the others. These values are ignored for spatial sounds.

Methods

__init__(self)

Attributes

fade	Sets the non-spatial fade value for a voice.
pan	Sets the non-spatial panning value for a voice.

__init__(

self: carb.audio._audio.VoiceParamBalance,

) → None

property fade

Sets the non-spatial fade value for a voice. This value is valid when the `VOICE_PARAM_BALANCE` flag is used. This is 0.0 to have the sound ‘centered’ in all speakers. This is -1.0 to have the sound balanced to the back side. This is 1.0 to have the sound balanced to the front side. The way the sound is balanced depends on the number of channels. For example, a mono sound will be balanced between the front and back speakers according to the fade value, but a 5.1 sound will just have the front or back channels’ volumes turned down according to the fade value. This value is ignored for spatial sounds. The default value is 0.0.

Note that using fade on non-spatial sounds should only be used for mono or stereo sounds. When it is applied to sounds with more channels, the results are often undefined or may sound odd.

property pan

Sets the non-spatial panning value for a voice. This value is valid when the `VOICE_PARAM_BALANCE` flag is used. This is 0.0 to have the sound ‘centered’ in all speakers. This is -1.0 to have the sound balanced to the left side. This is 1.0 to have the sound balanced to the right side. The way the sound is balanced depends on the number of channels. For example, a mono sound will be balanced between the left and right sides according to the panning value, but a stereo sound will just have the left or right channels’ volumes turned down according to the panning value. This value is ignored for spatial sounds. The default value is 0.0.

Note that panning on non-spatial sounds should only be used for mono or stereo sounds. When it is applied to sounds with more channels, the results are often undefined or may sound odd.