Video Streaming API
This document is copyright protected and is the property of Axis Communications AB and may not be copied, reproduced or distributed in any way without
the prior written consent of Axis Communications AB.
5 Stream Proles
A stream prole is a set of video stream parameters suitable for different applications, devices or situations. Stream proles can be
used when retrieving a video stream from Axis products using the HTTP API, the RTSP API or the web GUI. All parameters that can be
set in a video stream request can also be saved in a stream prole.
A few stream proles are included at startup. The included stream proles are designed according to basic requirements and can
be customized by users with appropriate access rights. Users can easily create new stream proles when needed. User-created
proles may also be removed.
Stream proles are also used to dene special image stream settings, for example for instant replay and events recording.
The stream prole API is an extension to the video stream CGI’s Stream proles parameters are added, updated, listed and removed
using the parameter management CGI (param.cgi).
5.1 Prerequisites
5.1.1 Identication
Property: Properties.API.HTTP.Version=3
Firmware: 5.00 and later.
5.2 Common Examples
Example 1:
Add a new stream prole. In this example the new prole is the 5th stream prole so it will be referred to as StreamProfile.S4.
Request:
http://myserver/axis-cgi/param.cgi?action=add
&template=streamprofile
&group=StreamProfile
Response:
S4 OK
Example 2:
Add and congure a stream prole in one request. Here the prole is named myprofile2 and the Parameters string is
videocodec=h264&resolution=4CIF&text=1&textstring=4CIF%20profile. See2.7 Image RequestArguments,
on page 13 what arguments that could be used in the Parameters string.
Note
Characters in the Parameters string must be URL-encoded, so
resolution=CIF&text=1&textstring=CIF%20profile becomes
resolution%3dCIF%26text%3d1%26textstring%3dCIF%2520profile
The blank space is encoded as %20, the equal sign (=) as %3d, the ampersand (&) as %26 and the percent sign is encoded
as %25.
28