require(["esri/layers/support/VideoElement"], (VideoElement) => { /* code goes here */ });
import VideoElement from "@arcgis/core/layers/support/VideoElement.js";
esri/layers/support/VideoElement
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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The video content referenced in the video element instance. | VideoElement | ||
The name of the class. | Accessor | ||
The geographic location of the image or video element to be placed on the map. | VideoElement | ||
The opacity of the element. | VideoElement | ||
The element type. | VideoElement | ||
The video element to be added to the media layer's source. | VideoElement |
Property Details
-
content
content HTMLVideoElementreadonly
-
The video content referenced in the video element instance. The content matches the video referenced in the video parameter.
-
georeference
georeference ExtentAndRotationGeoreference |CornersGeoreference |ControlPointsGeoreference
-
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, the corner points of the bounding box, or by defining control points.
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({ image: "https://arcgis.github.io/arcgis-samples-javascript/sample-data/media-layer/new-orleans/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 }), bottomLeft: new Point({ x: -122.363, y: 45.061 }), topRight: new Point({ x: -121.369, y: 45.678 }), topLeft: new Point({ x: -122.363, y: 45.678 }) }) });
// georeference an ImageElement, using ControlPointsGeoreference in the // North American Datum 1927 spatial reference const spatialReference = new SpatialReference({ wkid: 4267 }); const swCorner = { sourcePoint: { x: 80, y: 1732 }, mapPoint: new Point({ x: -107.875, y: 37.875, spatialReference }) }; const nwCorner = { sourcePoint: { x: 75, y: 102 }, mapPoint: new Point({ x: -107.875, y: 38, spatialReference }) }; const neCorner = { sourcePoint: { x: 1353, y: 99 }, mapPoint: new Point({ x: -107.75, y: 38, spatialReference }) }; const seCorner = { sourcePoint: { x: 1361, y: 1721 }, mapPoint: new Point({ x: -107.75, y: 37.875, spatialReference }) }; const controlPoints = [swCorner, nwCorner, neCorner, seCorner]; const georeference = new ControlPointsGeoreference({ controlPoints, width: 1991, height: 2500 }); const imageElement = new ImageElement({ image: "https://jsapi.maps.arcgis.com/sharing/rest/content/items/1a3df04e7d734535a3a6a09dfec5a6b2/data", georeference });
-
opacity
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
type Stringreadonly
-
The element type.
For VideoElement the type is always "video".
-
video
video String |HTMLVideoElement
-
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" });
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");