VRConfig | Bitmovin Player API 7.8.25

Example:

source: {
  dash : 'http://path/to/mpd/file.mpd',
  vr: {
    contentType: bitmovin.player.VR.CONTENT_TYPE.SINGLE,
    startPosition: 180,
    initialRotation: true,
    initialRotateRate: 0.025
  }
}

Hierarchy

VRConfig

Index

Properties

Optional apiControl

apiControl: VRControlConfig

The api control config.

Optional cardboard

cardboard: string

Allows to set a cardboard config as string to adjust the VR/360 rendering to a specific cardboard device. The QR codes on cardboards contain short URLs, which lead to a long URL, e.g. http://google.com/cardboard/cfg?p=CghSZWQgQnVsbBILUmVkIEJ1bGwgVlId7FE4PSWPwnU9KhAAAEhCAABIQgAASEIAAEhCWAA1KVwPPToICtcjPArXIzxQAGAC. The content of parameter p should be used as string.

Example:

{
  ...
  cardboard:
'CghSZWQgQnVsbBILUmVkIEJ1bGwgVlId7FE4PSWPwnU9KhAAAEhCAABIQgAASEIAAEhCWAA1KVwPPToICtcjPArXIzxQAGAC'
}

Optional contentFieldOfView

contentFieldOfView: number

Specifies the width of the content, stated in degrees.

contentType

contentType: ContentType

Specifies the type of the VR/360 content.

Optional enableFrameRateMeasurements

enableFrameRateMeasurements: boolean

Specifies whether performance measurements shall be enabled or not.

Optional horizontalFieldOfView

horizontalFieldOfView: number

Specifies the horizontal field of view in degrees.

Optional keyboardControl

keyboardControl: VRKeyboardControlConfig

The keyboard control config.

Optional mouseControl

mouseControl: VRControlConfig

The mouse control config.

Optional restrictedInlinePlayback

restrictedInlinePlayback: boolean

Specifies whether the restricted inline playback shall be used or not.

Optional startPosition

startPosition: number

Specifies the starting viewpoint, stated in degrees.

Optional stereo

stereo: boolean

Specifies if the video should start in stereo mode (true) or not (false, default).

Optional verticalFieldOfView

verticalFieldOfView: number

Specifies the vertical field of view in degrees.

Optional viewingDirectionChangeEventInterval

viewingDirectionChangeEventInterval: number

The minimal interval between consecutive ON_VR_VIEWING_DIRECTION_CHANGE events.

Optional viewingDirectionChangeThreshold

viewingDirectionChangeThreshold: number

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

Optional viewingWindow

viewingWindow: VRViewingWindowConfig

Specifies the angles the user can view around within the VR/360 video. Per default, the user has no limitations.