Logo Mibo

Voice Module

Constructors for Voice values.

Functions and values

Function or value Description

at volume pan

Full Usage: at volume pan

Parameters:
    volume : float32 - Playback volume (1.0 = full).
    pan : float32 - Stereo pan (-1 left .. 1 right).

Returns: Voice
Modifiers: inline

A voice with the given volume and pan, normal pitch.

volume : float32

Playback volume (1.0 = full).

pan : float32

Stereo pan (-1 left .. 1 right).

Returns: Voice

center

Full Usage: center

Returns: Voice

The default voice: full volume, centered, normal pitch.

Returns: Voice

clamp voice

Full Usage: clamp voice

Parameters:
    voice : Voice - The voice to clamp.

Returns: Voice The same voice with every knob inside its portable range.
Modifiers: inline

Clamps a voice to the portable ranges — Volume 0.0..1.0, Pan -1.0..1.0, Pitch 0.5..2.0. The services call this at the entry of every play, so an out-of-range knob can never crash one backend while playing fine on another.

voice : Voice

The voice to clamp.

Returns: Voice

The same voice with every knob inside its portable range.

ofVolume volume

Full Usage: ofVolume volume

Parameters:
    volume : float32 - Playback volume (1.0 = full).

Returns: Voice
Modifiers: inline

A voice with the given volume, centered, normal pitch.

volume : float32

Playback volume (1.0 = full).

Returns: Voice

Type something to start searching.