Buffer start endpoint

The bufferStart endpoint lets you track the quality and consistency of content playback based on the visitor's connection or media availability. Call this endpoint whenever the media player enters a buffering state. See Media Edge API implementation examples for more examples calling this endpoint.

A "Buffer resume" endpoint does not exist using this API; instead, it is inferred when you call the play endpoint following bufferStart. Call the play endpoint when the media player exits a buffered state and resumes playing content.

Usage of this endpoint requires an active session. Make sure that you call the sessionStart endpoint first to obtain a valid session ID.

bufferStart

POST https://edge.adobedc.net/ee/va/v1/bufferStart?configId={datastreamID}

Copy
curl -X POST "https://edge.adobedc.net/ee/va/v1/bufferStart?configId={datastreamID}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.bufferStart",
        "mediaCollection": {
          "sessionID": "ffab5[...]45ec3",
          "playhead": 0
        },
        "timestamp": "YYYY-08-20T22:41:40+00:00"
      }
    }
  ]
}'
Copied to your clipboard
curl -X POST "https://edge.adobedc.net/ee/va/v1/bufferStart?configId={datastreamID}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.bufferStart",
        "mediaCollection": {
          "sessionID": "ffab5[...]45ec3",
          "playhead": 0
        },
        "timestamp": "YYYY-08-20T22:41:40+00:00"
      }
    }
  ]
}'

If successfully processed, the API returns 204 No Content.

This endpoint requires the following payload properties within the xdm object:

Last updated 10/5/2024

Was this helpful?

Yes

No