Page History

...

Note

title	Important!

You can get audio from x64 Server only.

You can't get audio in MJPEG format.

General information

GET httpGET http://IP- Address:port/prefix/live/media/{VIDEOSOURCEID}

Tip
{VIDEOSOURCEID} - – a three-component source endpoint ID (see see Get list of video sources (cameras)cameras and information about them). For instance, "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".

...

Note

title	Important!

If no parameters are specified in the request, then the video will be received in the MJPEG format.

Parameter	Required	Description
format	No	Parameter values are "mp4", "hls". Video can be received in the original format (without recompression) via HLS protocols. HLS protocol supports only H.264 format. The "mp4" player allows to receive the original video in H.264 and H.265. In all other cases the server

recompresses

re-compresses it to MJPEG format.

Note

title	Important!

If video is requested in the format that differs from the original one, then recompression will be performed, therefore, Server load will increase.

w, h

No

w – frame width, h – frame height.

Info

title	Note

If h and w values are more than size of original video, the video will be received with original size.

Zooming out of width and height is available only discretely

-

– in 2, 4, 8 times, etc. If specified sizes are not corresponding to 1/2, 1/4 etc. of original video size, the video will be received with size divisible by the original video size close to specified values.

Note

title	Important!

The mp4 video is transferred without scaling.

fr

No

fps.

Note

title	Important!

This parameter is relevant only for MJPEG video.

enable_token_auth

No

Get signed links to video streams.

enable_token_

auth -

auth – enable authorization by

token

token = 1.

valid_token_

hours -

hours – signature validation time (in hours). The maximum value is a week. The default value is 12 hours.

valid_token_hours

No

key_frames

No

1 – playback only by key frames;

0 – original frame rate (default).

Sample request:

GET http://IP -Address:port/prefix/live/media/Server1/DeviceIpint.23/SourceEndpoint.video:0:0?w=640&h=480&enable_token_auth=1&valid_token_hours=1

...

Parameter	Required	Description
keep_alive	No	Time in seconds in which the stream is to be kept alive.
hls_time	No	The segment length in seconds.
hls_list_size	No	The maximum number of playlist entries. If set to 0 the list file will contain all the segments.
hls_wrap	No	The number after which the segment filename number wraps. If set to 0 the number will be never wrapped.

Sample request:

GET http://127.0.0.1:80/live/media/SERVER1/DeviceIpint.23/SourceEndpoint.video:0:0?format=hls&keep_alive=60

Sample response:

Code Block

{
    "keep_alive_seconds": 60,
    "keep_alive_url": "/live/media/hls/keep?stream_id=7e9d8c93-80e2-4521-9a54-cb854fe3cd2d",
    "stop_url": "/live/media/hls/stop?stream_id=7e9d8c93-80e2-4521-9a54-cb854fe3cd2d",
    "stream_url": "/hls/7e9d8c93-80e2-4521-9a54-cb854fe3cd2d/playout.m3u8"
}

...

Parameter	Description
keep_alive_seconds	Time in seconds in which the stream is to be kept alive.
keep_alive_url	The url to keep the stream alive.
stop_url	The url to stop the stream.
stream_url	The url to access the list of segments.

Note

title	Important!

HLS protocol video becomes available

in several seconds after getting the response

with some delay (about 20 seconds). This is due to a feature of the HLS protocol: after receiving the link, it forms a cache of several video segments, and only after that the video starts playing.

To playback video via HLS protocol use the stream_url parameter from the response as follows:

...

Request to get the structure of the RTSP link: http://login:password@IP-address:Port/live/media/Server1/DeviceIpint.23/SourceEndpoint.video:0:0?format=rtsp

Sample response:

Code Block

{
    "http": {
        "description": "RTP/RTSP/HTTP/TCP",
        "path": "hosts/Server1/DeviceIpint.23/SourceEndpoint.video:0:0",
        "port": "8554"
    },
    "rtsp": {
        "description": "RTP/UDP or RTP/RTSP/TCP",
        "path": "hosts/Server1/DeviceIpint.23/SourceEndpoint.video:0:0",
        "port": "554"
    }
}

Request to get video: GET rtsp://login:password@IP -addressAddress:554/hosts/Server1/DeviceIpint.23/SourceEndpoint.video:0:0

Note

title	AttentionImportant!

In some cases, the RTSP video can be streamed with artifacts. To fix this, change the TCP/IP settings using this reg file.

RTSP stream information:

GET GET http://IP -Address:port/prefix/rtsp/stat

HTTP video

ffplay.exe -v debug "http://login:password@IP-address Address:8001/live/media/Server1/DeviceIpint.23/SourceEndpoint.video:0:0?w=1600&h=0"

Note

title	Important!

HTTP sends video in mjpeg only, w and h parameters are mandatory.

Tunneling RTSP over HTTP

see See Configure tunneling RTSP over HTTP in VLC.

Video is sent over the tunnel in the original format.

...

ffplay -rtsp_transport http "rtsp://login:password@IP - Address:80/rtspproxy/hosts/Server1/DeviceIpint.23/SourceEndpoint.video:0:0"

GET for VLC: rtsp://login:password@IP - Address:80/rtspproxy/hosts/Server1/DeviceIpint.23/SourceEndpoint.video:0:0

H.264 and H.265 video

To get live video in the original H.264/H.265 format use mp4 format.

...

Page tree

Versions Compared

Old Version 5

New Version Current

Key

General information

HTTP video

Tunneling RTSP over HTTP

H.264 and H.265 video