lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

ConsumerIrManager

public final class ConsumerIrManager
extends Object

java.lang.Object
   ↳ android.hardware.ConsumerIrManager


Class that operates consumer infrared on the device.

Instances of this class must be obtained using Context.getSystemService(Class) with the argument ConsumerIrManager.class or Context.getSystemService(String) with the argument Context.CONSUMER_IR_SERVICE.

Requires the 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.