TV input services let the user pause and resume channel playback using time-shifting APIs. Android 7.0 expands on time-shifting by letting the user save multiple recorded sessions.
Users can schedule recordings in advance or start a recording as they watch a program. Once the system saves a recording, the user can browse, manage, and play back the recording using the system TV app.
If you want to provide recording functionality for your TV input service, you must indicate to the system that your app supports recording, implement the ability to record programs, handle and communicate any errors that occur during recording, and manage your recorded sessions.
Indicate support for recording
To tell the system that your TV input service supports recording, set
android:canRecord attribute in your service metadata XML file
<tv-input xmlns:android="http://schemas.android.com/apk/res/android" android:canRecord="true" android:setupActivity="com.example.sampletvinput.SampleTvInputSetupActivity" />
For more information on the service metadata file, see Declare your TV input service in the manifest.
Alternatively, you can indicate recording support in your code using these steps:
- In your TV input service
onCreate()method, create a new
TvInputInfoobject using the
- When creating the new
build()to indicate that your service supports recording.
- Register your
TvInputInfoobject with the system by calling
Record a session
After your TV input service registers that it supports recording
functionality, the system calls your
TvInputService.onCreateRecordingSession() method when it needs to access
your app's recording implementation. Implement your own
TvInputService.RecordingSession subclass and return it
onCreateRecordingSession() callback fires. This subclass is responsible
for switching to the correct channel data, recording the requested data,
and communicating recording status and errors to the system.
When the system calls
RecordingSession.onTune(), passing in a channel URI, tune to the channel
that the URI specifies. Notify the system that your app has tuned to the
desired channel by calling
notifyTuned() or, if your app can't tune to the proper channel, call
The system next invokes the
RecordingSession.onStartRecording() callback. Your app must start recording
immediately. When the system invokes this callback, it might provide a URI
that contains information about the program that is about to be recorded.
When the recording is done, copy this data to the
Finally, the system calls
RecordingSession.onStopRecording(). At this point, your app must stop
recording immediately. You also need to create an entry in the
table that includes the recorded session data URI in the
RecordedPrograms.COLUMN_RECORDING_DATA_URI column, and any program
information that the system provided in the initial call to
For more details on how to access the
see the Manage recorded sessions section.
Handle recording errors
If an error occurs during recording, resulting in unusable recorded data,
notify the system by calling
You can also call
notifyError() after a recording session is created to let the system know
that your app can no longer record sessions.
If an error occurs during recording but you want to provide a
partial recording to users for playback, call
notifyRecordingStopped() to enable the system to
use the partial session.
Manage recorded sessions
The system maintains information for all recorded sessions from all
recording-capable channel apps in the
content provider table. This information is accessible through the
content recording URIs. Use content provider APIs to
read, add, and delete entries from this table.
For more information on working with content provider data, see Content provider basics.
TV devices might have limited storage, so use your best judgment when
allocating storage to save recorded sessions. Use
there isn't enough space to save a recorded session.
When the user initiates recording, start recording data as soon
as possible. To facilitate this, complete any up-front time-consuming tasks,
like accessing and allocating storage space, when the system invokes the
onCreateRecordingSession() callback. Doing so lets you start
recording immediately when the
onStartRecording() callback fires.