VideoStreamingAPI
ThisdocumentiscopyrightprotectedandisthepropertyofAxisCommunicationsABandmaynotbecopied,reproducedordistributedinanywaywithout
thepriorwrittenconsentofAxisCommunicationsAB.

5StreamProles

Astreamproleisasetofvideostreamparameterssuitablefordifferentapplications,devicesorsituations.Streamprolescanbe
usedwhenretrievingavideostreamfromAxisproductsusingtheHTTPAPI,theRTSPAPIorthewebGUI.Allparametersthatcanbe
setinavideostreamrequestcanalsobesavedinastreamprole.
Afewstreamprolesareincludedatstartup.Theincludedstreamprolesaredesignedaccordingtobasicrequirementsandcan
becustomizedbyuserswithappropriateaccessrights.Userscaneasilycreatenewstreamproleswhenneeded.User-created
prolesmayalsoberemoved.
Streamprolesarealsousedtodenespecialimagestreamsettings,forexampleforinstantreplayandeventsrecording.
ThestreamproleAPIisanextensiontothevideostreamCGI’sStreamprolesparametersareadded,updated,listedandremoved
usingtheparametermanagementCGI(param.cgi).

5.1Prerequisites

5.1.1Identication

Property:Properties.API.HTTP.Version=3
Firmware:5.00andlater.

5.2CommonExamples

Example1:
Addanewstreamprole.Inthisexamplethenewproleisthe5thstreamprolesoitwillbereferredtoasStreamProfile.S4.
Request:
http://myserver/axis-cgi/param.cgi?action=add
&template=streamprofile
&group=StreamProfile
Response:
S4OK
Example2:
Addandcongureastreamproleinonerequest.Heretheproleisnamedmyprofile2andtheParametersstringis
videocodec=h264&resolution=4CIF&text=1&textstring=4CIF%20profile.See2.7ImageRequestArguments,
onpage13whatargumentsthatcouldbeusedintheParametersstring.
Note
CharactersintheParametersstringmustbeURL-encoded,so
resolution=CIF&text=1&textstring=CIF%20profilebecomes
resolution%3dCIF%26text%3d1%26textstring%3dCIF%2520profile
Theblankspaceisencodedas%20,theequalsign(=)as%3d,theampersand(&)as%26andthepercentsignisencoded
as%25.
28