Interface CreateSessionOptions

Options available when creating a CameraKitSession.

interface CreateSessionOptions {
    liveRenderTarget?: HTMLCanvasElement;
    renderWhileTabHidden?: boolean;
}

Properties

liveRenderTarget? renderWhileTabHidden?

Properties

OptionalliveRenderTarget

liveRenderTarget?: HTMLCanvasElement

Optionally provide an existing canvas element, on which the Live RenderTarget will be rendered.

If this is not provided, CameraKit will create a new canvas element which can be added to the DOM.

OptionalrenderWhileTabHidden

renderWhileTabHidden?: boolean

Browsers optimize tabs when they are hidden - for example, by pausing the execution of requestAnimationFrame callbacks.

If you need the CameraKitSession to continue rendering even when the tab is in the background, set this to true. There is a small performance penalty, and it's a good practice to only render in the background if absolutely necessary.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR