Skip to main content

Class: CanvasRecorderPlugin

Plugins.CanvasRecorderPlugin

Hierarchy

  • AViewerPlugin<"start" | "stop" | "error">

    CanvasRecorderPlugin

Implements

Properties

PluginType

Static Readonly PluginType: "CanvasRecorder"

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:24


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:14


convergeMode

convergeMode: boolean = false

Implementation of

IConvergedCanvasRecorder.convergeMode

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:30


mimeType

mimeType: string = 'auto'

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:34


videoFrameRate

videoFrameRate: number = 30

Implementation of

IConvergedCanvasRecorder.videoFrameRate

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:38


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22


recorder

get recorder(): undefined | CanvasRecorder

Returns

undefined | CanvasRecorder

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:16


uiConfig

get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:153

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:47


fromJSON

fromJSON(data, meta?): null | CanvasRecorderPlugin | Promise<null | CanvasRecorderPlugin>

Parameters

NameType
dataany
meta?any

Returns

null | CanvasRecorderPlugin | Promise<null | CanvasRecorderPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:54


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"start" | "serialize" | "deserialize" | "stop" | "error"
listener(event: IEvent<"start" | "serialize" | "deserialize" | "stop" | "error">) => void

Returns

void

Inherited from

AViewerPlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"start" | "serialize" | "deserialize" | "stop" | "error"
listener(event: IEvent<"start" | "serialize" | "deserialize" | "stop" | "error">) => void

Returns

boolean

Inherited from

AViewerPlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"start" | "serialize" | "deserialize" | "stop" | "error"
listener(event: IEvent<"start" | "serialize" | "deserialize" | "stop" | "error">) => void

Returns

void

Inherited from

AViewerPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"start" | "serialize" | "deserialize" | "stop" | "error">

Returns

void

Inherited from

AViewerPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


isRecording

isRecording(): boolean

Returns

boolean

Implementation of

IConvergedCanvasRecorder.isRecording

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:20


refreshRecorderOptions

refreshRecorderOptions(): void

Returns

void

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:40


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:52


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:115


startRecording

startRecording(): boolean

Returns

boolean

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:123


stopRecording

stopRecording(): Promise<undefined | Blob>

Returns

Promise<undefined | Blob>

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:145

Constructors

constructor

new CanvasRecorderPlugin()

Inherited from

AViewerPlugin.constructor

Defined in

webgi/src/helpers/EventDispatcher.ts:39