showLiveRtsp()

This function starts the live streaming functionality of the video application.

Synopsis

int showLiveRtsp(string urlString, int dialogIdx, uint transportOption);

Parameter

Parameter Description
urlString A complete rtsp streaming URL including authentication parameters (e.g.: rtsp://admin:password@10.1.0.2:554/)
dialogIdx Identifies the video dialog in which to display the video when a grid with several videos is selected.
transportOption

This parameter can be used to switch between UDP mode and tunneled http mode. Valid values are:

  • const uint STREAM_TRANSPORT_UNICAST_RTSP = 64;
  • const uint STREAM_TRANSPORT_UNICAST_RTSP_TUNNELED = 66;

Return Value

If the license is available and the URL is valid, the function returns the value 0.

Errors

Values unequal to 0 are error codes.

The following error codes are supported:

  • const uint ERROR_WRONG_TRANSPORT_OPTION = 0x1010;
  • const uint ERROR_INVALID_URL = 0x1020;
  • const uint ERROR_INVALID_VIDEO_PLAYER_WIDGET = 0x1040;
  • const uint ERROR_LICENSE_MISSING = 0x1080;
  • const uint ERROR_INVALID_ARGUMENT_COUNT = 0x1100;

Description

The function starts the rtsp streaming feature of the video application from a given URL to a specified video dialogue. Successful connection establishment and errors during connection establishment to the RTSP streaming source are reported asynchronously via onStreamStateChanged().

Note:

Note that when using authentification in the url (e.g.: rtsp://username:password@1.1.1.1:554) some camera manufacturers cannot process some characters. e.g.:

Axis cameras (e.g. model Q1615 Mk III and above) may encounter issues where the URL is marked as invalid when the # character is used in the username or password.

Assignment

Video functions

Availability

UI, CTRL