Type Alias AudioDevice

key	value
type	entity
key	`"audioDevice"`
is	api.TargetType.AudioTrackPlayer

The device with which an audio track on the timeline can be associated.

type AudioDevice = {
    audioOutput: NexusObject<Empty>;
    displayName: PrimitiveField<string, "mut">;
    gain: PrimitiveField<number, "mut">;
    isActive: PrimitiveField<boolean, "mut">;
    panning: PrimitiveField<number, "mut">;
    positionX: PrimitiveField<number, "mut">;
    positionY: PrimitiveField<number, "mut">;
}

Properties

The location representing the audio output of the device. Audible is what's laid out on the timeline.

key	value
is	api.TargetType.AudioOutput

displayName: PrimitiveField<string, "mut">

The user-assigned name of this device.

gain: PrimitiveField<number, "mut">

This audio device's output gain. Equivalent to a dB range of [-inf, 0.0]

key	value
default	0.7079399824142456
range	[0, 1]
is	api.TargetType.AutomatableParameter

isActive: PrimitiveField<boolean, "mut">

Whether this device is active or not. An inactive device won't produce any sound.

key	value
default	true
is	api.TargetType.AutomatableParameter

panning: PrimitiveField<number, "mut">

Pans the track left/right. -1 is fully left, 0 is centered (unchanged), 1 is fully right.

key	value
default	0
range	[-1, 1]
is	api.TargetType.AutomatableParameter

positionX: PrimitiveField<number, "mut">

X position on the desktop in the DAW.

key	value
default	0
range	full

positionY: PrimitiveField<number, "mut">

Y position on the desktop in the DAW.

key	value
default	0
range	full