Interface AudioOutputProvider

Provider of the Audio Output Audio Track asset.

Example

// @input Asset.AudioTrackAsset audioOutput
audioOutput = script.audioOutput.control;
audioOutput.sampleRate = script.sampleRate;
interface AudioOutputProvider {
    maxFrameSize: number;
    sampleRate: number;
    enqueueAudioFrame(audioFrame: Float32Array, inShape: vec3): void;
    getLoadStatus(): LoadStatus;
    getPreferredFrameSize(): number;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

maxFrameSize sampleRate

Methods

enqueueAudioFrame getLoadStatus getPreferredFrameSize getTypeName isOfType isSame

Properties

ReadonlymaxFrameSize

maxFrameSize: number

The maximum frame size of the audio track asset.

sampleRate

sampleRate: number

Sample rate (samples per second) of the audio track asset.

Methods

enqueueAudioFrame

  • enqueueAudioFrame(audioFrame, inShape): void

  • Enqueue audio data into an audio playback system.

    shape.x - buffer size, must be less or equal to audioFrame length.

    Parameters

    • audioFrame: Float32Array
    • inShape: vec3

    Returns void

getLoadStatus

getPreferredFrameSize

  • getPreferredFrameSize(): number

  • Preferred size for audio output at the current frame update.

    Returns number

getTypeName

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods