Skip to content

audio_initializer.md

Latest commit

 

History

History
79 lines (47 loc) · 2.38 KB

audio_initializer.md

File metadata and controls

79 lines (47 loc) · 2.38 KB
Raw

AudioInitializer

from tdw.add_ons.audio_initializer import AudioInitializer

Initialize standard (Unity) audio.

This assumes that an avatar corresponding to avatar_id has already been added to the scene.

Fields

  • avatar_id The ID of the listening avatar.

  • commands These commands will be appended to the commands of the next communicate() call.

  • initialized If True, this module has been initialized.

Functions

__init__

AudioInitializer()

AudioInitializer(avatar_id="a", framerate=60)

Parameter Type Default Description
avatar_id str "a" The ID of the listening avatar.
framerate int 60 The target simulation framerate.

get_initialization_commands

self.get_initialization_commands()

This function gets called exactly once per add-on. To re-initialize, set self.initialized = False.

Returns: A list of commands that will initialize this add-on.

on_send

self.on_send(resp)

This is called after commands are sent to the build and a response is received.

Use this function to send commands to the build on the next frame, given the resp response. Any commands in the self.commands list will be sent on the next frame.

Parameter Type Default Description
resp List[bytes] The response from the build.

play

self.play(path, position)

self.play(path, position, audio_id=None, object_id=None)

Load a .wav file and prepare to send a command to the build to play the audio. The command will be sent on the next Controller.communicate() call.

Parameter Type Default Description
path Union[str, Path] The path to a .wav file.
position POSITION The position of audio source. Can be a numpy array or x, y, z dictionary.
audio_id int None The unique ID of the audio source. If None, a random ID is generated.
object_id int None If not None, parent the audio source to this object.

before_send

self.before_send(commands)

This is called within Controller.communicate(commands) before sending commands to the build. By default, this function doesn't do anything.

Parameter Type Default Description
commands List[dict] The commands that are about to be sent to the build.