PluginDefinition
Source declaration reusable across Player instances.
You are reading the v8 docsDev
InterfaceTypeScript@discord-player/plugin-host
View sourcepackages/plugin-host/src/plugins/types.ts:240interface PluginDefinition<Options>Source declaration reusable across Player instances.
Properties
id
id: stringUnique registration identifier.
remoteHostoptional
remoteHost?: RemotePluginHostOptionsExisting HTTP deployment providing this provider's metadata capabilities.
priorityoptional
priority?: numberDefault operation priority.
Methods
setupoptional
setup(ctx: PluginContext<Options>): void | Promise<void>Initialize owned resources and handlers.
Parameters
| Name | Type | Description |
|---|---|---|
| ctx | PluginContext<Options> | Registration context. |
Returns
void | Promise<void>
destroyoptional
destroy(ctx: PluginContext<Options>): void | Promise<void>Optional teardown after calls have drained.
Parameters
| Name | Type | Description |
|---|---|---|
| ctx | PluginContext<Options> | Registration context. |
Returns
void | Promise<void>