tiramisu - v1.0.0

tiramisu/audio

Types

AudioBuffer

</>

Audio buffer type (opaque, wraps Web Audio API AudioBuffer)

pub type AudioBuffer

AudioConfig

</>

Audio playback configuration

pub type AudioConfig {
  AudioConfig(
    volume: Float,
    loop: Bool,
    playback_rate: Float,
    autoplay: Bool,
  )
}

Constructors 

  • AudioConfig(
  volume: Float,
  loop: Bool,
  playback_rate: Float,
  autoplay: Bool,
)

    Arguments

    volume

    Volume (0.0 to 1.0)

    loop

    Whether to loop the audio

    playback_rate

    Playback rate (1.0 = normal speed)

    autoplay

    Whether the audio should autoplay

AudioNode

</>

Audio node for the scene graph This is a declarative way to add audio to the scene

pub type AudioNode {
  AudioNode(
    id: String,
    config: AudioConfig,
    audio_type: AudioType,
    position: option.Option(vec3.Vec3(Float)),
  )
}

Constructors

AudioSource

</>

Opaque handle to a THREE.Audio or THREE.PositionalAudio object

pub type AudioSource

AudioType

</>

Type of audio (global or positional)

pub type AudioType {
  GlobalAudio
  PositionalAudio(
    ref_distance: Float,
    rolloff_factor: Float,
    max_distance: Float,
  )
}

Constructors 

  • GlobalAudio

    Global audio (2D, same volume everywhere)

  • PositionalAudio(
  ref_distance: Float,
  rolloff_factor: Float,
  max_distance: Float,
)

    Positional audio (3D, volume based on distance)

    Arguments

    ref_distance

    Maximum hearing distance

    rolloff_factor

    How quickly audio fades with distance

    max_distance

    Maximum distance where audio can be heard

Values

config

</> 
pub fn config() -> AudioConfig

Create default audio config

get_current_time

</> 
pub fn get_current_time(source_id: String) -> Float

Get current playback time in seconds

global_audio

</> 
pub fn global_audio(id: String, config: AudioConfig) -> AudioNode

Create a global audio node (2D audio)

is_playing

</> 
pub fn is_playing(source_id: String) -> Bool

Check if an audio source is playing

pause

</> 
pub fn pause(source_id: String) -> Nil

Pause an audio source

play

</> 
pub fn play(source_id: String) -> Nil

Play an audio source

positional

</> 
pub fn positional() -> AudioType

Create a default positional audio configuration

positional_audio

</> 
pub fn positional_audio(
  id: String,
  config: AudioConfig,
  position: vec3.Vec3(Float),
) -> AudioNode

Create a positional audio node (3D audio at a position)

positional_audio_custom

</> 
pub fn positional_audio_custom(
  id: String,
  config: AudioConfig,
  position: vec3.Vec3(Float),
  audio_type: AudioType,
) -> AudioNode

Create a positional audio node with custom settings

set_autoplay

</> 
pub fn set_autoplay(
  config: AudioConfig,
  autoplay: Bool,
) -> AudioConfig

Set autoplay

set_current_time

</> 
pub fn set_current_time(source_id: String, time: Float) -> Nil

Set current playback time in seconds

set_loop

</> 
pub fn set_loop(config: AudioConfig, loop: Bool) -> AudioConfig

Set looping

set_max_distance

</> 
pub fn set_max_distance(
  audio: AudioType,
  distance: Float,
) -> AudioType

Set maximum distance for positional audio

set_playback_rate

</> 
pub fn set_playback_rate(
  config: AudioConfig,
  rate: Float,
) -> AudioConfig

Set playback rate (1.0 = normal, 2.0 = double speed, etc.)

set_ref_distance

</> 
pub fn set_ref_distance(
  audio: AudioType,
  distance: Float,
) -> AudioType

Set reference distance for positional audio

set_rolloff_factor

</> 
pub fn set_rolloff_factor(
  audio: AudioType,
  factor: Float,
) -> AudioType

Set rolloff factor for positional audio

set_source_volume

</> 
pub fn set_source_volume(source_id: String, volume: Float) -> Nil

Set volume of a playing audio source

set_volume

</> 
pub fn set_volume(
  config: AudioConfig,
  volume: Float,
) -> AudioConfig

Set volume (0.0 to 1.0)

stop

</> 
pub fn stop(source_id: String) -> Nil

Stop an audio source (resets to beginning)

✨ Search Document