Interface PlayerVRAPI

interface PlayerVRAPI {
    deviceOrientationPermissionRequired(): boolean;
    disableGyroscope(): boolean;
    disableKeyboardControl(): boolean;
    disableMouseControl(): boolean;
    enableGyroscope(): boolean;
    enableKeyboardControl(): boolean;
    enableMouseControl(): boolean;
    getHorizontalFieldOfView(): number;
    getLastError(): string;
    getState(): string;
    getStereo(): boolean;
    getVerticalFieldOfView(): number;
    getViewingDirection(): ViewingDirection;
    getViewingDirectionChangeEventInterval(): number;
    getViewingDirectionChangeThreshold(): number;
    getZoom(): number;
    isGyroscopeEnabled(): boolean;
    isKeyboardControlEnabled(): boolean;
    isMouseControlEnabled(): boolean;
    moveViewingDirection(direction): boolean;
    requestDeviceOrientationPermission(): Promise<void>;
    setHorizontalFieldOfView(fieldOfView): boolean;
    setStereo(enableStereo): boolean;
    setVerticalFieldOfView(fieldOfView): boolean;
    setViewingDirection(viewingDirection): boolean;
    setViewingDirectionChangeEventInterval(interval): boolean;
    setViewingDirectionChangeThreshold(threshold): boolean;
    zoom(factor): boolean;
}

Methods

deviceOrientationPermissionRequired disableGyroscope disableKeyboardControl disableMouseControl enableGyroscope enableKeyboardControl enableMouseControl getHorizontalFieldOfView getLastError getState getStereo getVerticalFieldOfView getViewingDirection getViewingDirectionChangeEventInterval getViewingDirectionChangeThreshold getZoom isGyroscopeEnabled isKeyboardControlEnabled isMouseControlEnabled moveViewingDirection requestDeviceOrientationPermission setHorizontalFieldOfView setStereo setVerticalFieldOfView setViewingDirection setViewingDirectionChangeEventInterval setViewingDirectionChangeThreshold zoom

Methods

deviceOrientationPermissionRequired

  • deviceOrientationPermissionRequired(): boolean

  • Returns true, if a permission is required to access device orientation data.

    Returns boolean

    True, if a permission is required, false otherwise.

disableGyroscope

  • disableGyroscope(): boolean

  • Disables the gyroscope (also on VRHMDs).

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

disableKeyboardControl

  • disableKeyboardControl(): boolean

  • Disables the keyboard controls.

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

disableMouseControl

  • disableMouseControl(): boolean

  • Disables the mouse controls.

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

enableGyroscope

  • enableGyroscope(): boolean

  • Enables the gyroscope (also on VRHMDs).

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

enableKeyboardControl

  • enableKeyboardControl(): boolean

  • Enables the keyboard controls.

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

enableMouseControl

  • enableMouseControl(): boolean

  • Enables the mouse controls.

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

getHorizontalFieldOfView

  • getHorizontalFieldOfView(): number

  • Gets the horizontal field of view in degrees.

    Returns number

    • The horizontal field of view in degrees.

getLastError

  • getLastError(): string

  • Returns the last recorded error or null, if no error occurred.

    Returns string

    • The last recorded error.

getState

  • getState(): string

  • Returns the current state of the VR handler or null, if the VR handler is not yet initialized.

    Returns string

    • The current state of the VR handler.

getStereo

  • getStereo(): boolean

  • Returns true, if stereo is enabled, false otherwise.

    Returns boolean

    • True, if stereo is enabled, false otherwise.

getVerticalFieldOfView

  • getVerticalFieldOfView(): number

  • Gets the vertical field of view in degrees.

    Returns number

    • The vertical field of view in degrees.

getViewingDirection

  • getViewingDirection(): ViewingDirection

  • Returns the current viewing direction, if the VRHandler is in the playing state.

    Returns ViewingDirection

    • The current viewing direction.

getViewingDirectionChangeEventInterval

  • getViewingDirectionChangeEventInterval(): number

  • Gets the minimal interval between consecutive VRViewingDirectionChange events.

    Returns number

    • The minimal interval between consecutive VRViewingDirectionChange events.

getViewingDirectionChangeThreshold

  • getViewingDirectionChangeThreshold(): number

  • Gets the number of degrees that the viewport can change before the VRViewingDirectionChange event is triggered.

    Returns number

    • The threshold in degrees that the viewport can change before the VRViewingDirectionChange event is triggered.

getZoom

  • getZoom(): number

  • Returns the current zoom factor.

    Returns number

    • The current zoom factor, if the VRHandler is ready, -1 otherwise.

isGyroscopeEnabled

  • isGyroscopeEnabled(): boolean

  • Returns true, if the gyroscope is enabled, false otherwise.

    Returns boolean

    • True, if the gyroscope is enabled, false otherwise.

isKeyboardControlEnabled

  • isKeyboardControlEnabled(): boolean

  • Returns true, if keyboard controls are enabled, false otherwise.

    Returns boolean

    • True, if keyboard controls are enabled, false otherwise.

isMouseControlEnabled

  • isMouseControlEnabled(): boolean

  • Returns true, if mouse controls are enabled, false otherwise.

    Returns boolean

    • True, if mouse controls are enabled, false otherwise.

moveViewingDirection

  • moveViewingDirection(direction): boolean

  • Moves the current VR viewing direction in the given direction with the given speed. The speed is determined by the length of the direction vector in degrees / second. The movement will be continued for 110ms, after that period the movement will be dampened and fade out. To sustain a smooth viewport movement, no more than 100ms must pass between consecutive calls to this function.

    Parameters

    • direction: Vec3

      A three-component vector describing the direction and speed in which the viewing direction shall be moved.

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

requestDeviceOrientationPermission

  • requestDeviceOrientationPermission(): Promise<void>

  • Requests the permission needed to access device orientation data, if required.

    Returns Promise<void>

    A promise that resolves when the required permissions have been acquired.

setHorizontalFieldOfView

  • setHorizontalFieldOfView(fieldOfView): boolean

  • Sets the horizontal field of view in degrees.

    Parameters

    • fieldOfView: number

      The horizontal field of view in degrees.

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

setStereo

  • setStereo(enableStereo): boolean

  • Enables or disables stereo mode for VR content.

    Parameters

    • enableStereo: boolean

      If true, stereo mode will be enabled.

    Returns boolean

    • True if API call was successful, false otherwise.

setVerticalFieldOfView

  • setVerticalFieldOfView(fieldOfView): boolean

  • Sets the vertical field of view in degrees.

    Parameters

    • fieldOfView: number

      The vertical field of view in degrees.

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

setViewingDirection

  • setViewingDirection(viewingDirection): boolean

  • Sets the given viewing direction, if the VRHandler is in the playing state.

    Parameters

    Returns boolean

    • True, if the viewing direction could be set, false otherwise.

setViewingDirectionChangeEventInterval

  • setViewingDirectionChangeEventInterval(interval): boolean

  • Sets the minimal interval between consecutive VRViewingDirectionChange events. The default value is 250ms.

    Parameters

    • interval: number

      The minimal interval between consecutive VRViewingDirectionChange events.

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

setViewingDirectionChangeThreshold

  • setViewingDirectionChangeThreshold(threshold): boolean

  • Sets the number of degrees that the viewport can change before the VRViewingDirectionChange event is triggered. The default value is 5°.

    Parameters

    • threshold: number

      The threshold in degrees that the viewport can change before the VRViewingDirectionChange event is triggered.

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

zoom

  • zoom(factor): boolean

  • Applies a zoom factor to the current field of view.

    Parameters

    • factor: number

      The zoom factor to apply.

    Returns boolean

    • True, if the VRHandler is ready, false otherwise.

Settings

Member Visibility

Theme

On This Page

deviceOrientationPermissionRequireddisableGyroscopedisableKeyboardControldisableMouseControlenableGyroscopeenableKeyboardControlenableMouseControlgetHorizontalFieldOfViewgetLastErrorgetStategetStereogetVerticalFieldOfViewgetViewingDirectiongetViewingDirectionChangeEventIntervalgetViewingDirectionChangeThresholdgetZoomisGyroscopeEnabledisKeyboardControlEnabledisMouseControlEnabledmoveViewingDirectionrequestDeviceOrientationPermissionsetHorizontalFieldOfViewsetStereosetVerticalFieldOfViewsetViewingDirectionsetViewingDirectionChangeEventIntervalsetViewingDirectionChangeThresholdzoom