1.0.4

MediaTailor/com.amazon.mediatailorsdk/Session

Session

actual class Session : SessionCommon

The session object which represents a successfully initialized MediaTailor session. This object exposes the methods/properties to manage or monitor the MediaTailor session.

expect class Session

actual class Session

The session object which represents a successfully initialized MediaTailor session. This object exposes the methods/properties to manage or monitor the MediaTailor session.

actual class Session

actual class Session

The session object which represents a successfully initialized MediaTailor session. This object exposes the methods/properties to manage or monitor the MediaTailor session.

The session object which represents a successfully initialized MediaTailor session. This object exposes the methods/properties to manage or monitor the MediaTailor session.

Properties

val palNonce: String?

The nonce generated by Google PAL SDK for this session, or null if unavailable.

val playbackUrl: String?

The URL to be used by a player for content stream playback, with inserted ads, or null if the MediaTailor session was initialized elsewhere.

val trackingUrl: String

The URL to be used to retrieve information for ad tracking.

Functions

fun addAdObserver(adObserver: AdObserver)

Add an ad observer.

addUiEventListener

fun addUiEventListener(event: SessionUiEvent, listener: SessionUiEventListener)

Add a UI event listener.

Destroy the session object and free related resources.

fun getAllAds(receiver: (ads: List<AdData>) -> Unit)

Get the list of all the ads that are currently being tracked.

getAllNonLinearAds

fun getAllNonLinearAds(receiver: (ads: List<NonLinearAdsData>) -> Unit)

Get the list of all the nonlinear ads that are currently being tracked.

getPalGestureRecognizer

fun getPalGestureRecognizer(): <Error class: unknown class>?

Get the UIGestureRecognizer (created by Google PAL SDK) which must be attached to the player view where the ads are displayed.

fun getPalGestureRecognizer(): <Error class: unknown class>?

fun getPalGestureRecognizer(): <Error class: unknown class>?

Get the UIGestureRecognizer (created by Google PAL SDK) which must be attached to the player view where the ads are displayed.

onAdClickthrough

fun onAdClickthrough()

For the caller to notify the session object about the click-through of the current ad.

For the caller to notify the session object about the current ad being skipped.

onPlaybackEvent

fun onPlaybackEvent(playbackEvent: PlaybackEvent)

For the caller to notify the session object about a playback event.

onPlaybackRateUpdate

fun onPlaybackRateUpdate(rate: Double)

For the caller to notify the session object about the current playback rate.

onPlayerControlClick

fun onPlayerControlClick(event: MotionEvent)

For the caller to notify the session object about the player's UI control being clicked.

onPlayheadUpdate

fun onPlayheadUpdate(playhead: Double, programDateTime: Double? = null)

For the caller to notify the session object about the current playhead position.

onVideoClick

fun onVideoClick(event: MotionEvent)

For the caller to notify the session object about the player being clicked.

fun onVideoClick()

For the caller to notify the session object about the player being clicked.

fun onVideoClick()

fun onVideoClick()

For the caller to notify the session object about the player being clicked.

removeAdObserver

fun removeAdObserver(adObserver: AdObserver)

Remove an ad observer.

removeUiEventListener

fun removeUiEventListener(event: SessionUiEvent, listener: SessionUiEventListener)

Remove a UI event listener.

startUpdatingAdTrackingInfo

fun startUpdatingAdTrackingInfo(requestInterval: Double)

For the caller to manually start/restart periodic ad tracking info requests.

stopUpdatingAdTrackingInfo

fun stopUpdatingAdTrackingInfo()

For the caller to manually stop periodic ad tracking info requests.

updateAdTrackingInfo

fun updateAdTrackingInfo()

For the caller to manually trigger a single request to update ad tracking information.