Webex · Schema

AudioIn

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
samplingInterval number The sampling interval, in seconds, of the downstream audio quality data.
startTime string The date and time when this audio session started.
endTime string The date and time when this audio session ended.
packetLoss array The percentage of audio packet loss, as a float between 0.0 and 100.0, during each sampling interval.
latency array The average latency, in milliseconds, during each sampling interval.
resolutionHeight array Not applicable to audio.
frameRate array Not applicable to audio.
mediaBitRate array The bitrate of the incoming audio.
codec string The codec of the incoming audio.
jitter array The incoming audio jitter.
transportType string The network protocol used for video transmission.
View JSON Schema on GitHub

JSON Schema

webex-audioin-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AudioIn",
  "title": "AudioIn",
  "type": "object",
  "properties": {
    "samplingInterval": {
      "type": "number",
      "example": 60,
      "description": "The sampling interval, in seconds, of the downstream audio quality data."
    },
    "startTime": {
      "type": "string",
      "example": "2020-04-10T17:00:00.000Z",
      "description": "The date and time when this audio session started."
    },
    "endTime": {
      "type": "string",
      "example": "2020-04-10T18:00:00.000Z",
      "description": "The date and time when this audio session ended."
    },
    "packetLoss": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "The percentage of audio packet loss, as a 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": "Not applicable to audio."
    },
    "frameRate": {
      "type": "array",
      "items": {
        "type": "number",
        "example": 25.940001
      },
      "description": "Not applicable to audio."
    },
    "mediaBitRate": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "The bitrate of the incoming audio."
    },
    "codec": {
      "type": "string",
      "example": "Opus",
      "description": "The codec of the incoming audio."
    },
    "jitter": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "The incoming audio jitter."
    },
    "transportType": {
      "type": "string",
      "enum": [
        "UDP",
        "TCP"
      ],
      "description": "The network protocol used for video transmission."
    }
  }
}