Class: CanvasRecorderPlugin

Plugins.CanvasRecorderPlugin

Hierarchy

• AViewerPlugin<"start" | "stop" | "error" | "encode-progress">

  ↳ CanvasRecorderPlugin

Implements

• IConvergedCanvasRecorder

Properties

PluginType

▪ Static Readonly PluginType: "CanvasRecorder"

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:34

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:19

---

convergeMode

• convergeMode: boolean = true

Implementation of

IConvergedCanvasRecorder.convergeMode

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:42

---

mimeType

• mimeType: string = 'video/mp4'

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:45

---

videoFrameRate

• videoFrameRate: number = 30

Implementation of

IConvergedCanvasRecorder.videoFrameRate

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:49

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:211

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

---

recorder

• get recorder(): undefined | ICanvasRecorder<any>

Returns

undefined | ICanvasRecorder<any>

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:21

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:45

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | CanvasRecorderPlugin | Promise<null | CanvasRecorderPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84

---

isRecording

▸ isRecording(): boolean

Returns

boolean

Implementation of

IConvergedCanvasRecorder.isRecording

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:30

---

refreshRecorderOptions

▸ refreshRecorderOptions(): void

Returns

void

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:54

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:73

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:134

---

record

▸ record(action, onStart?): Promise<undefined | Blob>

Parameters

Name	Type
action	() => Promise<any>
onStart?	() => void

Returns

Promise<undefined | Blob>

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:145

---

startRecording

▸ startRecording(): boolean

Returns

boolean

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:184

---

stopRecording

▸ stopRecording(): Promise<undefined | Blob>

Returns

Promise<undefined | Blob>

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:195

---

recordCamera360

▸ recordCamera360(durationNum): Promise<undefined | Blob>

Parameters

Name	Type
durationNum	number

Returns

Promise<undefined | Blob>

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:330

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

---

_getRecorder

▸ Protected _getRecorder(type): undefined | ICanvasRecorder<any>

Parameters

Name	Type
type	"image" | "ffmpeg.js" | "canvas-media"

Returns

undefined | ICanvasRecorder<any>

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:372

Constructors

constructor

• new CanvasRecorderPlugin()

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/CanvasRecorderPlugin.ts:25