mmir-webpack/docs/interfaces/mmir_tooling.pluginoptions.md

Integration for MMIR library in webpack builds

**[mmir-webpack 7.0.0-beta1](../README.md)**

> [Globals](../README.md) / [mmir-tooling](../modules/mmir_tooling.md) / PluginOptions

# Interface: PluginOptions

**`example`** 
```
var includePlugins = [
	{id: 'mmir-plugin-asr-nuance-xhr', config: {
   // ctx: 'nuance',//OPTIONAL install into sub-context "nuance"
     appKey: "9...",
     appId: "NMDPTRIAL....",
	}},
 {id: 'mmir-plugin-asr-google-xhr',
   mode: 'wasm',
   config: {
     appKey: 'A....',
     results: 5
 }},
 {id: 'mmir-plugin-tts-nuance-xhr', config: {
   appKey: "9....",
   appId: "NMDPTRIAL_...",
   voice: {fr: 'Samantha'},
   language: {ja: 'jpn-JPN'}
 }},
 {id: 'mmir-plugin-tts-speakjs', config: {
   env: 'browser',
   ctx: 'local' //OPTIONAL install into sub-context "local"
 }},
 {id: 'mmir-plugin-speech-android', config: {
   // ctx: 'android',//OPTIONAL install into sub-context "android"
   voice: {de: 'male'},
   language: {en: 'eng-IND'}
 }},
];
```

## Hierarchy

* **PluginOptions**

## Index

### Properties

* [build](mmir_tooling.pluginoptions.md#build)
* [config](mmir_tooling.pluginoptions.md#config)
* [id](mmir_tooling.pluginoptions.md#id)
* [mode](mmir_tooling.pluginoptions.md#mode)

## Properties

### build

• `Optional` **build**: Array<[PluginExportConfigInfo](mmir_tooling.pluginexportconfiginfo.md) \| [PluginExportConfigInfoMultiple](mmir_tooling.pluginexportconfiginfomultiple.md)\>

if supported by plugin:
custom build options.

NOTE if the plugin does not support custom build configuration, this
     will be ignored.

___

### config

• `Optional` **config**: [PluginConfig](../modules/mmir_tooling.md#pluginconfig) \| [TTSPluginSpeechConfig](mmir_tooling.ttspluginspeechconfig.md)

configuration for the plugin: specific fields/values depending on the plugin
NOTE some plugins require credentials, e.g. "appId" and "appKey"

___

### id

•  **id**: string

the (package) ID of the plugin
NOTE: the plugin needs to be installed, i.e. "npm install ..."

___

### mode

• `Optional` **mode**: [PluginModeOption](../modules/mmir_tooling.md#pluginmodeoption)

mode for including the plugin: if the plugin does not support the specified mode, will automatically use "default" mode