Class: abstract Plugin<Config>

Abstract base class for all plugins, extending Module

Extends

• Module

Extended by

• Playback

Type Parameters

• Config = any

Constructors

new Plugin()

new Plugin<Config>(ctx): Plugin<Config>

Constructor for the Plugin class

Parameters

• ctx: Context

The VxdkContext instance

Returns

Plugin<Config>

Overrides

Module.constructor

Defined in

modules/common/module.ts:55 (opens in a new tab)

Properties

hooks

hooks: Hook<Plugin<Config>>

Inherited from

Module.hooks

Defined in

modules/common/module.ts:22 (opens in a new tab)

name

abstract name: string

Inherited from

Module.name

Defined in

modules/common/module.ts:21 (opens in a new tab)

type

readonly type: PluginType = PluginType.PLUGIN

Defined in

modules/common/module.ts:49 (opens in a new tab)

Accessors

bridge

get protected bridge(): PlatformBridgeController

Protected getter for the bridge instance

Returns

PlatformBridgeController

Defined in

modules/common/module.ts:85 (opens in a new tab)

controller

get protected controller(): Controller

Protected getter for the controller instance

Returns

Controller

Defined in

modules/common/module.ts:78 (opens in a new tab)

emit

get protected emit(): (name, data?) => void

Protected getter for the 'emit' event emission method

Returns

Function

Parameters

• name: string | number

• data?: undefined

Returns

void

Defined in

modules/common/module.ts:128 (opens in a new tab)

emitIfChanged

get protected emitIfChanged(): (name, data) => void

Protected getter for the 'emitIfChanged' event emission method

Returns

Function

Parameters

• name: string | number

• data: any

Returns

void

Defined in

modules/common/module.ts:135 (opens in a new tab)

events

get protected events(): string[]

Protected getter for the events array

Returns

string[]

Array of event names

Defined in

modules/common/module.ts:114 (opens in a new tab)

logger

get protected logger(): Logger

Protected getter for the logger instance

Returns

Logger

Logger instance for this module

Inherited from

Module.logger

Defined in

modules/common/module.ts:40 (opens in a new tab)

off

get protected off(): (name, listener) => void

Protected getter for the 'off' event unbinding method

Returns

Function

Parameters

• name: string | number

• listener: Listener<void>

Returns

void

Defined in

modules/common/module.ts:99 (opens in a new tab)

on

get protected on(): (name, listener) => Disposable

Protected getter for the 'on' event binding method

Returns

Function

Parameters

• name: string | number

• listener: Listener<void>

Returns

Disposable

Defined in

modules/common/module.ts:92 (opens in a new tab)

once

get protected once(): (name, listener) => void

Protected getter for the 'once' event binding method

Returns

Function

Parameters

• name: string | number

• listener: Listener<void>

Returns

void

Defined in

modules/common/module.ts:106 (opens in a new tab)

storage

get protected storage(): StorageController

Protected getter for the storage instance

Returns

StorageController

Defined in

modules/common/module.ts:71 (opens in a new tab)

Methods

connectedCallback()

connectedCallback(): void

Callback method called when the module is connected

Returns

void

Inherited from

Module.connectedCallback

Defined in

modules/common/module.ts:28 (opens in a new tab)

disconnectedCallback()

disconnectedCallback(): void

Callback method called when the module is disconnected

Returns

void

Inherited from

Module.disconnectedCallback

Defined in

modules/common/module.ts:34 (opens in a new tab)

getConfig()

protected getConfig(): Config

Protected method to get the plugin configuration

Returns

Config

The plugin configuration

Defined in

modules/common/module.ts:64 (opens in a new tab)