Interface ControllerSocketPorts

interface ControllerSocketPorts {
    url: string;
    token: string | null;
    onEvent?: (name: string, payload: unknown) => void;
    onStatus?: (status: ControllerStatus) => void;
    openSocket?: (url: string) => ControlSocketLike;
}

Properties

url: string

Hub URL, already validated by normalizeControlSocketUrl.

token: string | null

Shared secret to present as ?token=, or null for an open hub.

onEvent?: (name: string, payload: unknown) => void

An event pushed by the viewer.

onStatus?: (status: ControllerStatus) => void

Connection state changed.

openSocket?: (url: string) => ControlSocketLike

Socket factory, injectable for tests.