Update IConsumerIr method comments and add units to parameter
Test: atest ConsumerIrTest VtsHalIrTargetTest hal_implementation_test Bug: 213468221 Change-Id: Ied20fec1a522e3757fbbc9ec60812b6805acd0f5
This commit is contained in:
parent
e0a7d60db0
commit
4811381f3e
3 changed files with 12 additions and 14 deletions
|
@ -35,5 +35,5 @@ package android.hardware.ir;
|
|||
@VintfStability
|
||||
interface IConsumerIr {
|
||||
android.hardware.ir.ConsumerIrFreqRange[] getCarrierFreqs();
|
||||
void transmit(in int carrierFreq, in int[] pattern);
|
||||
void transmit(in int carrierFreqHz, in int[] pattern);
|
||||
}
|
||||
|
|
|
@ -23,23 +23,21 @@ interface IConsumerIr {
|
|||
/**
|
||||
* Enumerates which frequencies the IR transmitter supports.
|
||||
*
|
||||
* Status OK (EX_NONE) on success.
|
||||
*
|
||||
* @return - an array of all supported frequency ranges.
|
||||
*/
|
||||
ConsumerIrFreqRange[] getCarrierFreqs();
|
||||
|
||||
/**
|
||||
* Sends an IR pattern at a given frequency in HZ.
|
||||
*
|
||||
* The pattern is alternating series of carrier on and off periods measured in
|
||||
* microseconds. The carrier should be turned off at the end of a transmit
|
||||
* even if there are and odd number of entries in the pattern array.
|
||||
*
|
||||
* This call must return when the transmit is complete or encounters an error.
|
||||
*
|
||||
* Status OK (EX_NONE) on success.
|
||||
* EX_UNSUPPORTED_OPERATION when the frequency is not supported.
|
||||
* @param carrierFreq - Frequency of the transmission in HZ.
|
||||
*
|
||||
* @param pattern - Alternating series of on and off periods measured in
|
||||
* microseconds. The carrier should be turned off at the end of a transmit
|
||||
* even if there are an odd number of entries in the pattern array.
|
||||
*
|
||||
* @throws EX_UNSUPPORTED_OPERATION when the frequency is not supported.
|
||||
*/
|
||||
void transmit(in int carrierFreq, in int[] pattern);
|
||||
void transmit(in int carrierFreqHz, in int[] pattern);
|
||||
}
|
||||
|
|
|
@ -30,7 +30,7 @@ const std::vector<ConsumerIrFreqRange> kSupportedFreqs = {
|
|||
|
||||
class ConsumerIr : public BnConsumerIr {
|
||||
::ndk::ScopedAStatus getCarrierFreqs(std::vector<ConsumerIrFreqRange>* _aidl_return) override;
|
||||
::ndk::ScopedAStatus transmit(int32_t in_carrierFreq,
|
||||
::ndk::ScopedAStatus transmit(int32_t in_carrierFreqHz,
|
||||
const std::vector<int32_t>& in_pattern) override;
|
||||
};
|
||||
|
||||
|
@ -46,9 +46,9 @@ bool isSupportedFreq(int32_t freq) {
|
|||
return false;
|
||||
}
|
||||
|
||||
::ndk::ScopedAStatus ConsumerIr::transmit(int32_t in_carrierFreq,
|
||||
::ndk::ScopedAStatus ConsumerIr::transmit(int32_t in_carrierFreqHz,
|
||||
const std::vector<int32_t>& in_pattern) {
|
||||
if (isSupportedFreq(in_carrierFreq)) {
|
||||
if (isSupportedFreq(in_carrierFreqHz)) {
|
||||
// trasmit the pattern, each integer is number of microseconds in an
|
||||
// alternating on/off state.
|
||||
usleep(std::accumulate(in_pattern.begin(), in_pattern.end(), 0));
|
||||
|
|
Loading…
Reference in a new issue