savoiardi/audio

Audio buffers, listeners, and scene audio objects.

The audio API mirrors the Three.js audio model while keeping the public surface typed in terms of listeners, global audio, and positional audio.

Types

Audio

</>

A non-positional audio source.

pub type Audio

AudioBuffer

</>

A decoded audio buffer.

pub type AudioBuffer

Listener

</>

A scene listener, typically attached to a camera.

pub type Listener

PositionalAudio

</>

An audio source with positional attenuation.

pub type PositionalAudio

Values

attach_listener

</>

pub fn attach_listener(
  listener: Listener,
  camera: camera.Camera,
) -> Listener

Attaches a listener to a camera.

audio_from_object3d

</>

pub fn audio_from_object3d(
  object: object.Object3D,
) -> Result(Audio, Nil)

Safely downcasts an object to an audio source.

clear_buffer

</>

pub fn clear_buffer(audio: Audio) -> Audio

Removes the current buffer from an audio source.

dispose

</>

pub fn dispose(audio: Audio) -> Nil

Disposes an audio source.

dispose_listener

</>

pub fn dispose_listener(listener: Listener) -> Nil

Disposes a listener.

find_listener

</>

pub fn find_listener(scene: scene.Scene) -> Result(Listener, Nil)

Finds the first listener attached somewhere in the scene.

from_positional

</>

pub fn from_positional(audio: PositionalAudio) -> Audio

Widens a positional audio source into the shared audio type.

global

</>

pub fn global(listener: Listener) -> Audio

Creates a global audio source that plays through the listener.

has_buffer

</>

pub fn has_buffer(audio: Audio) -> Bool

Returns whether an audio source has a buffer.

is_audio

</>

pub fn is_audio(object: object.Object3D) -> Bool

Returns whether an object is an audio source.

is_listener

</>

pub fn is_listener(object: object.Object3D) -> Bool

Returns whether an object is an audio listener.

is_positional_audio

</>

pub fn is_positional_audio(object: object.Object3D) -> Bool

Returns whether an object is a positional audio source.

listener

</>

pub fn listener() -> Listener

Creates a new listener.

listener_from_object3d

</>

pub fn listener_from_object3d(
  object: object.Object3D,
) -> Result(Listener, Nil)

Safely downcasts an object to a listener.

listener_to_object3d

</>

pub fn listener_to_object3d(
  listener: Listener,
) -> object.Object3D

Views a listener as an object.

load

</>

pub fn load(
  loader: loader.AudioLoader,
  url: String,
  on_result: fn(Result(AudioBuffer, loader.LoadError)) -> Nil,
) -> Nil

Loads an audio buffer and reports the result through a callback.

load_async

</>

pub fn load_async(
  loader: loader.AudioLoader,
  url: String,
) -> promise.Promise(Result(AudioBuffer, loader.LoadError))

Loads an audio buffer asynchronously.

pause

</>

pub fn pause(audio: Audio) -> Audio

Pauses an audio source.

play

</>

pub fn play(audio: Audio) -> Audio

Starts playback for an audio source.

positional

</>

pub fn positional(listener: Listener) -> PositionalAudio

Creates a positional audio source that plays through the listener.

positional_from_object3d

</>

pub fn positional_from_object3d(
  object: object.Object3D,
) -> Result(PositionalAudio, Nil)

Safely downcasts an object to a positional audio source.

set_buffer

</>

pub fn set_buffer(audio: Audio, buffer: AudioBuffer) -> Audio

Assigns a buffer to an audio source.

set_loop

</>

pub fn set_loop(audio: Audio, should_loop: Bool) -> Audio

Enables or disables looping for an audio source.

set_max_distance

</>

pub fn set_max_distance(
  audio: PositionalAudio,
  distance: Float,
) -> PositionalAudio

Sets the maximum effective distance for positional attenuation.

set_playback_rate

</>

pub fn set_playback_rate(audio: Audio, rate: Float) -> Audio

Sets the playback rate for an audio source.

set_ref_distance

</>

pub fn set_ref_distance(
  audio: PositionalAudio,
  distance: Float,
) -> PositionalAudio

Sets the reference distance for positional attenuation.

set_rolloff_factor

</>

pub fn set_rolloff_factor(
  audio: PositionalAudio,
  factor: Float,
) -> PositionalAudio

Sets the rolloff factor for positional attenuation.

set_volume

</>

pub fn set_volume(audio: Audio, volume: Float) -> Audio

Sets the playback volume for an audio source.

stop

</>

pub fn stop(audio: Audio) -> Audio

Stops an audio source.

to_object3d

</>

pub fn to_object3d(audio: Audio) -> object.Object3D

Views an audio source as an object.