Cue

Since 0.6

Signature

export interface Cue {
  /** Present so a play cue and a mixer cue can sit in the same table. Default "play". */
  kind?: "play"
  asset: string
  loop?: boolean
  bus?: AudioBus
  /** 0..1, before the director's master volume. */
  volume?: number
  /** Playback rate; 1 is as authored. Omitted takes the asset's `meta.audio` default. */
  pitch?: number
  /** Spatialise here; omitted plays non-spatial. */
  at?: Target
  /** Name this playback so it can be stopped without the handle. */
  tag?: string
}

Import: import type { Cue } from "@argus/gameplay"

Members

Member	Signature	Description
`kind`	`kind?: "play"`	Present so a play cue and a mixer cue can sit in the same table. Default "play".
`asset`	`asset: string`
`loop`	`loop?: boolean`
`bus`	`bus?: AudioBus`
`volume`	`volume?: number`	0..1, before the director's master volume.
`pitch`	`pitch?: number`	Playback rate; 1 is as authored. Omitted takes the asset's `meta.audio` default.
`at`	`at?: Target`	Spatialise here; omitted plays non-spatial.
`tag`	`tag?: string`	Name this playback so it can be stopped without the handle.