Class: CanvasRecorderPlugin

Plugins.CanvasRecorderPlugin

Hierarchy

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

  ↳ CanvasRecorderPlugin

Implements

• IConvergedCanvasRecorder

Properties

PluginType

▪ Static Readonly PluginType: "CanvasRecorder"

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

convergeMode

• convergeMode: boolean = true

Implementation of

IConvergedCanvasRecorder.convergeMode

---

mimeType

• mimeType: string = 'video/mp4'

---

videoFrameRate

• videoFrameRate: number = 30

Implementation of

IConvergedCanvasRecorder.videoFrameRate

---

endPaddingMs

• endPaddingMs: number = 500

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer

---

recorder

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

Returns

undefined | ICanvasRecorder<any>

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

---

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

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

---

isRecording

▸ isRecording(): boolean

Returns

boolean

Implementation of

IConvergedCanvasRecorder.isRecording

---

refreshRecorderOptions

▸ refreshRecorderOptions(): void

Returns

void

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

---

record

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

Parameters

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

Returns

Promise<undefined | Blob>

---

startRecording

▸ startRecording(): boolean

Returns

boolean

---

stopRecording

▸ stopRecording(): Promise<undefined | Blob>

Returns

Promise<undefined | Blob>

---

download360Recording

▸ download360Recording(duration?, ccw?, angle?, ease?): Promise<void>

Prompts for duration if not specified

Parameters

Name	Type	Default value
duration	null | number	null
ccw	boolean	false
angle	number	360
ease?	Easing	undefined

Returns

Promise<void>

---

recordCamera360

▸ recordCamera360(durationNum, ccw?, angle?, ease?): Promise<undefined | Blob>

Parameters

Name	Type	Default value
durationNum	number	undefined
ccw	boolean	false
angle	number	360
ease?	Easing	undefined

Returns

Promise<undefined | Blob>

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

---

_getRecorder

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

Parameters

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

Returns

undefined | ICanvasRecorder<any>

Constructors

constructor

• new CanvasRecorderPlugin()

Overrides

AViewerPlugin.constructor