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
      - VIDEO_OA_HID_init()
        Initializes a driver for communication with the HID-Joystick or HID-JogShuttle connected to host via USB.
      - VIDEO_OA_isJogShuttleAvailable()
        Checks whether a jog shuttle is configured for the workstation with the passed number.
      - VIDEO_OA_isJoystickAvailable()
        Checks whether a joystick is configured for the workstation with the passed number.
  - Graphical objects
  - Data Point Types
  - Video Widget
  - Streaming
  - vimacc OA - Release Notes

VIDEO_OA_isJogShuttleAvailable()

Checks whether a jog shuttle is configured for the workstation with the passed number.

Synopsis

bool VIDEO_OA_isJogShuttleAvailable(int number = 0);

Parameters


Parameter	Description
number	Number of the workstation (0 = current workstation)

Errors

Missing or wrong arguments

Description

This function checks whether a jog shuttle is configured for the workstation with the passed number. If no number or 0 is defined, the current workstation is checked.

EXAMPLE

main()
{
  DebugN(VIDEO_OA_isJogShuttleAvailable());
}

Assignment

Video functions

Availability

UI, CTRL