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.

notifyAdBufferReady

open fun notifyAdBufferReady(buffer: AdBuffer): Unit

Notifies when the advertisement buffer is filled and ready to be read.
If you override this method you must call through to the superclass implementation.

notifyBiInteractiveAppCreated

fun notifyBiInteractiveAppCreated(
    biIAppUri: Uri, 
    biIAppId: String?
): Unit

Notifies the broadcast-independent(BI) interactive application has been created.
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.

notifyTeletextAppStateChanged

fun notifyTeletextAppStateChanged(state: Int): Unit

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

onAdBufferConsumed

open fun onAdBufferConsumed(buffer: AdBuffer): Unit

Called when an advertisement buffer is consumed.

onAdResponse

open fun onAdResponse(response: AdResponse): Unit

Called when an advertisement response is received.

onAvailableSpeeds

open fun onAvailableSpeeds(speeds: FloatArray): Unit

Receives available playback speeds.

onBroadcastInfoResponse

open fun onBroadcastInfoResponse(response: BroadcastInfoResponse): Unit

Called when a broadcast info response is received.

onContentAllowed

open fun onContentAllowed(): Unit

Called when content is allowed.

onContentBlocked

open fun onContentBlocked(rating: TvContentRating): Unit

Called when content is blocked.

onCreateBiInteractiveAppRequest

open fun onCreateBiInteractiveAppRequest(
    biIAppUri: Uri, 
    params: Bundle?
): Unit

Creates broadcast-independent(BI) interactive application.

The implementation should call notifyBiInteractiveAppCreated(android.net.Uri,java.lang.String), no matter if it's created successfully or not.

onCreateMediaView

open fun onCreateMediaView(): View?

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

onCurrentChannelLcn

open fun onCurrentChannelLcn(lcn: Int): Unit

Receives logical channel number (LCN) of current channel.

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.

onDestroyBiInteractiveAppRequest

open fun onDestroyBiInteractiveAppRequest(biIAppId: String): Unit

Destroys broadcast-independent(BI) interactive application.

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 TvInteractiveAppView. Note that the size of the underlying surface can be different if the surface was changed by calling layoutSurface.

onRecordingConnectionFailed

open fun onRecordingConnectionFailed(
    recordingId: String, 
    inputId: String
): Unit

This is called when an error occurred while establishing a connection to the recording session for the corresponding TV input.

onRecordingDisconnected

open fun onRecordingDisconnected(
    recordingId: String, 
    inputId: String
): Unit

This is called when the connection to the current recording session is lost.

onRecordingError

open fun onRecordingError(
    recordingId: String, 
    err: Int
): Unit

This is called when an issue has occurred. It may be called at any time after the current recording session is created until it is released.

onRecordingScheduled

open fun onRecordingScheduled(
    recordingId: String, 
    requestId: String?
): Unit

This is called when the recording has been scheduled.

onRecordingStarted

open fun onRecordingStarted(
    recordingId: String, 
    requestId: String?
): Unit

This is called when a recording has been started.

When a scheduled recording is started, this is also called, and the request ID in this case is null.

onRecordingStopped

open fun onRecordingStopped(recordingId: String): Unit

This is called when the recording has been stopped.

onRecordingTuned

open fun onRecordingTuned(
    recordingId: String, 
    channelUri: Uri
): Unit

This is called when the recording session has been tuned to the given channel and is ready to start recording.

onRelease

abstract fun onRelease(): Unit

Releases TvInteractiveAppService session.

onResetInteractiveApp

open fun onResetInteractiveApp(): Unit

Resets TvInteractiveAppService session.

onSetSurface

abstract fun onSetSurface(surface: Surface?): Boolean

Called when the application sets the surface.

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

onSetTeletextAppEnabled

open fun onSetTeletextAppEnabled(enable: Boolean): Unit

To toggle Digital Teletext Application if there is one in AIT app list.

onSignalStrength

open fun onSignalStrength(strength: Int): Unit

Called when signal strength is changed.

onSigningResult

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

Receives signing result.

onStartInteractiveApp

open fun onStartInteractiveApp(): Unit

Starts TvInteractiveAppService session.

onStopInteractiveApp

open fun onStopInteractiveApp(): Unit

Stops TvInteractiveAppService session.

onStreamVolume

open fun onStreamVolume(volume: Float): Unit

Receives current stream volume.

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.

onTimeShiftCurrentPositionChanged

open fun onTimeShiftCurrentPositionChanged(
    inputId: String, 
    timeMs: Long
): Unit

Called when time shift current position is changed.

onTimeShiftMode

open fun onTimeShiftMode(mode: Int): Unit

Receives current time shift mode.

onTimeShiftPlaybackParams

open fun onTimeShiftPlaybackParams(params: PlaybackParams): Unit

Called when the time shift android.media.PlaybackParams is set or changed.

onTimeShiftStartPositionChanged

open fun onTimeShiftStartPositionChanged(
    inputId: String, 
    timeMs: Long
): Unit

Called when time shift start position is changed.

onTimeShiftStatusChanged

open fun onTimeShiftStatusChanged(
    inputId: String, 
    status: Int
): Unit

Called when time shift status is changed.

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.

onTrackSelected

open fun onTrackSelected(
    type: Int, 
    trackId: String
): Unit

Called when the corresponding TV input selected to a track. If the track is deselected and no track is currently selected, trackId is an empty string.

onTrackballEvent

open fun onTrackballEvent(event: MotionEvent): Boolean

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

onTracksChanged

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

Called when the tracks are changed.

onTuned

open fun onTuned(channelUri: Uri): Unit

Called when the corresponding TV input tuned to a channel.

onTvMessage

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

Called when a TV message is received

onTvRecordingInfo

open fun onTvRecordingInfo(recordingInfo: TvRecordingInfo?): Unit

Receives the requested android.media.tv.TvRecordingInfo.

onTvRecordingInfoList

open fun onTvRecordingInfoList(recordingInfoList: MutableList<TvRecordingInfo!>): Unit

Receives requested recording info list.

onVideoAvailable

open fun onVideoAvailable(): Unit

Called when video is available.

onVideoUnavailable

open fun onVideoUnavailable(reason: Int): Unit

Called when video is unavailable.

removeBroadcastInfo

open fun removeBroadcastInfo(requestId: Int): Unit

Remove broadcast information request from the related TV input.
If you override this method you must call through to the superclass implementation.

requestAd

open fun requestAd(request: AdRequest): Unit

Sends an advertisement request to be processed by the related TV input.
If you override this method you must call through to the superclass implementation.

requestAvailableSpeeds

open fun requestAvailableSpeeds(): Unit

Requests available speeds for time shift.
If you override this method you must call through to the superclass implementation.

requestBroadcastInfo

open fun requestBroadcastInfo(request: BroadcastInfoRequest): Unit

Requests broadcast related information from the related TV input.
If you override this method you must call through to the superclass implementation.

requestCurrentChannelLcn

open fun requestCurrentChannelLcn(): Unit

Requests the logic channel number (LCN) of the current channel.
If you override this method you must call through to the superclass implementation.

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.

requestScheduleRecording

open fun requestScheduleRecording(
    requestId: String, 
    inputId: String, 
    channelUri: Uri, 
    programUri: Uri, 
    params: Bundle
): Unit

Requests scheduling of a recording.
If you override this method you must call through to the superclass implementation.

requestScheduleRecording

open fun requestScheduleRecording(
    requestId: String, 
    inputId: String, 
    channelUri: Uri, 
    startTime: Long, 
    duration: Long, 
    repeatDays: Int, 
    params: Bundle
): Unit

Requests scheduling of a recording.
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 broadcast-independent interactive app requires signing during handshaking, and the interactive app 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.

requestStartRecording

open fun requestStartRecording(
    requestId: String, 
    programUri: Uri?
): Unit

Requests starting of recording

This is used to request the active android.media.tv.TvRecordingClient to call android.media.tv.TvRecordingClient#startRecording(Uri) with the provided programUri. A non-null programUri implies the started recording should be of that specific program, whereas null programUri does not impose such a requirement and the recording can span across multiple TV programs.
If you override this method you must call through to the superclass implementation.

requestStopRecording

open fun requestStopRecording(recordingId: String): Unit

Requests the recording associated with the recordingId to stop.

This is used to request the associated android.media.tv.TvRecordingClient to call android.media.tv.TvRecordingClient#stopRecording().
If you override this method you must call through to the superclass implementation.

requestStreamVolume

open fun requestStreamVolume(): Unit

Requests stream volume.
If you override this method you must call through to the superclass implementation.

requestTimeShiftMode

open fun requestTimeShiftMode(): Unit

Requests time shift mode.
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.

requestTvRecordingInfo

open fun requestTvRecordingInfo(recordingId: String): Unit

Gets the recording info for the specified recording
If you override this method you must call through to the superclass implementation.

requestTvRecordingInfoList

open fun requestTvRecordingInfoList(type: Int): Unit

Gets a list of TvRecordingInfo for the specified recording type.
If you override this method you must call through to the superclass implementation.

sendPlaybackCommandRequest

open fun sendPlaybackCommandRequest(
    cmdType: String, 
    parameters: Bundle?
): Unit

Sends a specific playback command to be processed by the related TV input.
If you override this method you must call through to the superclass implementation.

sendTimeShiftCommandRequest

open fun sendTimeShiftCommandRequest(
    cmdType: String, 
    parameters: Bundle?
): Unit

Sends a specific time shift command to be processed by the related TV input.
If you override this method you must call through to the superclass implementation.

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 Interactive App service can disable its media view when needed.
If you override this method you must call through to the superclass implementation.

setTvRecordingInfo

open fun setTvRecordingInfo(
    recordingId: String, 
    recordingInfo: TvRecordingInfo
): Unit

Sets the recording info for the specified recording
If you override this method you must call through to the superclass implementation.

setVideoBounds

open fun setVideoBounds(rect: Rect): Unit

Sets broadcast video bounds.
If you override this method you must call through to the superclass implementation.