Skip to content

Most visited

Recently visited

navigation

TvInputService.RecordingSession

public static abstract class TvInputService.RecordingSession
extends Object

java.lang.Object
   ↳ android.media.tv.TvInputService.RecordingSession


Base class for derived classes to implement to provide a TV input recording session.

Summary

Public constructors

TvInputService.RecordingSession(Context context)

Creates a new RecordingSession.

Public methods

void notifyError(int error)

Informs the application that there is an error and this recording session is no longer able to start or continue recording.

void notifyRecordingStopped(Uri recordedProgramUri)

Informs the application that this recording session has stopped recording and created a new data entry in the TvContract.RecordedPrograms table that describes the newly recorded program.

void notifyTuned(Uri channelUri)

Informs the application that this recording session has been tuned to the given channel and is ready to start recording.

void onAppPrivateCommand(String action, Bundle data)

Processes a private command sent from the application to the TV input.

abstract void onRelease()

Called when the application requests to release all the resources held by this recording session.

abstract void onStartRecording(Uri programUri)

Called when the application requests to start TV program recording.

abstract void onStopRecording()

Called when the application requests to stop TV program recording.

void onTune(Uri channelUri, Bundle params)

Called when the application requests to tune to a given channel for TV program recording.

abstract void onTune(Uri channelUri)

Called when the application requests to tune to a given channel for TV program recording.

Inherited methods

Public constructors

TvInputService.RecordingSession

added in API level 24
TvInputService.RecordingSession (Context context)

Creates a new RecordingSession.

Parameters
context Context: The context of the application

Public methods

notifyError

added in API level 24
void notifyError (int error)

Informs the application that there is an error and this recording session is no longer able to start or continue recording. It may be called at any time after the recording session is created until onRelease() is called.

The application may release the current session upon receiving the error code through onError(int). The session may call notifyRecordingStopped(Uri) if a partially recorded but still playable program is available, before calling this method.

Parameters
error int: The error code. Should be one of the followings.

notifyRecordingStopped

added in API level 24
void notifyRecordingStopped (Uri recordedProgramUri)

Informs the application that this recording session has stopped recording and created a new data entry in the TvContract.RecordedPrograms table that describes the newly recorded program.

The recording session must call this method in response to onStopRecording(). The session may call it even before receiving a call to onStopRecording() if a partially recorded program is available when there is an error.

Parameters
recordedProgramUri Uri: The URI of the newly recorded program.

notifyTuned

added in API level 24
void notifyTuned (Uri channelUri)

Informs the application that this recording session has been tuned to the given channel and is ready to start recording.

Upon receiving a call to onTune(Uri), the session is expected to tune to the passed channel and call this method to indicate that it is now available for immediate recording. When onStartRecording(Uri) is called, recording must start with minimal delay.

Parameters
channelUri Uri: The URI of a channel.

onAppPrivateCommand

added in API level 24
void onAppPrivateCommand (String action, 
                Bundle data)

Processes a private command sent from the application to the TV input. This can be used to provide domain-specific features that are only known between certain TV inputs and their clients.

Parameters
action String: Name of the command to be performed. This must be a scoped name, i.e. prefixed with a package name you own, so that different developers will not create conflicting commands.

This value must never be null.

data Bundle: Any data to include with the command.

onRelease

added in API level 24
void onRelease ()

Called when the application requests to release all the resources held by this recording session.

onStartRecording

added in API level 24
void onStartRecording (Uri programUri)

Called when the application requests to start TV program recording. Recording must start immediately when this method is called.

The application may supply the URI for a TV program for filling in program specific data fields in the TvContract.RecordedPrograms table. 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. In either case, the application must call stopRecording() to stop the recording.

The session must call notifyError(int) if the start request cannot be fulfilled.

Parameters
programUri Uri: The URI for the TV program to record, built by buildProgramUri(long). Can be null.

onStopRecording

added in API level 24
void onStopRecording ()

Called when the application requests to stop TV program recording. Recording must stop immediately when this method is called.

The session must create a new data entry in the TvContract.RecordedPrograms table that describes the newly recorded program and call notifyRecordingStopped(Uri) with the URI to that entry. If the stop request cannot be fulfilled, the session must call notifyError(int).

onTune

added in API level 24
void onTune (Uri channelUri, 
                Bundle params)

Called when the application requests to tune to a given channel for TV program recording. Override this method in order to handle domain-specific features that are only known between certain TV inputs and their clients.

The application may call this method before starting or after stopping recording, but not during recording. The default implementation calls onTune(Uri).

The session must call notifyTuned(Uri) if the tune request was fulfilled, or notifyError(int) otherwise.

Parameters
channelUri Uri: The URI of a channel.

params Bundle: Domain-specific data for this tune request. Keys must be a scoped name, i.e. prefixed with a package name you own, so that different developers will not create conflicting keys.

onTune

added in API level 24
void onTune (Uri channelUri)

Called when the application requests to tune to a given channel for TV program recording.

The application may call this method before starting or after stopping recording, but not during recording.

The session must call notifyTuned(Uri) if the tune request was fulfilled, or notifyError(int) otherwise.

Parameters
channelUri Uri: The URI of a channel.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (April 2018 — Developer Survey)