Skip to content

Interface: RemoteClientOptions

Defined in: remote.ts:107

Properties

mode

mode: () => PencilMode

Defined in: remote.ts:114

Returns

PencilMode


onHostGone?

optional onHostGone?: () => void

Defined in: remote.ts:120

Returns

void


onSignal?

optional onSignal?: (data) => void

Defined in: remote.ts:119

WebRTC signaling from the host — feed it straight to the peer connection.

Parameters

data

unknown

Returns

void


onVideoStatus?

optional onVideoStatus?: (status) => void

Defined in: remote.ts:117

Parameters

status

VideoStatus

Returns

void


overrides?

optional overrides?: () => StrokeOverrides | undefined

Defined in: remote.ts:116

The user's brush knobs, when the host's presentation offers them.

Returns

StrokeOverrides | undefined


send

send: (message) => void

Defined in: remote.ts:109

Put a message on the wire.

Parameters

message

ClientToRelay

Returns

void


surface

surface: () => Surface

Defined in: remote.ts:111

The preview canvas, in CSS px — what local coordinates are normalized against.

Returns

Surface


tool

tool: () => Tool

Defined in: remote.ts:113

The instrument, as the iPad currently holds it.

Returns

Tool