Add-ons
- API
- Communication Center
- Disaster Recovery System
- Standard Object Library
- BACnet Application
- SmartSCADA
- WinCC OA Excel Report
- Video
  - Video Basics
  - Object Explorer Overview
  - Camera lists
  - Sequences
  - Configurations
  - External events
  - Video Export
  - Video Workstation
  - Playback
  - Human Interface Devices (HID)
  - CTRL Functions
    - VIDEO_OA_getDefaultStreamNumForDisplay()
      Returns the default stream for a display.
    - VIDEO_OA_getDefaultStreamNumForWorkstation()
      Returns the default stream for a user interface.
    - getFrameTimestampTickInterval()
      The function of provides information about the capture time of video frames.
    - VIDEO_OA_getStreamInfo()
      Returns the stream information, which is saved in a camera data point
    - VIDEO_OA_getStreamInfoForShowLiveDefaultDisplay()
      Returns the stream information to open a live stream on a display monitor. The default stream is used.
    - VIDEO_OA_getStreamInfoForShowLiveDefaultWidget()
      Returns the stream information to open a live stream on an EWO. The default stream is used.
    - VIDEO_OA_filterKeywordValue()
      Returns the value of a keyword.
    - VIDEO_OA_getUserPermission()
      The function returns the authorization for the given action.
    - VIDEO_OA_getWorkstationDp()
      Returns the data point name of the workstation for the given manager number.
    - onFrameRate()
    - onLatestFrameTimestamp
      The Event with which the frame timestamp information is reported for video_oa/control_functions/VIDEO_OA_getFrameTimestampTickIntervall.html and video_oa/control_functions/VIDEO_OA_setFrameTimestampTickIntervall.html.
    - onStreamStateChanged()
      The event which is triggerd by a change in the stream state .
    - VIDEO_OA_openMessageInfo()
      This function opens an information window and you can adjust the message individually.
    - VIDEO_OA_openMessageInfoAnswer()
      This function opens a dialog and you can adjust the message individually.
    - VIDEO_OA_openMessageWarning()
      This function opens a warning window and you can adjust the message individually.
    - VIDEO_OA_openNoPermission()
      Opens an information window. The window informs about the required authorization level.
    - VIDEO_OA_openObjectExplorer()
      This function opens the object explorer.
    - VIDEO_OA_getDefaultStreamNumForDisplay()
      Returns the default stream for a display.
    - setFpsReportInterval()
      The function delivers the current frame rate.
    - setFrameTimestampTickInterval()
      The function sets the capture time of video frames.
    - showLiveRtsp()
      This function starts the live streaming functionality of the video application.
    - Verwaltung von Kameras
    - Video EWO
    - Konfigurationen und Sequenzen
    - Bedienpult
    - HID
  - Graphical objects
  - Data Point Types
  - vimacc OA - Release Notes

VIDEO_OA_getStreamInfo()

Returns the stream information, which is saved in a camera data point

Synopsis

dyn_string VIDEO_OA_getStreamInfo(string camera, unsigned stream = 1, string mode ="live", string type = "widget");

Parameters


Parameter	Description
camera	Camera data point (e.g. Camera_00001)
stream	Stream number (1, 2 or 3)
mode	Live or playback stream live = live stream playback = playback stream
type	Display type widget = Display in a video EWO display = Display on a display server. In this mode the stream information will be returned without the controller annex and can be used directly for a display on a display server.

Return Value

[1] Stream information

[2] Stream number of the returned information of [1]. The value corresponds to the parameter value stream when the requested stream was found.

[3] 0 = the returned stream number is the requested stream number. 1= the returned stream number does not correspond to the requested number. If the requested stream number is not found, the function will search for available streams in the order Stream 1, Stream 2, Stream 3. If the stream 3 is requested and it does not exist, the function will search for the stream information for the stream 1 first and then for the information for the stream 2. The function will return the information that was found first.

-1 = No stream information was found for this camera.

Errors

Missing or wrong arguments

Description

This function returns the stream information for the given stream. The information is saved in the camera data point in the element *.object.device.currentStreamInfo or *.object.device.currentPklaybackInfo. If no stream information is found for the specified stream, the function will search for the stream information of other stream numbers in the order Stream 1, Stream 2, Stream 3.

EXAMPLE

main()
{
  dyn_string streamInfo = VIDEO_OA_getStreamInfo("Camera_00001");
  if (streamInfo[1] != "")
  ewo1.showLive(streamInfo[1], 1, 0);
  else
  VIDEO_OA_openMessageWarning(getCatStr("voa_general",
  "display_streamNotFound"));
}

Assignment

Video functions

Availability

UI, CTRL