com.bitmovin.player.api

Interface VrApi

public VrApi

Method Detail

getGyroscopicOrientationProvider

@Nullable
com.bitmovin.player.vr.orientation.OrientationProvider getGyroscopicOrientationProvider()

The gyroscopic OrientationProvider that is used for VR control.

setGyroscopicOrientationProvider

void setGyroscopicOrientationProvider(@Nullable
                                      com.bitmovin.player.vr.orientation.OrientationProvider p)

The gyroscopic OrientationProvider that is used for VR control.

getTouchOrientationProvider

@Nullable
com.bitmovin.player.vr.orientation.OrientationProvider getTouchOrientationProvider()

The touch OrientationProvider that is used for VR control.

setTouchOrientationProvider

void setTouchOrientationProvider(@Nullable
                                 com.bitmovin.player.vr.orientation.OrientationProvider p)

The touch OrientationProvider that is used for VR control.

isGyroscopeEnabled

boolean isGyroscopeEnabled()

Specifies whether the gyroscope of the device is enabled.

setGyroscopeEnabled

void setGyroscopeEnabled(boolean p)

Specifies whether the gyroscope of the device is enabled.

isTouchControlEnabled

boolean isTouchControlEnabled()

Specifies whether the touch controls of the device are enabled.

setTouchControlEnabled

void setTouchControlEnabled(boolean p)

Specifies whether the touch controls of the device are enabled.

isStereo

boolean isStereo()

Specifies whether stereo mode is enabled.

setStereo

void setStereo(boolean p)

Specifies whether stereo mode is enabled.

getViewingDirection

@Nullable
ViewingDirection getViewingDirection()

The current viewing direction.

setViewingDirection

void setViewingDirection(@Nullable
                         ViewingDirection p)

The current viewing direction.

getViewingDirectionChangeThreshold

double getViewingDirectionChangeThreshold()

The number of degrees that the viewport can change before the class VRViewingDirectionChangeEvent is triggered. The default value is 5°.

See Also:

class VRViewingDirectionChangeEvent

setViewingDirectionChangeThreshold

void setViewingDirectionChangeThreshold(double p)

The number of degrees that the viewport can change before the class VRViewingDirectionChangeEvent is triggered. The default value is 5°.

See Also:

class VRViewingDirectionChangeEvent

getViewingDirectionChangeEventInterval

double getViewingDirectionChangeEventInterval()

The minimal interval between consecutive class VRViewingDirectionChangeEvents. The default value is 250ms.

See Also:

class VRViewingDirectionChangeEvent

setViewingDirectionChangeEventInterval

void setViewingDirectionChangeEventInterval(double p)

The minimal interval between consecutive class VRViewingDirectionChangeEvents. The default value is 250ms.

See Also:

class VRViewingDirectionChangeEvent

moveViewingDirection

void moveViewingDirection(@NotNull
                          Vector3 direction)

Moves the current VR viewing direction in the given direction with the given speed by passing a three-component class Vector3. 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.

See Also:

direction, class Vector3

setVrRenderer

void setVrRenderer(@Nullable
                   com.bitmovin.player.vr.VrRenderer renderer)

Sets the VrRenderer that is used to modify VR properties.