PreviewCanvasControllerOptions

Defined in: packages/sdk/src/preview-controller.ts:7

Properties

adaptiveScales?

readonly optional adaptiveScales: readonly number[]

Defined in: packages/sdk/src/preview-controller.ts:19

---

background?

readonly optional background: string

Defined in: packages/sdk/src/preview-controller.ts:11

---

fit?

readonly optional fit: "fill" | "contain" | "cover"

Defined in: packages/sdk/src/preview-controller.ts:10

---

onError()?

readonly optional onError: (error) => void

Defined in: packages/sdk/src/preview-controller.ts:22

Parameters

error

unknown

Returns

void

---

onFrame()?

readonly optional onFrame: (frame) => void

Defined in: packages/sdk/src/preview-controller.ts:21

Parameters

frame

PreviewCanvasFrame

Returns

void

---

onPointer()?

readonly optional onPointer: (event) => void

Defined in: packages/sdk/src/preview-controller.ts:20

Parameters

event

PreviewCanvasPointerEvent

Returns

void

---

pauseWhenHidden?

readonly optional pauseWhenHidden: boolean

Defined in: packages/sdk/src/preview-controller.ts:16

Pause playback while the page is hidden and resume it when visible.

---

pixelRatio?

readonly optional pixelRatio: number

Defined in: packages/sdk/src/preview-controller.ts:12

---

quality?

readonly optional quality: PreviewCanvasQuality

Defined in: packages/sdk/src/preview-controller.ts:8

---

renderOnResize?

readonly optional renderOnResize: boolean

Defined in: packages/sdk/src/preview-controller.ts:17

---

renderScale?

readonly optional renderScale: number

Defined in: packages/sdk/src/preview-controller.ts:9

---

subscribePlayer?

readonly optional subscribePlayer: boolean

Defined in: packages/sdk/src/preview-controller.ts:14

Own Player frames and draw them to the Canvas. Defaults to true.

---

targetFrameMs?

readonly optional targetFrameMs: number

Defined in: packages/sdk/src/preview-controller.ts:18