Added in API level 19
ConsumerIrManager
public
final
class
ConsumerIrManager
extends Object
| java.lang.Object | |
| ↳ | android.hardware.ConsumerIrManager |
Class that operates consumer infrared on the device.
Requires the PackageManager#FEATURE_CONSUMER_IR feature which can be detected using PackageManager.hasSystemFeature(String).
Summary
Nested classes | |
|---|---|
class |
ConsumerIrManager.CarrierFrequencyRange
Represents a range of carrier frequencies (inclusive) on which the infrared transmitter can transmit |
Public methods | |
|---|---|
CarrierFrequencyRange[]
|
getCarrierFrequencies()
Query the infrared transmitter's supported carrier frequencies |
boolean
|
hasIrEmitter()
Check whether the device has an infrared emitter. |
void
|
transmit(int carrierFrequency, int[] pattern)
Transmit an infrared pattern This method is synchronous; when it returns the pattern has been transmitted. |
Inherited methods | |
|---|---|
Public methods
getCarrierFrequencies
Added in API level 19
public CarrierFrequencyRange[] getCarrierFrequencies ()
Query the infrared transmitter's supported carrier frequencies
| Returns | |
|---|---|
CarrierFrequencyRange[] |
an array of
ConsumerIrManager.CarrierFrequencyRange
objects representing the ranges that the transmitter can support, or
null if there was an error communicating with the Consumer IR Service. |
hasIrEmitter
Added in API level 19
public boolean hasIrEmitter ()
Check whether the device has an infrared emitter.
| Returns | |
|---|---|
boolean |
true if the device has an infrared emitter, else false. |
transmit
Added in API level 19
public void transmit (int carrierFrequency,
int[] pattern)Transmit an infrared pattern
This method is synchronous; when it returns the pattern has been transmitted. Only patterns shorter than 2 seconds will be transmitted.
| Parameters | |
|---|---|
carrierFrequency |
int: The IR carrier frequency in Hertz. |
pattern |
int: The alternating on/off pattern in microseconds to transmit. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# ConsumerIrManager\n\nAdded in [API level 19](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Nested Classes](#nestedclasses) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nConsumerIrManager\n=================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/hardware/ConsumerIrManager \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\n\nfinal\n\nclass\nConsumerIrManager\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.hardware.ConsumerIrManager |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nClass that operates consumer infrared on the device.\n\n\u003cbr /\u003e\n\n\nRequires the [PackageManager#FEATURE_CONSUMER_IR](/reference/android/content/pm/PackageManager#FEATURE_CONSUMER_IR) feature which can be detected using [PackageManager.hasSystemFeature(String)](/reference/android/content/pm/PackageManager#hasSystemFeature(java.lang.String)).\n\nSummary\n-------\n\n| ### Nested classes ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` class` | [ConsumerIrManager.CarrierFrequencyRange](/reference/android/hardware/ConsumerIrManager.CarrierFrequencyRange) Represents a range of carrier frequencies (inclusive) on which the infrared transmitter can transmit |\n\n| ### Public methods ||\n|---------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[CarrierFrequencyRange[]](/reference/android/hardware/ConsumerIrManager.CarrierFrequencyRange) | ` `[getCarrierFrequencies](/reference/android/hardware/ConsumerIrManager#getCarrierFrequencies())`() ` Query the infrared transmitter's supported carrier frequencies |\n| ` boolean` | ` `[hasIrEmitter](/reference/android/hardware/ConsumerIrManager#hasIrEmitter())`() ` Check whether the device has an infrared emitter. |\n| ` void` | ` `[transmit](/reference/android/hardware/ConsumerIrManager#transmit(int,%20int[]))`(int carrierFrequency, int[] pattern) ` Transmit an infrared pattern This method is synchronous; when it returns the pattern has been transmitted. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic methods\n--------------\n\n### getCarrierFrequencies\n\nAdded in [API level 19](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic CarrierFrequencyRange[] getCarrierFrequencies ()\n```\n\nQuery the infrared transmitter's supported carrier frequencies\n\n\u003cbr /\u003e\n\n| Returns ||\n|------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [CarrierFrequencyRange[]](/reference/android/hardware/ConsumerIrManager.CarrierFrequencyRange) | an array of [ConsumerIrManager.CarrierFrequencyRange](/reference/android/hardware/ConsumerIrManager.CarrierFrequencyRange) objects representing the ranges that the transmitter can support, or null if there was an error communicating with the Consumer IR Service. \u003cbr /\u003e |\n\n### hasIrEmitter\n\nAdded in [API level 19](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic boolean hasIrEmitter ()\n```\n\nCheck whether the device has an infrared emitter.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-----------|----------------------------------------------------------------|\n| `boolean` | true if the device has an infrared emitter, else false. \u003cbr /\u003e |\n\n### transmit\n\nAdded in [API level 19](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic void transmit (int carrierFrequency, \n int[] pattern)\n```\n\nTransmit an infrared pattern\n\n\nThis method is synchronous; when it returns the pattern has\nbeen transmitted. Only patterns shorter than 2 seconds will\nbe transmitted.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------------|---------------------------------------------------------------------------|\n| `carrierFrequency` | `int`: The IR carrier frequency in Hertz. \u003cbr /\u003e |\n| `pattern` | `int`: The alternating on/off pattern in microseconds to transmit. \u003cbr /\u003e |"]]