Interface AudioParam

Cacophony's own audio type interfaces.

These are minimal structural interfaces covering only what Cacophony actually uses. Both the native Web Audio API and standardized-audio-context satisfy these structurally, so users can pass either.

interface AudioParam {
    value: number;
    cancelScheduledValues(cancelTime: number): AudioParam;
    exponentialRampToValueAtTime(value: number, endTime: number): AudioParam;
    linearRampToValueAtTime(value: number, endTime: number): AudioParam;
    setTargetAtTime?(
        target: number,
        startTime: number,
        timeConstant: number,
    ): AudioParam;
    setValueAtTime(value: number, startTime: number): AudioParam;
}

Index

Properties

Methods

cancelScheduledValues exponentialRampToValueAtTime linearRampToValueAtTime setTargetAtTime? setValueAtTime

Properties

value

value: number

Methods

cancelScheduledValues

cancelScheduledValues(cancelTime: number): AudioParam
Parameters
- cancelTime: number
Returns AudioParam
- Defined in src/context.ts:18

exponentialRampToValueAtTime

exponentialRampToValueAtTime(value: number, endTime: number): AudioParam
Parameters
- value: number
- endTime: number
Returns AudioParam
- Defined in src/context.ts:17

linearRampToValueAtTime

linearRampToValueAtTime(value: number, endTime: number): AudioParam
Parameters
- value: number
- endTime: number
Returns AudioParam
- Defined in src/context.ts:16

`Optional`setTargetAtTime

setTargetAtTime?(
    target: number,
    startTime: number,
    timeConstant: number,
): AudioParam
Optional for custom hosts; spatial setters stay immediate when unavailable.
Parameters
- target: number
- startTime: number
- timeConstant: number
Returns AudioParam
- Defined in src/context.ts:20

setValueAtTime

setValueAtTime(value: number, startTime: number): AudioParam
Parameters
- value: number
- startTime: number
Returns AudioParam
- Defined in src/context.ts:15