public
final
class
TvInputManager
extends Object
java.lang.Object | |
↳ | android.media.tv.TvInputManager |
Central system API to the overall TV input framework (TIF) architecture, which arbitrates
interaction between applications and the selected TV inputs. You can retrieve an instance of
this interface with Context.getSystemService(Context.TV_INPUT_SERVICE)
.
There are three primary parties involved in the TV input framework (TIF) architecture:
TvInputService
represents an input source
of TV, which can be a pass-through input such as HDMI, or a tuner input which provides broadcast
TV programs. The system binds to the TV input per application’s request.
on implementing TV inputs.
TvView
or
TvRecordingClient
for further interaction such as watching and recording broadcast TV
programs.
Nested classes | |
---|---|
class |
TvInputManager.TvInputCallback
Callback used to monitor status of the TV inputs. |
Constants | |
---|---|
String |
ACTION_BLOCKED_RATINGS_CHANGED
Broadcast intent action when the user blocked content ratings change. |
String |
ACTION_PARENTAL_CONTROLS_ENABLED_CHANGED
Broadcast intent action when the parental controls enabled state changes. |
String |
ACTION_QUERY_CONTENT_RATING_SYSTEMS
Broadcast intent action used to query available content rating systems. |
String |
ACTION_SETUP_INPUTS
Activity action to set up channel sources i.e. TV inputs of type
|
int |
INPUT_STATE_CONNECTED
State for |
int |
INPUT_STATE_CONNECTED_STANDBY
State for |
int |
INPUT_STATE_DISCONNECTED
State for |
String |
META_DATA_CONTENT_RATING_SYSTEMS
Content rating systems metadata associated with |
int |
RECORDING_ERROR_INSUFFICIENT_SPACE
Error for |
int |
RECORDING_ERROR_RESOURCE_BUSY
Error for |
int |
RECORDING_ERROR_UNKNOWN
Error for |
long |
TIME_SHIFT_INVALID_TIME
Value returned by |
int |
TIME_SHIFT_STATUS_AVAILABLE
Status for |
int |
TIME_SHIFT_STATUS_UNAVAILABLE
Status for |
int |
TIME_SHIFT_STATUS_UNKNOWN
Status for |
int |
TIME_SHIFT_STATUS_UNSUPPORTED
Status for |
int |
VIDEO_UNAVAILABLE_REASON_AUDIO_ONLY
Reason for |
int |
VIDEO_UNAVAILABLE_REASON_BUFFERING
Reason for |
int |
VIDEO_UNAVAILABLE_REASON_TUNING
Reason for |
int |
VIDEO_UNAVAILABLE_REASON_UNKNOWN
Reason for |
int |
VIDEO_UNAVAILABLE_REASON_WEAK_SIGNAL
Reason for |
Public methods | |
---|---|
int
|
getInputState(String inputId)
Returns the state of a given TV input. |
TvInputInfo
|
getTvInputInfo(String inputId)
Returns the |
List<TvInputInfo>
|
getTvInputList()
Returns the complete list of TV inputs on the system. |
boolean
|
isParentalControlsEnabled()
Returns the user's parental controls enabled state. |
boolean
|
isRatingBlocked(TvContentRating rating)
Checks whether a given TV content rating is blocked by the user. |
void
|
registerCallback(TvInputManager.TvInputCallback callback, Handler handler)
Registers a |
void
|
unregisterCallback(TvInputManager.TvInputCallback callback)
Unregisters the existing |
void
|
updateTvInputInfo(TvInputInfo inputInfo)
Updates the |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
String ACTION_BLOCKED_RATINGS_CHANGED
Broadcast intent action when the user blocked content ratings change. For use with the
isRatingBlocked(TvContentRating)
.
Constant Value: "android.media.tv.action.BLOCKED_RATINGS_CHANGED"
String ACTION_PARENTAL_CONTROLS_ENABLED_CHANGED
Broadcast intent action when the parental controls enabled state changes. For use with the
isParentalControlsEnabled()
.
Constant Value: "android.media.tv.action.PARENTAL_CONTROLS_ENABLED_CHANGED"
String ACTION_QUERY_CONTENT_RATING_SYSTEMS
Broadcast intent action used to query available content rating systems.
The TV input manager service locates available content rating systems by querying broadcast receivers that are registered for this action. An application can offer additional content rating systems to the user by declaring a suitable broadcast receiver in its manifest.
Here is an example broadcast receiver declaration that an application might include in its AndroidManifest.xml to advertise custom content rating systems. The meta-data specifies a resource that contains a description of each content rating system that is provided by the application.
<receiver android:name=".TvInputReceiver"> <intent-filter> <action android:name= "android.media.tv.action.QUERY_CONTENT_RATING_SYSTEMS" /> </intent-filter> <meta-data android:name="android.media.tv.metadata.CONTENT_RATING_SYSTEMS" android:resource="@xml/tv_content_rating_systems" /> </receiver>
In the above example, the @xml/tv_content_rating_systems
resource refers to an
XML resource whose root element is <rating-system-definitions>
that
contains zero or more <rating-system-definition>
elements. Each
<rating-system-definition>
element specifies the ratings, sub-ratings and rating
orders of a particular content rating system.
See also:
Constant Value: "android.media.tv.action.QUERY_CONTENT_RATING_SYSTEMS"
String ACTION_SETUP_INPUTS
Activity action to set up channel sources i.e. TV inputs of type
TYPE_TUNER
. When invoked, the system will display an appropriate UI for
the user to initiate the individual setup flow provided by
setupActivity
of each TV input service.
Constant Value: "android.media.tv.action.SETUP_INPUTS"
int INPUT_STATE_CONNECTED
State for getInputState(String)
and
onInputStateChanged(String, int)
: The input source is connected.
This state indicates that a source device is connected to the input port and is in the normal operation mode. It is mostly relevant to hardware inputs such as HDMI input. This is the default state for any hardware inputs where their states are unknown. Non-hardware inputs are considered connected all the time.
Constant Value: 0 (0x00000000)
int INPUT_STATE_CONNECTED_STANDBY
State for getInputState(String)
and
onInputStateChanged(String, int)
: The input source is connected but
in standby mode.
This state indicates that a source device is connected to the input port but is in standby mode. It is mostly relevant to hardware inputs such as HDMI input.
Constant Value: 1 (0x00000001)
int INPUT_STATE_DISCONNECTED
State for getInputState(String)
and
onInputStateChanged(String, int)
: The input source is disconnected.
This state indicates that a source device is disconnected from the input port. It is mostly relevant to hardware inputs such as HDMI input.
Constant Value: 2 (0x00000002)
String META_DATA_CONTENT_RATING_SYSTEMS
Content rating systems metadata associated with ACTION_QUERY_CONTENT_RATING_SYSTEMS
.
Specifies the resource ID of an XML resource that describes the content rating systems that are provided by the application.
Constant Value: "android.media.tv.metadata.CONTENT_RATING_SYSTEMS"
int RECORDING_ERROR_INSUFFICIENT_SPACE
Error for notifyError(int)
and
onError(int)
: Recording cannot proceed due to
insufficient storage space.
Constant Value: 1 (0x00000001)
int RECORDING_ERROR_RESOURCE_BUSY
Error for notifyError(int)
and
onError(int)
: Recording cannot proceed because
a required recording resource was not able to be allocated.
Constant Value: 2 (0x00000002)
int RECORDING_ERROR_UNKNOWN
Error for notifyError(int)
and
onError(int)
: The requested operation cannot be
completed due to a problem that does not fit under any other error codes, or the error code
for the problem is defined on the higher version than application's
android:targetSdkVersion
.
Constant Value: 0 (0x00000000)
long TIME_SHIFT_INVALID_TIME
Value returned by onTimeShiftGetCurrentPosition()
and
onTimeShiftGetStartPosition()
when time shifting has not
yet started.
Constant Value: -9223372036854775808 (0x8000000000000000)
int TIME_SHIFT_STATUS_AVAILABLE
Status for notifyTimeShiftStatusChanged(int)
and
onTimeShiftStatusChanged(String, int)
: Time shifting is
currently available. In this status, the application assumes it can pause/resume playback,
seek to a specified time position and set playback rate and audio mode.
Constant Value: 3 (0x00000003)
int TIME_SHIFT_STATUS_UNAVAILABLE
Status for notifyTimeShiftStatusChanged(int)
and
onTimeShiftStatusChanged(String, int)
: Time shifting is
currently unavailable but might work again later.
Constant Value: 2 (0x00000002)
int TIME_SHIFT_STATUS_UNKNOWN
Status for notifyTimeShiftStatusChanged(int)
and
onTimeShiftStatusChanged(String, int)
: Unknown status. Also
the status prior to calling notifyTimeShiftStatusChanged
.
Constant Value: 0 (0x00000000)
int TIME_SHIFT_STATUS_UNSUPPORTED
Status for notifyTimeShiftStatusChanged(int)
and
onTimeShiftStatusChanged(String, int)
: The current TV input
does not support time shifting.
Constant Value: 1 (0x00000001)
int VIDEO_UNAVAILABLE_REASON_AUDIO_ONLY
Reason for notifyVideoUnavailable(int)
and
onVideoUnavailable(String, int)
: Video is unavailable because
the current TV program is audio-only.
Constant Value: 4 (0x00000004)
int VIDEO_UNAVAILABLE_REASON_BUFFERING
Reason for notifyVideoUnavailable(int)
and
onVideoUnavailable(String, int)
: Video is unavailable because
the corresponding TV input has stopped playback temporarily to buffer more data.
Constant Value: 3 (0x00000003)
int VIDEO_UNAVAILABLE_REASON_TUNING
Reason for notifyVideoUnavailable(int)
and
onVideoUnavailable(String, int)
: Video is unavailable because
the corresponding TV input is in the middle of tuning to a new channel.
Constant Value: 1 (0x00000001)
int VIDEO_UNAVAILABLE_REASON_UNKNOWN
Reason for notifyVideoUnavailable(int)
and
onVideoUnavailable(String, int)
: Video is unavailable due to
an unspecified error.
Constant Value: 0 (0x00000000)
int VIDEO_UNAVAILABLE_REASON_WEAK_SIGNAL
Reason for notifyVideoUnavailable(int)
and
onVideoUnavailable(String, int)
: Video is unavailable due to
weak TV signal.
Constant Value: 2 (0x00000002)
int getInputState (String inputId)
Returns the state of a given TV input.
The state is one of the following:
Parameters | |
---|---|
inputId |
String :
The ID of the TV input. |
Returns | |
---|---|
int |
Throws | |
---|---|
IllegalArgumentException |
if the argument is null .
|
TvInputInfo getTvInputInfo (String inputId)
Returns the TvInputInfo
for a given TV input.
Parameters | |
---|---|
inputId |
String :
The ID of the TV input. |
Returns | |
---|---|
TvInputInfo |
the TvInputInfo for a given TV input. null if not found.
|
List<TvInputInfo> getTvInputList ()
Returns the complete list of TV inputs on the system.
Returns | |
---|---|
List<TvInputInfo> |
List of TvInputInfo for each TV input that describes its meta information.
|
boolean isParentalControlsEnabled ()
Returns the user's parental controls enabled state.
Returns | |
---|---|
boolean |
true if the user enabled the parental controls, false otherwise.
|
boolean isRatingBlocked (TvContentRating rating)
Checks whether a given TV content rating is blocked by the user.
Parameters | |
---|---|
rating |
TvContentRating :
The TV content rating to check. Can be UNRATED . |
Returns | |
---|---|
boolean |
true if the given TV content rating is blocked, false otherwise.
|
void registerCallback (TvInputManager.TvInputCallback callback, Handler handler)
Registers a TvInputManager.TvInputCallback
.
Parameters | |
---|---|
callback |
TvInputManager.TvInputCallback :
A callback used to monitor status of the TV inputs. |
handler |
Handler :
A Handler that the status change will be delivered to.
|
void unregisterCallback (TvInputManager.TvInputCallback callback)
Unregisters the existing TvInputManager.TvInputCallback
.
Parameters | |
---|---|
callback |
TvInputManager.TvInputCallback :
The existing callback to remove.
|
void updateTvInputInfo (TvInputInfo inputInfo)
Updates the TvInputInfo
for an existing TV input. A TV input service
implementation may call this method to pass the application and system an up-to-date
TvInputInfo
object that describes itself.
The system automatically creates a TvInputInfo
object for each TV input,
based on the information collected from the AndroidManifest.xml
, thus it is not
necessary to call this method unless such information has changed dynamically.
Use TvInputInfo.Builder
to build a new TvInputInfo
object.
Attempting to change information about a TV input that the calling package does not own does nothing.
Parameters | |
---|---|
inputInfo |
TvInputInfo :
The TvInputInfo object that contains new information. |
Throws | |
---|---|
IllegalArgumentException |
if the argument is null . |
See also: