Interface IParameterManager

Describes functionality to manage our parameters in various aspects, including initialization, cleanup, and simple getter methods.

interface IParameterManager {
    cleanup(): void;
    getParameter<T extends ParameterType>(
        id: string,
    ): undefined | ParameterFromType<T>;
    getParameters(): Record<string, Parameter>;
    hasParameter(id: string): boolean;
    initializeParameters(): Promise<void>;
    registerParameter<T extends ParameterType>(
        config: ParameterConfigFromType<T>,
    ): ParameterFromType<T>;
    removeParameter(id: string): void;
    resetParameters(source?: ParameterChangeSource): void;
}

Implemented by

ParameterManager

Index

Methods

cleanup getParameter getParameters hasParameter initializeParameters registerParameter removeParameter resetParameters

Methods

cleanup

cleanup(): void
Removes all event subscribers and ensures no dangling listeners, etc.

Returns void
- Defined in parameter/parameter.types.ts:367

getParameter

getParameter<T extends ParameterType>(
id: string,
): undefined | ParameterFromType<T>
Retrieve the parameter object with the given ID.
Type Parameters
- T extends ParameterType
Parameters
- id: string
Returns undefined | ParameterFromType<T>
- Defined in parameter/parameter.types.ts:342

getParameters

getParameters(): Record<string, Parameter>
Retrieve all parameters.

Returns Record<string, Parameter>
- Defined in parameter/parameter.types.ts:347

hasParameter

hasParameter(id: string): boolean
Checks whether there is a parameter with the given ID.
Parameters
- id: string
Returns boolean
- Defined in parameter/parameter.types.ts:352

initializeParameters

initializeParameters(): Promise<void>
Loads and initializes parameters from data embedded in the backend.

CAUTION: You MUST define the "getParametersJsonData" native function in the backend code that initializes the juce::WebBrowserComponent.

Returns Promise<void>
- Defined in parameter/parameter.types.ts:331

registerParameter

registerParameter<T extends ParameterType>(
config: ParameterConfigFromType<T>,
): ParameterFromType<T>
Sets up the workings for a single parameter, creating the object and wiring up bidirectional communication with the backend.
Type Parameters
- T extends ParameterType
Parameters
- config: ParameterConfigFromType<T>
Returns ParameterFromType<T>
- Defined in parameter/parameter.types.ts:337

removeParameter

removeParameter(id: string): void
Removes the parameter with the given ID if it exists.
Parameters
- id: string
Returns void
- Defined in parameter/parameter.types.ts:357

resetParameters

resetParameters(source?: ParameterChangeSource): void
Resets all parameters to their default values.
Parameters
- Optionalsource: ParameterChangeSource
Returns void
- Defined in parameter/parameter.types.ts:362