-
public final class MediaHelperHelper for AV Insights
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classMediaHelper.Companion
-
Field Summary
Fields Modifier and Type Field Description private StringsessionIdprivate DoubleplaybackSpeed
-
Method Summary
Modifier and Type Method Description final StringgetSessionId()Current session id final UnitsetSessionId(String sessionId)final DoublegetPlaybackSpeed()Current playback speed final UnitsetPlaybackSpeed(Double playbackSpeed)final <ERROR CLASS>setHeartbeat(SparseLongArray values)Sets heartbeat value final <ERROR CLASS>setBufferHeartbeat(SparseLongArray values)Sets buffer heartbeat value final MediaHelpersetExtraProps(Property extraProps)Sets a map of extraProps on the media object and returns it. final Unitheartbeat(Integer cursorPosition, Property properties)Generate heartbeat event. final UnitbufferHeartbeat(Property properties)Generate heartbeat during buffering. final UnitrebufferHeartbeat(Property properties)Generate heartbeat during rebuffering. final Unitplay(Integer cursorPosition, Property properties)Generate play event (play attempt). final UnitbufferStart(Integer cursorPosition, Property properties)Player buffering start to initiate the launch of the media. final UnitplaybackStart(Integer cursorPosition, Property properties)Media playback start (first frame of the media). final UnitplaybackPaused(Integer cursorPosition, Property properties)Media playback paused. final UnitplaybackResumed(Integer cursorPosition, Property properties)Media playback restarted manually after a pause. final UnitplaybackStopped(Integer cursorPosition, Property properties)Media playback stopped. final Unitseek(Integer oldCursorPosition, Integer newCursorPosition, Property properties)Measuring seek event. final UnitseekBackward(Integer oldCursorPosition, Integer newCursorPosition, Property properties)Measuring seek backward. final UnitseekForward(Integer oldCursorPosition, Integer newCursorPosition, Property properties)Measuring seek forward. final UnitseekStart(Integer oldCursorPosition, Property properties)Measuring seek start. final UnitadClick(Property properties)Measuring media click (especially for ads). final UnitadSkip(Property properties)Measuring media skip (especially for ads). final Unitdisplay(Property properties)Measuring reco or Ad display. final Unitclose(Property properties)Measuring close action. final Unitvolume(Property properties)Measurement of a volume change action. final UnitsubtitleOn(Property properties)Measurement of activated subtitles. final UnitsubtitleOff(Property properties)Measurement of deactivated subtitles. final UnitfullscreenOn(Property properties)Measuring a full-screen display. final UnitfullscreenOff(Property properties)Measuring a full screen deactivation. final Unitquality(Property properties)Measurement of a quality change action. final Unitspeed(Property properties)Measurement of a speed change action. final Unitshare(Property properties)Measurement of a sharing action. final Uniterror(String message, Property properties)Error measurement preventing reading from continuing. -
-
Method Detail
-
getSessionId
final String getSessionId()
Current session id
-
setSessionId
final Unit setSessionId(String sessionId)
-
getPlaybackSpeed
final Double getPlaybackSpeed()
Current playback speed
-
setPlaybackSpeed
final Unit setPlaybackSpeed(Double playbackSpeed)
-
setHeartbeat
final <ERROR CLASS> setHeartbeat(SparseLongArray values)
Sets heartbeat value
- Parameters:
values- new values for heartbeat
-
setBufferHeartbeat
final <ERROR CLASS> setBufferHeartbeat(SparseLongArray values)
Sets buffer heartbeat value
- Parameters:
values- new values for buffer heartbeat
-
setExtraProps
final MediaHelper setExtraProps(Property extraProps)
Sets a map of extraProps on the media object and returns it.
- Parameters:
extraProps- The extra props (e.g.
-
heartbeat
final Unit heartbeat(Integer cursorPosition, Property properties)
Generate heartbeat event.
- Parameters:
cursorPosition- Cursor position in millisecondsproperties- extra properties for event
-
bufferHeartbeat
final Unit bufferHeartbeat(Property properties)
Generate heartbeat during buffering.
- Parameters:
properties- extra properties for event
-
rebufferHeartbeat
final Unit rebufferHeartbeat(Property properties)
Generate heartbeat during rebuffering.
- Parameters:
properties- extra properties for event
-
play
final Unit play(Integer cursorPosition, Property properties)
Generate play event (play attempt).
- Parameters:
cursorPosition- Cursor position in millisecondsproperties- extra properties for event
-
bufferStart
final Unit bufferStart(Integer cursorPosition, Property properties)
Player buffering start to initiate the launch of the media.
- Parameters:
cursorPosition- Cursor position in millisecondsproperties- extra properties for event
-
playbackStart
final Unit playbackStart(Integer cursorPosition, Property properties)
Media playback start (first frame of the media).
- Parameters:
cursorPosition- Cursor position in millisecondsproperties- extra properties for event
-
playbackPaused
final Unit playbackPaused(Integer cursorPosition, Property properties)
Media playback paused.
- Parameters:
cursorPosition- Cursor position in millisecondsproperties- extra properties for event
-
playbackResumed
final Unit playbackResumed(Integer cursorPosition, Property properties)
Media playback restarted manually after a pause.
- Parameters:
cursorPosition- Cursor position in millisecondsproperties- extra properties for event
-
playbackStopped
final Unit playbackStopped(Integer cursorPosition, Property properties)
Media playback stopped.
- Parameters:
cursorPosition- Cursor position in millisecondsproperties- extra properties for event
-
seek
final Unit seek(Integer oldCursorPosition, Integer newCursorPosition, Property properties)
Measuring seek event.
- Parameters:
oldCursorPosition- Starting position in millisecondsnewCursorPosition- Ending position in millisecondsproperties- extra properties for event
-
seekBackward
final Unit seekBackward(Integer oldCursorPosition, Integer newCursorPosition, Property properties)
Measuring seek backward.
- Parameters:
oldCursorPosition- Starting position in millisecondsnewCursorPosition- Ending position in millisecondsproperties- extra properties for event
-
seekForward
final Unit seekForward(Integer oldCursorPosition, Integer newCursorPosition, Property properties)
Measuring seek forward.
- Parameters:
oldCursorPosition- Starting position in millisecondsnewCursorPosition- Ending position in millisecondsproperties- extra properties for event
-
seekStart
final Unit seekStart(Integer oldCursorPosition, Property properties)
Measuring seek start.
- Parameters:
oldCursorPosition- Starting position in millisecondsproperties- extra properties for event
-
adClick
final Unit adClick(Property properties)
Measuring media click (especially for ads).
- Parameters:
properties- extra properties for event
-
adSkip
final Unit adSkip(Property properties)
Measuring media skip (especially for ads).
- Parameters:
properties- extra properties for event
-
display
final Unit display(Property properties)
Measuring reco or Ad display.
- Parameters:
properties- extra properties for event
-
close
final Unit close(Property properties)
Measuring close action.
- Parameters:
properties- extra properties for event
-
volume
final Unit volume(Property properties)
Measurement of a volume change action.
- Parameters:
properties- extra properties for event
-
subtitleOn
final Unit subtitleOn(Property properties)
Measurement of activated subtitles.
- Parameters:
properties- extra properties for event
-
subtitleOff
final Unit subtitleOff(Property properties)
Measurement of deactivated subtitles.
- Parameters:
properties- extra properties for event
-
fullscreenOn
final Unit fullscreenOn(Property properties)
Measuring a full-screen display.
- Parameters:
properties- extra properties for event
-
fullscreenOff
final Unit fullscreenOff(Property properties)
Measuring a full screen deactivation.
- Parameters:
properties- extra properties for event
-
quality
final Unit quality(Property properties)
Measurement of a quality change action.
- Parameters:
properties- extra properties for event
-
speed
final Unit speed(Property properties)
Measurement of a speed change action.
- Parameters:
properties- extra properties for event
-
share
final Unit share(Property properties)
Measurement of a sharing action.
- Parameters:
properties- extra properties for event
-
-
-
-