Skip to content

Mixer Store

MixerStore

Bases: Store[TOptions]

Mixer store.

Parameters:

  • store_name (str) –

    Name of the store plugin to instantiate.

  • sources (Iterable[Store], default: tuple() ) –

    Sources to mix.

  • sync_flags (TSyncFlags | None, default: None ) –

    Sync flags.

default_sync_flags property

The default value for :attr:MixerStore.sync_flags.

sources property

The mixed sources.

sync_flags property writable

The sync flags of mixer.

get_default_sync_flags()

Gets the default value for :attr:MixerStore.sync_flags.

Returns:

  • SyncFlags

    Default sync flags.

get_sources()

Gets the mixed underlying sources.

Returns:

  • Collection[Store]

    Mixed sources.

get_sync_flags()

Gets the sync flags of mixer.

Returns:

  • SyncFlags

    Sync flags.

set_sync_flags(sync_flags=None)

Sets the sync flags of mixer.

If sync_flags is None, resets it to the default.

Parameters:

  • sync_flags (TSyncFlags | None, default: None ) –

    Sync flags.