Interface MixinProvider

MixinProviders can add and intercept interfaces to other devices to add or augment their behavior.

Hierarchy

MixinProvider

Index

Methods

canMixin getMixin releaseMixin

Methods

canMixin

canMixin(type: ScryptedDeviceType, interfaces: string[]): Promise<string[]>
Called by the system to determine if this provider can create a mixin for the supplied device. Returns null if a mixin can not be created, otherwise returns a list of new interfaces (which may be an empty list) that are provided by the mixin.
Parameters
- type: ScryptedDeviceType
- interfaces: string[]
Returns Promise<string[]>

getMixin

getMixin(mixinDevice: any, mixinDeviceInterfaces: ScryptedInterface[], mixinDeviceState: DeviceState): Promise<any>
Create a mixin that can be applied to the supplied device.
Parameters
- mixinDevice: any
- mixinDeviceInterfaces: ScryptedInterface[]
- mixinDeviceState: DeviceState
Returns Promise<any>

releaseMixin

releaseMixin(id: string, mixinDevice: any): Promise<void>
Release a mixin device that was previously returned from getMixin.
Parameters
- id: string
- mixinDevice: any
Returns Promise<void>

Generated using TypeDoc