---
orphan: true
---

# {py:mod}`simvx.core._audio_decoder`

```{py:module} simvx.core._audio_decoder
```

```{autodoc2-docstring} simvx.core._audio_decoder
:allowtitles:
```

## Module Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`decoder_available <simvx.core._audio_decoder.decoder_available>`
  - ```{autodoc2-docstring} simvx.core._audio_decoder.decoder_available
    :summary:
    ```
* - {py:obj}`decode_file <simvx.core._audio_decoder.decode_file>`
  - ```{autodoc2-docstring} simvx.core._audio_decoder.decode_file
    :summary:
    ```
* - {py:obj}`stream_file <simvx.core._audio_decoder.stream_file>`
  - ```{autodoc2-docstring} simvx.core._audio_decoder.stream_file
    :summary:
    ```
* - {py:obj}`has_duration_probe <simvx.core._audio_decoder.has_duration_probe>`
  - ```{autodoc2-docstring} simvx.core._audio_decoder.has_duration_probe
    :summary:
    ```
* - {py:obj}`file_duration <simvx.core._audio_decoder.file_duration>`
  - ```{autodoc2-docstring} simvx.core._audio_decoder.file_duration
    :summary:
    ```
* - {py:obj}`playback_device <simvx.core._audio_decoder.playback_device>`
  - ```{autodoc2-docstring} simvx.core._audio_decoder.playback_device
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <simvx.core._audio_decoder.__all__>`
  - ```{autodoc2-docstring} simvx.core._audio_decoder.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core._audio_decoder.__all__
:value: >
   ['DecodeFailedError', 'DecoderUnavailableError', 'decode_file', 'decoder_available', 'file_duration'...

```{autodoc2-docstring} simvx.core._audio_decoder.__all__
```

````

`````{py:exception} DecoderUnavailableError()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError

Bases: {py:obj}`RuntimeError`

```{autodoc2-docstring} simvx.core._audio_decoder.DecoderUnavailableError
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core._audio_decoder.DecoderUnavailableError.__init__
```

```{py:class} __cause__
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__cause__

```

```{py:class} __context__
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__context__

```

````{py:method} __delattr__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__dir__

````

````{py:method} __eq__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__eq__

````

````{py:method} __format__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__format__

````

````{py:method} __ge__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__getattribute__

````

````{py:method} __getstate__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__gt__

````

````{py:method} __hash__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__hash__

````

````{py:method} __le__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__le__

````

````{py:method} __lt__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__lt__

````

````{py:method} __ne__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__ne__

````

````{py:method} __new__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__new__

````

````{py:method} __reduce__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__repr__

````

````{py:method} __setattr__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__setattr__

````

````{py:method} __setstate__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__setstate__

````

````{py:method} __sizeof__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__str__

````

````{py:method} __subclasshook__()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__subclasshook__

````

```{py:class} __suppress_context__
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__suppress_context__

```

```{py:class} __traceback__
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.__traceback__

```

````{py:method} add_note()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.add_note

````

```{py:class} args
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.args

```

````{py:method} with_traceback()
:canonical: simvx.core._audio_decoder.DecoderUnavailableError.with_traceback

````

`````

`````{py:exception} DecodeFailedError()
:canonical: simvx.core._audio_decoder.DecodeFailedError

Bases: {py:obj}`RuntimeError`

```{autodoc2-docstring} simvx.core._audio_decoder.DecodeFailedError
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core._audio_decoder.DecodeFailedError.__init__
```

```{py:class} __cause__
:canonical: simvx.core._audio_decoder.DecodeFailedError.__cause__

```

```{py:class} __context__
:canonical: simvx.core._audio_decoder.DecodeFailedError.__context__

```

````{py:method} __delattr__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__dir__

````

````{py:method} __eq__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__eq__

````

````{py:method} __format__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__format__

````

````{py:method} __ge__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__getattribute__

````

````{py:method} __getstate__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__gt__

````

````{py:method} __hash__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__hash__

````

````{py:method} __le__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__le__

````

````{py:method} __lt__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__lt__

````

````{py:method} __ne__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__ne__

````

````{py:method} __new__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__new__

````

````{py:method} __reduce__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__repr__

````

````{py:method} __setattr__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__setattr__

````

````{py:method} __setstate__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__setstate__

````

````{py:method} __sizeof__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__str__

````

````{py:method} __subclasshook__()
:canonical: simvx.core._audio_decoder.DecodeFailedError.__subclasshook__

````

```{py:class} __suppress_context__
:canonical: simvx.core._audio_decoder.DecodeFailedError.__suppress_context__

```

```{py:class} __traceback__
:canonical: simvx.core._audio_decoder.DecodeFailedError.__traceback__

```

````{py:method} add_note()
:canonical: simvx.core._audio_decoder.DecodeFailedError.add_note

````

```{py:class} args
:canonical: simvx.core._audio_decoder.DecodeFailedError.args

```

````{py:method} with_traceback()
:canonical: simvx.core._audio_decoder.DecodeFailedError.with_traceback

````

`````

````{py:function} decoder_available() -> bool
:canonical: simvx.core._audio_decoder.decoder_available

```{autodoc2-docstring} simvx.core._audio_decoder.decoder_available
```
````

````{py:function} decode_file(path: str, *, sample_rate: int, channels: int) -> typing.Any
:canonical: simvx.core._audio_decoder.decode_file

```{autodoc2-docstring} simvx.core._audio_decoder.decode_file
```
````

````{py:function} stream_file(path: str, *, sample_rate: int, channels: int, frames_to_read: int, seek_frame: int = 0) -> typing.Any
:canonical: simvx.core._audio_decoder.stream_file

```{autodoc2-docstring} simvx.core._audio_decoder.stream_file
```
````

````{py:function} has_duration_probe(container: str) -> bool
:canonical: simvx.core._audio_decoder.has_duration_probe

```{autodoc2-docstring} simvx.core._audio_decoder.has_duration_probe
```
````

````{py:function} file_duration(path: str, container: str) -> float | None
:canonical: simvx.core._audio_decoder.file_duration

```{autodoc2-docstring} simvx.core._audio_decoder.file_duration
```
````

````{py:function} playback_device(*, sample_rate: int, channels: int, buffersize_msec: int) -> typing.Any
:canonical: simvx.core._audio_decoder.playback_device

```{autodoc2-docstring} simvx.core._audio_decoder.playback_device
```
````