DocumentationAnalyticsStreaming media services guide

Picture in picture

Last update: June 8, 2026

CREATED FOR:

  • Developer

This page covers data collection for the Picture in picture player state. See Streams impacted by picture in picture, Picture in picture counts, and Picture in picture total duration for the corresponding reporting metrics.

style
shade-box

The picture in picture player state tracks when the viewer enters and exits picture-in-picture playback. Fire a state-start event when picture-in-picture begins and a state-end event when it ends. The backend computes three metrics from these events: streams impacted, count of state entries, and total time in state.

Property
Value
Context data variables
a.media.states.pictureinpicture.set, a.media.states.pictureinpicture.count, a.media.states.pictureinpicture.time
XDM collection field
xdm.mediaCollection.statesStart[] and xdm.mediaCollection.statesEnd[] (entries with name: "pictureInPicture")
Audience Manager traits
c_contextdata.a.media.states.pictureinpicture.set, c_contextdata.a.media.states.pictureinpicture.count, c_contextdata.a.media.states.pictureinpicture.time
Required
No
Sent with
State start, state end
Web SDK

Use sendEvent to send a media.statesUpdate event with the state added to statesStart:

code language-javascript 
alloy("sendEvent", {
  xdm: {
    eventType: "media.statesUpdate",
    mediaCollection: {
      statesStart: [{ name: "pictureInPicture" }],
      sessionID: "{sid}",
      playhead: 60
    }
  }
});

When the viewer exits picture-in-picture, send another event with the state in statesEnd:

code language-javascript 
alloy("sendEvent", {
  xdm: {
    eventType: "media.statesUpdate",
    mediaCollection: {
      statesEnd: [{ name: "pictureInPicture" }],
      sessionID: "{sid}",
      playhead: 90
    }
  }
});
iOS

Use tracker.trackPlayerStateStart() and tracker.trackPlayerStateEnd() with the MediaConstants.PlayerState.PICTURE_IN_PICTURE constant.

code language-swift 
let stateObject = Media.createStateObjectWith(stateName: MediaConstants.PlayerState.PICTURE_IN_PICTURE)

tracker.trackPlayerStateStart(info: stateObject)
tracker.trackPlayerStateEnd(info: stateObject)
Android

Use tracker.trackPlayerStateStart() and tracker.trackPlayerStateEnd() with the MediaConstants.PlayerState.PICTURE_IN_PICTURE constant.

code language-kotlin 
val stateObject = Media.createStateObject(MediaConstants.PlayerState.PICTURE_IN_PICTURE)

tracker.trackPlayerStateStart(stateObject)
tracker.trackPlayerStateEnd(stateObject)
Roku Edge

Use sendMediaEvent to send a media.statesUpdate event with the state added to statesStart:

code language-brightscript 
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.statesUpdate",
        "mediaCollection": {
            "statesStart": [{ "name": "pictureInPicture" }],
            "playhead": 60
        }
    }
})

When the viewer exits picture-in-picture, send another event with the state in statesEnd:

code language-brightscript 
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.statesUpdate",
        "mediaCollection": {
            "statesEnd": [{ "name": "pictureInPicture" }],
            "playhead": 90
        }
    }
})
Media Edge API

Call the statesUpdate endpoint with pictureInPicture in statesStart (or statesEnd when the viewer exits PiP):

code language-json 
{
  "events": [{
    "xdm": {
      "eventType": "media.statesUpdate",
      "mediaCollection": {
        "statesStart": [{ "name": "pictureInPicture" }],
        "sessionID": "{sid}",
        "playhead": 60
      }
    }
  }]
}

Legacy implementation types (Analytics-only)

Media SDK JS 3.x

Use ADB.Media.createStateObject and the ADB.Media.PlayerState.PictureInPicture constant:

code language-javascript 
var stateObject = ADB.Media.createStateObject(ADB.Media.PlayerState.PictureInPicture);

tracker.trackPlayerStateStart(stateObject);
tracker.trackPlayerStateEnd(stateObject);
Chromecast

Use ADBMobile.media.createStateObject with the "pictureInPicture" string directly, as Chromecast does not have named PlayerState constants:

code language-javascript 
var stateObject = ADBMobile.media.createStateObject("pictureInPicture");
ADBMobile.media.trackEvent(ADBMobile.media.Event.StateStart, stateObject);
// When the viewer exits picture-in-picture:
ADBMobile.media.trackEvent(ADBMobile.media.Event.StateEnd, stateObject);
Roku 2.x
Player state tracking is not available in the Roku 2.x SDK. To track player states, use the Roku Edge SDK.
Media Collection API

Send a stateStart POST request when picture-in-picture begins, and a stateEnd POST when it ends:

code language-json 
{
  "playerTime": { "playhead": 60, "ts": 1699523820000 },
  "eventType": "stateStart",
  "params": {
    "media.state.name": "pictureInPicture"
  }
}

See the Media Collection API events reference for the full request structure.

recommendation-more-help
media-analytics-help