# {py:mod}`simvx.core.audio_errors` ```{py:module} simvx.core.audio_errors ``` ```{autodoc2-docstring} simvx.core.audio_errors :allowtitles: ``` ## Module Contents ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`warn_once ` - ```{autodoc2-docstring} simvx.core.audio_errors.warn_once :summary: ``` * - {py:obj}`raise_or_warn ` - ```{autodoc2-docstring} simvx.core.audio_errors.raise_or_warn :summary: ``` ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`__all__ ` - ```{autodoc2-docstring} simvx.core.audio_errors.__all__ :summary: ``` * - {py:obj}`STRICT ` - ```{autodoc2-docstring} simvx.core.audio_errors.STRICT :summary: ``` ```` ### API ````{py:data} __all__ :canonical: simvx.core.audio_errors.__all__ :value: > ['STRICT', 'AudioError', 'AudioBackendUnavailable', 'UnknownBusError', 'InvalidStreamError', 'AudioC... ```{autodoc2-docstring} simvx.core.audio_errors.__all__ ``` ```` ````{py:data} STRICT :canonical: simvx.core.audio_errors.STRICT :type: bool :value: > None ```{autodoc2-docstring} simvx.core.audio_errors.STRICT ``` ```` ````{py:function} warn_once(key: str, msg: str, *args: object, exc_info: bool = False) -> None :canonical: simvx.core.audio_errors.warn_once ```{autodoc2-docstring} simvx.core.audio_errors.warn_once ``` ```` ````{py:function} raise_or_warn(exc: BaseException, *, key: str, message: str) -> None :canonical: simvx.core.audio_errors.raise_or_warn ```{autodoc2-docstring} simvx.core.audio_errors.raise_or_warn ``` ```` `````{py:exception} AudioError() :canonical: simvx.core.audio_errors.AudioError Bases: {py:obj}`Exception` ```{autodoc2-docstring} simvx.core.audio_errors.AudioError ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} simvx.core.audio_errors.AudioError.__init__ ``` ```{py:class} __cause__ :canonical: simvx.core.audio_errors.AudioError.__cause__ ``` ```{py:class} __context__ :canonical: simvx.core.audio_errors.AudioError.__context__ ``` ````{py:method} __delattr__() :canonical: simvx.core.audio_errors.AudioError.__delattr__ ```` ````{py:method} __dir__() :canonical: simvx.core.audio_errors.AudioError.__dir__ ```` ````{py:method} __eq__() :canonical: simvx.core.audio_errors.AudioError.__eq__ ```` ````{py:method} __format__() :canonical: simvx.core.audio_errors.AudioError.__format__ ```` ````{py:method} __ge__() :canonical: simvx.core.audio_errors.AudioError.__ge__ ```` ````{py:method} __getattribute__() :canonical: simvx.core.audio_errors.AudioError.__getattribute__ ```` ````{py:method} __getstate__() :canonical: simvx.core.audio_errors.AudioError.__getstate__ ```` ````{py:method} __gt__() :canonical: simvx.core.audio_errors.AudioError.__gt__ ```` ````{py:method} __hash__() :canonical: simvx.core.audio_errors.AudioError.__hash__ ```` ````{py:method} __le__() :canonical: simvx.core.audio_errors.AudioError.__le__ ```` ````{py:method} __lt__() :canonical: simvx.core.audio_errors.AudioError.__lt__ ```` ````{py:method} __ne__() :canonical: simvx.core.audio_errors.AudioError.__ne__ ```` ````{py:method} __new__() :canonical: simvx.core.audio_errors.AudioError.__new__ ```` ````{py:method} __reduce__() :canonical: simvx.core.audio_errors.AudioError.__reduce__ ```` ````{py:method} __reduce_ex__() :canonical: simvx.core.audio_errors.AudioError.__reduce_ex__ ```` ````{py:method} __repr__() :canonical: simvx.core.audio_errors.AudioError.__repr__ ```` ````{py:method} __setattr__() :canonical: simvx.core.audio_errors.AudioError.__setattr__ ```` ````{py:method} __setstate__() :canonical: simvx.core.audio_errors.AudioError.__setstate__ ```` ````{py:method} __sizeof__() :canonical: simvx.core.audio_errors.AudioError.__sizeof__ ```` ````{py:method} __str__() :canonical: simvx.core.audio_errors.AudioError.__str__ ```` ````{py:method} __subclasshook__() :canonical: simvx.core.audio_errors.AudioError.__subclasshook__ ```` ```{py:class} __suppress_context__ :canonical: simvx.core.audio_errors.AudioError.__suppress_context__ ``` ```{py:class} __traceback__ :canonical: simvx.core.audio_errors.AudioError.__traceback__ ``` ````{py:method} add_note() :canonical: simvx.core.audio_errors.AudioError.add_note ```` ```{py:class} args :canonical: simvx.core.audio_errors.AudioError.args ``` ````{py:method} with_traceback() :canonical: simvx.core.audio_errors.AudioError.with_traceback ```` ````` `````{py:exception} AudioBackendUnavailable() :canonical: simvx.core.audio_errors.AudioBackendUnavailable Bases: {py:obj}`simvx.core.audio_errors.AudioError` ```{autodoc2-docstring} simvx.core.audio_errors.AudioBackendUnavailable ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} simvx.core.audio_errors.AudioBackendUnavailable.__init__ ``` ```{py:class} __cause__ :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__cause__ ``` ```{py:class} __context__ :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__context__ ``` ````{py:method} __delattr__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__delattr__ ```` ````{py:method} __dir__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__dir__ ```` ````{py:method} __eq__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__eq__ ```` ````{py:method} __format__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__format__ ```` ````{py:method} __ge__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__ge__ ```` ````{py:method} __getattribute__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__getattribute__ ```` ````{py:method} __getstate__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__getstate__ ```` ````{py:method} __gt__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__gt__ ```` ````{py:method} __hash__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__hash__ ```` ````{py:method} __le__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__le__ ```` ````{py:method} __lt__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__lt__ ```` ````{py:method} __ne__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__ne__ ```` ````{py:method} __new__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__new__ ```` ````{py:method} __reduce__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__reduce__ ```` ````{py:method} __reduce_ex__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__reduce_ex__ ```` ````{py:method} __repr__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__repr__ ```` ````{py:method} __setattr__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__setattr__ ```` ````{py:method} __setstate__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__setstate__ ```` ````{py:method} __sizeof__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__sizeof__ ```` ````{py:method} __str__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__str__ ```` ````{py:method} __subclasshook__() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__subclasshook__ ```` ```{py:class} __suppress_context__ :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__suppress_context__ ``` ```{py:class} __traceback__ :canonical: simvx.core.audio_errors.AudioBackendUnavailable.__traceback__ ``` ````{py:method} add_note() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.add_note ```` ```{py:class} args :canonical: simvx.core.audio_errors.AudioBackendUnavailable.args ``` ````{py:method} with_traceback() :canonical: simvx.core.audio_errors.AudioBackendUnavailable.with_traceback ```` ````` `````{py:exception} UnknownBusError(name: str, *, available: list[str]) :canonical: simvx.core.audio_errors.UnknownBusError Bases: {py:obj}`simvx.core.audio_errors.AudioError` ```{autodoc2-docstring} simvx.core.audio_errors.UnknownBusError ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} simvx.core.audio_errors.UnknownBusError.__init__ ``` ```{py:class} __cause__ :canonical: simvx.core.audio_errors.UnknownBusError.__cause__ ``` ```{py:class} __context__ :canonical: simvx.core.audio_errors.UnknownBusError.__context__ ``` ````{py:method} __delattr__() :canonical: simvx.core.audio_errors.UnknownBusError.__delattr__ ```` ````{py:method} __dir__() :canonical: simvx.core.audio_errors.UnknownBusError.__dir__ ```` ````{py:method} __eq__() :canonical: simvx.core.audio_errors.UnknownBusError.__eq__ ```` ````{py:method} __format__() :canonical: simvx.core.audio_errors.UnknownBusError.__format__ ```` ````{py:method} __ge__() :canonical: simvx.core.audio_errors.UnknownBusError.__ge__ ```` ````{py:method} __getattribute__() :canonical: simvx.core.audio_errors.UnknownBusError.__getattribute__ ```` ````{py:method} __getstate__() :canonical: simvx.core.audio_errors.UnknownBusError.__getstate__ ```` ````{py:method} __gt__() :canonical: simvx.core.audio_errors.UnknownBusError.__gt__ ```` ````{py:method} __hash__() :canonical: simvx.core.audio_errors.UnknownBusError.__hash__ ```` ````{py:method} __le__() :canonical: simvx.core.audio_errors.UnknownBusError.__le__ ```` ````{py:method} __lt__() :canonical: simvx.core.audio_errors.UnknownBusError.__lt__ ```` ````{py:method} __ne__() :canonical: simvx.core.audio_errors.UnknownBusError.__ne__ ```` ````{py:method} __new__() :canonical: simvx.core.audio_errors.UnknownBusError.__new__ ```` ````{py:method} __reduce__() :canonical: simvx.core.audio_errors.UnknownBusError.__reduce__ ```` ````{py:method} __reduce_ex__() :canonical: simvx.core.audio_errors.UnknownBusError.__reduce_ex__ ```` ````{py:method} __repr__() :canonical: simvx.core.audio_errors.UnknownBusError.__repr__ ```` ````{py:method} __setattr__() :canonical: simvx.core.audio_errors.UnknownBusError.__setattr__ ```` ````{py:method} __setstate__() :canonical: simvx.core.audio_errors.UnknownBusError.__setstate__ ```` ````{py:method} __sizeof__() :canonical: simvx.core.audio_errors.UnknownBusError.__sizeof__ ```` ````{py:method} __str__() :canonical: simvx.core.audio_errors.UnknownBusError.__str__ ```` ````{py:method} __subclasshook__() :canonical: simvx.core.audio_errors.UnknownBusError.__subclasshook__ ```` ```{py:class} __suppress_context__ :canonical: simvx.core.audio_errors.UnknownBusError.__suppress_context__ ``` ```{py:class} __traceback__ :canonical: simvx.core.audio_errors.UnknownBusError.__traceback__ ``` ````{py:method} add_note() :canonical: simvx.core.audio_errors.UnknownBusError.add_note ```` ```{py:class} args :canonical: simvx.core.audio_errors.UnknownBusError.args ``` ````{py:method} with_traceback() :canonical: simvx.core.audio_errors.UnknownBusError.with_traceback ```` ````` `````{py:exception} InvalidStreamError() :canonical: simvx.core.audio_errors.InvalidStreamError Bases: {py:obj}`simvx.core.audio_errors.AudioError` ```{autodoc2-docstring} simvx.core.audio_errors.InvalidStreamError ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} simvx.core.audio_errors.InvalidStreamError.__init__ ``` ```{py:class} __cause__ :canonical: simvx.core.audio_errors.InvalidStreamError.__cause__ ``` ```{py:class} __context__ :canonical: simvx.core.audio_errors.InvalidStreamError.__context__ ``` ````{py:method} __delattr__() :canonical: simvx.core.audio_errors.InvalidStreamError.__delattr__ ```` ````{py:method} __dir__() :canonical: simvx.core.audio_errors.InvalidStreamError.__dir__ ```` ````{py:method} __eq__() :canonical: simvx.core.audio_errors.InvalidStreamError.__eq__ ```` ````{py:method} __format__() :canonical: simvx.core.audio_errors.InvalidStreamError.__format__ ```` ````{py:method} __ge__() :canonical: simvx.core.audio_errors.InvalidStreamError.__ge__ ```` ````{py:method} __getattribute__() :canonical: simvx.core.audio_errors.InvalidStreamError.__getattribute__ ```` ````{py:method} __getstate__() :canonical: simvx.core.audio_errors.InvalidStreamError.__getstate__ ```` ````{py:method} __gt__() :canonical: simvx.core.audio_errors.InvalidStreamError.__gt__ ```` ````{py:method} __hash__() :canonical: simvx.core.audio_errors.InvalidStreamError.__hash__ ```` ````{py:method} __le__() :canonical: simvx.core.audio_errors.InvalidStreamError.__le__ ```` ````{py:method} __lt__() :canonical: simvx.core.audio_errors.InvalidStreamError.__lt__ ```` ````{py:method} __ne__() :canonical: simvx.core.audio_errors.InvalidStreamError.__ne__ ```` ````{py:method} __new__() :canonical: simvx.core.audio_errors.InvalidStreamError.__new__ ```` ````{py:method} __reduce__() :canonical: simvx.core.audio_errors.InvalidStreamError.__reduce__ ```` ````{py:method} __reduce_ex__() :canonical: simvx.core.audio_errors.InvalidStreamError.__reduce_ex__ ```` ````{py:method} __repr__() :canonical: simvx.core.audio_errors.InvalidStreamError.__repr__ ```` ````{py:method} __setattr__() :canonical: simvx.core.audio_errors.InvalidStreamError.__setattr__ ```` ````{py:method} __setstate__() :canonical: simvx.core.audio_errors.InvalidStreamError.__setstate__ ```` ````{py:method} __sizeof__() :canonical: simvx.core.audio_errors.InvalidStreamError.__sizeof__ ```` ````{py:method} __str__() :canonical: simvx.core.audio_errors.InvalidStreamError.__str__ ```` ````{py:method} __subclasshook__() :canonical: simvx.core.audio_errors.InvalidStreamError.__subclasshook__ ```` ```{py:class} __suppress_context__ :canonical: simvx.core.audio_errors.InvalidStreamError.__suppress_context__ ``` ```{py:class} __traceback__ :canonical: simvx.core.audio_errors.InvalidStreamError.__traceback__ ``` ````{py:method} add_note() :canonical: simvx.core.audio_errors.InvalidStreamError.add_note ```` ```{py:class} args :canonical: simvx.core.audio_errors.InvalidStreamError.args ``` ````{py:method} with_traceback() :canonical: simvx.core.audio_errors.InvalidStreamError.with_traceback ```` ````` `````{py:exception} AudioCapabilityError(capability: str | object, *, backend: str, advertised: set[str] | set[object] | frozenset[object], remediation: str | None = None) :canonical: simvx.core.audio_errors.AudioCapabilityError Bases: {py:obj}`simvx.core.audio_errors.AudioError` ```{autodoc2-docstring} simvx.core.audio_errors.AudioCapabilityError ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} simvx.core.audio_errors.AudioCapabilityError.__init__ ``` ```{py:class} __cause__ :canonical: simvx.core.audio_errors.AudioCapabilityError.__cause__ ``` ```{py:class} __context__ :canonical: simvx.core.audio_errors.AudioCapabilityError.__context__ ``` ````{py:method} __delattr__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__delattr__ ```` ````{py:method} __dir__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__dir__ ```` ````{py:method} __eq__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__eq__ ```` ````{py:method} __format__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__format__ ```` ````{py:method} __ge__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__ge__ ```` ````{py:method} __getattribute__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__getattribute__ ```` ````{py:method} __getstate__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__getstate__ ```` ````{py:method} __gt__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__gt__ ```` ````{py:method} __hash__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__hash__ ```` ````{py:method} __le__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__le__ ```` ````{py:method} __lt__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__lt__ ```` ````{py:method} __ne__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__ne__ ```` ````{py:method} __new__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__new__ ```` ````{py:method} __reduce__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__reduce__ ```` ````{py:method} __reduce_ex__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__reduce_ex__ ```` ````{py:method} __repr__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__repr__ ```` ````{py:method} __setattr__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__setattr__ ```` ````{py:method} __setstate__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__setstate__ ```` ````{py:method} __sizeof__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__sizeof__ ```` ````{py:method} __str__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__str__ ```` ````{py:method} __subclasshook__() :canonical: simvx.core.audio_errors.AudioCapabilityError.__subclasshook__ ```` ```{py:class} __suppress_context__ :canonical: simvx.core.audio_errors.AudioCapabilityError.__suppress_context__ ``` ```{py:class} __traceback__ :canonical: simvx.core.audio_errors.AudioCapabilityError.__traceback__ ``` ````{py:method} add_note() :canonical: simvx.core.audio_errors.AudioCapabilityError.add_note ```` ```{py:class} args :canonical: simvx.core.audio_errors.AudioCapabilityError.args ``` ````{py:method} with_traceback() :canonical: simvx.core.audio_errors.AudioCapabilityError.with_traceback ```` ````` `````{py:exception} AudioMutationDuringPlaybackError(prop_name: str, *, player: str) :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError Bases: {py:obj}`simvx.core.audio_errors.AudioError` ```{autodoc2-docstring} simvx.core.audio_errors.AudioMutationDuringPlaybackError ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} simvx.core.audio_errors.AudioMutationDuringPlaybackError.__init__ ``` ```{py:class} __cause__ :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__cause__ ``` ```{py:class} __context__ :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__context__ ``` ````{py:method} __delattr__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__delattr__ ```` ````{py:method} __dir__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__dir__ ```` ````{py:method} __eq__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__eq__ ```` ````{py:method} __format__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__format__ ```` ````{py:method} __ge__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__ge__ ```` ````{py:method} __getattribute__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__getattribute__ ```` ````{py:method} __getstate__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__getstate__ ```` ````{py:method} __gt__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__gt__ ```` ````{py:method} __hash__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__hash__ ```` ````{py:method} __le__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__le__ ```` ````{py:method} __lt__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__lt__ ```` ````{py:method} __ne__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__ne__ ```` ````{py:method} __new__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__new__ ```` ````{py:method} __reduce__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__reduce__ ```` ````{py:method} __reduce_ex__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__reduce_ex__ ```` ````{py:method} __repr__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__repr__ ```` ````{py:method} __setattr__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__setattr__ ```` ````{py:method} __setstate__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__setstate__ ```` ````{py:method} __sizeof__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__sizeof__ ```` ````{py:method} __str__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__str__ ```` ````{py:method} __subclasshook__() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__subclasshook__ ```` ```{py:class} __suppress_context__ :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__suppress_context__ ``` ```{py:class} __traceback__ :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.__traceback__ ``` ````{py:method} add_note() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.add_note ```` ```{py:class} args :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.args ``` ````{py:method} with_traceback() :canonical: simvx.core.audio_errors.AudioMutationDuringPlaybackError.with_traceback ```` `````