DocumentationAnalyticsStreaming media services guide

Full screen

Last update: June 8, 2026

CREATED FOR:

  • Developer

This page covers data collection for the Full screen player state. See Streams impacted by full screen, Full screen counts, and Full screen total duration for the corresponding reporting metrics.

style
shade-box

The full-screen player state tracks when the viewer enters and exits full-screen playback. Fire a state-start event whenever the viewer enters full-screen and a state-end event when the viewer exits. 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.fullscreen.set, a.media.states.fullscreen.count, a.media.states.fullscreen.time
XDM collection field
xdm.mediaCollection.statesStart[] and xdm.mediaCollection.statesEnd[] (entries with name: "fullscreen")
Audience Manager traits
c_contextdata.a.media.states.fullscreen.set, c_contextdata.a.media.states.fullscreen.count, c_contextdata.a.media.states.fullscreen.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: "fullscreen" }],
      sessionID: "{sid}",
      playhead: 60
    }
  }
});

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

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

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

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

tracker.trackPlayerStateStart(info: stateObject)
// ...later, when the user exits full-screen:
tracker.trackPlayerStateEnd(info: stateObject)
Android

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

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

tracker.trackPlayerStateStart(stateObject)
// ...later, when the user exits full-screen:
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": "fullscreen" }],
            "playhead": 60
        }
    }
})

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

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

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

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

Legacy implementation types (Analytics-only)

Media SDK JS 3.x

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

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

tracker.trackPlayerStateStart(stateObject);
// ...later, when the user exits full-screen:
tracker.trackPlayerStateEnd(stateObject);
Chromecast

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

code language-javascript 
var stateObject = ADBMobile.media.createStateObject("fullscreen");
ADBMobile.media.trackEvent(ADBMobile.media.Event.StateStart, stateObject);
// When the user exits full-screen:
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 the viewer enters full-screen, and a stateEnd POST when they exit:

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

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

recommendation-more-help
media-analytics-help