Session

Session

Session(context: Context)

Creates a new Session.

isMediaViewEnabled

open fun isMediaViewEnabled(): Boolean

Returns true if media view is enabled, false otherwise.

layoutSurface

open fun layoutSurface(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Unit

Assigns a size and position to the surface passed in onSetSurface. The position is relative to the overlay view that sits on top of this surface.
If you override this method you must call through to the superclass implementation.

notifySessionStateChanged

open fun notifySessionStateChanged(
    state: Int, 
    err: Int
): Unit

Notifies when the session state is changed.
If you override this method you must call through to the superclass implementation.

onCreateMediaView

open fun onCreateMediaView(): View?

Called when the application requests to create a media view. Each session implementation can override this method and return its own view.

onCurrentChannelUri

open fun onCurrentChannelUri(channelUri: Uri?): Unit

Receives current channel URI.

onCurrentTvInputId

open fun onCurrentTvInputId(inputId: String?): Unit

Receives current TV input ID.

onCurrentVideoBounds

open fun onCurrentVideoBounds(bounds: Rect): Unit

Receives current video bounds.

onError

open fun onError(
    errMsg: String, 
    params: Bundle
): Unit

Called when the application sends information of an error.

onGenericMotionEvent

open fun onGenericMotionEvent(event: MotionEvent): Boolean

Implement this method to handle generic motion events on the current session.

onKeyDown

open fun onKeyDown(
    keyCode: Int, 
    event: KeyEvent?
): Boolean

Called when a key down event has occurred. If you return true, you can first call KeyEvent.startTracking() to have the framework track the event through its onKeyUp(int,android.view.KeyEvent) and also call your onKeyLongPress(int,android.view.KeyEvent) if it occurs.

onKeyLongPress

open fun onKeyLongPress(
    keyCode: Int, 
    event: KeyEvent?
): Boolean

Called when a long press has occurred. If you return true, the final key up will have KeyEvent.FLAG_CANCELED and KeyEvent.FLAG_CANCELED_LONG_PRESS set. Note that in order to receive this callback, someone in the event change must return true from onKeyDown and call KeyEvent.startTracking() on the event.

onKeyMultiple

open fun onKeyMultiple(
    keyCode: Int, 
    count: Int, 
    event: KeyEvent?
): Boolean

Called when a user's interaction with an analog control, such as flinging a trackball, generates simulated down/up events for the same key multiple times in quick succession.

onKeyUp

open fun onKeyUp(
    keyCode: Int, 
    event: KeyEvent?
): Boolean

Called when a key up event has occurred.

onMediaViewSizeChanged

open fun onMediaViewSizeChanged(
    width: Int, 
    height: Int
): Unit

Called when the size of the media view is changed by the application.

This is always called at least once when the session is created regardless of whether the media view is enabled or not. The media view container size is the same as the containing TvAdView. Note that the size of the underlying surface can be different if the surface was changed by calling layoutSurface.

onRelease

abstract fun onRelease(): Unit

Releases TvAdService session.

onResetAdService

open fun onResetAdService(): Unit

Resets TvAdService session.

onSetSurface

abstract fun onSetSurface(surface: Surface?): Boolean

Called when the application sets the surface.

The TV AD service should render AD UI onto the given surface. When called with null, the AD service should immediately free any references to the currently set surface and stop using it.

onSigningResult

open fun onSigningResult(
    signingId: String, 
    result: ByteArray
): Unit

Receives signing result.

onStartAdService

open fun onStartAdService(): Unit

Starts TvAdService session.

onStopAdService

open fun onStopAdService(): Unit

Stops TvAdService session.

onSurfaceChanged

open fun onSurfaceChanged(
    format: Int, 
    width: Int, 
    height: Int
): Unit

Called after any structural changes (format or size) have been made to the surface passed in onSetSurface. This method is always called at least once, after onSetSurface is called with non-null surface.

onTouchEvent

open fun onTouchEvent(event: MotionEvent): Boolean

Implement this method to handle touch screen motion events on the current session.

onTrackInfoList

open fun onTrackInfoList(tracks: MutableList<TvTrackInfo!>): Unit

Receives track list.

onTrackballEvent

open fun onTrackballEvent(event: MotionEvent): Boolean

Implement this method to handle trackball events on the current session.

onTvInputSessionData

open fun onTvInputSessionData(
    type: String, 
    data: Bundle
): Unit

Called when data from the linked android.media.tv.TvInputService is received.

onTvMessage

open fun onTvMessage(
    type: Int, 
    data: Bundle
): Unit

Called when a TV message is received

requestCurrentChannelUri

open fun requestCurrentChannelUri(): Unit

Requests the URI of the current channel.
If you override this method you must call through to the superclass implementation.

requestCurrentTvInputId

open fun requestCurrentTvInputId(): Unit

Requests current TV input ID.
If you override this method you must call through to the superclass implementation.

requestCurrentVideoBounds

open fun requestCurrentVideoBounds(): Unit

Requests the bounds of the current video.
If you override this method you must call through to the superclass implementation.

requestSigning

open fun requestSigning(
    signingId: String, 
    algorithm: String, 
    alias: String, 
    data: ByteArray
): Unit

Requests signing of the given data.

This is used when the corresponding server of the AD service app requires signing during handshaking, and the service doesn't have the built-in private key. The private key is provided by the content providers and pre-built in the related app, such as TV app.
If you override this method you must call through to the superclass implementation.

requestTrackInfoList

open fun requestTrackInfoList(): Unit

Requests the list of TvTrackInfo.
If you override this method you must call through to the superclass implementation.

sendTvAdSessionData

open fun sendTvAdSessionData(
    type: String, 
    data: Bundle
): Unit

Sends data related to this session to corresponding linked android.media.tv.TvInputService object via TvView.

setMediaViewEnabled

open fun setMediaViewEnabled(enable: Boolean): Unit

Enables or disables the media view.

By default, the media view is disabled. Must be called explicitly after the session is created to enable the media view.

The TV AD service can disable its media view when needed.
If you override this method you must call through to the superclass implementation.