Operations

• CONF /v1/config/notify

  Notification events for changes to the Configuration.

  Specify which events to subscribe to.

  Operation IDconfig-subscribe

  Channel specific informationws

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  object

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  Expand all

  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

  Expand all

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  Expand all

  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

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  object

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  Expand all

  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

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  uid: ConfigSourceCreated

  type

  required

  string

  Const:"source"

  action

  required

  string

  Const:"created"

  value

  Expand all

  required

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  integer

  format: int32>= 0

  Source ID

  And with:

  Expand all

  allOf

  Consists of:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  type

  string

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

  address

  Expand all

  oneOf

  Adheres to:

  string

  format: url

  Short-form Source address.

  Or to:

  Expand all

  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

  Default value:30

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  stream

  number

  format: int32>= 0uid: id

  Stream ID

  And with:

  restricted any

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ConfigSourceUpdated

  type

  required

  string

  Const:"source"

  action

  required

  string

  Const:"updated"

  value

  Expand all

  required

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  integer

  format: int32>= 0

  Source ID

  And with:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  type

  string

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

  address

  Expand all

  oneOf

  Adheres to:

  string

  format: url

  Short-form Source address.

  Or to:

  Expand all

  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

  Default value:30

  Additional properties are allowed.

  And with:

  Expand all

  restricted any

  stream

  number

  format: int32>= 0uid: id

  Stream ID

  And with:

  restricted any

  >= 2 properties

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ConfigSourceStats

  type

  required

  string

  Const:"source"

  action

  required

  string

  Const:"stats"

  value

  Expand all

  required

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  integer

  format: int32>= 0

  Source ID

  And with:

  Expand all

  object

  status

  required

  string

  Status codes for programmatic use:

  • "starting": Execution node is starting up
  • "ready": Execution node has started up and is ready to process data
  • "running": Execution node has started up and is actively processing data
  • "stalled": Execution node has become unresponsive for an unknown reason
  • "error": An error has occurred within the execution node

  Allowed values:
  • "starting"
  • "ready"
  • "running"
  • "stalled"
  • "error"

  code

  string

  Error code for programmatic error handling:

  • "access": Unable to access camera over network
  • "auth": Invalid camera credentials
  • "unknown": Unidentified error

  Allowed values:
  • "access"
  • "auth"
  • "unknown"

  reason

  string

  Error reason string for debugging purposes only

  fps

  required

  number

  format: float>= 0

  latency

  required

  number

  format: float>= 0

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ConfigSourceDeleted

  type

  required

  string

  Const:"source"

  action

  required

  string

  Const:"deleted"

  value

  Expand all

  required

  object

  id

  required

  integer

  format: int32>= 0

  Source ID

  Additional properties are NOT allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ConfigSinkCreated

  type

  required

  string

  Const:"sink"

  action

  required

  string

  Const:"created"

  value

  Expand all

  required

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  integer

  format: int32>= 0

  Sink ID

  And with:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  type

  string

  Allowed values:
  • "file"
  • "embedding"
  • "zmq"
  • "zmqinternal"
  • "inf"

  address

  string

  format: url

  filter

  Expand all

  array<integer>

  A list of sources to include. An empty list indicates no filtering is enabled.

  Default value:[]

  Items:

  integer

  format: int32>= 0

  Source ID

  Additional properties are allowed.

  And with:

  restricted any

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ConfigSinkUpdated

  type

  required

  string

  Const:"sink"

  action

  required

  string

  Const:"updated"

  value

  Expand all

  required

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  integer

  format: int32>= 0

  Sink ID

  And with:

  Expand all

  object

  type

  string

  Allowed values:
  • "file"
  • "embedding"
  • "zmq"
  • "zmqinternal"
  • "inf"

  address

  string

  format: url

  filter

  Expand all

  array<integer>

  A list of sources to include. An empty list indicates no filtering is enabled.

  Default value:[]

  Items:

  integer

  format: int32>= 0

  Source ID

  Additional properties are allowed.

  And with:

  restricted any

  >= 2 properties

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ConfigSinkStats

  type

  required

  string

  Const:"sink"

  action

  required

  string

  Const:"stats"

  value

  Expand all

  required

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  integer

  format: int32>= 0

  Sink ID

  And with:

  Expand all

  object

  status

  required

  string

  Status codes for programmatic use:

  • "starting": Execution node is starting up
  • "ready": Execution node has started up and is ready to process data
  • "running": Execution node has started up and is actively processing data
  • "stalled": Execution node has become unresponsive for an unknown reason
  • "error": An error has occurred within the execution node

  Allowed values:
  • "starting"
  • "ready"
  • "running"
  • "stalled"
  • "error"

  code

  string

  Error code for programmatic error handling:

  • "access": Unable to access camera over network
  • "auth": Invalid camera credentials
  • "unknown": Unidentified error

  Allowed values:
  • "access"
  • "auth"
  • "unknown"

  reason

  string

  Error reason string for debugging purposes only

  fps

  required

  number

  format: float>= 0

  latency

  required

  number

  format: float>= 0

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ConfigSinkDeleted

  type

  required

  string

  Const:"sink"

  action

  required

  string

  Const:"deleted"

  value

  Expand all

  required

  object

  id

  required

  integer

  format: int32>= 0

  Sink ID

  Additional properties are NOT allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ConfigPipelineCreated

  type

  required

  string

  Const:"pipeline"

  action

  required

  string

  Const:"created"

  value

  Expand all

  required

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  integer

  format: int32>= 0

  Pipeline ID

  And with:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  elements

  Expand all

  array<oneOf>

  non-empty

  Sequence of processing stages

  Items:

  Expand all

  oneOf

  Adheres to:

  string

  Short-form Pipeline element.

  Or to:

  Expand all

  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"

  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

  Expand all

  object

  A mapping from Source IDs to static metadata JSON.

  This enables configuring different static metadata for the Pipeline based on the Source. The static metadata is served for the Channel produced from the Source and Pipeline. The keys of this object are Source IDs and the values are arbitrary JSON objects. Multiple Source IDs may be included in each key by separating them with commas.

  If this property is omitted, then an empty JSON object is used by default for unspecified sources. Using an empty string key in this mapping allows overriding the default JSON object.

  Property names must adhere to:

  Expand all

  oneOf

  Adheres to:

  restricted any

  must match: ^(\d+,?)+$

  Or to:

  string

  Allowed values:
  • ""

  Additional properties:

  Expand all

  object

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

  Extensions

  Expand all

  x-additionalPropertiesName

  source-id

  Additional properties are allowed.

  Additional properties are allowed.

  usecase

  string

  The high-level description of the analytics performed by the pipeline.

  sources

  Expand all

  array<integer>

  IDs of input sources to the pipeline

  Items:

  integer

  format: int32>= 0

  Source ID

  sinks

  Expand all

  array<integer>

  IDs of output sinks from the pipeline

  Items:

  integer

  format: int32>= 0

  Sink ID

  Additional properties are allowed.

  And with:

  restricted any

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ConfigPipelineUpdated

  type

  required

  string

  Const:"pipeline"

  action

  required

  string

  Const:"updated"

  value

  Expand all

  required

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  integer

  format: int32>= 0

  Pipeline ID

  And with:

  Expand all

  object

  elements

  Expand all

  array<oneOf>

  non-empty

  Sequence of processing stages

  Items:

  Expand all

  oneOf

  Adheres to:

  string

  Short-form Pipeline element.

  Or to:

  Expand all

  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"

  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

  Expand all

  object

  A mapping from Source IDs to static metadata JSON.

  This enables configuring different static metadata for the Pipeline based on the Source. The static metadata is served for the Channel produced from the Source and Pipeline. The keys of this object are Source IDs and the values are arbitrary JSON objects. Multiple Source IDs may be included in each key by separating them with commas.

  If this property is omitted, then an empty JSON object is used by default for unspecified sources. Using an empty string key in this mapping allows overriding the default JSON object.

  Property names must adhere to:

  Expand all

  oneOf

  Adheres to:

  restricted any

  must match: ^(\d+,?)+$

  Or to:

  string

  Allowed values:
  • ""

  Additional properties:

  Expand all

  object

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

  Extensions

  Expand all

  x-additionalPropertiesName

  source-id

  Additional properties are allowed.

  Additional properties are allowed.

  usecase

  string

  The high-level description of the analytics performed by the pipeline.

  sources

  Expand all

  array<integer>

  IDs of input sources to the pipeline

  Items:

  integer

  format: int32>= 0

  Source ID

  sinks

  Expand all

  array<integer>

  IDs of output sinks from the pipeline

  Items:

  integer

  format: int32>= 0

  Sink ID

  Additional properties are allowed.

  And with:

  restricted any

  >= 2 properties

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ConfigPipelineStats

  type

  required

  string

  Const:"pipeline"

  action

  required

  string

  Const:"stats"

  value

  Expand all

  required

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  integer

  format: int32>= 0

  Pipeline ID

  And with:

  Expand all

  object

  status

  required

  string

  Status codes for programmatic use:

  • "starting": Execution node is starting up
  • "ready": Execution node has started up and is ready to process data
  • "running": Execution node has started up and is actively processing data
  • "stalled": Execution node has become unresponsive for an unknown reason
  • "error": An error has occurred within the execution node

  Allowed values:
  • "starting"
  • "ready"
  • "running"
  • "stalled"
  • "error"

  code

  string

  Error code for programmatic error handling:

  • "access": Unable to access camera over network
  • "auth": Invalid camera credentials
  • "unknown": Unidentified error

  Allowed values:
  • "access"
  • "auth"
  • "unknown"

  reason

  string

  Error reason string for debugging purposes only

  fps

  required

  number

  format: float>= 0

  latency

  required

  number

  format: float>= 0

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ConfigPipelineDeleted

  type

  required

  string

  Const:"pipeline"

  action

  required

  string

  Const:"deleted"

  value

  Expand all

  required

  object

  id

  required

  integer

  format: int32>= 0

  Pipeline ID

  Additional properties are NOT allowed.

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example

    Live video Source created.

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

  • #2 Example

    Live video Source updated (address and rate).

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

  • #3 Example

    Live video Source stats updated.

    {
      "type": "source",
      "action": "stats",
      "value": {
        "status": "running",
        "fps": 15,
        "latency": 12.85
      }
    }
    

  • #4 Example

    Live video Source deleted.

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

  • #5 Example

    File Sink created.

    {
      "type": "sink",
      "action": "created",
      "value": {
        "id": 1,
        "type": "file",
        "address": "./output.mp4",
        "filter": []
      }
    }
    

  • #6 Example

    File Sink updated (address and filter).

    {
      "type": "sink",
      "action": "updated",
      "value": {
        "id": 1,
        "type": "video",
        "address": "./new_output.mp4",
        "filter": [
          2
        ]
      }
    }
    

  • #7 Example

    File Sink stats updated.

    {
      "type": "sink",
      "action": "stats",
      "value": {
        "status": "running",
        "fps": 14.8,
        "latency": 147.2
      }
    }
    

  • #8 Example

    File Sink deleted.

    {
      "type": "sink",
      "action": "deleted",
      "value": {
        "id": 1
      }
    }
    

  • #9 Example

    Pipeline created.

    {
      "type": "pipeline",
      "action": "created",
      "value": {
        "id": 0,
        "elements": [
          "person-detection-nano:a:0.3:0.3",
          "object-tracking-OH:3:3:50:bottom:0.2:3"
        ],
        "usecase": "my-usecase",
        "sources": [
          2
        ],
        "sinks": [
          1
        ]
      }
    }
    

  • #10 Example

    Pipeline updated (usecase and sinks).

    {
      "type": "pipeline",
      "action": "updated",
      "value": {
        "id": 0,
        "elements": [
          "person-detection-nano:a:0.3:0.3",
          "object-tracking-OH:3:3:50:bottom:0.2:3"
        ],
        "usecase": "new-usecase",
        "sources": [
          2
        ],
        "sinks": []
      }
    }
    

  • #11 Example

    Pipeline stats updated.

    {
      "type": "pipeline",
      "action": "stats",
      "value": {
        "status": "running",
        "fps": 14.9,
        "latency": 122.67
      }
    }
    

  • #12 Example

    Pipeline deleted.

    {
      "type": "pipeline",
      "action": "deleted",
      "value": {
        "id": 0
      }
    }
    

• CONF /v1/exports/notify

  Notification events for changes to the Exports.

  Specify which events to subscribe to.

  Operation IDexports-subscribe

  Channel specific informationws

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  object

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  Expand all

  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

  Expand all

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  Expand all

  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

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  object

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  Expand all

  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

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  uid: ExportsChannelCreated

  type

  required

  string

  Const:"channel"

  action

  required

  string

  Const:"created"

  value

  Expand all

  required

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  number

  format: int32>= 0uid: id

  Channel ID

  And with:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  source

  integer

  format: int32>= 0

  Source ID

  pipeline

  integer

  format: int32>= 0

  Pipeline ID

  stream

  Expand all

  oneOf

  Adheres to:

  number

  format: int32>= 0uid: id

  Stream ID

  Or to:

  null

  Additional properties are allowed.

  And with:

  restricted any

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ExportsChannelDeleted

  type

  required

  string

  Const:"channel"

  action

  required

  string

  Const:"deleted"

  value

  Expand all

  required

  object

  id

  required

  number

  format: int32>= 0uid: id

  Channel ID

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ExportsStreamCreated

  type

  required

  string

  Const:"stream"

  action

  required

  string

  Const:"created"

  value

  Expand all

  required

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  number

  format: int32>= 0uid: id

  Stream ID

  And with:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  sources

  Expand all

  array<integer>

  non-empty

  Items:

  integer

  format: int32>= 0

  Source ID

  Additional properties are allowed.

  And with:

  restricted any

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ExportsStreamDeleted

  type

  required

  string

  Const:"stream"

  action

  required

  string

  Const:"deleted"

  value

  Expand all

  required

  object

  id

  required

  number

  format: int32>= 0uid: id

  Stream ID

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example

    Stream created.

    {
      "type": "stream",
      "action": "created",
      "value": {
        "id": 0,
        "sources": [
          2
        ]
      }
    }
    

  • #2 Example

    Channel created.

    {
      "type": "channel",
      "action": "created",
      "value": {
        "id": 1,
        "source": 2,
        "pipeline": 3,
        "stream": 0
      }
    }
    

  • #3 Example

    Channel deleted.

    {
      "type": "channel",
      "action": "deleted",
      "value": {
        "id": 1
      }
    }
    

  • #4 Example

    Stream deleted.

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

• CONF /v1/exports/channels/metadata

  Multi-Channel metadata streaming.

  Specify which channels to subscribe to.

  Operation IDchannels-metadata-subscribe

  Channel specific informationws

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  allOf

  Expand all

  1 item:

  Expand all

  object

  uid: ChannelsQuerySubscription

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all channels.

  Or to:

  Expand all

  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:

  Expand all

  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

  Expand all

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  Expand all

  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

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  allOf

  Expand all

  1 item:

  Expand all

  object

  uid: ChannelsQuerySubscription

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all channels.

  Or to:

  Expand all

  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:

  Expand all

  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

  Expand all

  oneOf

  uid: ChannelMultipartWithID

  Adheres to:

  Expand all

  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:

  Expand all

  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:

  Expand all

  object

  Metadata for the Fire Detection use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<object>

  The identified instances of the object.

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Line Crossing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  UpCount

  Expand all

  object

  Additional properties:

  integer

  format: int32

  DownCount

  Expand all

  object

  Additional properties:

  integer

  format: int32

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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.

  CrossedLines

  Expand all

  array<string>

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

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  Expand all

  object

  Metadata for the Mask Detection use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the People Counting use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Physical Distancing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Pose Detection use-case

  Poses

  Expand all

  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

  Expand all

  array<object>

  The identified instances of the pose.

  Pose

  Expand all

  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

  Expand all

  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:

  Expand all

  object

  Metadata for the PPE Compliance use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<object>

  The identified people.

  Hardhat

  Expand all

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  PPE gear

  BoundingBox

  Expand all

  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

  Expand all

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  PPE gear

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Tracing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  Id

  required

  string

  Unique tracking ID of the instance.

  BoundingBox

  Expand all

  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

  Expand all

  array<array<number>>

  Items:

  Expand all

  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:

  Expand all

  object

  Metadata for the Zone Violation use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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.

  IntersectedZones

  Expand all

  array<string>

  non-empty

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

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional items:

  string

  format: bytemedia type: image/jpegencoding: base64uid: ChannelJpeg

  Optional Jpeg image

  Or to:

  Expand all

  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:

  Expand all

  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:

  Expand all

  object

  Metadata for the Fire Detection use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<object>

  The identified instances of the object.

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Line Crossing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  UpCount

  Expand all

  object

  Additional properties:

  integer

  format: int32

  DownCount

  Expand all

  object

  Additional properties:

  integer

  format: int32

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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.

  CrossedLines

  Expand all

  array<string>

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

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  Expand all

  object

  Metadata for the Mask Detection use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the People Counting use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Physical Distancing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Pose Detection use-case

  Poses

  Expand all

  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

  Expand all

  array<object>

  The identified instances of the pose.

  Pose

  Expand all

  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

  Expand all

  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:

  Expand all

  object

  Metadata for the PPE Compliance use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<object>

  The identified people.

  Hardhat

  Expand all

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  PPE gear

  BoundingBox

  Expand all

  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

  Expand all

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  PPE gear

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Tracing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  Id

  required

  string

  Unique tracking ID of the instance.

  BoundingBox

  Expand all

  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

  Expand all

  array<array<number>>

  Items:

  Expand all

  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:

  Expand all

  object

  Metadata for the Zone Violation use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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.

  IntersectedZones

  Expand all

  array<string>

  non-empty

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

  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: bytemedia type: image/jpegencoding: base64uid: 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.

• CONF /v1/exports/channels/notify

  Multi-Channel event notification.

  Specify which channels to subscribe to.

  Operation IDchannels-notify-subscribe

  Channel specific informationws

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  object

  uid: ChannelsQuerySubscription

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all channels.

  Or to:

  Expand all

  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

  Expand all

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  Expand all

  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

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  object

  uid: ChannelsQuerySubscription

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all channels.

  Or to:

  Expand all

  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

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  id

  required

  number

  format: int32>= 0uid: id

  Channel ID

  And with:

  Expand all

  oneOf

  uid: ChannelNotifications

  Adheres to:

  Expand all

  object

  uid: ChannelFPS

  The processing frame rate of the channel

  type

  required

  string

  Const:"fps"

  value

  required

  number

  format: float>= 0

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

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ChannelLatency

  The processing latency of the channel

  type

  required

  string

  Const:"latency"

  value

  required

  number

  format: float>= 0

  The processing latency of the channel (measured in milliseconds)

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example

    FPS changed event (for Channel 0).

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

  • #2 Example

    Latency changed event (for Channel 1).

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

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

  Channel metadata streaming.

  Receive JSON metadata from an inferencing Channel.

  Operation IDchannel-metadata

  Parameters

  Expand all

  id

  required

  number

  format: int32>= 0uid: id

  The ID of the Channel to connect to.

  Channel specific informationws

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  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

  Expand all

  oneOf

  uid: ChannelMultipart

  Adheres to:

  Expand all

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

  [ 1 .. 2 ] items

  Multi-part metadata message without timestamp.

  1 item:

  Expand all

  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:

  Expand all

  object

  Metadata for the Fire Detection use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<object>

  The identified instances of the object.

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Line Crossing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  UpCount

  Expand all

  object

  Additional properties:

  integer

  format: int32

  DownCount

  Expand all

  object

  Additional properties:

  integer

  format: int32

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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.

  CrossedLines

  Expand all

  array<string>

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

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  Expand all

  object

  Metadata for the Mask Detection use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the People Counting use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Physical Distancing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Pose Detection use-case

  Poses

  Expand all

  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

  Expand all

  array<object>

  The identified instances of the pose.

  Pose

  Expand all

  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

  Expand all

  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:

  Expand all

  object

  Metadata for the PPE Compliance use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<object>

  The identified people.

  Hardhat

  Expand all

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  PPE gear

  BoundingBox

  Expand all

  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

  Expand all

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  PPE gear

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Tracing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  Id

  required

  string

  Unique tracking ID of the instance.

  BoundingBox

  Expand all

  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

  Expand all

  array<array<number>>

  Items:

  Expand all

  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:

  Expand all

  object

  Metadata for the Zone Violation use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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.

  IntersectedZones

  Expand all

  array<string>

  non-empty

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

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional items:

  string

  format: bytemedia type: image/jpegencoding: base64uid: ChannelJpeg

  Optional Jpeg image

  Or to:

  Expand all

  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:

  Expand all

  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:

  Expand all

  object

  Metadata for the Fire Detection use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<object>

  The identified instances of the object.

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Line Crossing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  UpCount

  Expand all

  object

  Additional properties:

  integer

  format: int32

  DownCount

  Expand all

  object

  Additional properties:

  integer

  format: int32

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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.

  CrossedLines

  Expand all

  array<string>

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

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Or to:

  Expand all

  object

  Metadata for the Mask Detection use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the People Counting use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Physical Distancing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Pose Detection use-case

  Poses

  Expand all

  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

  Expand all

  array<object>

  The identified instances of the pose.

  Pose

  Expand all

  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

  Expand all

  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:

  Expand all

  object

  Metadata for the PPE Compliance use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<object>

  The identified people.

  Hardhat

  Expand all

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  PPE gear

  BoundingBox

  Expand all

  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

  Expand all

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  PPE gear

  BoundingBox

  Expand all

  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:

  Expand all

  object

  Metadata for the Tracing use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  Id

  required

  string

  Unique tracking ID of the instance.

  BoundingBox

  Expand all

  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

  Expand all

  array<array<number>>

  Items:

  Expand all

  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:

  Expand all

  object

  Metadata for the Zone Violation use-case

  Labels

  Expand all

  array<object>

  Name

  required

  string

  The classification name.

  Confidence

  required

  number

  format: float[ 0 .. 1 ]

  A percentage-based confidence of the classification.

  Instances

  Expand all

  array<allOf>

  The identified instances of the object.

  Items:

  Expand all

  allOf

  Consists of:

  Expand all

  restricted any

  An instance which can be blurred using its bounding box.

  Blur

  Expand all

  oneOf

  Adheres to:

  string

  Allowed values:
  • "box"
  • "circle"

  Or to:

  null

  And with:

  Expand all

  object

  Instance

  BoundingBox

  Expand all

  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.

  IntersectedZones

  Expand all

  array<string>

  non-empty

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

  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: bytemedia type: image/jpegencoding: base64uid: 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.

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

  Channel event notification.

  Specify which events to subscribe to.

  Operation IDchannel-notify-subscribe

  Parameters

  Expand all

  id

  required

  number

  format: int32>= 0uid: id

  The ID of the Channel to connect to.

  Channel specific informationws

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  object

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  Expand all

  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

  Expand all

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  Expand all

  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

  Expand all

  id

  required

  number

  format: int32>= 0uid: id

  The ID of the Channel to connect to.

  Channel specific informationws

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  object

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  Expand all

  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

  Expand all

  oneOf

  uid: ChannelNotifications

  Adheres to:

  Expand all

  object

  uid: ChannelFPS

  The processing frame rate of the channel

  type

  required

  string

  Const:"fps"

  value

  required

  number

  format: float>= 0

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

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: ChannelLatency

  The processing latency of the channel

  type

  required

  string

  Const:"latency"

  value

  required

  number

  format: float>= 0

  The processing latency of the channel (measured in milliseconds)

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example

    FPS changed event.

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

  • #2 Example

    Latency changed event.

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

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

  Video streaming.

  Receive a binary stream of fragmented MP4 video.

  • External Docs

  Operation IDmp4-video-stream

  Parameters

  Expand all

  id

  required

  number

  format: int32>= 0uid: id

  The ID of the Stream to connect to.

  Channel specific informationws

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  Accepts one of the following messages:

  • #0Stream statusStreamStatus

    Stream status indication.

    • text/plain

    Payload

    Expand all

    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.

• CONF /v1/stats/notify

  Notification events for updates to the Statistics.

  Specify which events to subscribe to.

  Operation IDstats-subscribe

  Channel specific informationws

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  object

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  Expand all

  array<string>

  non-empty

  An initial set of events to subscribe to.

  Items:

  string

  uid: StatsType

  Allowed values:
  • "uptime"
  • "cpu"
  • "memory"
  • "activated"

  Additional properties are NOT allowed.

  Accepts the following message:

  Global statistics notification subscriptionStatsNotificationSubscription

  Subscribe or unsubscribe from events.

  Payload

  Expand all

  oneOf

  Adheres to:

  boolean

  The subscription state for all events.

  Or to:

  Expand all

  object

  non-empty

  A subscription change request.

  (pattern property)

  boolean

  Property names must adhere to:

  string

  uid: StatsType

  Allowed values:
  • "uptime"
  • "cpu"
  • "memory"
  • "activated"

  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

  Expand all

  bindingVersion

  0.1.0

  method

  GET

  query

  Expand all

  object

  subscribe

  Expand all

  oneOf

  Adheres to:

  boolean

  The initial subscription state for all events.

  Or to:

  Expand all

  array<string>

  non-empty

  An initial set of events to subscribe to.

  Items:

  string

  uid: StatsType

  Allowed values:
  • "uptime"
  • "cpu"
  • "memory"
  • "activated"

  Additional properties are NOT allowed.

  Accepts the following message:

  Global stats notificationStatsNotification

  Global statistics changed notification.

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  uid: StatUptime

  The uptime (in seconds) since Nimble started

  type

  required

  string

  Const:"uptime"

  value

  required

  number

  format: float>= 0

  The uptime (in seconds) since Nimble started

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: StatCPU

  The CPU load (measured in CPU threads utilized)

  type

  required

  string

  Const:"cpu"

  value

  required

  number

  format: float>= 0

  CPU utilization (measured in CPU threads)

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: StatMemory

  The amount of memory used (measured in bytes)

  type

  required

  string

  Const:"memory"

  value

  Expand all

  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.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  uid: StatActivated

  The activation status

  type

  required

  string

  Const:"activated"

  value

  required

  boolean

  Whether Nimble is activated or not.

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example

    Uptime (in seconds).

    {
      "type": "uptime",
      "value": 29.763
    }
    

  • #2 Example

    One CPU thread utilized.

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

  • #3 Example

    Half of a CPU thread utilized.

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

  • #4 Example

    2.5GiB virtual memory and 800MiB physical RAM used.

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

  • #5 Example

    Nimble is activated.

    {
      "type": "activated",
      "value": true
    }