platform_hardware_interfaces/broadcastradio/1.0/IBroadcastRadioFactory.hal
Andreas Huber 40d3a9bd8c Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
2017-03-29 08:53:58 -07:00

36 lines
1.3 KiB
Text

/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.hardware.broadcastradio@1.0;
import IBroadcastRadio;
interface IBroadcastRadioFactory {
/**
* Connects to a broadcast radio HAL module for a given class
* (AM/FM, Satellite, DAB).
*
* @param classId Class of the module to connect to .
* @return retval operation completion status. Returns INVALID_ARGUMENTS
* if there is no corresponding hardware module found,
* NOT_INITIALIZED if an error occurred while opening the hardware
* module.
* @return result the interface for the created module.
*/
connectModule(Class classId)
generates (Result retval, IBroadcastRadio result);
};