Scrypted Development

Appearance

Scrypted Documentation / ScryptedStatic

Interface: ScryptedStatic ​

Properties ​

log? ​

optional log: Logger

Deprecated ​

deviceManager ​

deviceManager: DeviceManager

endpointManager ​

endpointManager: EndpointManager

mediaManager ​

mediaManager: MediaManager

systemManager ​

systemManager: SystemManager

serverVersion? ​

optional serverVersion: string

pluginHostAPI ​

pluginHostAPI: any

pluginRemoteAPI ​

pluginRemoteAPI: any

Methods ​

fork() ​

fork<T>(options?): PluginFork<T>

Start a new instance of the plugin, returning an instance of the new process and the result of the fork method.

Type Parameters ​

• T

Parameters ​

• options?: ForkOptions

Returns ​

PluginFork<T>

connect() ​

connect(socket, options?): void

Initiate the Scrypted RPC wire protocol on a socket.

Parameters ​

• socket: Socket

• options?: ConnectOptions

Returns ​

void

connectRPCObject() ​

connectRPCObject<T>(value): Promise<T>

Attempt to retrieve an RPC object by directly connecting to the plugin that created the object. All operations on this object will bypass routing through the Scrypted Server which typically manages plugin communication. This is ideal for sending large amounts of data.

Type Parameters ​

• T

Parameters ​

• value: T

Returns ​

Promise<T>