Webex · Schema

ShareOut

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
samplingInterval number The sampling interval, in seconds, of the upstream content sharing data.
startTime string The date and time when this content sharing session started.
endTime string The date and time when this content sharing session ended.
packetLoss array The percentage of content sharing packet loss, in float between 0.0 and 100.0, during each sampling interval.
latency array The average latency, in milliseconds, during each sampling interval.
resolutionHeight array The height in pixels of the outgoing share video.
frameRate array The frame rate of the outgoing share video.
mediaBitRate array The bit rate of the outgoing share video.
codec string The codec of the outgoing share video.
jitter array The jitter for the outgoing share video.
transportType string The network protocol used for video transmission.
View JSON Schema on GitHub

JSON Schema

webex-shareout-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShareOut",
  "title": "ShareOut",
  "type": "object",
  "properties": {
    "samplingInterval": {
      "type": "number",
      "example": 60,
      "description": "The sampling interval, in seconds, of the upstream content sharing data."
    },
    "startTime": {
      "type": "string",
      "example": "2020-04-10T17:00:00.000Z",
      "description": "The date and time when this content sharing session started."
    },
    "endTime": {
      "type": "string",
      "example": "2020-04-10T18:00:00.000Z",
      "description": "The date and time when this content sharing session ended."
    },
    "packetLoss": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "The percentage of content sharing packet loss, in float between 0.0 and 100.0, during each sampling interval."
    },
    "latency": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "The average latency, in milliseconds, during each sampling interval."
    },
    "resolutionHeight": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "The height in pixels of the outgoing share video."
    },
    "frameRate": {
      "type": "array",
      "items": {
        "type": "number",
        "example": 25.940001
      },
      "description": "The frame rate of the outgoing share video."
    },
    "mediaBitRate": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "The bit rate of the outgoing share video."
    },
    "codec": {
      "type": "string",
      "example": "H.264 BP",
      "description": "The codec of the outgoing share video."
    },
    "jitter": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "The jitter for the outgoing share video."
    },
    "transportType": {
      "type": "string",
      "enum": [
        "UDP",
        "TCP"
      ],
      "description": "The network protocol used for video transmission."
    }
  }
}