Interface BaseSound

The base interface for any sound-producing entity, including individual sounds, groups, and playbacks. BaseSound

interface BaseSound {
    isPlaying: boolean;
    position?: Position;
    threeDOptions?: any;
    volume: number;
    addFilter(filter): void;
    fadeIn?(duration, type?): Promise<void>;
    fadeOut?(duration, type?): Promise<void>;
    fadeTo?(value, duration, type?): Promise<void>;
    pause(): void;
    play(): BaseSound[];
    removeFilter(filter): void;
    seek?(time): void;
    stop(): void;
    stopWithFade?(duration, type?): Promise<void>;
}

Implemented by

Properties

isPlaying position? threeDOptions? volume

Methods

addFilter fadeIn? fadeOut? fadeTo? pause play removeFilter seek? stop stopWithFade?

Properties

isPlaying

isPlaying: boolean

Optional position

position?: Position

Optional threeDOptions

threeDOptions?: any

volume

volume: number

Methods

addFilter

  • addFilter(filter): void

  • Parameters

    • filter: BiquadFilterNode

    Returns void

Optional fadeIn

  • fadeIn(duration, type?): Promise<void>

  • Parameters

    Returns Promise<void>

Optional fadeOut

  • fadeOut(duration, type?): Promise<void>

  • Parameters

    Returns Promise<void>

Optional fadeTo

  • fadeTo(value, duration, type?): Promise<void>

  • Parameters

    • value: number
    • duration: number
    • Optional type: FadeType

    Returns Promise<void>

pause

play

removeFilter

  • removeFilter(filter): void

  • Parameters

    • filter: BiquadFilterNode

    Returns void

Optional seek

  • seek(time): void

  • Parameters

    • time: number

    Returns void

stop

Optional stopWithFade

  • stopWithFade(duration, type?): Promise<void>

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

isPlayingpositionthreeDOptionsvolumeaddFilterfadeInfadeOutfadeTopauseplayremoveFilterseekstopstopWithFade