Five standard player states are available and you can add your own custom states.
Standard State Name | Media SDK constant | Media Collection API name |
---|---|---|
Full Screen | ADB.Media.PlayerState.Fullscreen |
fullScreen |
Closed Captioning | ADB.Media.PlayerState.ClosedCaptioning |
closedCaptioning |
Mute | ADB.Media.PlayerState.Mute |
mute |
Picture in Picture | ADB.Media.PlayerState.PictureInPicture |
pictureInPicture |
In Focus | ADB.Media.PlayerState.InFocus |
inFocus |
The data is computed in the same way for standard and custom states but the data is stored differently for Analytics reporting.
For standard states—When you enable the player state tracking from the Media Management console in Analytics reporting (admin side), 15 solution variables are available for reporting and data exports.
For custom states—You can create your own processing rules to store the computed values into custom events and then use those rules for reporting and data exports.
closedCapationing
can be started and stopped five times but it will count as a single state.With the ability to create custom states, you can capture custom actions and update custom metadata during a playback session.
For information about creating custom states, see the Media API Reference guide: createStateObject