CreateStream

Creating and configuring a stream on the media server. If a request is sent with an existing stream identifier on the server, the stream will restart with new configuration parameters: the current connection with the source is terminated and a new one is established, the stream state and buffers are cleared.

POST /streams/{new-stream-uid}/

Body
json	JSON { "primary-node": "node-host-1", "secondary-node": "node-host-2", "stream-enable": true, "stream-url": "rtsp://admin:admin@192.168.7.34:554/Streaming/Channels/101", "stream-proto": "rtsp,hls", "stream-tracks": "video,audio", "stream-limit": 0, "stream-access": "public", "stream-whitelist": "", "reconnect-numbers": 500, "reconnect-timeout": "10s", "reconnect-interval": "30m", "reconnect-invalid": 10, "dvr-enable": true, "dvr-archive": "/storage", "dvr-duration": "3d", "dvr-capacity": "10G", "dvr-chunk": "2m" }
token^required	string	API request authorization token. See Mediaserver/Web API/Authorization/CreateApiToken.
new-stream-uid^optional	uid	Unique identifier of the virtual camera {@hint:uid}.
stream-url^required	url	Connection URL for the stream or publishing URL for the stream. See Mediaserver/Configuration/Stream (stream.ini).
stream-tracks^optional	array	List of channels allowed to be captured, regardless of whether a channel exists in the stream or not.
stream-proto^optional	array	Protocols allowed for clients to connect to the media server for viewing the stream.
stream-enable^optional	bool	Whether the media server is allowed or denied access to the stream (if denied, live and DVR playback and recording are unavailable).
dvr-enable^required	enum	Allows or denies the server to record and store a copy of the stream.
dvr-archive^required	path	Sets the root directory for storing DVR recordings.
dvr-duration^required	seconds	Sets the duration of recording storage.
dvr-capacity^required	bytes	Limits the amount of disk space for recordings. This parameter is for informational purposes only and does not impose physical restrictions.
dvr-chunk^required	seconds	Sets the recording segment duration.
stream-access^required	string	Determines the type of authentication for clients connecting to view the stream.
stream-whitelist^required	array	List of allowed IP addresses that can connect to view the stream.
stream-limit^required	int	Limits the maximum number of concurrent client connections for viewing streams across all protocols.
reconnect-numbers^optional	int	Number of reconnection attempts. The limit of consecutive reconnection attempts to the stream, after which the media server marks the stream as unavailable and excludes it from further capture.
reconnect-timeout^optional	seconds	Progressive time delay between reconnection attempts.
reconnect-interval^optional	seconds	Maximum value of progressive delay between connections.
reconnect-invalid^optional	seconds
primary-node^optional	string	If cluster functionality is available, the parameter sets the primary stream capture node.
secondary-node^optional	string	If cluster functionality is available, the parameter sets the secondary (backup) stream capture node.

Response
200		Stream successfully created.
403		Authorization error. Invalid or missing API access token. See Mediaserver/Web API/Authorization/CreateApiToken.

Example

JSON

curl -k --location --request POST 'https://localhost:8080/streams/{new-stream-uid}/?token=string' \
--header 'Content-Type: application/json \
--data-raw '{
    "primary-node": "node-host-1",
    "secondary-node": "node-host-2",
    "stream-enable": true,
    "stream-url": "rtsp://admin:admin@192.168.7.34:554/Streaming/Channels/101",
    "stream-proto": "rtsp,hls",
    "stream-tracks": "video,audio",
    "stream-limit": 0,
    "stream-access": "public",
    "stream-whitelist": "",
    "reconnect-numbers": 500,
    "reconnect-timeout": "10s",
    "reconnect-interval": "30m",
    "reconnect-invalid": 10,
    "dvr-enable": true,
    "dvr-archive": "/storage",
    "dvr-duration": "3d",
    "dvr-capacity": "10G",
    "dvr-chunk": "2m"
}'