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

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

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

## Module Contents

### Classes

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

* - {py:obj}`AudioBus <simvx.core.audio_bus.AudioBus>`
  - ```{autodoc2-docstring} simvx.core.audio_bus.AudioBus
    :summary:
    ```
* - {py:obj}`AudioBusLayout <simvx.core.audio_bus.AudioBusLayout>`
  - ```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout
    :summary:
    ```
````

### Data

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

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

### API

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

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

````

````{py:data} __all__
:canonical: simvx.core.audio_bus.__all__
:value: >
   ['AudioBus', 'AudioBusLayout']

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

````

`````{py:class} AudioBus(name: str, volume_db: float = 0.0, send_to: str = '')
:canonical: simvx.core.audio_bus.AudioBus

```{autodoc2-docstring} simvx.core.audio_bus.AudioBus
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.audio_bus.AudioBus.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.audio_bus.AudioBus.__slots__
:value: >
   ('name', 'volume_db', 'mute', 'solo', 'send_to', '_effects')

```{autodoc2-docstring} simvx.core.audio_bus.AudioBus.__slots__
```

````

````{py:method} get_linear_volume() -> float
:canonical: simvx.core.audio_bus.AudioBus.get_linear_volume

```{autodoc2-docstring} simvx.core.audio_bus.AudioBus.get_linear_volume
```

````

````{py:method} add_effect(effect: typing.Any) -> None
:canonical: simvx.core.audio_bus.AudioBus.add_effect

```{autodoc2-docstring} simvx.core.audio_bus.AudioBus.add_effect
```

````

````{py:method} remove_effect(effect: typing.Any) -> None
:canonical: simvx.core.audio_bus.AudioBus.remove_effect

```{autodoc2-docstring} simvx.core.audio_bus.AudioBus.remove_effect
```

````

````{py:property} effects
:canonical: simvx.core.audio_bus.AudioBus.effects
:type: list[typing.Any]

```{autodoc2-docstring} simvx.core.audio_bus.AudioBus.effects
```

````

````{py:method} __repr__() -> str
:canonical: simvx.core.audio_bus.AudioBus.__repr__

````

`````

`````{py:class} AudioBusLayout()
:canonical: simvx.core.audio_bus.AudioBusLayout

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.__init__
```

````{py:method} add_bus(name: str, volume_db: float = 0.0, send_to: str = '') -> simvx.core.audio_bus.AudioBus
:canonical: simvx.core.audio_bus.AudioBusLayout.add_bus

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.add_bus
```

````

````{py:method} remove_bus(name: str) -> None
:canonical: simvx.core.audio_bus.AudioBusLayout.remove_bus

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.remove_bus
```

````

````{py:method} get_bus(name: str) -> simvx.core.audio_bus.AudioBus | None
:canonical: simvx.core.audio_bus.AudioBusLayout.get_bus

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.get_bus
```

````

````{py:property} buses
:canonical: simvx.core.audio_bus.AudioBusLayout.buses
:type: list[simvx.core.audio_bus.AudioBus]

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.buses
```

````

````{py:property} bus_names
:canonical: simvx.core.audio_bus.AudioBusLayout.bus_names
:type: list[str]

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.bus_names
```

````

````{py:method} get_effective_volume(bus_name: str) -> float
:canonical: simvx.core.audio_bus.AudioBusLayout.get_effective_volume

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.get_effective_volume
```

````

````{py:method} get_effective_linear(bus_name: str) -> float
:canonical: simvx.core.audio_bus.AudioBusLayout.get_effective_linear

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.get_effective_linear
```

````

````{py:method} get_default() -> simvx.core.audio_bus.AudioBusLayout
:canonical: simvx.core.audio_bus.AudioBusLayout.get_default
:classmethod:

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.get_default
```

````

````{py:method} create_default() -> simvx.core.audio_bus.AudioBusLayout
:canonical: simvx.core.audio_bus.AudioBusLayout.create_default
:classmethod:

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.create_default
```

````

````{py:method} reset()
:canonical: simvx.core.audio_bus.AudioBusLayout.reset
:classmethod:

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.reset
```

````

````{py:method} to_dict() -> list[dict]
:canonical: simvx.core.audio_bus.AudioBusLayout.to_dict

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.to_dict
```

````

````{py:method} from_dict(data: list[dict]) -> simvx.core.audio_bus.AudioBusLayout
:canonical: simvx.core.audio_bus.AudioBusLayout.from_dict
:classmethod:

```{autodoc2-docstring} simvx.core.audio_bus.AudioBusLayout.from_dict
```

````

`````