Specifications

ManualsBrandsAxis Communications ManualsStereo ReceiverVersion 3 Stereo Receiver

VAPIX®VERSION3

VideoStreamingAPI

Summary of content (32 pages)

PAGE 1
VAPIX® VERSION 3 Video Streaming API
PAGE 2
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. COPYRIGHT NOTICE 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.
PAGE 3
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. 7. LIMITATION OF LIABILITY 7.1.
PAGE 4
Video Streaming API Table of Contents 1 2 3 4 5 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.1 References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2 Unknown Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Video Streaming Over HTTP . . . . . . . .
PAGE 5
Video Streaming API Table of Contents 5.5 RTSP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 © 2008 - 2013 Axis Communications AB. AXIS COMMUNICATIONS, AXIS, ETRAX, ARTPEC and VAPIX are registered trademarks or trademark applications of Axis AB in various jurisdictions. All other company names and products are trademarks or registered trademarks of their respective companies. We reserve the right to introduce modifications without notice.
PAGE 6
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. 1 Overview 1.1 Description This document explains the basic arguments and parameters to send, receive and configure a video stream using HTTP or RTSP requests. 1.1.1 References All VAPIX® references are available at: http://www.axis.com/vapix 1.
PAGE 7
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. 2 Video Streaming Over HTTP The HTTP-based video interface provides the functionality for requesting single and multipart images and for getting and setting internal parameter values. The image and CGI requests are handled by the built-in web server. 2.1 Prerequisites 2.1.
PAGE 8
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. Syntax: http:///axis-cgi/imagesize.cgi? camera=[&=...] With the following arguments and values: Argument Description Any image argument. See 2.7 Image Request Arguments for image CGI arguments.
PAGE 9
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. Response: HTTP Code: 200 OK Content-Type: text/plain Body (value for argument "camera" is specified): Body (value for argument "camera" is not specified): [error message] 2.4 Video Status This section only applies to video encoders. The videostatus.
PAGE 10
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. Returned data after a successful request. HTTP Code: 200 OK Content-Type: text/plain Body: Video Video Video Video 1 2 3 4 = = = = video no video no video video The response no video means that there is no analog video signal attached to the physical video input port. 2.
PAGE 11
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. 2.5.2.1 Successful Request Successful response to a HTTP request. Response: HTTP Code: 200 OK Content-Type: image/bitmap Content-Length: Body: 2.
PAGE 12
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. HTTP Code: 200 OK Content-Type: image/jpeg Content-Length: Body: 2.6.3 Motion JPEG Video CGI Request The mjpg/video.cgi is used to request a Motion JPEG video stream with specified arguments.
PAGE 13
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. http://myserver/axis-cgi/mjpg/video.cgi? streamprofile=myprofile&resolution=CIF 2.6.4 Motion JPEG Video Response When a Motion JPEG video is requested, the Axis product either returns the specified Motion JPEG video or an error. 2.6.4.
PAGE 14
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. rotation= 0 901 1801 2701 Rotate the image clockwise. The number of rotation alternatives in an Axis product is defined by the parameter Properties.Image.Rotation. squarepixel= 0 1 Enable/disable square pixel (aspect ratio) correction.
PAGE 15
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. 3 RTSP API RTSP (Real Time Streaming Protocol) is a control protocol for media streams delivered by a media server. RTSP can be considered a “remote control” providing commands such as play and pause.
PAGE 16
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. Content-Type The media type of the content. User-Agent Information about the client that initiates the request. Require Query whether an option is supported. Unsupported features are listed in the Unsupported header field. See example 2 in section 3.2.10 RTSP SET_PARAMETER. 3.2.
PAGE 17
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. Request: DESCRIBE rtsp://myserver/axis-media/media.amp ?videocodec=h264&resolution=640x480 RTSP/1.0 CSeq: 0 User-Agent: Axis AMC Accept: application/sdp Response: RTSP/1.0 200 OK CSeq: 0 Content-Type: application/sdp Content-Base: rtsp://myserver/axis-media/media.
PAGE 18
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. a=transform:0,-1,0;1,0,0;0,0,1 3.2.5 RTSP OPTIONS The OPTIONS request returns a list of supported RTSP commands. The command can be used to keep RTSP sessions alive by repeating the OPTIONS request at regular intervals.
PAGE 19
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. The response returns a session identifier that should be used together with the stream control commands (for example PLAY, PAUSE and TEARDOWN). If the session header includes the timeout parameter, the session will close after the timeout time unless explicitly kept alive.
PAGE 20
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. Header field Description Range The play time period. RTP-Info Information about the RTP stream, including the sequence number of the first packet of the stream. Example 6: Request: PLAY rtsp://myserver/axis-media/media.amp ?videocodec=h264&resolution=640x480 RTSP/1.
PAGE 21
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. 3.2.8.1 RTSP PAUSE On Live Stream If PAUSE is requested during live streaming the data transmission will stop immediately. If PLAY later is requested the live steam starts on the latest sampled frame.
PAGE 22
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. Send a request with Require and RenewStream:yes in the header. Request: SET_PARAMETER rtsp://myserver/axis-media/media.amp RTSP/1.0 CSeq: 7 Session: 12345678 Require: com.axis.parameters-in-header RenewStream: yes If the request is successful (response 200 OK), the stream is renewed.
PAGE 23
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. Example 12: GET request. Request: GET axis-media/media.amp?videocodec=h264&audio=0 HTTP/1.0 x-sessioncookie: 123456789 Response: HTTP/1.0 200 OK Content-Type: application/x-rtsp-tunnelled Example 13: POST request. There is no response from the Axis product.
PAGE 24
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. Syntax: rtsp:///axis-media/media.amp [?=[&=...]] The following parameters are supported for H.264, MPEG-4 Part 2 and Motion JPEG streams: Parameter Valid values Description videocodec h264 mpeg4 jpeg1 The selected video codec.
PAGE 25
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. textbackgroundcolor black white transparent semitransparent Set the color of the text background shown in the image. rotation 0 90 180 2701 Rotate the image clockwise. textpos 0 1 The position of the string shown in the image. 0 = Top. 1 = Bottom.
PAGE 26
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. videobitratepriority none framerate The priority when rate control is used. videokeyframeinterval An integer Corresponds to the GOV length setting in the web GUI. Default: 32, but product and codec dependent.
PAGE 27
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. 4 Always Multicast Always multicast means starting a multicast stream and letting it run continuously. Enabling always multicast reduces the latency when connecting to an Axis product.
PAGE 28
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 Profiles A stream profile is a set of video stream parameters suitable for different applications, devices or situations. Stream profiles can be used when retrieving a video stream from Axis products using the HTTP API, the RTSP API or the web GUI.
PAGE 29
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. Request: http://myserver/axis-cgi/param.cgi?action=add &template=streamprofile &group=StreamProfile &StreamProfile.S.Name=myprofile2 StreamProfile.S.Description=My%204CIF%20profile &StreamProfile.S.
PAGE 30
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. Note In order to create a new dynamic parameter admin or operator access control is needed. [StreamProfile.
PAGE 31
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. Request: http://myserver/axis-cgi/mjpg/video.cgi?&streamprofile=myprofile 5.5 RTSP Request Saved stream profiles are also convenient when requesting video streams using RTSP.