AudioRegion

interface AudioRegion extends LoopableRegion, AudioContent { uuid: string position: number duration: number complete: number mute: boolean label: string hue: number loopDuration: number loopOffset: number sample: Sample playback: AudioPlayback gain: number waveformOffset: number transientPlayMode: TransientPlayMode playbackRate: number transpose: number track: AudioTrack fading: AudioFading remove(): void }

Region playing a sample

Hierarchy


Properties

uuid: string

readonly

Inherited from uuid

Unique id

position: number

Inherited from position

Start position in PPQN

duration: number

Inherited from duration

Length in PPQN (seconds for non-synced audio regions)

complete: number

readonly

Inherited from complete

End position (position + duration)

mute: boolean

Inherited from mute

Mute the region

label: string

Inherited from label

Custom label

hue: number

Inherited from hue

Color hue (0 to 360)

loopDuration: number

Inherited from loopDuration

Loop cycle length in PPQN (seconds for non-synced audio regions)

loopOffset: number

Inherited from loopOffset

Loop start offset in PPQN (seconds for non-synced audio regions)

sample: Sample

readonly

Inherited from sample

The sample

playback: AudioPlayback

readonly

Inherited from playback

Tempo following mode (fixed at creation)

gain: number

Inherited from gain

Gain in dB (default 0)

waveformOffset: number

Inherited from waveformOffset

Waveform display offset in seconds

transientPlayMode: TransientPlayMode

Inherited from transientPlayMode

Time-stretch transient mode (only "timestretch")

playbackRate: number

Inherited from playbackRate

Playback rate (only "timestretch", default 1.0)

transpose: number

Inherited from transpose

Transpose in semitones (only "signalsmith", -24 to 24)

track: AudioTrack

readonly

The audio track this region belongs to

fading: AudioFading

readonly

Fade in and out

Methods

remove(): void

Inherited from remove

Remove the region

Returns

  • void