Variable ParamMgrFactoryConst

Type declaration

• create:function

  • create<Params, InternalParams>(module, optionsIn?): Promise<ParamMgrNode<Params, InternalParams>>

  • Get a ParamManager as an AudioWorkletNode instance

    The second argument optionsIn decides how ParamMgr should automate parameters and generate WamParameter-compatible AudioParams.

    The option could have three possible properties: paramsConfig, paramsMapping and internalParamsConfig.

    If you do not have to configure one-to-many parameters, please declare internalParamsConfig only, where you can put an AudioParam or an object that contains default, min, max values, automation rate with the onChange callback. The factory will generate automatically automatable AudioParams for you.

    Else, you can declare paramsConfig with exposed parameters' configs. The omitted properties will be filled according the internal parameter with the same name. In the paramsMapping, you can declare how one-to-many parameters maps values to the internal parameters. *

    Type Parameters

    • Params extends string = string

    • InternalParams extends string = string

    Parameters

    • module: WebAudioModule<WamNode>

      the module instance

    • Optional optionsIn: ParametersMappingConfiguratorOptions<Params, InternalParams>

      config of the parameters

    Returns Promise<ParamMgrNode<Params, InternalParams>>