broadcastradio/1.0/IBroadcastRadioFactory.hal

   1 /*
   2  * Copyright (C) 2016 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package android.hardware.broadcastradio@1.0;
  18
  19 import IBroadcastRadio;
  20
  21 interface IBroadcastRadioFactory {
  22
  23     /**
  24      * Connects to a broadcast radio HAL module for a given class
  25      * (AM/FM, Satellite, DAB).
  26      *
  27      * @param classId Class of the module to connect to .
  28      * @return retval operation completion status. Returns INVALID_ARGUMENTS
  29      *         if there is no corresponding hardware module found,
  30      *         NOT_INITIALIZED if an error occurred while opening the hardware
  31      *         module.
  32      * @return result the interface for the created module.
  33      */
  34     connectModule(Class classId)
  35       generates (Result retval, IBroadcastRadio result);
  36 };