VAPIX Video Streaming API - Axis Communications

1 VAPIX VERSION3 VideoStreamingAPIV ideoStreamingAPIT hisdocumentiscopyrightprotectedandisthep ropertyofAxisCommunicationsABandmaynotbe copied, , LICENSEAGREEMENTThisVAPIX LicenseAgreement( License )isalegalagreementbetweenyou(eitherindiv idualoranentity)andAxisCommunicationsAB( axis ).ByusingtheINTERFACEandINTERFACEDESCRIP TION(eachdefinedbelow),whetherinwholeori npart, ( INTERFACE )andthewrittenspecificationoftheINTERFAC E(the INTERFACEDESCRIPTION )forthesoleandlimitedpurposeofcreating,m anufacturinganddevelopingasolutionthatin tegratesanyunitorportionincludedinthepro ductrangeofAxisnetworkproducts,asdefined byAxisatitsdiscretion(an AxisProduct )andtomarket, ,INTERFACEDESCRIPTION oranyportionsthereofandshallnotusetheINT ERFACE, ,decompile, ,yourecognizethat(i)otherthirdpartiesmay claimtoownpatentsorcopyrightsthatcouldco vercertainsolutionswhichintegrateAxispro ducts,orwhichresultfromthecombinationofA xisproductsandadditionaltechnologyorsolu tionsand(ii)youareresponsibleforensuring thatanysolutionwhichintegrateswithanAxis Product,oracombinationofasolutionandanAx isproduct, (s).

2 (i)anysolutioncreated,manufacturedand/or developedbyyouwhichintegratesanAxisProdu ctshallnotinfringeorotherwiseviolateanyt hirdpartyrights,includingbutnotlimitedto thirdpartyintellectualpropertyrights;and (ii)youruseoftheINTERFACEandINTERFACEDES CRIPTION willcomplywithallapplicableforeignanddom esticlaws, "ASIS" , ,WHETHEREXPRESSORIMPLIED,INCLUDINGBUTNOT LIMITEDTO,THEIMPLIEDWARRANTIESOFMERCHANT ABILITY,FITNESSFORAPARTICULARPURPOSE,TIT LE,NON-INFRINGEMENTANDPRODUCTLIABILITY,O RANYWARRANTYARISINGOUTOFANYPROPOSAL, , , , (I)EXAMININGWHETHERTHEINTERFACEANDTHEINT ERFACEDESCRIPTIONAREENCUMBEREDBYORINFRIN GESUPONARIGHTHELDBYATHIRDPARTYAND(II)ANY INTELLECTUALPROPERTYINFRINGEMENTCLAIMSTH ATARISEOUTOFORRELATETOSOLUTIONSCREATED, , ,LOSSOFPRODUCTION,LOSSOFPROFIT,LOSSOFUSE ,LOSSOFCONTRACTSORFORANYOTHERCONSEQUENTI AL, ,itssubsidiaries,affiliates,officers,emp loyees,andagentsharmlessfromanyandallcla ims,damages,losses,liabilities,actions,j udgments,costs,andexpensesbroughtbyathir dparty,includingclaimsforinfringementofi ntellectualpropertyrights,arisingoutofor inconnectionwith(i)youruseoftheINTERFACE orINTERFACEDESCRIPTION otherthaninaccordancewiththetermsofthisa greement,and/or(ii)anysolutioncreated, , , (Snapshot) , axis ,ETRAX, , , referencesareavailableat: , , :ChecksupportedVAPIX ://myserver/ axis - ://myserver/ axis - ://myserver/ axis - ://myserver/ axis - ://myserver/ axis -cgi/ (PAL/NTSC).

3 :viewerMethod:GET/POST7 VideoStreamingAPIT hisdocumentiscopyrightprotectedandisthep ropertyofAxisCommunicationsABandmaynotbe copied, :http://<servername>/ axis - <value>[&<argument>=<value>..] :http://myserver/ axis - :imagewidth=720imageheight=576 Example7 :http://myserver/ axis - :imagewidth=192imageheight= , :HTTPCode:200 OKContent-Type:text/plainBody:imagewidth =<value>imageheight=<value> <! >.8 VideoStreamingAPIT hisdocumentiscopyrightprotectedandisthep ropertyofAxisCommunicationsABandmaynotbe copied, :HTTPCode:200 OKContent-Type:text/plainBody(valueforar gument"camera"isspecified):<!--[errormessage]-->Body(valueforargument"camera"isnotspecif ied):[errormessage] :viewerMethod:GETS yntax:http://<servername>/ axis - <argument>=<value>Withthefollowingargumentandvalues:Argume ntValidvaluesDescriptionstatus=<int>[[,<int>],..] :HTTPCode:200 OKContent-Type:text/plainBody:Video1=<information>.

4 <information> :Requestvideostatusfromvideosource1,2, ://myserver/ axis - ,2,3,4 Response:9 VideoStreamingAPIT hisdocumentiscopyrightprotectedandisthep ropertyofAxisCommunicationsABandmaynotbe copied, :200 OKContent-Type:text/plainBody:Video1=vid eoVideo2=novideoVideo3=novideoVideo4= ://myserver/ axis - ,mjpeg,h264, :viewerMethod:GETS yntax:http://<servername>/ axis -cgi/ [?<argument>=<value<[&<argument>=<value>..]] ://myserver/ axis -cgi/ ://myserver/ axis -cgi/ , , :HTTPCode:200 OKContent-Type:image/bitmapContent-Lengt h:<imagesizeinbytes>Body:<bitmapimagedata> (Snapshot) (snapshot).AJPEG image(snapshot) :viewerMethod:GETS yntax:http://<servername>/ axis -cgi/ [?<argument>=<value>[&<argument>=<value>..]] ://myserver/ axis -cgi/ ://myserver/ axis -cgi/ , :11 VideoStreamingAPIT hisdocumentiscopyrightprotectedandisthep ropertyofAxisCommunicationsABandmaynotbe copied, :200 OKContent-Type:image/jpegContent-Length:<imagesizeinbytes>Body:<JPEG imagedata> , :viewerMethod:GETS yntax:http://<servername>/ axis -cgi/ [?]

5 <argument>=<value>[&<argument>=<value>..]] ,onpage13 <string> <streamprofilename> #. <int> <int> <int> , ://myserver/ axis -cgi/ ://myserver/ axis -cgi/ , ://myserver/ axis -cgi/ , , <boundary>.Response:HTTPCode:200 OKContent-Type:multipart/x-mixed-replace ;boundary=<boundary>Body:--<boundary> <image>--<boundary> <image>Wherethereturned<image>fieldis:Content-Type:image/jpegContent-L ength:<imagesizeinbytes> <JPEG imagedata> , ( ) <string> , <string> <int> , , <int> <int>01 Enable/disablesquarepixel(aspectratio) : , (RealTimeStreamingProtocol) remotecontrol ,RTSPAPI providesparameterscontrollingmediastream propertiessuchasresolution,compression, (RTSP),RFC4566 SDP:SessionDescriptionProtocolandRFC3550 :COMMAND rtsp://<servername>/ axis - [?<parameter>=<value>[&<parameter>=<value>..]] <CRLF>Headerfield1:val1<CRLF>Headerfield2:val2<CRLF>..<CRLF>[Body]COMMAND isanyofDESCRIBE,SETUP,OPTIONS,PLAY,PAUSE ,TEARDOWN, (CRLF).

6 (returnedbytheAxisproductinSETUP response). , : <StatusCode> <ReasonPhrase> <CRLF>Headerfield1:val3<CRLF>Headerfield2:val4<CRLF>..[Body] :HeaderFieldDescriptionCSeqResponseseque ncenumber(matchesthesequencenumberofther equest). (s).TheSessionDescriptionProtocol(SDP) :HeaderFieldDescriptionAcceptListofconte nttypesthatclientsupports(application/sd pistheonlysupportedtype).Theresponsetoth eDESCRIBE commandcontainstheadditionalheaderfields :HeaderFieldDescriptionContent-TypeTypeo fcontent(application/sdp). , :16 VideoStreamingAPIT hisdocumentiscopyrightprotectedandisthep ropertyofAxisCommunicationsABandmaynotbe copied, :DESCRIBE rtsp://myserver/ axis - :0 User-Agent:AxisAMCA ccept:application/sdpResponse: :0 Content-Type:application/sdpContent-Base :rtsp://myserver/ axis - :Wed,16 Jul200812:48:47 GMTC ontent-Length:847v=0o=-12162125275548721 216212527554872 INIP4myservers=MediaPresentatione=NONEc= :50064t=00a=control:rtsp://myserver/ axis - :npt= :50000a= :1,0,0;0,1,0;0,0,1a=control:rtsp://myser ver/ axis - :96H264/90000a=fmtp:96packetization-mode =1;profile-level-id=420029;sprop-paramet er-sets=Z0 IAKeKQFAe2 AtwEBAaQeJEV,aM48gA==m=audio0 RTP/AVP97b=AS:64a=control:rtsp://myserve r/ axis - :97mpeg4-generic/16000/1a=fmtp:97profile -level-id=15;mode=AAC-hbr;config=1408;Si zeLength=13;IndexLength=3;IndexDeltaLeng th=3;Profile=1;bitrate=64000; , , (a3x3matrix).

7 Syntax:a=transform:<MATRIX> :Avideostreamwhichisrotated90degreesisde scribedby:17 VideoStreamingAPIT hisdocumentiscopyrightprotectedandisthep ropertyofAxisCommunicationsABandmaynotbe copied, :0,-1,0;1,0,0;0,0, ( ). (*) :OPTIONS* :1 User-Agent:AxisAMCS ession:12345678 Response: :1 Session:12345678 Public:DESCRIBE,GET_PARAMETER,PAUSE,PLAY ,SETUP,SET_PARAMETER,TEARDOWNDate:Wed,16 Jul200812:48:48 GMTNoteAsindicatedintheresponse,theGET_P ARAMETER commandissupported; :RTP/AVP;unicast;client_port=port1-port2 RTP/AVP;multicast;client_port=port1-port 2 RTP/AVP/TCP;unicastIfusingunicastincombi nationwithTCP,itisrecommendedtoincreaset hesizeoftheRTPpacketsto64000bytes(fromth estandard1500bytes), , (forexamplePLAY,PAUSEandTEARDOWN).Ifthes essionheaderincludesthetimeoutparameter, (forexampleOPTIONS, ) :TheresponsetothefirstSETUP requestreturnsthesessionidentifier(Sessi on) :SETUP rtsp://myserver/ axis - :2 User-Agent:AxisAMCT ransport:RTP/AVP;unicast;client_port=200 00-20001 Response: :2 Session:12345678;timeout=60 Transport:RTP/AVP;unicast;client_port=20 000-20001;server_port=50000-50001;ssrc=B 0BA7855;mode="PLAY"Date:Wed,16 Jul200812:48:47 GMTE xample5:Request:SETUP rtsp:///myserver// axis - :3 User-Agent:AxisAMCT ransport:RTP/AVP;unicast;client_port=200 02-20003 Session:12345678 Response: :3 Session:12345678;timeout=60 Transport:RTP/AVP;unicast;client_port=20 002-20003;server_port=50002-50003;ssrc=D 7EB59C0.

8 Mode="PLAY"Date:Wed,16 Jul200812:48 (orrestartsifpaused) :19 VideoStreamingAPIT hisdocumentiscopyrightprotectedandisthep ropertyofAxisCommunicationsABandmaynotbe copied, , :Request:PLAY rtsp://myserver/ axis - :4 User-Agent:AxisAMCS ession:12345678 Response: :4 Session:12345678 Range:npt= :url=rtsp://myserver/ axis - ;seq=46932;rtptime=1027887748,url=rtsp:/ /myserver/ axis - ;seq=3322;rtptime=611053482 Date:Wed,16 Jul200812:48:48 GMTE xample7:Playtherecording myrecording .Request:PLAY rtsp://myserver/ axis - myrecording :4 User-Agent: :Request:PAUSE rtsp://myserver/ axis - :5 User-Agent:AxisAMCS ession:12345678 Response: :5 Session:12345678 Date:Wed,16 Jul200812:48:49 GMT20 VideoStreamingAPIT hisdocumentiscopyrightprotectedandisthep ropertyofAxisCommunicationsABandmaynotbe copied, :Request:TEARDOWN rtsp://myserver/ axis - :6 User-Agent:AxisAMCS ession:12345678 Response: :6 Session:12345678 Date:Wed,16 Jul200812:49 , :SET_PARAMETER rtsp://myserver/ axis - :7 Session:12345678 Content-Type:text/parametersContent-Leng th:19 Renew-Stream:yesResponse: :7 Session:12345678 Date:Wed,16 Jul200813:01:25 GMTE xample11:InsomeolderAxisproducts,I- , , :SET_PARAMETER rtsp://myserver/ axis - :7 Session:12345678 :yesIftherequestissuccessful(response200 OK), ,theAxisproductrespondswith551 Optionnotsupported(below) : :7 Session:12345678.

9 Wed,16 Jul200813:01:24 :SET_PARAMETER rtsp://myserver/ axis - :8 Session:12345678 Content-Type:text/parametersContent-Leng th:19 Renew- : :8 Session:12345678 Date:Wed,16 Jul200813:01 ,twosessionsaresetup;oneGET(forcommandre pliesandstreamdata)andonePOST(forcommand s).RTSP commandssentonthePOST connectionarebase64encoded, (conveyedinthex-sessioncookieheader).The GETandPOST requestsareacceptedonboththeHTTP port(default80)andtheRTSP serverport(default554). :http://<servername>/ axis - , :GETaxis- :123456789 Response: :application/x-rtsp-tunnelledExample13 :POST axis - :123456789 Content-Length:32767 Content-Type: ://myserver/ axis - :14 User-Agent:AxisAMCA ccept: [ ]ParameterDefaultvaluesValidvaluesAccess controlDescriptionAuthenticateOverHTTPno 1 , , :rtsp://<servername>/ axis - [?<parameter>=<value>[&<parameter>=<value>..]] ,MPEG-4 Part2 :Productdependent;inorderofpriority:h264 ,mpeg4, (forcompatibilitywithapplicationswithout audiocontrol).

10 0= , , <int>,<int>overlaypos=<int>x<int> <bool> , (includingvideocodec) #. :ParameterValidvaluesDescriptionvideobit rateAnintegerTherate(inkbits/s) >0= :0videomaxbitrateAnintegerMaximumbitrate (inkbits/s) :00= , :32, :ParameterValidvaluesDescriptionsquarepi xel01 Enable/disablesquarepixel(aspectratio) (RTCP) , (SDP). :http://myserver/ axis - :v=0o=-12844643630929041284464363092904 INIP4axiss=Multicastpresentatione=NONEt= 00a=range:npt= :50000a= :1,0,0;0,1,0;0,0,1a=rtpmap:96H264/90000a =fmtp:96packetization-mode=1;profile-lev el-id=420029;sprop-parameter-sets=Z0 IAKeKQFgJNgScFAQXh4kRU,aM48gA==27 VideoStreamingAPIT hisdocumentiscopyrightprotectedandisthep ropertyofAxisCommunicationsABandmaynotbe copied, , , , sStreamprofilesparametersareadded,update d,listedandremovedusingtheparametermanag ementCGI( ). :http://myserver/ axis - :S4 OKExample2 , ,soresolution=CIF&text=1&textstring=CIF% 20profilebecomesresolution%3dCIF%26text% 3d1%26textstring%3dCIF%2520profileThebla nkspaceisencodedas%20,theequalsign(=)as% 3d,theampersand(&)as%26andthepercentsign isencodedas% , :http://myserver/ axis - :S5 OKExample3 :resolution=CIF,text=1andtextstring= , ,soresolution=CIF&text=1&textstring=CIF% 20profilebecomesresolution%3dCIF%26text% 3d1%26textstring%3dCIF% ,theequalsign(=)as%3d,theampersand(&)as% 26andthepercentsignisencodedas% :http://myserver/ axis - :OKExample4 :http://myserver/ axis - , [ #]Template:streamprofileParameterValidva luesAccesscontrolDescriptionNameA-Za-z0- 9-,_admin:read,writeoperator:read, :read,writeoperator:read, <argument1>=<value1>&<argument2>=<valu-e2>.