Added in API level 21

TvInputInfo

class TvInputInfo : Parcelable
kotlin.Any
   ↳ android.media.tv.TvInputInfo

This class is used to specify meta information of a TV input.

Summary

Nested classes

A convenience builder for creating TvInputInfo objects.
Constants
static String

Used as a String extra field in setup intents created by createSetupIntent() to supply the ID of a specific TV input to set up.
static Int

TV input type: the TV input service represents a component port.
static Int

TV input type: the TV input service represents a composite port.
static Int

TV input type: the TV input service represents a display port.
static Int

TV input type: the TV input service represents a DVI port.
static Int

TV input type: the TV input service is HDMI.
static Int

TV input type: a generic hardware TV input type.
static Int

TV input type: the TV input service represents a SCART port.
static Int

TV input type: the TV input service represents a SVIDEO port.
static Int

TV input type: the TV input service is a tuner which provides channels.
static Int

TV input type: the TV input service represents a VGA port.
Inherited constants
Public methods
Boolean

Returns true if this TV input can pause recording TV programs, false otherwise.
Boolean

Returns true if this TV input can record TV programs, false otherwise.
Intent!

Returns an intent to start the settings activity for this TV input.
Intent!

Returns an intent to start the setup activity for this TV input.
Int

Boolean
equals(other: Any?)
Bundle!

Returns domain-specific extras associated with this TV input.
String!

Returns a unique ID for this TV input.
String!

Returns the parent input ID.
ServiceInfo!

Returns the information of the service that implements this TV input.
Int

Returns the number of tuners this TV input has.
Int

Returns the type of this TV input.
Int

Boolean
isHidden(context: Context!)

Checks if this TV input is marked hidden by the user in the settings.
Boolean

Returns true if this TV input is pass-though which does not have any real channels in TvProvider.
CharSequence!

Loads the custom label set by user in settings.
Drawable!
loadIcon(context: Context)

Loads the user-displayed icon for this TV input.
CharSequence!
loadLabel(context: Context)

Loads the user-displayed label for this TV input.
String

Unit
writeToParcel(dest: Parcel, flags: Int)

Used to package this object into a Parcel.
Properties
static Parcelable.Creator<TvInputInfo!>

Constants

EXTRA_INPUT_ID

Added in API level 21
static val EXTRA_INPUT_ID: String

Used as a String extra field in setup intents created by createSetupIntent() to supply the ID of a specific TV input to set up.

Value: "android.media.tv.extra.INPUT_ID"

TYPE_COMPONENT

Added in API level 21
static val TYPE_COMPONENT: Int

TV input type: the TV input service represents a component port.

Value: 1004

TYPE_COMPOSITE

Added in API level 21
static val TYPE_COMPOSITE: Int

TV input type: the TV input service represents a composite port.

Value: 1001

TYPE_DISPLAY_PORT

Added in API level 21
static val TYPE_DISPLAY_PORT: Int

TV input type: the TV input service represents a display port.

Value: 1008

TYPE_DVI

Added in API level 21
static val TYPE_DVI: Int

TV input type: the TV input service represents a DVI port.

Value: 1006

TYPE_HDMI

Added in API level 21
static val TYPE_HDMI: Int

TV input type: the TV input service is HDMI. (e.g. HDMI 1)

Value: 1007

TYPE_OTHER

Added in API level 21
static val TYPE_OTHER: Int

TV input type: a generic hardware TV input type.

Value: 1000

TYPE_SCART

Added in API level 21
static val TYPE_SCART: Int

TV input type: the TV input service represents a SCART port.

Value: 1003

TYPE_SVIDEO

Added in API level 21
static val TYPE_SVIDEO: Int

TV input type: the TV input service represents a SVIDEO port.

Value: 1002

TYPE_TUNER

Added in API level 21
static val TYPE_TUNER: Int

TV input type: the TV input service is a tuner which provides channels.

Value: 0

TYPE_VGA

Added in API level 21
static val TYPE_VGA: Int

TV input type: the TV input service represents a VGA port.

Value: 1005

Public methods

canPauseRecording

Added in API level 31
fun canPauseRecording(): Boolean

Returns true if this TV input can pause recording TV programs, false otherwise.

canRecord

Added in API level 24
fun canRecord(): Boolean

Returns true if this TV input can record TV programs, false otherwise.

createSettingsIntent

Added in API level 21
Deprecated in API level 26
fun createSettingsIntent(): Intent!

Deprecated: Use createSetupIntent() instead. Settings activity is deprecated. Use setup activity instead to provide settings.

Returns an intent to start the settings activity for this TV input.

createSetupIntent

Added in API level 21
fun createSetupIntent(): Intent!

Returns an intent to start the setup activity for this TV input.

describeContents

Added in API level 21
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 21
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getExtras

Added in API level 24
fun getExtras(): Bundle!

Returns domain-specific extras associated with this TV input.

getId

Added in API level 21
fun getId(): String!

Returns a unique ID for this TV input. The ID is generated from the package and class name implementing the TV input service.

getParentId

Added in API level 21
fun getParentId(): String!

Returns the parent input ID.

A TV input may have a parent input if the TV input is actually a logical representation of a device behind the hardware port represented by the parent input. For example, a HDMI CEC logical device, connected to a HDMI port, appears as another TV input. In this case, the parent input of this logical device is the HDMI port.

Applications may group inputs by parent input ID to provide an easier access to inputs sharing the same physical port. In the example of HDMI CEC, logical HDMI CEC devices behind the same HDMI port have the same parent ID, which is the ID representing the port. Thus applications can group the hardware HDMI port and the logical HDMI CEC devices behind it together using this method.

Return
String! the ID of the parent input, if exists. Returns null if the parent input is not specified.

getServiceInfo

Added in API level 21
fun getServiceInfo(): ServiceInfo!

Returns the information of the service that implements this TV input.

getTunerCount

Added in API level 24
fun getTunerCount(): Int

Returns the number of tuners this TV input has.

This method is valid only for inputs of type TYPE_TUNER. For inputs of other types, it returns 0.

Tuners correspond to physical/logical resources that allow reception of TV signal. Having N tuners means that the TV input is capable of receiving N different channels concurrently.

getType

Added in API level 21
fun getType(): Int

Returns the type of this TV input.

Return
Int Value is android.media.tv.TvInputInfo#TYPE_TUNER, android.media.tv.TvInputInfo#TYPE_OTHER, android.media.tv.TvInputInfo#TYPE_COMPOSITE, android.media.tv.TvInputInfo#TYPE_SVIDEO, android.media.tv.TvInputInfo#TYPE_SCART, android.media.tv.TvInputInfo#TYPE_COMPONENT, android.media.tv.TvInputInfo#TYPE_VGA, android.media.tv.TvInputInfo#TYPE_DVI, android.media.tv.TvInputInfo#TYPE_HDMI, or android.media.tv.TvInputInfo#TYPE_DISPLAY_PORT

hashCode

Added in API level 21
fun hashCode(): Int
Return
Int a hash code value for this object.

isHidden

Added in API level 24
fun isHidden(context: Context!): Boolean

Checks if this TV input is marked hidden by the user in the settings.

Parameters
context Context!: Supplies a Context used to check if this TV input is hidden.
Return
Boolean true if the user marked this TV input hidden in settings. false otherwise.

isPassthroughInput

Added in API level 21
fun isPassthroughInput(): Boolean

Returns true if this TV input is pass-though which does not have any real channels in TvProvider. false otherwise.

loadCustomLabel

Added in API level 24
fun loadCustomLabel(context: Context!): CharSequence!

Loads the custom label set by user in settings.

Parameters
context Context!: Supplies a Context used to load the custom label.
Return
CharSequence! a CharSequence containing the TV input's custom label. null if there is no custom label.

loadIcon

Added in API level 21
fun loadIcon(context: Context): Drawable!

Loads the user-displayed icon for this TV input.

Parameters
context Context: Supplies a Context used to load the icon. This value cannot be null.
Return
Drawable! a Drawable containing the TV input's icon. If the TV input does not have an icon, application's icon is returned. If it's unavailable too, null is returned.

loadLabel

Added in API level 21
fun loadLabel(context: Context): CharSequence!

Loads the user-displayed label for this TV input.

Parameters
context Context: Supplies a Context used to load the label. This value cannot be null.
Return
CharSequence! a CharSequence containing the TV input's label. If the TV input does not have a label, its name is returned.

toString

Added in API level 21
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 21
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Used to package this object into a Parcel.

Parameters
dest Parcel: The Parcel to be written. This value cannot be null.
flags Int: The flags used for parceling.

Properties

CREATOR

Added in API level 21
static val CREATOR: Parcelable.Creator<TvInputInfo!>