---
orphan: true
---

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

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

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

## Module Contents

### Classes

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

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

### Data

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

* - {py:obj}`AudioSource <simvx.core._audio_stream.AudioSource>`
  - ```{autodoc2-docstring} simvx.core._audio_stream.AudioSource
    :summary:
    ```
* - {py:obj}`AudioContainer <simvx.core._audio_stream.AudioContainer>`
  - ```{autodoc2-docstring} simvx.core._audio_stream.AudioContainer
    :summary:
    ```
* - {py:obj}`log <simvx.core._audio_stream.log>`
  - ```{autodoc2-docstring} simvx.core._audio_stream.log
    :summary:
    ```
````

### API

````{py:data} AudioSource
:canonical: simvx.core._audio_stream.AudioSource
:value: >
   None

```{autodoc2-docstring} simvx.core._audio_stream.AudioSource
```

````

````{py:data} AudioContainer
:canonical: simvx.core._audio_stream.AudioContainer
:value: >
   None

```{autodoc2-docstring} simvx.core._audio_stream.AudioContainer
```

````

````{py:data} log
:canonical: simvx.core._audio_stream.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.core._audio_stream.log
```

````

`````{py:class} AudioStream(source: simvx.core._audio_stream.AudioSource)
:canonical: simvx.core._audio_stream.AudioStream

```{autodoc2-docstring} simvx.core._audio_stream.AudioStream
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core._audio_stream.AudioStream.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core._audio_stream.AudioStream.__slots__
:value: >
   ('source', '_path', 'backend_data', 'sample_rate', 'channels', '_container')

```{autodoc2-docstring} simvx.core._audio_stream.AudioStream.__slots__
```

````

````{py:property} path
:canonical: simvx.core._audio_stream.AudioStream.path
:type: str

```{autodoc2-docstring} simvx.core._audio_stream.AudioStream.path
```

````

````{py:property} container
:canonical: simvx.core._audio_stream.AudioStream.container
:type: simvx.core._audio_stream.AudioContainer

```{autodoc2-docstring} simvx.core._audio_stream.AudioStream.container
```

````

````{py:method} __repr__()
:canonical: simvx.core._audio_stream.AudioStream.__repr__

````

````{py:method} tone(freq_hz: float, *, duration: float = 1.0, volume: float = 0.3, sample_rate: int = _SAMPLE_RATE) -> simvx.core._audio_stream.AudioStream
:canonical: simvx.core._audio_stream.AudioStream.tone
:classmethod:

```{autodoc2-docstring} simvx.core._audio_stream.AudioStream.tone
```

````

````{py:method} from_pcm(samples: numpy.ndarray, *, sample_rate: int, channels: int, name: str = 'pcm') -> simvx.core._audio_stream.AudioStream
:canonical: simvx.core._audio_stream.AudioStream.from_pcm
:classmethod:

```{autodoc2-docstring} simvx.core._audio_stream.AudioStream.from_pcm
```

````

````{py:method} empty(*, name: str = 'empty') -> simvx.core._audio_stream.AudioStream
:canonical: simvx.core._audio_stream.AudioStream.empty
:classmethod:

```{autodoc2-docstring} simvx.core._audio_stream.AudioStream.empty
```

````

`````