TvAdService.Session

Session

public Session (Context context)

Creates a new Session.

isMediaViewEnabled

public boolean isMediaViewEnabled ()

Returns true if media view is enabled, false otherwise.

layoutSurface

public void layoutSurface (int left, 
                int top, 
                int right, 
                int bottom)

Assigns a size and position to the surface passed in onSetSurface(Surface). 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

public void notifySessionStateChanged (int state, 
                int err)

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

onCreateMediaView

public View onCreateMediaView ()

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

onCurrentChannelUri

public void onCurrentChannelUri (Uri channelUri)

Receives current channel URI.

onCurrentTvInputId

public void onCurrentTvInputId (String inputId)

Receives current TV input ID.

onCurrentVideoBounds

public void onCurrentVideoBounds (Rect bounds)

Receives current video bounds.

onError

public void onError (String errMsg, 
                Bundle params)

Called when the application sends information of an error.

onGenericMotionEvent

public boolean onGenericMotionEvent (MotionEvent event)

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

onKeyDown

public boolean onKeyDown (int keyCode, 
                KeyEvent event)

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

public boolean onKeyLongPress (int keyCode, 
                KeyEvent event)

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(int, KeyEvent) and call KeyEvent.startTracking() on the event.

onKeyMultiple

public boolean onKeyMultiple (int keyCode, 
                int count, 
                KeyEvent event)

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

public boolean onKeyUp (int keyCode, 
                KeyEvent event)

Called when a key up event has occurred.

onMediaViewSizeChanged

public void onMediaViewSizeChanged (int width, 
                int height)

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(int, int, int, int).

onRelease

public abstract void onRelease ()

Releases TvAdService session.

onResetAdService

public void onResetAdService ()

Resets TvAdService session.

onSetSurface

public abstract boolean onSetSurface (Surface surface)

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

public void onSigningResult (String signingId, 
                byte[] result)

Receives signing result.

onStartAdService

public void onStartAdService ()

Starts TvAdService session.

onStopAdService

public void onStopAdService ()

Stops TvAdService session.

onSurfaceChanged

public void onSurfaceChanged (int format, 
                int width, 
                int height)

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

onTouchEvent

public boolean onTouchEvent (MotionEvent event)

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

onTrackInfoList

public void onTrackInfoList (List<TvTrackInfo> tracks)

Receives track list.

onTrackballEvent

public boolean onTrackballEvent (MotionEvent event)

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

onTvInputSessionData

public void onTvInputSessionData (String type, 
                Bundle data)

Called when data from the linked TvInputService is received.

onTvMessage

public void onTvMessage (int type, 
                Bundle data)

Called when a TV message is received

requestCurrentChannelUri

public void requestCurrentChannelUri ()

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

requestCurrentTvInputId

public void requestCurrentTvInputId ()

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

requestCurrentVideoBounds

public void requestCurrentVideoBounds ()

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

requestSigning

public void requestSigning (String signingId, 
                String algorithm, 
                String alias, 
                byte[] data)

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

public void requestTrackInfoList ()

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

sendTvAdSessionData

public void sendTvAdSessionData (String type, 
                Bundle data)

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

setMediaViewEnabled

public void setMediaViewEnabled (boolean enable)

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.