VideoElement

AMD: require(["esri/layers/support/VideoElement"], (VideoElement) => { /* code goes here */ });
ESM: import VideoElement from "@arcgis/core/layers/support/VideoElement";
Class: esri/layers/support/VideoElement
Inheritance: VideoElement Accessor
Since: ArcGIS API for JavaScript 4.24

Represents a video element referenced in the MediaLayer's source. MediaLayer can display videos that are supported by web browsers. Refer to the common codecs document for supported video types.

Coordinates of the image and video elements can be specified in any spatial reference and are projected to the view's spatial reference. The content is stretched linearly between the coordinates, therefore it’s recommended for the image or video to match the view’s spatial reference to align correctly, especially for content covering large areas like the entire earth.

// create a video element by setting video param to point to the video file url
// set the geographic location of the video file on the map using an extent
const element = new VideoElement({
  video: "https://arcgis.github.io/arcgis-samples-javascript/sample-data/media-layer/videos/hurricanes_aerosol-aug.mp4",
  georeference: new ExtentAndRotationGeoreference({
    extent: new Extent({
      xmin: -150,
      ymin: 1,
      xmax: 20,
      ymax: 80,
      spatialReference: {
        wkid: 4326
      }
    })
  })
});
See also:

Constructors

new VideoElement(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
HTMLVideoElementmore details

The video content referenced in the video element instance.

more detailsVideoElement
Stringmore details

The name of the class.

more detailsAccessor
ExtentAndRotationGeoreference|CornersGeoreferencemore details

The geographic location of the image or video element to be placed on the map.

more detailsVideoElement
Numbermore details

The opacity of the element.

more detailsVideoElement
Stringmore details

The element type.

more detailsVideoElement
String|HTMLVideoElementmore details

The video element to be added to the media layer's source.

more detailsVideoElement

Property Details

content HTMLVideoElementreadonly

The video content referenced in the video element instance. The content matches the video referenced in the video parameter.

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

The geographic location of the image or video element to be placed on the map. The location can be set by either specifying extent and rotation of the element, or corner points of the bounding box.

Examples:
// create a new ExtentAndRotationGeoreference
const geoReference = new ExtentAndRotationGeoreference({
  extent: new Extent({
    spatialReference: {
      wkid: 102100
    },
    xmin: -10047456.27662979,
    ymin: 3486722.2723874687,
    xmax: -10006982.870152846,
    ymax: 3514468.91365495
  })
});
const imageElement = new ImageElement({
  type: "image",
  image: "https://arcgis.github.io/arcgis-samples-javascript/sample-data/media-layer/neworleans1891.png",
  georeference: geoReference
});
// create a canvas image element by setting its corner points of the bounding box
const canvasElement = new ImageElement({
  image: canvas,
  georeference: new CornersGeoreference({
    bottomRight: new Point({
      x: -121.369,
      y: 45.061,
      spatialReference: {
        wkid: 4326
      }
    }),
    bottomLeft: new Point({
      x: -122.363,
      y: 45.061,
      spatialReference: {
        wkid: 4326
      }
    }),
    topRight: new Point({
      x: -121.369,
      y: 45.678,
      spatialReference: {
        wkid: 4326
      }
    }),
    topLeft: new Point({
      x: -122.363,
      y: 45.678,
      spatialReference: {
        wkid: 4326
      }
    })
  })
});
opacity Number

The opacity of the element. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.

Default Value:1
type Stringreadonly

The element type.

For VideoElement the type is always "video".

The video element to be added to the media layer's source. The video element can be URL string pointing the video for example.

Example:
// create a video element by setting video param to point to the video file url
// set the geographic location of the video file on the map using an extent
const element = new VideoElement({
  video: "https://arcgis.github.io/arcgis-samples-javascript/sample-data/media-layer/videos/hurricanes_aerosol-aug.mp4",
  georeference: new ExtentAndRotationGeoreference({
    extent: new Extent({
      xmin: -150,
      ymin: 1,
      xmax: 20,
      ymax: 80,
      spatialReference: {
        wkid: 4326
      }
    })
  })
});

// add the video element to the media layer
const layer = new MediaLayer({
  source: [element],
  title: "2017 Hurricanes and Aerosols Simulation",
  copyright: "NASA's Goddard Space Flight Center"
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.