Amazon MediaLive · JSON Structure

Medialive Api Esam Structure

Esam

Type: object Properties: 6 Required: 2
BroadcastingMedia ProcessingMedia

Esam is a JSON Structure definition published by Amazon MediaLive, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

AcquisitionPointId AdAvailOffset PasswordParam PoisEndpoint Username ZoneIdentity

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-medialive/refs/heads/main/json-structure/medialive-api-esam-structure.json",
  "name": "Esam",
  "type": "object",
  "description": "Esam",
  "properties": {
    "AcquisitionPointId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__stringMax256"
        },
        {
          "xml": {
            "name": "acquisitionPointId"
          },
          "description": "Sent as acquisitionPointIdentity to identify the MediaLive channel to the POIS."
        }
      ]
    },
    "AdAvailOffset": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integerMinNegative1000Max1000"
        },
        {
          "xml": {
            "name": "adAvailOffset"
          },
          "description": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages."
        }
      ]
    },
    "PasswordParam": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "passwordParam"
          },
          "description": "Documentation update needed"
        }
      ]
    },
    "PoisEndpoint": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__stringMax2048"
        },
        {
          "xml": {
            "name": "poisEndpoint"
          },
          "description": "The URL of the signal conditioner endpoint on the Placement Opportunity Information System (POIS). MediaLive sends SignalProcessingEvents here when SCTE-35 messages are read."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "username"
          },
          "description": "Documentation update needed"
        }
      ]
    },
    "ZoneIdentity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__stringMax256"
        },
        {
          "xml": {
            "name": "zoneIdentity"
          },
          "description": "Optional data sent as zoneIdentity to identify the MediaLive channel to the POIS."
        }
      ]
    }
  },
  "required": [
    "AcquisitionPointId",
    "PoisEndpoint"
  ]
}