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;
    pause(): void;
    play(): BaseSound[];
    removeFilter(filter): void;
    seek?(time): void;
    stop(): void;
}

Implemented by

Index

Properties

isPlaying position? threeDOptions? volume

Methods

addFilter pause play removeFilter seek? stop

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
- Defined in cacophony.ts:75

pause

pause(): void
Returns void
- Defined in cacophony.ts:74

play

play(): BaseSound[]
Returns BaseSound[]
- Defined in cacophony.ts:71

removeFilter

removeFilter(filter): void
Parameters
- filter: BiquadFilterNode
Returns void
- Defined in cacophony.ts:76

`Optional` seek

seek(time): void
Parameters
- time: number
Returns void
- Defined in cacophony.ts:72

stop

stop(): void
Returns void
- Defined in cacophony.ts:73