Interface VRConfiguration

Describes the configuration of the virtual reality feature of a source.

Remarks


- Available since v2.12.0.
- See the VR API to control display of VR videos.

interface VRConfiguration {
    360?: boolean;
    nativeVR?: boolean;
    panoramaMode?: VRPanoramaMode;
    stereoMode?: VRStereoMode;
}

Properties

360? nativeVR? panoramaMode? stereoMode?

Properties

Optional 360

360?: boolean

Whether the source contains 360° video content.

Default Value

false

Optional nativeVR

nativeVR?: boolean

Whether the source plays using native VR.

Remarks


- This property is only available for iOS.

Default Value

false

Optional panoramaMode

panoramaMode?: VRPanoramaMode

The panorama mode of the media.

Remarks


- If the "360" property is set to true, panoramaMode is ignored and the content will be displayed as 360 degrees panorama.

Default Value

undefined

Optional stereoMode

stereoMode?: VRStereoMode

The stereoscopic mode of the media.

Default Value

''

Settings

Member Visibility

Theme

On This Page

360nativeVRpanoramaModestereoMode

Generated using TypeDoc