Help Videos

Help and training videos can be delivered through ESD/SPD Web. We provide a standard set of help videos that demonstrate how to use ESD/SPD.

The video help facility in ESD/SPD is flexible. It can be used to deliver our standard help videos as well as other videos that you would like to make available through your application.

Delivering Standard Help Videos

Standard ESD/SPD Web SDK help videos are distributed in a ZIP file separate from the package that includes the ESD/SPD Web documentation, examples, and binaries. In addition to the help video files, two JSON data files are included in this package, helpVideos_ESD.json and helpVideos_SPD.json. These files define distinct sets of help videos. The file helpVideos_ESD.json defines a set of videos that is appropriate when the Web SDK is used for traffic accident diagramming. The file helpVideos_SPD.json defines a set of videos that is appropriate when the Web SDK is used for crime scene and traffic accident diagramming.

To include the standard help videos in your solution:

• Place the video files and one of the two JSON files on your http server.
• Edit the JSON data file and change the help video URIs in this file so that they point to the locations of the help videos on your http server.
• Set the editor's helpVideoUrl property to point to the URI of the JSON data file on your server.

Delivering Custom Help Videos

To include custom help videos in your solution:

• Place your help videos on your http server. We recommended that you include both .webm and .mp4 versions of your videos so they can be played in all supported browsers.
• Create a JSON data file as described in the helpVideoUrl property documentation and place it on your http server.
• Use the helpVideoUrl property to point to the URI of your JSON data file.

Delivering a Mix of Standard and Custom Help Videos

You can combine the standard help videos with your help videos:

• Place the standard help videos and your custom videos on your http server.
• Select one the standard JSON data files and customize it to include references to the standard videos and your help videos. Place this file on your http server.
• Use the helpVideoUrl property to point to the URI of your custom JSON data file.