Skip to main content

Class: PresenterClient

Client for synchronizing a custom presenter view with the main presentation window via BroadcastChannel.

Constructors​

Constructor​

new PresenterClient(channelName?: string): PresenterClient

Parameters​

ParameterTypeDefault value
channelNamestring"stageroutine-channel"

Returns​

PresenterClient

Methods​

close()​

close(): void

Closes the presenter communication channel.

Returns​

void


gotoScene()​

gotoScene(sceneIndex: number): void

Jumps directly to a scene by 0-based index.

Parameters​

ParameterType
sceneIndexnumber

Returns​

void


gotoStep()​

gotoStep(stepIndex: number): void

Jumps directly to a step by 0-based index.

Parameters​

ParameterType
stepIndexnumber

Returns​

void


next()​

next(): void

Advances the presentation to the next step.

Returns​

void


onUpdate()​

onUpdate(callback: (msg: StageStateChangedEvent) => void): void

Registers a callback invoked whenever the presentation state changes.

Parameters​

ParameterTypeDescription
callback(msg: StageStateChangedEvent) => voidReceives the latest StageStateChangedEvent payload.

Returns​

void


prev()​

prev(): void

Returns the presentation to the previous step.

Returns​

void