Take timed thumbnail snapshots of a transcoded stream with a Wowza Streaming Engine Java module

The ModuleTranscoderTimedSnapshot module for Wowza Streaming Engine™ media server software can be used to take a thumbnail snapshot of a transcoded stream at regular intervals. It can be configured to save a sequence of time-stamped images or a single image that is continuously overwritten.

Prerequisites


Wowza Streaming Engine 4.0.0 or later is required.

Transcoder must be enabled in the Wowza Streaming Engine application.

Installation


  1. Download wse-plugin-transcodertimedsnapshot.zip.
     
  2. Extract the contents from the downloaded (zipped) package, and then copy the lib/wse-plugin-transcodertimedsnapshot.jar file from the package to the lib folder in your Wowza Streaming Engine installation ([install-dir]/lib).
     
  3. Restart Wowza Streaming Engine.

Configuration


To enable this module, add the following module definition to your application configuration. See Configure modules for details.

Name
Description
Fully Qualified Class Name
TranscoderTimedSnapshot Takes snapshots of transcoder streams. com.wowza.wms.plugin.TranscoderTimedSnapshot

Properties


After enabling the module, you can adjust the default settings by adding the following properties to your application. See Configure properties for details.

Path
Name
Type
Value
Notes
/Root/Application transcoderTimedSnapshotStreamNames String myStream Comma-separated list of streams from which to save snapshots. (default: myStream)
/Root/Application transcoderTimedSnapshotHeight Integer 480 Height of snapshot images. If set to 0, the source stream height will be used. (default: 0)
/Root/Application transcoderTimedSnapshotWidth Integer 640 Width of snapshot images. If set to 0, the source stream width will be used. (default: 0)
/Root/Application transcoderTimedSnapshotInterval Integer 1000 Number of milliseconds between each snapshot. Minimum=1000 (1 second). (default: 1000)
/Root/Application transcoderTimedSnapshotImagePrefix String thumbnail_ Prefix that will be added to each image. (default: thumbnail_)
/Root/Application transcoderTimedSnapshotFormat String png File format of the snapshot images. Can be .png, .jpg, or .bmp. (default: .png)
/Root/Application transcoderTimedSnapshotTimestampImages Boolean true Add a time-stamp string to the saved image names. This will create a sequence of images. If set to false, the same image will be overwritten each time. (default: true)

Usage


The timed snapshots end up in the [install-dir]/content folder by default. To change the default location, see Change where Wowza Streaming Engine stores video-on-demand content. You can also set the value directly in the Application.xml file in the <Streams>/<StorageDIR> element.

For developers


  • Get the source code on GitHub