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 milliseconds

  properties - 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 milliseconds

  properties - 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 milliseconds

  properties - 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 milliseconds

  properties - extra properties for event

• playbackPaused

   final Unit playbackPaused(Integer cursorPosition, Property properties)

  Media playback paused.

  Parameters:

  cursorPosition - Cursor position in milliseconds

  properties - extra properties for event

• playbackResumed

   final Unit playbackResumed(Integer cursorPosition, Property properties)

  Media playback restarted manually after a pause.

  Parameters:

  cursorPosition - Cursor position in milliseconds

  properties - extra properties for event

• playbackStopped

   final Unit playbackStopped(Integer cursorPosition, Property properties)

  Media playback stopped.

  Parameters:

  cursorPosition - Cursor position in milliseconds

  properties - extra properties for event

• seek

   final Unit seek(Integer oldCursorPosition, Integer newCursorPosition, Property properties)

  Measuring seek event.

  Parameters:

  oldCursorPosition - Starting position in milliseconds

  newCursorPosition - Ending position in milliseconds

  properties - extra properties for event

• seekBackward

   final Unit seekBackward(Integer oldCursorPosition, Integer newCursorPosition, Property properties)

  Measuring seek backward.

  Parameters:

  oldCursorPosition - Starting position in milliseconds

  newCursorPosition - Ending position in milliseconds

  properties - extra properties for event

• seekForward

   final Unit seekForward(Integer oldCursorPosition, Integer newCursorPosition, Property properties)

  Measuring seek forward.

  Parameters:

  oldCursorPosition - Starting position in milliseconds

  newCursorPosition - Ending position in milliseconds

  properties - extra properties for event

• seekStart

   final Unit seekStart(Integer oldCursorPosition, Property properties)

  Measuring seek start.

  Parameters:

  oldCursorPosition - Starting position in milliseconds

  properties - 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

• error

   final Unit error(String message, Property properties)

  Error measurement preventing reading from continuing.

  Parameters:

  message - error message

  properties - extra properties for event

• track

   final Unit track(String eventName, Property properties)

  Track custom event, don't use it for built-in events.

  Parameters:

  eventName - name of custom event

  properties - extra properties for event