Error

The error event signals that the media player encountered an error. Tracking an error does not close the session. If the error prevents playback from continuing, call Session end after the error event.

The errorDetails.source property accepts only two values: player (errors originating in the media player) and external (errors from an outside source such as a CDN or network).

Web SDK

Call sendEvent with eventType: "media.error" and the required errorDetails:

alloy("sendEvent", {
  xdm: {
    eventType: "media.error",
    mediaCollection: {
      errorDetails: {
        name: "media-error-001",
        source: "player"
      },
      sessionID: "{sid}",
      playhead: 45
    }
  }
});

Mobile SDK

Call trackError with an error ID string.

iOS (Swift)

tracker.trackError(errorId: "media-error-001")

Android (Kotlin)

tracker.trackError("media-error-001")

Roku (BrightScript)

Call sendMediaEvent with eventType: "media.error" and the required errorDetails:

m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.error",
        "mediaCollection": {
            "errorDetails": {
                "name": "media-error-001",
                "source": "player"
            },
            "playhead": 45
        }
    }
})

Media Edge API

Call the error endpoint with the required errorDetails:

curl -X POST "https://edge.adobedc.net/ee/va/v1/error?configId={datastreamID}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [{
    "xdm": {
      "eventType": "media.error",
      "mediaCollection": {
        "sessionID": "{sid}",
        "playhead": 45,
        "errorDetails": {
          "name": "media-error-001",
          "source": "player"
        }
      },
      "timestamp": "YYYY-08-20T22:41:40+00:00"
    }
  }]
}'

Media SDK

Call trackError with an error ID string:

tracker.trackError("media-error-001");

Media Collection API

Send an error POST to the events endpoint:

{
  "playerTime": { "playhead": 45, "ts": 1699523820000 },
  "eventType": "error",
  "params": {
    "media.errorId": "media-error-001",
    "media.errorSource": "player"
  }
}