PlaybackContextDesc

class carb.audio.PlaybackContextDesc

Bases: pybind11_object

Descriptor used to indicate the options passed to the createContext() function. This determines the how the context will behave.

Methods

__init__(self)

Attributes

flags	Flags to indicate some additional behavior of the context.
max_buses	The maximum number of data buses to process simultaneously.
output	Descriptor for the output to choose for the new audio context.
output_display_name	A name to use for any audio device connection that requires one.

__init__(

self: carb.audio._audio.PlaybackContextDesc,

) → None

property flags

Flags to indicate some additional behavior of the context. This may be a set of zero or more of the `CONTEXT_FLAG_*` flags.

property max_buses

The maximum number of data buses to process simultaneously. This is equivalent to the maximum number of potentially audible sounds that could possibly affect the output on the speakers. If more voices than this are active, the quietest or furthest voice will be deactivated. The default value for this is 64. Set this to 0 to use the default for the platform.

For a baking context, this should be set to a value that is large enough to guarantee that no voices will become virtualized. If a voice becomes virtualized in a baking context and it is set to simulate that voice’s current position, the resulting position when it becomes a real voice again is unlikely to match the expected position. This is because there is no fixed time base to simulate the voice on. The voice will be simulated as if it were playing in real time.

property output

Descriptor for the output to choose for the new audio context. This must specify at least one output target.

property output_display_name

A name to use for any audio device connection that requires one. This can be set to `None` to use a generic default name if necessary. This is useful in situations where a platform, such as Pulse Audio, will display a name to the user for each individual audio connection.