Interface AudioOutputProvider

Description

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, inShape): void;
    getLoadStatus(): LoadStatus;
    getPreferredFrameSize(): number;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

maxFrameSize sampleRate

Methods

enqueueAudioFrame getLoadStatus getPreferredFrameSize getTypeName isOfType isSame

Properties

Readonly maxFrameSize

maxFrameSize: number

Description

The maximum frame size of the audio track asset.

sampleRate

sampleRate: number

Description

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

Methods

enqueueAudioFrame

  • enqueueAudioFrame(audioFrame, inShape): void

  • Parameters

    • audioFrame: Float32Array
    • inShape: vec3

    Returns void

    Description

    Enqueue audio data into an audio playback system.

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

getLoadStatus

getPreferredFrameSize

  • getPreferredFrameSize(): number

  • Returns number

    Description

    Preferred size for audio output at the current frame update.

getTypeName

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

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

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc