API Signature: POST http://{SignageIP}:9646/api/videocapture


The above API helps a client application bring the source of a webcam video stream onto the screen on a signage for a defined time interval. 


API Body

 

{
  "DeviceId": "\\\\?\\USB#VID_05AC&PID_8510&MI_00#7&1C1EDF39&0&0000#{e5323777-f976-4f5b-9b55-b94699c46e44}\\GLOBAL",
  "Duration": 15,
  "RenderTransform": {
    "ScaleX": 1.5,
    "ScaleY": 1.5
  }
}

  

FieldDescription
DeviceIdThe unique ID of a webcam device.
DurationThe time interval the asset will be shown on the signage.
ContentOverrideDefines if the trigger should override the playback of another triggered content.
ContentRewindDefines if the trigger should rewind the current playback on a device as long as the matching asset is currently playing.
RenderTransform.ScaleXSets the x-axis scale factor.
RenderTransform.ScaleY
Sets the y-axis scale factor.

 

API Response


Status CodeBody Message
201 - CreatedRequest received.
409 - ConflictSignage is in real-time mode. Offline trigger requests can not be processed.
409 - Conflict

Video capture device Id can not be null or empty.

409 - Conflict

Video capture device can not be found.

409 - Conflict

Duration must be 15,30,45 or 60 seconds.