TvInputManager

ACTION_BLOCKED_RATINGS_CHANGED

public static final 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"

ACTION_PARENTAL_CONTROLS_ENABLED_CHANGED

public static final 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"

ACTION_QUERY_CONTENT_RATING_SYSTEMS

public static final 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.

Constant Value: "android.media.tv.action.QUERY_CONTENT_RATING_SYSTEMS"

ACTION_SETUP_INPUTS

public static final String ACTION_SETUP_INPUTS

Activity action to set up channel sources i.e. TV inputs of type TvInputInfo#TYPE_TUNER. When invoked, the system will display an appropriate UI for the user to initiate the individual setup flow provided by R.attr.setupActivity of each TV input service.

Constant Value: "android.media.tv.action.SETUP_INPUTS"

ACTION_VIEW_RECORDING_SCHEDULES

public static final String ACTION_VIEW_RECORDING_SCHEDULES

Activity action to display the recording schedules. When invoked, the system will display an appropriate UI to browse the schedules.

Constant Value: "android.media.tv.action.VIEW_RECORDING_SCHEDULES"

BROADCAST_INFO_STREAM_EVENT

public static final int BROADCAST_INFO_STREAM_EVENT

Constant Value: 5 (0x00000005)

BROADCAST_INFO_TYPE_COMMAND

public static final int BROADCAST_INFO_TYPE_COMMAND

Constant Value: 7 (0x00000007)

BROADCAST_INFO_TYPE_DSMCC

public static final int BROADCAST_INFO_TYPE_DSMCC

Constant Value: 6 (0x00000006)

BROADCAST_INFO_TYPE_PES

public static final int BROADCAST_INFO_TYPE_PES

Constant Value: 4 (0x00000004)

BROADCAST_INFO_TYPE_SECTION

public static final int BROADCAST_INFO_TYPE_SECTION

Constant Value: 3 (0x00000003)

BROADCAST_INFO_TYPE_TABLE

public static final int BROADCAST_INFO_TYPE_TABLE

Constant Value: 2 (0x00000002)

BROADCAST_INFO_TYPE_TIMELINE

public static final int BROADCAST_INFO_TYPE_TIMELINE

Constant Value: 8 (0x00000008)

BROADCAST_INFO_TYPE_TS

public static final int BROADCAST_INFO_TYPE_TS

Constant Value: 1 (0x00000001)

INPUT_STATE_CONNECTED

public static final int INPUT_STATE_CONNECTED

State for getInputState(java.lang.String) and TvInputCallback#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. Non-hardware inputs are considered connected all the time.

Constant Value: 0 (0x00000000)

INPUT_STATE_CONNECTED_STANDBY

public static final int INPUT_STATE_CONNECTED_STANDBY

State for getInputState(java.lang.String) and TvInputCallback#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 or low power mode. It is mostly relevant to hardware inputs such as HDMI input and Component inputs.

Constant Value: 1 (0x00000001)

INPUT_STATE_DISCONNECTED

public static final int INPUT_STATE_DISCONNECTED

State for getInputState(java.lang.String) and TvInputCallback#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)

META_DATA_CONTENT_RATING_SYSTEMS

public static final 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"

RECORDING_ERROR_INSUFFICIENT_SPACE

public static final int RECORDING_ERROR_INSUFFICIENT_SPACE

Error for TvInputService.RecordingSession#notifyError(int) and TvRecordingClient.RecordingCallback#onError(int): Recording cannot proceed due to insufficient storage space.

Constant Value: 1 (0x00000001)

RECORDING_ERROR_RESOURCE_BUSY

public static final int RECORDING_ERROR_RESOURCE_BUSY

Error for TvInputService.RecordingSession#notifyError(int) and TvRecordingClient.RecordingCallback#onError(int): Recording cannot proceed because a required recording resource was not able to be allocated.

Constant Value: 2 (0x00000002)

RECORDING_ERROR_UNKNOWN

public static final int RECORDING_ERROR_UNKNOWN

Error for TvInputService.RecordingSession#notifyError(int) and TvRecordingClient.RecordingCallback#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)

SIGNAL_STRENGTH_LOST

public static final int SIGNAL_STRENGTH_LOST

Signal lost.

Constant Value: 1 (0x00000001)

SIGNAL_STRENGTH_STRONG

public static final int SIGNAL_STRENGTH_STRONG

Strong signal.

Constant Value: 3 (0x00000003)

SIGNAL_STRENGTH_WEAK

public static final int SIGNAL_STRENGTH_WEAK

Weak signal.

Constant Value: 2 (0x00000002)

TIME_SHIFT_INVALID_TIME

public static final long TIME_SHIFT_INVALID_TIME

Value returned by TvInputService.Session#onTimeShiftGetCurrentPosition() and TvInputService.Session#onTimeShiftGetStartPosition() when time shifting has not yet started.

Constant Value: -9223372036854775808 (0x8000000000000000)

TIME_SHIFT_MODE_AUTO

public static final int TIME_SHIFT_MODE_AUTO

Time shift mode: auto.

Time shift mode is handled automatically.

Constant Value: 4 (0x00000004)

TIME_SHIFT_MODE_LOCAL

public static final int TIME_SHIFT_MODE_LOCAL

Time shift mode: local.

Time shift is handle locally, using on-device data. E.g. playing a local file.

Constant Value: 2 (0x00000002)

TIME_SHIFT_MODE_NETWORK

public static final int TIME_SHIFT_MODE_NETWORK

Time shift mode: network.

Time shift is handle remotely via network. E.g. online streaming.

Constant Value: 3 (0x00000003)

TIME_SHIFT_MODE_OFF

public static final int TIME_SHIFT_MODE_OFF

Time shift mode: off.

Time shift is disabled.

Constant Value: 1 (0x00000001)

TIME_SHIFT_STATUS_AVAILABLE

public static final int TIME_SHIFT_STATUS_AVAILABLE

Status for TvInputService.Session#notifyTimeShiftStatusChanged(int) and TvView.TvInputCallback#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)

TIME_SHIFT_STATUS_UNAVAILABLE

public static final int TIME_SHIFT_STATUS_UNAVAILABLE

Status for TvInputService.Session#notifyTimeShiftStatusChanged(int) and TvView.TvInputCallback#onTimeShiftStatusChanged(String, int): Time shifting is currently unavailable but might work again later.

Constant Value: 2 (0x00000002)

TIME_SHIFT_STATUS_UNKNOWN

public static final int TIME_SHIFT_STATUS_UNKNOWN

Status for TvInputService.Session#notifyTimeShiftStatusChanged(int) and TvView.TvInputCallback#onTimeShiftStatusChanged(String, int): Unknown status. Also the status prior to calling notifyTimeShiftStatusChanged.

Constant Value: 0 (0x00000000)

TIME_SHIFT_STATUS_UNSUPPORTED

public static final int TIME_SHIFT_STATUS_UNSUPPORTED

Status for TvInputService.Session#notifyTimeShiftStatusChanged(int) and TvView.TvInputCallback#onTimeShiftStatusChanged(String, int): The current TV input does not support time shifting.

Constant Value: 1 (0x00000001)

TV_MESSAGE_GROUP_ID_NONE

public static final long TV_MESSAGE_GROUP_ID_NONE

This value for TV_MESSAGE_KEY_GROUP_ID denotes that the message doesn't belong to any group.

Constant Value: -1 (0xffffffffffffffff)

TV_MESSAGE_KEY_GROUP_ID

public static final String TV_MESSAGE_KEY_GROUP_ID

This constant is used as a Bundle key for TV messages. This is used to optionally identify messages that belong together, such as headers and bodies of the same event. For messages that do not have a group, this value should be TV_MESSAGE_GROUP_ID_NONE.

As -1 is a reserved value, -1 should not be used as a valid groupId.

Type: long

Constant Value: "android.media.tv.TvInputManager.group_id"

TV_MESSAGE_KEY_RAW_DATA

public static final String TV_MESSAGE_KEY_RAW_DATA

This constant is used as a Bundle key for TV messages. The value of the key stores the raw data contained in this TV message. The format of this data is determined by the format defined by the subtype, found using the key at TV_MESSAGE_KEY_SUBTYPE. See TV_MESSAGE_KEY_SUBTYPE for more information on how to parse this data.

Type: byte[]

Constant Value: "android.media.tv.TvInputManager.raw_data"

TV_MESSAGE_KEY_STREAM_ID

public static final String TV_MESSAGE_KEY_STREAM_ID

This constant is used as a Bundle key for TV messages. The value of the key identifies the stream on the TV input source for which the watermark event is relevant to.

Type: String

Constant Value: "android.media.tv.TvInputManager.stream_id"

TV_MESSAGE_KEY_SUBTYPE

public static final String TV_MESSAGE_KEY_SUBTYPE

This constant is used as a Bundle key for TV messages. The value of the key identifies the subtype of the data, such as the format of the CC data. The format found at this key can then be used to identify how to parse the data at TV_MESSAGE_KEY_RAW_DATA.

To parse the raw data based on the subtype, please refer to the official documentation of the concerning subtype. For example, for the subtype TV_MESSAGE_SUBTYPE_WATERMARKING_A335, the document for A/335 from the ATSC standard details how this data is formatted. Similarly, the subtype TV_MESSAGE_SUBTYPE_CC_608E is documented in the ANSI/CTA standard for 608-E. These subtypes are examples of common formats for their respective uses and other subtypes may exist.

Type: String

Constant Value: "android.media.tv.TvInputManager.subtype"

TV_MESSAGE_SUBTYPE_CC_608E

public static final String TV_MESSAGE_SUBTYPE_CC_608E

This is a subtype for TV messages that can be potentially found as a value at TV_MESSAGE_KEY_SUBTYPE. It identifies the subtype of the message as the CC format CTA 608-E.

Constant Value: "CTA 608-E"

TV_MESSAGE_SUBTYPE_WATERMARKING_A335

public static final String TV_MESSAGE_SUBTYPE_WATERMARKING_A335

This is a subtype for TV messages that can be potentially found as a value at TV_MESSAGE_KEY_SUBTYPE. It identifies the subtype of the message as the watermarking format ATSC A/335.

Constant Value: "ATSC A/335"

TV_MESSAGE_TYPE_CLOSED_CAPTION

public static final int TV_MESSAGE_TYPE_CLOSED_CAPTION

Indicates that this TV message contains Closed Captioning data

Constant Value: 2 (0x00000002)

TV_MESSAGE_TYPE_OTHER

public static final int TV_MESSAGE_TYPE_OTHER

Indicates that this TV message contains other data

Constant Value: 1000 (0x000003e8)

TV_MESSAGE_TYPE_WATERMARK

public static final int TV_MESSAGE_TYPE_WATERMARK

Indicates that this TV message contains watermarking data

Constant Value: 1 (0x00000001)

VIDEO_UNAVAILABLE_REASON_AUDIO_ONLY

public static final int VIDEO_UNAVAILABLE_REASON_AUDIO_ONLY

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because the current TV program is audio-only.

Constant Value: 4 (0x00000004)

VIDEO_UNAVAILABLE_REASON_BUFFERING

public static final int VIDEO_UNAVAILABLE_REASON_BUFFERING

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because the corresponding TV input has stopped playback temporarily to buffer more data.

Constant Value: 3 (0x00000003)

VIDEO_UNAVAILABLE_REASON_CAS_BLACKOUT

public static final int VIDEO_UNAVAILABLE_REASON_CAS_BLACKOUT

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because of a geographical blackout.

Constant Value: 16 (0x00000010)

VIDEO_UNAVAILABLE_REASON_CAS_CARD_INVALID

public static final int VIDEO_UNAVAILABLE_REASON_CAS_CARD_INVALID

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because smart card is invalid.

Constant Value: 15 (0x0000000f)

VIDEO_UNAVAILABLE_REASON_CAS_CARD_MUTE

public static final int VIDEO_UNAVAILABLE_REASON_CAS_CARD_MUTE

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because smart card is muted.

Constant Value: 14 (0x0000000e)

VIDEO_UNAVAILABLE_REASON_CAS_INSUFFICIENT_OUTPUT_PROTECTION

public static final int VIDEO_UNAVAILABLE_REASON_CAS_INSUFFICIENT_OUTPUT_PROTECTION

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because the output protection level enabled on the device is not sufficient to meet the requirements in the license policy.

Constant Value: 7 (0x00000007)

VIDEO_UNAVAILABLE_REASON_CAS_LICENSE_EXPIRED

public static final int VIDEO_UNAVAILABLE_REASON_CAS_LICENSE_EXPIRED

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because Using a license in whhich the keys have expired.

Constant Value: 10 (0x0000000a)

VIDEO_UNAVAILABLE_REASON_CAS_NEED_ACTIVATION

public static final int VIDEO_UNAVAILABLE_REASON_CAS_NEED_ACTIVATION

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because the device need be activated.

Constant Value: 11 (0x0000000b)

VIDEO_UNAVAILABLE_REASON_CAS_NEED_PAIRING

public static final int VIDEO_UNAVAILABLE_REASON_CAS_NEED_PAIRING

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because the device need be paired.

Constant Value: 12 (0x0000000c)

VIDEO_UNAVAILABLE_REASON_CAS_NO_CARD

public static final int VIDEO_UNAVAILABLE_REASON_CAS_NO_CARD

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because smart card is missed.

Constant Value: 13 (0x0000000d)

VIDEO_UNAVAILABLE_REASON_CAS_PVR_RECORDING_NOT_ALLOWED

public static final int VIDEO_UNAVAILABLE_REASON_CAS_PVR_RECORDING_NOT_ALLOWED

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because the PVR record is not allowed by the license policy.

Constant Value: 8 (0x00000008)

VIDEO_UNAVAILABLE_REASON_CAS_REBOOTING

public static final int VIDEO_UNAVAILABLE_REASON_CAS_REBOOTING

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because CAS system is rebooting.

Constant Value: 17 (0x00000011)

VIDEO_UNAVAILABLE_REASON_CAS_UNKNOWN

public static final int VIDEO_UNAVAILABLE_REASON_CAS_UNKNOWN

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because of unknown CAS error.

Constant Value: 18 (0x00000012)

VIDEO_UNAVAILABLE_REASON_INSUFFICIENT_RESOURCE

public static final int VIDEO_UNAVAILABLE_REASON_INSUFFICIENT_RESOURCE

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because the resource is not enough to meet requirement.

Constant Value: 6 (0x00000006)

VIDEO_UNAVAILABLE_REASON_NOT_CONNECTED

public static final int VIDEO_UNAVAILABLE_REASON_NOT_CONNECTED

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable because the source is not physically connected, for example the HDMI cable is not connected.

Constant Value: 5 (0x00000005)

VIDEO_UNAVAILABLE_REASON_TUNING

public static final int VIDEO_UNAVAILABLE_REASON_TUNING

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#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)

VIDEO_UNAVAILABLE_REASON_UNKNOWN

public static final int VIDEO_UNAVAILABLE_REASON_UNKNOWN

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable due to an unspecified error.

Constant Value: 0 (0x00000000)

VIDEO_UNAVAILABLE_REASON_WEAK_SIGNAL

public static final int VIDEO_UNAVAILABLE_REASON_WEAK_SIGNAL

Reason for TvInputService.Session#notifyVideoUnavailable(int) and TvView.TvInputCallback#onVideoUnavailable(String, int): Video is unavailable due to weak TV signal.

Constant Value: 2 (0x00000002)

getBlockedRatings

public List<TvContentRating> getBlockedRatings ()

Returns the list of blocked content ratings.

getInputState

public int getInputState (String inputId)

Returns the state of a given TV input.

The state is one of the following:

• INPUT_STATE_CONNECTED
• INPUT_STATE_CONNECTED_STANDBY
• INPUT_STATE_DISCONNECTED

getTvInputInfo

public TvInputInfo getTvInputInfo (String inputId)

Returns the TvInputInfo for a given TV input.

getTvInputList

public List<TvInputInfo> getTvInputList ()

Returns the complete list of TV inputs on the system.

isParentalControlsEnabled

public boolean isParentalControlsEnabled ()

Returns the user's parental controls enabled state.

isRatingBlocked

public boolean isRatingBlocked (TvContentRating rating)

Checks whether a given TV content rating is blocked by the user.

registerCallback

public void registerCallback (TvInputManager.TvInputCallback callback, 
                Handler handler)

Registers a TvInputCallback.

unregisterCallback

public void unregisterCallback (TvInputManager.TvInputCallback callback)

Unregisters the existing TvInputCallback.

updateTvInputInfo

public 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.