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

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

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

## Module Contents

### Classes

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

* - {py:obj}`AudioStream <simvx.core.audio.AudioStream>`
  - ```{autodoc2-docstring} simvx.core.audio.AudioStream
    :summary:
    ```
* - {py:obj}`AudioListener <simvx.core.audio.AudioListener>`
  - ```{autodoc2-docstring} simvx.core.audio.AudioListener
    :summary:
    ```
* - {py:obj}`AudioStreamPlayer <simvx.core.audio.AudioStreamPlayer>`
  - ```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer
    :summary:
    ```
* - {py:obj}`AudioStreamPlayer2D <simvx.core.audio.AudioStreamPlayer2D>`
  - ```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D
    :summary:
    ```
* - {py:obj}`AudioStreamPlayer3D <simvx.core.audio.AudioStreamPlayer3D>`
  - ```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D
    :summary:
    ```
````

### Data

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

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

### API

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

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

````

````{py:data} __all__
:canonical: simvx.core.audio.__all__
:value: >
   ['AudioStream', 'AudioStreamPlayer', 'AudioStreamPlayer2D', 'AudioStreamPlayer3D', 'AudioListener']

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

````

`````{py:class} AudioStream(path: str)
:canonical: simvx.core.audio.AudioStream

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

```{rubric} Initialization
```

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

````{py:attribute} __slots__
:canonical: simvx.core.audio.AudioStream.__slots__
:value: >
   ('path', 'resource_uri', 'backend_data')

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

````

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

````

`````

`````{py:class} AudioListener()
:canonical: simvx.core.audio.AudioListener

```{autodoc2-docstring} simvx.core.audio.AudioListener
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.audio.AudioListener.__init__
```

````{py:method} get() -> simvx.core.audio.AudioListener
:canonical: simvx.core.audio.AudioListener.get
:classmethod:

```{autodoc2-docstring} simvx.core.audio.AudioListener.get
```

````

````{py:method} reset()
:canonical: simvx.core.audio.AudioListener.reset
:classmethod:

```{autodoc2-docstring} simvx.core.audio.AudioListener.reset
```

````

`````

`````{py:class} AudioStreamPlayer(stream: str | simvx.core.audio.AudioStream | None = None, **kwargs)
:canonical: simvx.core.audio.AudioStreamPlayer

Bases: {py:obj}`simvx.core.audio._AudioPlaybackMixin`, {py:obj}`simvx.core.engine.Node`

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.__init__
```

````{py:attribute} volume_db
:canonical: simvx.core.audio.AudioStreamPlayer.volume_db
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.volume_db
```

````

````{py:attribute} pitch_scale
:canonical: simvx.core.audio.AudioStreamPlayer.pitch_scale
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.pitch_scale
```

````

````{py:attribute} bus
:canonical: simvx.core.audio.AudioStreamPlayer.bus
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.bus
```

````

````{py:attribute} autoplay
:canonical: simvx.core.audio.AudioStreamPlayer.autoplay
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.autoplay
```

````

````{py:attribute} loop
:canonical: simvx.core.audio.AudioStreamPlayer.loop
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.loop
```

````

````{py:attribute} stream_mode
:canonical: simvx.core.audio.AudioStreamPlayer.stream_mode
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.stream_mode
```

````

````{py:attribute} buffer_size
:canonical: simvx.core.audio.AudioStreamPlayer.buffer_size
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.buffer_size
```

````

````{py:method} ready()
:canonical: simvx.core.audio.AudioStreamPlayer.ready

````

````{py:method} process(delta: float)
:canonical: simvx.core.audio.AudioStreamPlayer.process

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.process
```

````

````{py:method} play(from_position: float = 0.0)
:canonical: simvx.core.audio.AudioStreamPlayer.play

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.play
```

````

````{py:method} stop()
:canonical: simvx.core.audio.AudioStreamPlayer.stop

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.stop
```

````

````{py:method} get_playback_position() -> float
:canonical: simvx.core.audio.AudioStreamPlayer.get_playback_position

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer.get_playback_position
```

````

````{py:method} pause()
:canonical: simvx.core.audio.AudioStreamPlayer.pause

````

````{py:method} is_playing() -> bool
:canonical: simvx.core.audio.AudioStreamPlayer.is_playing

````

````{py:attribute} script_error_raised
:canonical: simvx.core.audio.AudioStreamPlayer.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.audio.AudioStreamPlayer.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.audio.AudioStreamPlayer.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.audio.AudioStreamPlayer.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.audio.AudioStreamPlayer.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.audio.AudioStreamPlayer.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.audio.AudioStreamPlayer.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.audio.AudioStreamPlayer.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.audio.AudioStreamPlayer.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.audio.AudioStreamPlayer.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.audio.AudioStreamPlayer.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.audio.AudioStreamPlayer.find_all

````

````{py:property} path
:canonical: simvx.core.audio.AudioStreamPlayer.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.audio.AudioStreamPlayer.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.audio.AudioStreamPlayer.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.audio.AudioStreamPlayer.is_in_group

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.audio.AudioStreamPlayer.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.audio.AudioStreamPlayer.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.audio.AudioStreamPlayer.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.audio.AudioStreamPlayer.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.audio.AudioStreamPlayer.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.audio.AudioStreamPlayer.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.audio.AudioStreamPlayer.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.audio.AudioStreamPlayer.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.audio.AudioStreamPlayer.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.audio.AudioStreamPlayer.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.audio.AudioStreamPlayer.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.audio.AudioStreamPlayer.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.audio.AudioStreamPlayer.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.audio.AudioStreamPlayer.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.audio.AudioStreamPlayer.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.audio.AudioStreamPlayer.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.audio.AudioStreamPlayer.__repr__

````

`````

`````{py:class} AudioStreamPlayer2D(stream: str | simvx.core.audio.AudioStream | None = None, **kwargs)
:canonical: simvx.core.audio.AudioStreamPlayer2D

Bases: {py:obj}`simvx.core.audio._AudioPlaybackMixin`, {py:obj}`simvx.core.engine.Node2D`

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D.__init__
```

````{py:attribute} volume_db
:canonical: simvx.core.audio.AudioStreamPlayer2D.volume_db
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D.volume_db
```

````

````{py:attribute} pitch_scale
:canonical: simvx.core.audio.AudioStreamPlayer2D.pitch_scale
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D.pitch_scale
```

````

````{py:attribute} bus
:canonical: simvx.core.audio.AudioStreamPlayer2D.bus
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D.bus
```

````

````{py:attribute} autoplay
:canonical: simvx.core.audio.AudioStreamPlayer2D.autoplay
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D.autoplay
```

````

````{py:attribute} loop
:canonical: simvx.core.audio.AudioStreamPlayer2D.loop
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D.loop
```

````

````{py:attribute} max_distance
:canonical: simvx.core.audio.AudioStreamPlayer2D.max_distance
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D.max_distance
```

````

````{py:attribute} attenuation
:canonical: simvx.core.audio.AudioStreamPlayer2D.attenuation
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D.attenuation
```

````

````{py:method} ready()
:canonical: simvx.core.audio.AudioStreamPlayer2D.ready

````

````{py:method} process(delta: float)
:canonical: simvx.core.audio.AudioStreamPlayer2D.process

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D.process
```

````

````{py:method} play(from_position: float = 0.0)
:canonical: simvx.core.audio.AudioStreamPlayer2D.play

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer2D.play
```

````

````{py:method} stop()
:canonical: simvx.core.audio.AudioStreamPlayer2D.stop

````

````{py:method} pause()
:canonical: simvx.core.audio.AudioStreamPlayer2D.pause

````

````{py:method} is_playing() -> bool
:canonical: simvx.core.audio.AudioStreamPlayer2D.is_playing

````

````{py:attribute} z_index
:canonical: simvx.core.audio.AudioStreamPlayer2D.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.audio.AudioStreamPlayer2D.z_as_relative
:value: >
   'Property(...)'

````

````{py:property} absolute_z_index
:canonical: simvx.core.audio.AudioStreamPlayer2D.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.audio.AudioStreamPlayer2D.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.audio.AudioStreamPlayer2D.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.audio.AudioStreamPlayer2D.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.audio.AudioStreamPlayer2D.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} global_position
:canonical: simvx.core.audio.AudioStreamPlayer2D.global_position
:type: simvx.core.math.types.Vec2

````

````{py:property} global_rotation
:canonical: simvx.core.audio.AudioStreamPlayer2D.global_rotation
:type: float

````

````{py:property} global_scale
:canonical: simvx.core.audio.AudioStreamPlayer2D.global_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.audio.AudioStreamPlayer2D.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.audio.AudioStreamPlayer2D.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.audio.AudioStreamPlayer2D.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.audio.AudioStreamPlayer2D.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.audio.AudioStreamPlayer2D.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.audio.AudioStreamPlayer2D.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.audio.AudioStreamPlayer2D.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, color=None)
:canonical: simvx.core.audio.AudioStreamPlayer2D.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.audio.AudioStreamPlayer2D.wrap_screen

````

````{py:attribute} script_error_raised
:canonical: simvx.core.audio.AudioStreamPlayer2D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.audio.AudioStreamPlayer2D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.audio.AudioStreamPlayer2D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.audio.AudioStreamPlayer2D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.audio.AudioStreamPlayer2D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.audio.AudioStreamPlayer2D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.audio.AudioStreamPlayer2D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.audio.AudioStreamPlayer2D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.audio.AudioStreamPlayer2D.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.audio.AudioStreamPlayer2D.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.audio.AudioStreamPlayer2D.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.audio.AudioStreamPlayer2D.find_all

````

````{py:property} path
:canonical: simvx.core.audio.AudioStreamPlayer2D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.audio.AudioStreamPlayer2D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.audio.AudioStreamPlayer2D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.audio.AudioStreamPlayer2D.is_in_group

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.audio.AudioStreamPlayer2D.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.audio.AudioStreamPlayer2D.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.audio.AudioStreamPlayer2D.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.audio.AudioStreamPlayer2D.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.audio.AudioStreamPlayer2D.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.audio.AudioStreamPlayer2D.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.audio.AudioStreamPlayer2D.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.audio.AudioStreamPlayer2D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.audio.AudioStreamPlayer2D.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.audio.AudioStreamPlayer2D.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.audio.AudioStreamPlayer2D.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.audio.AudioStreamPlayer2D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.audio.AudioStreamPlayer2D.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.audio.AudioStreamPlayer2D.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.audio.AudioStreamPlayer2D.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.audio.AudioStreamPlayer2D.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.audio.AudioStreamPlayer2D.__repr__

````

`````

`````{py:class} AudioStreamPlayer3D(stream: str | simvx.core.audio.AudioStream | None = None, **kwargs)
:canonical: simvx.core.audio.AudioStreamPlayer3D

Bases: {py:obj}`simvx.core.audio._AudioPlaybackMixin`, {py:obj}`simvx.core.engine.Node3D`

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D.__init__
```

````{py:attribute} volume_db
:canonical: simvx.core.audio.AudioStreamPlayer3D.volume_db
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D.volume_db
```

````

````{py:attribute} pitch_scale
:canonical: simvx.core.audio.AudioStreamPlayer3D.pitch_scale
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D.pitch_scale
```

````

````{py:attribute} bus
:canonical: simvx.core.audio.AudioStreamPlayer3D.bus
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D.bus
```

````

````{py:attribute} autoplay
:canonical: simvx.core.audio.AudioStreamPlayer3D.autoplay
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D.autoplay
```

````

````{py:attribute} loop
:canonical: simvx.core.audio.AudioStreamPlayer3D.loop
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D.loop
```

````

````{py:attribute} max_distance
:canonical: simvx.core.audio.AudioStreamPlayer3D.max_distance
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D.max_distance
```

````

````{py:attribute} attenuation
:canonical: simvx.core.audio.AudioStreamPlayer3D.attenuation
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D.attenuation
```

````

````{py:attribute} doppler_scale
:canonical: simvx.core.audio.AudioStreamPlayer3D.doppler_scale
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D.doppler_scale
```

````

````{py:method} ready()
:canonical: simvx.core.audio.AudioStreamPlayer3D.ready

````

````{py:method} process(delta: float)
:canonical: simvx.core.audio.AudioStreamPlayer3D.process

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D.process
```

````

````{py:method} play(from_position: float = 0.0)
:canonical: simvx.core.audio.AudioStreamPlayer3D.play

```{autodoc2-docstring} simvx.core.audio.AudioStreamPlayer3D.play
```

````

````{py:method} stop()
:canonical: simvx.core.audio.AudioStreamPlayer3D.stop

````

````{py:method} pause()
:canonical: simvx.core.audio.AudioStreamPlayer3D.pause

````

````{py:method} is_playing() -> bool
:canonical: simvx.core.audio.AudioStreamPlayer3D.is_playing

````

````{py:property} position
:canonical: simvx.core.audio.AudioStreamPlayer3D.position

````

````{py:property} rotation
:canonical: simvx.core.audio.AudioStreamPlayer3D.rotation
:type: simvx.core.math.types.Quat

````

````{py:property} scale
:canonical: simvx.core.audio.AudioStreamPlayer3D.scale

````

````{py:property} rotation_degrees
:canonical: simvx.core.audio.AudioStreamPlayer3D.rotation_degrees
:type: simvx.core.math.types.Vec3

````

````{py:property} global_position
:canonical: simvx.core.audio.AudioStreamPlayer3D.global_position
:type: simvx.core.math.types.Vec3

````

````{py:property} global_rotation
:canonical: simvx.core.audio.AudioStreamPlayer3D.global_rotation
:type: simvx.core.math.types.Quat

````

````{py:property} global_scale
:canonical: simvx.core.audio.AudioStreamPlayer3D.global_scale
:type: simvx.core.math.types.Vec3

````

````{py:property} forward
:canonical: simvx.core.audio.AudioStreamPlayer3D.forward
:type: simvx.core.math.types.Vec3

````

````{py:property} right
:canonical: simvx.core.audio.AudioStreamPlayer3D.right
:type: simvx.core.math.types.Vec3

````

````{py:property} up
:canonical: simvx.core.audio.AudioStreamPlayer3D.up
:type: simvx.core.math.types.Vec3

````

````{py:method} translate(offset: tuple[float, float, float] | numpy.ndarray)
:canonical: simvx.core.audio.AudioStreamPlayer3D.translate

````

````{py:method} translate_global(offset: tuple[float, float, float] | numpy.ndarray)
:canonical: simvx.core.audio.AudioStreamPlayer3D.translate_global

````

````{py:method} rotate(axis: tuple[float, float, float] | numpy.ndarray, angle: float)
:canonical: simvx.core.audio.AudioStreamPlayer3D.rotate

````

````{py:method} rotate_x(angle: float)
:canonical: simvx.core.audio.AudioStreamPlayer3D.rotate_x

````

````{py:method} rotate_y(angle: float)
:canonical: simvx.core.audio.AudioStreamPlayer3D.rotate_y

````

````{py:method} rotate_z(angle: float)
:canonical: simvx.core.audio.AudioStreamPlayer3D.rotate_z

````

````{py:method} look_at(target: tuple[float, float, float] | numpy.ndarray, up=None)
:canonical: simvx.core.audio.AudioStreamPlayer3D.look_at

````

````{py:method} wrap_bounds(bounds: tuple[float, float, float] | numpy.ndarray, margin: float = 1.0)
:canonical: simvx.core.audio.AudioStreamPlayer3D.wrap_bounds

````

````{py:attribute} script_error_raised
:canonical: simvx.core.audio.AudioStreamPlayer3D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.audio.AudioStreamPlayer3D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.audio.AudioStreamPlayer3D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.audio.AudioStreamPlayer3D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.audio.AudioStreamPlayer3D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.audio.AudioStreamPlayer3D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.audio.AudioStreamPlayer3D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.audio.AudioStreamPlayer3D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.audio.AudioStreamPlayer3D.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.audio.AudioStreamPlayer3D.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.audio.AudioStreamPlayer3D.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.audio.AudioStreamPlayer3D.find_all

````

````{py:property} path
:canonical: simvx.core.audio.AudioStreamPlayer3D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.audio.AudioStreamPlayer3D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.audio.AudioStreamPlayer3D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.audio.AudioStreamPlayer3D.is_in_group

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.audio.AudioStreamPlayer3D.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.audio.AudioStreamPlayer3D.exit_tree

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.audio.AudioStreamPlayer3D.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.audio.AudioStreamPlayer3D.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.audio.AudioStreamPlayer3D.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.audio.AudioStreamPlayer3D.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.audio.AudioStreamPlayer3D.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.audio.AudioStreamPlayer3D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.audio.AudioStreamPlayer3D.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.audio.AudioStreamPlayer3D.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.audio.AudioStreamPlayer3D.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.audio.AudioStreamPlayer3D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.audio.AudioStreamPlayer3D.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.audio.AudioStreamPlayer3D.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.audio.AudioStreamPlayer3D.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.audio.AudioStreamPlayer3D.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.audio.AudioStreamPlayer3D.__repr__

````

`````