Interface CreateViewerSessionOptions

interface CreateViewerSessionOptions {
    provider: ViewerSessionProvider;
    roomName: string;
    displayName?: string;
    pollIntervalMs?: number;
    heartbeatIntervalMs?: number;
    onChange?: (snapshot: ViewerSessionSnapshot) => void;
}

Index

Properties

provider roomName displayName? pollIntervalMs? heartbeatIntervalMs? onChange?

Properties

provider

provider: ViewerSessionProvider

roomName

roomName: string

`Optional`displayName

displayName?: string

`Optional`pollIntervalMs

pollIntervalMs?: number

Poll interval for approval, ms. Defaults to 5000.

`Optional`heartbeatIntervalMs

heartbeatIntervalMs?: number

Heartbeat interval, ms. Defaults to 30000. Ignored without a heartbeat.

`Optional`onChange

onChange?: (snapshot: ViewerSessionSnapshot) => void

Called on every state change.