Banuba WebAR JavaScript API Reference
    Preparing search index...

    Type Alias PlayerOptions

    type PlayerOptions = {
        devicePixelRatio?: number;
        enableAudio?: boolean;
        logger?: Logger;
        useFutureFilter?: boolean;
        useFutureInterpolate?: boolean;
    }
    Index

    Properties

    devicePixelRatio? enableAudio? logger? useFutureFilter? useFutureInterpolate?

    Properties

    devicePixelRatio?: number

    Ordinary you won't use the option

    Overrides devicePixelRatio used for proper rendering on HiDPI devices

    window.devicePixelRatio

    enableAudio?: boolean
    logger?: Logger

    A custom logger instance, pass {} to suppress all outputs

    window.console

    // suppressing `info` and `debug` messages, displaying only `error` and `warn` ones
    Player.create({
      logger {
       error: console.error.bind(console),
       warn: console.warn.bind(console),
      },
      // ... other options
    })
    useFutureFilter?: boolean

    Use future frame to filtrate prediction, improves stability, adds processed frame inconsistency

    true
    useFutureInterpolate?: boolean

    Use future frame to interpolate prediction, improves performance, adds processed frame inconsistency

    false

    Settings

    On This Page

    Properties