Class: EquirectangularVideoAdapter

PSV.adapters.EquirectangularVideoAdapter

new PSV.adapters.EquirectangularVideoAdapter (psv, options)

Adapter for equirectangular videos

Name Type Description
psv PSV.Viewer
options PSV.adapters.EquirectangularVideoAdapter.Options

Extends

Members

id string readonly inherited overrides

Unique identifier of the adapter

OVERLAY_UNIFORMS inherited overrides

Reference to main controller

supportsDownload boolean readonly inherited overrides

Indicates if the adapter supports panorama download natively

supportsOverlay boolean inherited overrides

Indicated if the adapter can display an additional transparent image above the panorama

Methods

Creates the cube mesh

Name Type Default Description
scale number 1 optional
Returns:
Type Description
external:THREE.Mesh

destroy () inherited overrides

Destroys the adapter

disposeTexture (textureData) abstract inherited overrides

Clear a loaded texture from memory

Name Type Description
textureData PSV.TextureData

loadTexture (panorama)Promise.<PSV.TextureData> inherited overrides

Loads the panorama texture(s)

Name Type Description
panorama PSV.adapters.EquirectangularVideoAdapter.Video
Returns:
Type Description
Promise.<PSV.TextureData>

setOverlay (mesh, textureData, opacity) abstract inherited overrides

Applies the overlay to the mesh

Name Type Description
mesh external:THREE.Mesh
textureData PSV.TextureData
opacity number

setTexture (mesh, textureData, transition) inherited overrides

Applies the texture to the mesh

Name Type Default Description
mesh external:THREE.Mesh
textureData PSV.TextureData
transition boolean false optional

setTextureOpacity (mesh, opacity) abstract inherited overrides

Changes the opacity of the mesh

Name Type Description
mesh external:THREE.Mesh
opacity number

supportsPreload (panorama)boolean inherited overrides

Indicates if the adapter supports preload of a panorama

Name Type Description
panorama *
Returns:
Type Description
boolean

supportsTransition (panorama)boolean inherited overrides

Indicates if the adapter supports transitions between panoramas

Name Type Description
panorama *
Returns:
Type Description
boolean

Type Definitions

PSV.adapters.EquirectangularVideoAdapter.Options Object

Properties:
Name Type Argument Default Description
autoplay boolean <optional>
false

automatically start the video

muted boolean <optional>
autoplay

initially mute the video

resolution number <optional>
64

number of faces of the sphere geometry, higher values may decrease performances

PSV.adapters.EquirectangularVideoAdapter.Video Object

Object defining a video

Properties:
Name Type Description
source string