AframeConfig

Members

components

:akamai.amp.aframe.AframeConfigComponents

The A-Frame components object.

disableDevicePermissionUI

:boolean

If true, player will disable default's Aframe device-orientation-permission-ui component for requesting user permission to access DeviceOrientation events.

See:

halfViewMode

:boolean

If set, user will only move into the front (180 degrees).

Default Value:
  • false

native

:boolean

set this to true to enable the native Aframe "Enter VR Mode" button on player container.

Default Value:
  • false

renderer

:RenderMode

Specifies the A-Frame renderer to be used. If not explicitly set and the strict flag is disabled, the player defaults to monoscopic rendering.

Example
The player can be configured to use one of the following renderers, depending on the media and context:
 - `sidebyside`: For stereoscopic video formats, suitable for 180° and 360° VR experiences.
 - `mono`: For monoscopic 360° VR views.
 - `audio`: When video rendering is not required, typically used to display a panoramic image as a poster.

resources

:Array

Required plug-in resources such as styles sheets and JS, also A-frame library is required in case don’t want to let the player load A-frame.io library.

rotation

:string

In monoscopic rendering defines the orientation of an entity in degrees, it is represented as X Y Z value degrees.

Default Value:
  • "0 180 0"

strict

:boolean

The strict flag determines whether the player should automatically monoscopic or stereoscopic rendering mode based on the media category.

When set to false (the default), the player will play all content in 360|180 view, regardless of the media category. When set to true, the player will render content as 360|180 if the media category explicitly includes "360" or "180".

Default Value:
  • false
Example
Possible category values:
 - For 180 View: "180", "stereo", "stereoscopic", "half".
 - For 360 View: "360", "mono", "monoscopic", "full", "stereo", "stereoscopic".

const config = {
 media: {
   src: "https://example/my-video.mp4",
   category: ["360", "stereo"], // Renders a stereoscopic 360° video.
 }
}

vrmode

:boolean

If false, VR display mode won't be available regardless of the device capabilities.

Default Value:
  • true