Download PDF
Download page VideoExport.
VideoExport
DESCRIPTION
Utility to create a video of animated Map Window(s) in a MetVue project file.
Note: This utility requires running through the HEC-MetVue executable. It is recommended to use the
VideoExport.cmd template in the utilities/windows directory in the build package.
This utility cannot be run while the HEC-MetVue application is running.
Use an .mp4 output filename with the version 3.7 exporter. Although the file selector and older usage text list other extensions, the current export path writes MP4 video.
USAGE
[-orderedMapWindows mappanels] [-start startTime] [-end endTime]
[-step timeStep] [-fps framesPerSecond] [-outputResolution "width,height"]
[-zoomExtents "minlat,maxlat,minlon,maxlon"] [-zoomTo "type:mappanel"]
[-syncZoomToMapWindow mappanel] [-showMapScale] [-mapScaleLocation location]
[-showNorthArrow] [-northArrowLocation location]
[-noLegend] [-legendLocation location] [-showDuration boolean]
-outputFile outputfile
OPTIONS
-projectFile projectfile
Specifies the project file containing the desired map settings.
-session session
Specifies the name of the session containing the desired map settings.
-mapWindow mappanel
Specifies the name of the Map Window containing the desired map settings.
Multiple names can be comma-separated. Use "all" to include all maps.
Default is "all".
If using "all", then only the active Map Windows will be included.
If using a specific Map Windows, then all specified Map Windows will be included, including inactive ones.
-orderedMapWindows mappanel1,mappanel2,...
Specifies the desired order of the Map Windows in the tiled output.
Multiple names should be comma-separated.
-start startTime
Specifies the start time for the animation (ISO8601 format, e.g., 2024-03-03T06:00Z).
-end endTime
Specifies the end time for the animation (ISO8601 format, e.g., 2024-03-03T18:00Z).
-step timeStep
Specifies the time step between frames (ISO8601 duration, e.g., P1D or PT3H).
-fps framesPerSecond
Specifies the frames per second for the output video. Default is 4.
-outputResolution "width,height"
Specifies the total video width and height in pixels, for example "1920,1080". Default is "1280,720".
-zoomExtents "minlat,maxlat,minlon,maxlon"
Specifies the bounding points of the desired image extents in decimal degrees.
The default is to use the settings specified by the projectfile/session/mappanel.
-zoomTo "type:mappanel"
Specifies a thematic zoom for a specific Map Window.
Valid types are:
data - Zoom to the data extents (EncompassTin).
maps - Zoom to the maps extents (EncompassMaps).
both - Zoom to both data and maps (EncompassBoth).
Example: -zoomTo "data:Precipitation"
NOTE: Multiple -zoomTo commands can be passed to the same operation.
To zoom Map Windows to consistent extents, use -syncZoomToMapWindow
-syncZoomToMapWindow mappanel
Specifies the source Map Window to synchronize the zoom extents of all
other rendered Map Windows.
-showMapScale
Include a map scale in the exported Map Windows.
-mapScaleLocation location
Set the map-scale location to topleft, topright, bottomleft or bottomright. Default is bottomright.
-showNorthArrow
Include a north arrow in the exported Map Windows.
-northArrowLocation location
Set the north-arrow location using the same location names as -mapScaleLocation. Default is bottomright.
-noLegend
Removes the legend from the output video.
-legendLocation location
Specifies the location of the legend. Valid values are 'topleft', 'topright', 'bottomleft' or 'bottomright'. Default is 'topright'.
-showDuration boolean
Specifies whether to show the duration label. Default is false.
-format outputformat
This argument does not select a different encoding in the current exporter. Use an .mp4 output filename; changing -format or the extension does not convert the output to AVI, MOV or MKV.
-outputFile outputfile
Specifies the output file for the video.
SAMPLE COMMAND LINE ARGUMENTS
Use these arguments after metvue.exe --video-export --, or replace the usage-help argument in the VideoExport.cmd template. Quote filenames and names that contain spaces. Start and end dates use ISO 8601 date-time values with an explicit offset, such as 2024-03-03T06:00Z.
Create an mp4 video for a specific Map Window
-projectFile C:\project.metvue -session session1 -mapWindow mappanel1
-outputFile C:\video.mp4
Create a video with custom time range and FPS
-projectFile C:\project.metvue -session session1 -mapWindow all -start 2024-03-03T00:00Z
-end 2024-03-04T00:00Z -step PT1H -fps 10 -outputFile C:\video.mp4
Set custom zoom and resolution
-projectFile C:\project.metvue -session session1 -mapWindow mappanel1
-zoomExtents "32,40,-104,-86" -outputResolution "1920,1080" -outputFile C:\video.mp4
Zoom to data for a specific map
-projectFile C:\project.metvue -session session1 -mapWindow Precipitation
-zoomTo "data:Precipitation" -outputFile C:\precip_zoom.mp4
Sync zoom of all maps to a specific map window
-projectFile C:\project.metvue -session session1 -mapWindow all
-syncZoomToMapWindow mappanel1 -outputFile C:\synced_video.mp4