Operations

• PUB /v1/config/notify

  Notification events for changes to the Configuration.

  Specify which events to subscribe to.

  Operation IDconfig-subscribe

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  object

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  array<string>

  non-empty

  An initial set of events to subscribe to.

  Items:

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  Additional properties are NOT allowed.

  Accepts the following message:

  Configuration notification subscriptionConfigNotificationSubscription

  Subscribe or unsubscribe from Configuration events.

  Payload

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  object

  non-empty

  A subscription change request.

  (pattern property)

  boolean

  Property names must adhere to:

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    Enable all events.

  • #2 Example

    Enable only Source events.

    {
      "source": true
    }
    

  • #3 Example

    Disable Source and enable Pipeline events.

    {
      "source": false,
      "pipeline": true
    }
    

  • #4 Example

    Disable all events (verbose).

    {
      "source": false,
      "pipeline": false,
      "sink": false
    }
    

• SUB /v1/config/notify

  Notification events for changes to the Configuration.

  Open a WebSocket connection to receive notification events for changes in the Configuration.

  Operation IDconfig-notify

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  object

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  array<string>

  non-empty

  An initial set of events to subscribe to.

  Items:

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  Additional properties are NOT allowed.

  Accepts the following message:

  Configuration notificationConfigNotification

  Global Configuration change notification.

  Payload

  oneOf

  Adheres to:

  allOf

  uid: ConfigSourceCreated

  Consists of:

  allOf

  uid: ConfigSourceNotificationItem

  Consists of:

  object

  uid: ConfigNotificationItem

  type

  required

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  action

  required

  string

  uid: ConfigNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"source"

  And with:

  restricted any

  type

  string

  Const:"source"

  action

  string

  Const:"created"

  source

  required

  object

  id

  required

  integer

  format: int32>= 0

  Source ID

  type

  required

  string

  Allowed values:
  • "video"
  • "file"
  • "youtube"
  • "zmqinternal"
  • "zmq"
  • "inf"

  address

  required

  oneOf

  Adheres to:

  string

  format: url

  Short-form Source address.

  Or to:

  object

  Long-form Source address.

  url

  required

  string

  format: url

  URL without username and password.

  user

  required

  string

  Username for HTTP authentication.

  pass

  required

  string

  Password for HTTP authentication.

  Additional properties are allowed.

  rate

  number

  format: float> 0

  timeout

  number

  format: float

  If source is disconnected, then try to reconnect for the specified number of minutes; -1 is try indefinitely.

  Default value:-1

  proxy

  boolean

  Default value:

  stream

  number

  format: int32>= 0uid: id

  Stream ID

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ConfigSourceUpdated

  Consists of:

  allOf

  uid: ConfigSourceNotificationItem

  Consists of:

  object

  uid: ConfigNotificationItem

  type

  required

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  action

  required

  string

  uid: ConfigNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"source"

  And with:

  restricted any

  type

  string

  Const:"source"

  action

  string

  Const:"updated"

  source

  required

  object

  >= 2 properties

  id

  required

  integer

  format: int32>= 0

  Source ID

  type

  string

  Allowed values:
  • "video"
  • "file"
  • "youtube"
  • "zmqinternal"
  • "zmq"
  • "inf"

  address

  oneOf

  Adheres to:

  string

  format: url

  Short-form Source address.

  Or to:

  object

  Long-form Source address.

  url

  required

  string

  format: url

  URL without username and password.

  user

  required

  string

  Username for HTTP authentication.

  pass

  required

  string

  Password for HTTP authentication.

  Additional properties are allowed.

  rate

  number

  format: float> 0

  timeout

  number

  format: float

  If source is disconnected, then try to reconnect for the specified number of minutes; -1 is try indefinitely.

  Default value:-1

  proxy

  boolean

  Default value:

  stream

  number

  format: int32>= 0uid: id

  Stream ID

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ConfigSourceDeleted

  Consists of:

  allOf

  uid: ConfigSourceNotificationItem

  Consists of:

  object

  uid: ConfigNotificationItem

  type

  required

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  action

  required

  string

  uid: ConfigNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"source"

  And with:

  restricted any

  type

  string

  Const:"source"

  action

  string

  Const:"deleted"

  source

  required

  object

  id

  required

  integer

  format: int32>= 0

  Source ID

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ConfigSinkCreated

  Consists of:

  allOf

  uid: ConfigSinkNotificationItem

  Consists of:

  object

  uid: ConfigNotificationItem

  type

  required

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  action

  required

  string

  uid: ConfigNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"sink"

  And with:

  restricted any

  type

  string

  Const:"sink"

  action

  string

  Const:"created"

  sink

  required

  object

  id

  required

  integer

  format: int32>= 0

  Sink ID

  type

  required

  string

  Allowed values:
  • "video"
  • "zmq"
  • "zmqinternal"
  • "inf"

  address

  required

  string

  format: url

  filter

  oneOf

  Default value:"*"

  Adheres to:

  string

  No filtering.

  Const:"*"

  Or to:

  allOf

  Consists of:

  any

  A single source to include.

  And with:

  integer

  format: int32>= 0

  Source ID

  Or to:

  array<integer>

  non-empty

  A list of sources to include.

  Items:

  integer

  format: int32>= 0

  Source ID

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ConfigSinkUpdated

  Consists of:

  allOf

  uid: ConfigSinkNotificationItem

  Consists of:

  object

  uid: ConfigNotificationItem

  type

  required

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  action

  required

  string

  uid: ConfigNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"sink"

  And with:

  restricted any

  type

  string

  Const:"sink"

  action

  string

  Const:"updated"

  sink

  required

  object

  >= 2 properties

  id

  required

  integer

  format: int32>= 0

  Sink ID

  type

  string

  Allowed values:
  • "video"
  • "zmq"
  • "zmqinternal"
  • "inf"

  address

  string

  format: url

  filter

  oneOf

  Default value:"*"

  Adheres to:

  string

  No filtering.

  Const:"*"

  Or to:

  allOf

  Consists of:

  any

  A single source to include.

  And with:

  integer

  format: int32>= 0

  Source ID

  Or to:

  array<integer>

  non-empty

  A list of sources to include.

  Items:

  integer

  format: int32>= 0

  Source ID

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ConfigSinkDeleted

  Consists of:

  allOf

  uid: ConfigSinkNotificationItem

  Consists of:

  object

  uid: ConfigNotificationItem

  type

  required

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  action

  required

  string

  uid: ConfigNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"sink"

  And with:

  restricted any

  type

  string

  Const:"sink"

  action

  string

  Const:"deleted"

  sink

  required

  object

  id

  required

  integer

  format: int32>= 0

  Sink ID

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ConfigPipelineCreated

  Consists of:

  allOf

  uid: ConfigPipelineNotificationItem

  Consists of:

  object

  uid: ConfigNotificationItem

  type

  required

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  action

  required

  string

  uid: ConfigNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"pipeline"

  And with:

  restricted any

  type

  string

  Const:"pipeline"

  action

  string

  Const:"created"

  pipeline

  required

  object

  id

  required

  integer

  format: int32>= 0

  Pipeline ID

  elements

  required

  array<oneOf>

  non-empty

  Sequence of processing stages

  Items:

  oneOf

  Adheres to:

  string

  Short-form Pipeline element.

  Or to:

  object

  Long-form Pipeline element.

  name

  required

  string

  The name of the Pipeline element.

  hw

  string

  The type of hardware device to use to run the Pipeline element.

  Default value:"cpu"

  Allowed values:
  • "cpu"
  • "igpu"
  • "gpu"
  • "fpga"

  mode

  string

  High-throughput ("a") or low-latency ("s") mode.

  Default value:"a"

  Allowed values:
  • "a"
  • "s"

  score_threshold

  number

  format: float[ 0 .. 1 ]

  iou_threshold

  number

  format: float[ 0 .. 1 ]

  config

  object

  Property names must adhere to:

  oneOf

  Adheres to:

  integer

  format: int32>= 0

  Source ID

  Or to:

  string

  Allowed values:
  • "*"

  Additional properties:

  object

  A Pipeline element configuration used for the input source(s).

  Additional properties are allowed.

  Additional properties are allowed.

  sources

  required

  array<integer>

  IDs of input sources to the pipeline

  Items:

  integer

  format: int32>= 0

  Source ID

  sinks

  required

  array<integer>

  IDs of output sinks from the pipeline

  Items:

  integer

  format: int32>= 0

  Sink ID

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ConfigPipelineUpdated

  Consists of:

  allOf

  uid: ConfigPipelineNotificationItem

  Consists of:

  object

  uid: ConfigNotificationItem

  type

  required

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  action

  required

  string

  uid: ConfigNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"pipeline"

  And with:

  restricted any

  type

  string

  Const:"pipeline"

  action

  string

  Const:"updated"

  pipeline

  required

  object

  >= 2 properties

  id

  required

  integer

  format: int32>= 0

  Pipeline ID

  elements

  array<oneOf>

  non-empty

  Sequence of processing stages

  Items:

  oneOf

  Adheres to:

  string

  Short-form Pipeline element.

  Or to:

  object

  Long-form Pipeline element.

  name

  required

  string

  The name of the Pipeline element.

  hw

  string

  The type of hardware device to use to run the Pipeline element.

  Default value:"cpu"

  Allowed values:
  • "cpu"
  • "igpu"
  • "gpu"
  • "fpga"

  mode

  string

  High-throughput ("a") or low-latency ("s") mode.

  Default value:"a"

  Allowed values:
  • "a"
  • "s"

  score_threshold

  number

  format: float[ 0 .. 1 ]

  iou_threshold

  number

  format: float[ 0 .. 1 ]

  config

  object

  Property names must adhere to:

  oneOf

  Adheres to:

  integer

  format: int32>= 0

  Source ID

  Or to:

  string

  Allowed values:
  • "*"

  Additional properties:

  object

  A Pipeline element configuration used for the input source(s).

  Additional properties are allowed.

  Additional properties are allowed.

  sources

  array<integer>

  IDs of input sources to the pipeline

  Items:

  integer

  format: int32>= 0

  Source ID

  sinks

  array<integer>

  IDs of output sinks from the pipeline

  Items:

  integer

  format: int32>= 0

  Sink ID

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ConfigPipelineDeleted

  Consists of:

  allOf

  uid: ConfigPipelineNotificationItem

  Consists of:

  object

  uid: ConfigNotificationItem

  type

  required

  string

  uid: ConfigNotificationType

  Allowed values:
  • "source"
  • "sink"
  • "pipeline"

  action

  required

  string

  uid: ConfigNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"pipeline"

  And with:

  restricted any

  type

  string

  Const:"pipeline"

  action

  string

  Const:"deleted"

  pipeline

  required

  object

  id

  required

  integer

  format: int32>= 0

  Pipeline ID

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    Live video Source created.

    {
      "type": "source",
      "action": "created",
      "source": {
        "id": 2,
        "type": "video",
        "address": "rtsp://localhost:554/axis-media/media.amp"
      }
    }
    

  • #2 Example

    Live video Source updated (address).

    {
      "type": "source",
      "action": "updated",
      "source": {
        "id": 2,
        "address": "rtsp://localhost:8554/h264major"
      }
    }
    

  • #3 Example

    Live video Source deleted.

    {
      "type": "source",
      "action": "deleted",
      "source": {
        "id": 2
      }
    }
    

• PUB /v1/exports/notify

  Notification events for changes to the Exports.

  Specify which events to subscribe to.

  Operation IDexports-subscribe

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  object

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  array<string>

  non-empty

  An initial set of events to subscribe to.

  Items:

  string

  uid: ExportsNotificationType

  Allowed values:
  • "channel"
  • "stream"

  Additional properties are NOT allowed.

  Accepts the following message:

  Exports notification subscriptionExportsNotificationSubscription

  Subscribe or unsubscribe from events.

  Payload

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  object

  non-empty

  A subscription change request.

  (pattern property)

  boolean

  Property names must adhere to:

  string

  uid: ExportsNotificationType

  Allowed values:
  • "channel"
  • "stream"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    Enable all events.

  • #2 Example

    Enable only Channel events.

    {
      "channel": true
    }
    

  • #3 Example

    Disable Channel and enable Stream events.

    {
      "channel": false,
      "stream": true
    }
    

  • #4 Example

    Disable all events (verbose).

    {
      "channel": false,
      "stream": false
    }
    

• SUB /v1/exports/notify

  Notification events for changes to the Exports.

  Open a WebSocket connection to receive notification events for changes to the Exports.

  Operation IDexports-notify

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  object

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  array<string>

  non-empty

  An initial set of events to subscribe to.

  Items:

  string

  uid: ExportsNotificationType

  Allowed values:
  • "channel"
  • "stream"

  Additional properties are NOT allowed.

  Accepts the following message:

  Exports notificationExportsNotification

  Exports changed notification

  Payload

  oneOf

  Adheres to:

  allOf

  uid: ExportsChannelCreated

  Consists of:

  allOf

  uid: ExportsChannelNotificationItem

  Consists of:

  object

  uid: ExportsNotificationItem

  type

  required

  string

  uid: ExportsNotificationType

  Allowed values:
  • "channel"
  • "stream"

  action

  required

  string

  uid: ExportsNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"channel"

  And with:

  restricted any

  type

  string

  Const:"channel"

  action

  string

  Const:"created"

  channel

  required

  object

  id

  required

  number

  format: int32>= 0uid: id

  Channel ID

  pipeline

  required

  integer

  format: int32>= 0

  Pipeline ID

  usecase

  oneOf

  Adheres to:

  string

  Allowed values:
  • "fire-detection"
  • "line-crossing"
  • "mask-detection"
  • "people-counting"
  • "physical-distancing"
  • "pose-detection"
  • "ppe-compliance"
  • "tracing"
  • "zone-violation"

  Or to:

  null

  stream

  oneOf

  Adheres to:

  number

  format: int32>= 0uid: id

  Stream ID

  Or to:

  null

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ExportsChannelUpdated

  Consists of:

  allOf

  uid: ExportsChannelNotificationItem

  Consists of:

  object

  uid: ExportsNotificationItem

  type

  required

  string

  uid: ExportsNotificationType

  Allowed values:
  • "channel"
  • "stream"

  action

  required

  string

  uid: ExportsNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"channel"

  And with:

  restricted any

  type

  string

  Const:"channel"

  action

  string

  Const:"updated"

  channel

  required

  object

  >= 2 properties

  id

  required

  number

  format: int32>= 0uid: id

  Channel ID

  pipeline

  integer

  format: int32>= 0

  Pipeline ID

  usecase

  oneOf

  Adheres to:

  string

  Allowed values:
  • "fire-detection"
  • "line-crossing"
  • "mask-detection"
  • "people-counting"
  • "physical-distancing"
  • "pose-detection"
  • "ppe-compliance"
  • "tracing"
  • "zone-violation"

  Or to:

  null

  stream

  oneOf

  Adheres to:

  number

  format: int32>= 0uid: id

  Stream ID

  Or to:

  null

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ExportsChannelDeleted

  Consists of:

  allOf

  uid: ExportsChannelNotificationItem

  Consists of:

  object

  uid: ExportsNotificationItem

  type

  required

  string

  uid: ExportsNotificationType

  Allowed values:
  • "channel"
  • "stream"

  action

  required

  string

  uid: ExportsNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"channel"

  And with:

  restricted any

  type

  string

  Const:"channel"

  action

  string

  Const:"deleted"

  channel

  required

  object

  id

  required

  number

  format: int32>= 0uid: id

  Channel ID

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ExportsStreamCreated

  Consists of:

  allOf

  uid: ExportsStreamNotificationItem

  Consists of:

  object

  uid: ExportsNotificationItem

  type

  required

  string

  uid: ExportsNotificationType

  Allowed values:
  • "channel"
  • "stream"

  action

  required

  string

  uid: ExportsNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"stream"

  And with:

  restricted any

  type

  string

  Const:"stream"

  action

  string

  Const:"created"

  stream

  required

  object

  id

  required

  number

  format: int32>= 0uid: id

  Stream ID

  source

  required

  integer

  format: int32>= 0

  Source ID

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ExportsStreamUpdated

  Consists of:

  allOf

  uid: ExportsStreamNotificationItem

  Consists of:

  object

  uid: ExportsNotificationItem

  type

  required

  string

  uid: ExportsNotificationType

  Allowed values:
  • "channel"
  • "stream"

  action

  required

  string

  uid: ExportsNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"stream"

  And with:

  restricted any

  type

  string

  Const:"stream"

  action

  string

  Const:"updated"

  stream

  required

  object

  >= 2 properties

  id

  required

  number

  format: int32>= 0uid: id

  Stream ID

  source

  integer

  format: int32>= 0

  Source ID

  Additional properties are NOT allowed.

  Or to:

  allOf

  uid: ExportsStreamDeleted

  Consists of:

  allOf

  uid: ExportsStreamNotificationItem

  Consists of:

  object

  uid: ExportsNotificationItem

  type

  required

  string

  uid: ExportsNotificationType

  Allowed values:
  • "channel"
  • "stream"

  action

  required

  string

  uid: ExportsNotificationAction

  Allowed values:
  • "created"
  • "updated"
  • "deleted"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"stream"

  And with:

  restricted any

  type

  string

  Const:"stream"

  action

  string

  Const:"deleted"

  stream

  required

  object

  id

  required

  number

  format: int32>= 0uid: id

  Stream ID

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    Stream created.

    {
      "type": "stream",
      "action": "created",
      "stream": {
        "id": 0
      }
    }
    

  • #2 Example

    Channel created.

    {
      "type": "channel",
      "action": "created",
      "channel": {
        "id": 0,
        "stream": 0
      }
    }
    

  • #3 Example

    Channel deleted.

    {
      "type": "channel",
      "action": "deleted",
      "channel": {
        "id": 0
      }
    }
    

  • #4 Example

    Stream deleted.

    {
      "type": "stream",
      "action": "deleted",
      "stream": {
        "id": 0
      }
    }
    

• PUB /v1/exports/channels/metadata

  Multi-Channel metadata streaming.

  Specify which channels to subscribe to.

  Operation IDchannels-metadata-subscribe

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  allOf

  1 item:

  object

  uid: ChannelsQuerySubscription

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all channels.

  Or to:

  array<number>

  non-empty

  An initial set of channels to subscribe to.

  Items:

  number

  format: int32>= 0uid: id

  Channel ID

  Additional properties are allowed.

  2 item:

  object

  uid: ChannelMetadataQuerySubscription

  format

  string

  Name of supported metadata formatter

  Default value:"megh"

  Allowed values:
  • "aws"
  • "megh"

  Additional properties are allowed.

  Accepts the following message:

  Channels subscriptionChannelsSubscription

  Specify which Channels to subscribe to.

  Payload

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  array<number>

  The Channels to subscribe to.

  Items:

  number

  format: int32>= 0uid: id

  Channel ID

  Examples

  Payload

  • #1 Example

    Enable all Channels.

  • #2 Example

    Enable only Channels 0 and 1.

    [
      0,
      1
    ]
    

  • #3 Example

    Disable Channel 1.

    [
      1
    ]
    

• SUB /v1/exports/channels/metadata

  Multi-Channel metadata streaming.

  Receive JSON metadata from all inferencing Channels.

  Operation IDchannels-metadata

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  allOf

  1 item:

  object

  uid: ChannelsQuerySubscription

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all channels.

  Or to:

  array<number>

  non-empty

  An initial set of channels to subscribe to.

  Items:

  number

  format: int32>= 0uid: id

  Channel ID

  Additional properties are allowed.

  2 item:

  object

  uid: ChannelMetadataQuerySubscription

  format

  string

  Name of supported metadata formatter

  Default value:"megh"

  Allowed values:
  • "aws"
  • "megh"

  Additional properties are allowed.

  Accepts the following message:

  Channel metadata with IDChannelMetadataWithID

  Metadata for a frame of video extracted by the inferencing Channel.

  Payload

  oneOf

  uid: ChannelMultipartWithID

  Adheres to:

  tuple<number, anyOf, ...optional<string>>

  [ 2 .. 3 ] items

  Multi-part metadata message without timestamp.

  1 item:

  number

  format: int32>= 0uid: id

  Channel ID

  2 item:

  anyOf

  JSON metadata (based on configured use-case).

  Important: Any position or size in the metadata is normalized from 0 to 1 relative to the dimensions of the video. 0,0 indicates top-left. For example, if the video dimensions are 1920x1080 pixels, then 0.5,0.2 encodes the position 960,216 in pixels. This allows the video to be transformed without requiring the metadata to be parsed and transformed too.

  Can adhere to:

  object

  Metadata for the Fire Detection use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified instances of the object.

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Line Crossing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  UpCount

  object

  Additional properties:

  integer

  format: int32

  DownCount

  object

  Additional properties:

  integer

  format: int32

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  ViolatingLines

  array<string>

  The IDs of lines that are being violated by the instance.

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Mask Detection use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Violation

  boolean

  Default value:

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the People Counting use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Physical Distancing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Violation

  boolean

  Default value:

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Pose Detection use-case

  Poses

  array<object>

  Name

  required

  string

  The classification name of the pose.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified instances of the pose.

  Pose

  required

  array<object>

  Name

  required

  string

  The identified part of the pose.

  X

  required

  number

  format: float[ 0 .. 1 ]

  Y

  required

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Connections

  required

  array<integer>

  Items:

  integer

  format: int32>= 0

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the PPE Compliance use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified people.

  Hardhat

  oneOf

  Adheres to:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  PPE gear

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  null

  Vest

  oneOf

  Adheres to:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  PPE gear

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  null

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Tracing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  Id

  required

  string

  Unique tracking ID of the instance.

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  History

  array<array<number>>

  Items:

  array<number>

  2 items

  A 2-dimensional point (x,y) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Zone Violation use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  ViolationZones

  array<string>

  non-empty

  A list of zones (by ID) that this instance is violating.

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional items:

  string

  format: byteuid: ChannelJpeg

  Optional Jpeg image

  Or to:

  tuple<number, anyOf, number, ...optional<string>>

  [ 3 .. 4 ] items

  Multi-part metadata message with timestamp.
  This message format is used when the stream property of the channel is non-null.

  1 item:

  number

  format: int32>= 0uid: id

  Channel ID

  2 item:

  anyOf

  JSON metadata (based on configured use-case).

  Important: Any position or size in the metadata is normalized from 0 to 1 relative to the dimensions of the video. 0,0 indicates top-left. For example, if the video dimensions are 1920x1080 pixels, then 0.5,0.2 encodes the position 960,216 in pixels. This allows the video to be transformed without requiring the metadata to be parsed and transformed too.

  Can adhere to:

  object

  Metadata for the Fire Detection use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified instances of the object.

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Line Crossing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  UpCount

  object

  Additional properties:

  integer

  format: int32

  DownCount

  object

  Additional properties:

  integer

  format: int32

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  ViolatingLines

  array<string>

  The IDs of lines that are being violated by the instance.

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Mask Detection use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Violation

  boolean

  Default value:

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the People Counting use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Physical Distancing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Violation

  boolean

  Default value:

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Pose Detection use-case

  Poses

  array<object>

  Name

  required

  string

  The classification name of the pose.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified instances of the pose.

  Pose

  required

  array<object>

  Name

  required

  string

  The identified part of the pose.

  X

  required

  number

  format: float[ 0 .. 1 ]

  Y

  required

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Connections

  required

  array<integer>

  Items:

  integer

  format: int32>= 0

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the PPE Compliance use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified people.

  Hardhat

  oneOf

  Adheres to:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  PPE gear

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  null

  Vest

  oneOf

  Adheres to:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  PPE gear

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  null

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Tracing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  Id

  required

  string

  Unique tracking ID of the instance.

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  History

  array<array<number>>

  Items:

  array<number>

  2 items

  A 2-dimensional point (x,y) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Zone Violation use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  ViolationZones

  array<string>

  non-empty

  A list of zones (by ID) that this instance is violating.

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  3 item:

  number

  format: doubleuid: ChannelMetadataTimestamp

  Media presentation timestamp (PTS)

  Additional items:

  string

  format: byteuid: ChannelJpeg

  Optional Jpeg image

  Examples

  Payload

  [
    0,
    {
      "Labels": [
        {
          "Name": "string",
          "Confidence": 1,
          "Instances": [
            {
              "BoundingBox": [
                1,
                1,
                1,
                1
              ],
              "Confidence": 1
            }
          ]
        }
      ]
    }
  ]
  

  This example has been generated automatically.

• PUB /v1/exports/channels/notify

  Multi-Channel event notification.

  Specify which channels to subscribe to.

  Operation IDchannels-notify-subscribe

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  object

  uid: ChannelsQuerySubscription

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all channels.

  Or to:

  array<number>

  non-empty

  An initial set of channels to subscribe to.

  Items:

  number

  format: int32>= 0uid: id

  Channel ID

  Additional properties are allowed.

  Accepts the following message:

  Channels subscriptionChannelsSubscription

  Specify which Channels to subscribe to.

  Payload

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  array<number>

  The Channels to subscribe to.

  Items:

  number

  format: int32>= 0uid: id

  Channel ID

  Examples

  Payload

  • #1 Example

    Enable all Channels.

  • #2 Example

    Enable only Channels 0 and 1.

    [
      0,
      1
    ]
    

  • #3 Example

    Disable Channel 1.

    [
      1
    ]
    

• SUB /v1/exports/channels/notify

  Multi-Channel event notification.

  Receive notification events for updates to Channels.

  Operation IDchannels-notify

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  object

  uid: ChannelsQuerySubscription

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all channels.

  Or to:

  array<number>

  non-empty

  An initial set of channels to subscribe to.

  Items:

  number

  format: int32>= 0uid: id

  Channel ID

  Additional properties are allowed.

  Accepts the following message:

  Channel notification with IDChannelNotificationWithID

  Channel statistics changed notification.

  Payload

  allOf

  Consists of:

  restricted any

  id

  required

  number

  format: int32>= 0uid: id

  Channel ID

  And with:

  oneOf

  uid: ChannelNotifications

  Adheres to:

  allOf

  uid: ChannelFPS

  The processing frame rate of the channel

  Consists of:

  object

  uid: ChannelNotification

  type

  required

  string

  uid: ChannelNotificationType

  Allowed values:
  • "fps"
  • "latency"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"fps"

  fps

  required

  number

  format: float>= 0

  The processing frame rate of the channel (measured in frames per second)

  Or to:

  allOf

  uid: ChannelLatency

  The processing latency of the channel

  Consists of:

  object

  uid: ChannelNotification

  type

  required

  string

  uid: ChannelNotificationType

  Allowed values:
  • "fps"
  • "latency"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"latency"

  latency

  required

  number

  format: float>= 0

  The processing latency of the channel (measured in milliseconds)

  Examples

  Payload

  • #1 Example

    FPS changed event (for Channel 0).

    {
      "id": 0,
      "type": "fps",
      "fps": 29.2
    }
    

  • #2 Example

    Latency changed event (for Channel 1).

    {
      "id": 1,
      "type": "latency",
      "latency": 134.1
    }
    

• SUB /v1/exports/channel/{id}/metadata

  Channel metadata streaming.

  Receive JSON metadata from an inferencing Channel.

  Operation IDchannel-metadata

  Parameters

  id

  required

  number

  format: int32>= 0uid: id

  The ID of the Channel to connect to.

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  object

  uid: ChannelMetadataQuerySubscription

  format

  string

  Name of supported metadata formatter

  Default value:"megh"

  Allowed values:
  • "aws"
  • "megh"

  Additional properties are allowed.

  Accepts the following message:

  Channel metadataChannelMetadata

  Metadata for a frame of video extracted by the inferencing Channel.

  Payload

  oneOf

  uid: ChannelMultipart

  Adheres to:

  tuple<anyOf, ...optional<string>>

  [ 1 .. 2 ] items

  Multi-part metadata message without timestamp.

  1 item:

  anyOf

  JSON metadata (based on configured use-case).

  Important: Any position or size in the metadata is normalized from 0 to 1 relative to the dimensions of the video. 0,0 indicates top-left. For example, if the video dimensions are 1920x1080 pixels, then 0.5,0.2 encodes the position 960,216 in pixels. This allows the video to be transformed without requiring the metadata to be parsed and transformed too.

  Can adhere to:

  object

  Metadata for the Fire Detection use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified instances of the object.

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Line Crossing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  UpCount

  object

  Additional properties:

  integer

  format: int32

  DownCount

  object

  Additional properties:

  integer

  format: int32

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  ViolatingLines

  array<string>

  The IDs of lines that are being violated by the instance.

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Mask Detection use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Violation

  boolean

  Default value:

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the People Counting use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Physical Distancing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Violation

  boolean

  Default value:

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Pose Detection use-case

  Poses

  array<object>

  Name

  required

  string

  The classification name of the pose.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified instances of the pose.

  Pose

  required

  array<object>

  Name

  required

  string

  The identified part of the pose.

  X

  required

  number

  format: float[ 0 .. 1 ]

  Y

  required

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Connections

  required

  array<integer>

  Items:

  integer

  format: int32>= 0

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the PPE Compliance use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified people.

  Hardhat

  oneOf

  Adheres to:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  PPE gear

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  null

  Vest

  oneOf

  Adheres to:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  PPE gear

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  null

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Tracing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  Id

  required

  string

  Unique tracking ID of the instance.

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  History

  array<array<number>>

  Items:

  array<number>

  2 items

  A 2-dimensional point (x,y) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Zone Violation use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  ViolationZones

  array<string>

  non-empty

  A list of zones (by ID) that this instance is violating.

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional items:

  string

  format: byteuid: ChannelJpeg

  Optional Jpeg image

  Or to:

  tuple<anyOf, number, ...optional<string>>

  [ 2 .. 3 ] items

  Multi-part metadata message with timestamp.
  This message format is used when the stream property of the channel is non-null.

  1 item:

  anyOf

  JSON metadata (based on configured use-case).

  Important: Any position or size in the metadata is normalized from 0 to 1 relative to the dimensions of the video. 0,0 indicates top-left. For example, if the video dimensions are 1920x1080 pixels, then 0.5,0.2 encodes the position 960,216 in pixels. This allows the video to be transformed without requiring the metadata to be parsed and transformed too.

  Can adhere to:

  object

  Metadata for the Fire Detection use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified instances of the object.

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Line Crossing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  UpCount

  object

  Additional properties:

  integer

  format: int32

  DownCount

  object

  Additional properties:

  integer

  format: int32

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  ViolatingLines

  array<string>

  The IDs of lines that are being violated by the instance.

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Mask Detection use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Violation

  boolean

  Default value:

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the People Counting use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Physical Distancing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Violation

  boolean

  Default value:

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Pose Detection use-case

  Poses

  array<object>

  Name

  required

  string

  The classification name of the pose.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified instances of the pose.

  Pose

  required

  array<object>

  Name

  required

  string

  The identified part of the pose.

  X

  required

  number

  format: float[ 0 .. 1 ]

  Y

  required

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Connections

  required

  array<integer>

  Items:

  integer

  format: int32>= 0

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the PPE Compliance use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<object>

  The identified people.

  Hardhat

  oneOf

  Adheres to:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  PPE gear

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  null

  Vest

  oneOf

  Adheres to:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  PPE gear

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Additional properties are NOT allowed.

  Or to:

  null

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Tracing use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  Id

  required

  string

  Unique tracking ID of the instance.

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  History

  array<array<number>>

  Items:

  array<number>

  2 items

  A 2-dimensional point (x,y) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  object

  Metadata for the Zone Violation use-case

  Labels

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  array<allOf>

  The identified instances of the object.

  Items:

  allOf

  Consists of:

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  object

  Instance

  BoundingBox

  required

  array<number>

  4 items

  A rectangular bounds (x,y,w,h) using normalized coordinates (0 to 1, inclusive).

  Items:

  number

  format: float[ 0 .. 1 ]

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  ViolationZones

  array<string>

  non-empty

  A list of zones (by ID) that this instance is violating.

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  2 item:

  number

  format: doubleuid: ChannelMetadataTimestamp

  Media presentation timestamp (PTS)

  Additional items:

  string

  format: byteuid: ChannelJpeg

  Optional Jpeg image

  Examples

  Payload

  [
    {
      "Labels": [
        {
          "Name": "string",
          "Confidence": 1,
          "Instances": [
            {
              "BoundingBox": [
                1,
                1,
                1,
                1
              ],
              "Confidence": 1
            }
          ]
        }
      ]
    }
  ]
  

  This example has been generated automatically.

• PUB /v1/exports/channel/{id}/notify

  Channel event notification.

  Specify which events to subscribe to.

  Operation IDchannel-notify-subscribe

  Parameters

  id

  required

  number

  format: int32>= 0uid: id

  The ID of the Channel to connect to.

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  object

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  array<string>

  non-empty

  An initial set of events to subscribe to.

  Items:

  string

  uid: ChannelNotificationType

  Allowed values:
  • "fps"
  • "latency"

  Additional properties are NOT allowed.

  Accepts the following message:

  Channel notification subscriptionChannelNotificationSubscription

  Subscribe or unsubscribe from Channel events.

  Payload

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  object

  non-empty

  A subscription change request.

  (pattern property)

  boolean

  Property names must adhere to:

  string

  uid: ChannelNotificationType

  Allowed values:
  • "fps"
  • "latency"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    Enable all events.

  • #2 Example

    Enable FPS events.

    {
      "fps": true
    }
    

  • #3 Example

    Disable FPS and enable latency events.

    {
      "fps": false,
      "latency": true
    }
    

  • #4 Example

    Disable all events (verbose).

    {
      "fps": false,
      "latency": false
    }
    

• SUB /v1/exports/channel/{id}/notify

  Channel event notification.

  Receive notification events for updates to specific Channel.

  Operation IDchannel-notify

  Parameters

  id

  required

  number

  format: int32>= 0uid: id

  The ID of the Channel to connect to.

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  object

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  array<string>

  non-empty

  An initial set of events to subscribe to.

  Items:

  string

  uid: ChannelNotificationType

  Allowed values:
  • "fps"
  • "latency"

  Additional properties are NOT allowed.

  Accepts the following message:

  Channel notificationChannelNotification

  Channel statistic changed notification.

  Payload

  oneOf

  uid: ChannelNotifications

  Adheres to:

  allOf

  uid: ChannelFPS

  The processing frame rate of the channel

  Consists of:

  object

  uid: ChannelNotification

  type

  required

  string

  uid: ChannelNotificationType

  Allowed values:
  • "fps"
  • "latency"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"fps"

  fps

  required

  number

  format: float>= 0

  The processing frame rate of the channel (measured in frames per second)

  Or to:

  allOf

  uid: ChannelLatency

  The processing latency of the channel

  Consists of:

  object

  uid: ChannelNotification

  type

  required

  string

  uid: ChannelNotificationType

  Allowed values:
  • "fps"
  • "latency"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"latency"

  latency

  required

  number

  format: float>= 0

  The processing latency of the channel (measured in milliseconds)

  Examples

  Payload

  • #1 Example

    FPS changed event.

    {
      "type": "fps",
      "fps": 29.2
    }
    

  • #2 Example

    Latency changed event.

    {
      "type": "latency",
      "latency": 134.1
    }
    

• SUB /v1/exports/stream/{id}

  Video streaming.

  Receive a binary stream of fragmented MP4 video.

  • External Docs

  Operation IDmp4-video-stream

  Parameters

  id

  required

  number

  format: int32>= 0uid: id

  The ID of the Stream to connect to.

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  Accepts one of the following messages:

  • #0Stream statusStreamStatus

    Stream status indication.

    • text/plain

    Payload

    oneOf

    Adheres to:

    string

    uid: StreamReset

    Indicates the video has reached end-of-stream and is restarting.

    Const:"reset"

    Examples

    Payload

    • #1 Example

      Reset status.

      reset

  • #1Stream dataStreamData

    Fragmented MP4 video Stream data.

    • video/mp4

    Payload

    string

    format: binary

    Examples

    Payload

    string

    This example has been generated automatically.

• PUB /v1/stats/notify

  Notification events for updates to the Statistics.

  Specify which events to subscribe to.

  Operation IDstats-subscribe

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  object

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  array<string>

  non-empty

  An initial set of events to subscribe to.

  Items:

  string

  uid: StatsType

  Allowed values:
  • "cpu"
  • "memory"

  Additional properties are NOT allowed.

  Accepts the following message:

  Global statistics notification subscriptionStatsNotificationSubscription

  Subscribe or unsubscribe from events.

  Payload

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  object

  non-empty

  A subscription change request.

  (pattern property)

  boolean

  Property names must adhere to:

  string

  uid: StatsType

  Allowed values:
  • "cpu"
  • "memory"

  Additional properties are NOT allowed.

  Examples

  Payload

  • #1 Example

    Enable all events.

  • #2 Example

    Enable only CPU Load events.

    {
      "cpu": true
    }
    

  • #3 Example

    Disable CPU Load and enable Memory events.

    {
      "cpu": false,
      "memory": true
    }
    

  • #4 Example

    Disable all events (verbose).

    {
      "cpu": false,
      "memory": false
    }
    

• SUB /v1/stats/notify

  Notification events for updates to the Statistics.

  Receive notification events for updates to Statistics.

  Operation IDstats-notify

  Channel specific informationws

  bindingVersion

  0.1.0

  method

  GET

  query

  object

  subscribe

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  array<string>

  non-empty

  An initial set of events to subscribe to.

  Items:

  string

  uid: StatsType

  Allowed values:
  • "cpu"
  • "memory"

  Additional properties are NOT allowed.

  Accepts the following message:

  Global stats notificationStatsNotification

  Global statistics changed notification.

  Payload

  oneOf

  Adheres to:

  allOf

  uid: StatCPU

  The CPU load (measured in CPU threads utilized)

  Consists of:

  object

  uid: Stat

  type

  required

  string

  uid: StatsType

  Allowed values:
  • "cpu"
  • "memory"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"cpu"

  cpu

  required

  number

  format: float>= 0

  CPU utilization (measured in CPU threads)

  Or to:

  allOf

  uid: StatMemory

  The amount of memory used (measured in bytes)

  Consists of:

  object

  uid: Stat

  type

  required

  string

  uid: StatsType

  Allowed values:
  • "cpu"
  • "memory"

  Additional properties are allowed.

  And with:

  restricted any

  type

  string

  Const:"memory"

  memory

  required

  object

  Amount of virtual and physical memory used (measured in bytes)

  virtual

  required

  integer

  format: int64>= 0

  Amount of virtual memory used (measured in bytes)

  physical

  required

  integer

  format: int64>= 0

  Amount of resident physical memory used (measured in bytes)

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example

    One CPU thread utilized.

    {
      "type": "cpu",
      "cpu": 1
    }
    

  • #2 Example

    Half of a CPU thread utilized.

    {
      "type": "cpu",
      "cpu": 0.5
    }
    

  • #3 Example

    2.5GiB virtual memory and 800MiB physical RAM used.

    {
      "type": "memory",
      "memory": {
        "virtual": 2684354560,
        "physical": 838860800
      }
    }