car-lib/src/android/car/navigation/CarNavigationStatusManager.java

/*
 * 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.car.navigation;

import android.annotation.RequiresPermission;
import android.annotation.SystemApi;
import android.car.Car;
import android.car.CarLibLog;
import android.car.CarManagerBase;
import android.car.cluster.renderer.IInstrumentClusterNavigation;
import android.os.Bundle;
import android.os.IBinder;
import android.os.RemoteException;

/**
 * API for providing navigation status for instrument cluster.
 * @hide
 */
@SystemApi
public final class CarNavigationStatusManager extends CarManagerBase {
    private static final String TAG = CarLibLog.TAG_NAV;

    private final IInstrumentClusterNavigation mService;

    /**
     * Only for CarServiceLoader
     * @hide
     */
    public CarNavigationStatusManager(Car car, IBinder service) {
        super(car);
        mService = IInstrumentClusterNavigation.Stub.asInterface(service);
    }

    /**
     * Sends events from navigation app to instrument cluster.
     *
     * @deprecated use {@link #sendEvent(Bundle)} instead.
     */
    @Deprecated
    @RequiresPermission(Car.PERMISSION_CAR_NAVIGATION_MANAGER)
    public void sendEvent(int eventType, Bundle bundle) {
        sendNavigationStateChange(bundle);
    }

    /**
     * Sends events from navigation app to instrument cluster.
     *
     * @param bundle object holding data about the navigation event. This information is
     *               generated using <a href="https://developer.android.com/reference/androidx/car/cluster/navigation/NavigationState.html#toParcelable()">
     *               androidx.car.cluster.navigation.NavigationState#toParcelable()</a>
     *
     * @throws IllegalStateException if the client is not holding
     *                 {@link android.car.CarAppFocusManager#APP_FOCUS_TYPE_NAVIGATION} focus.
     * @throws IllegalArgumentException if {@code bundle} is null, if it cannot be parsed or if the
     *                 {@link android.car.cluster.navigation.NavigationState.NavigationStateProto}
     *                 generated after parsing is not valid. This object is not valid if it contains
     *                 a {@link android.car.cluster.navigation.NavigationState.Maneuver} where
     *                 Maneuver#typeV2 is populated but Maneuver#type is not.
     */
    @RequiresPermission(Car.PERMISSION_CAR_NAVIGATION_MANAGER)
    public void sendNavigationStateChange(Bundle bundle) {
        try {
            mService.onNavigationStateChanged(bundle);
        } catch (RemoteException e) {
            handleRemoteExceptionFromCarService(e);
        }
    }

    /** @hide */
    @Override
    public void onCarDisconnected() {
    }

    /** Returns navigation features of instrument cluster */
    @RequiresPermission(Car.PERMISSION_CAR_NAVIGATION_MANAGER)
    public CarNavigationInstrumentCluster getInstrumentClusterInfo() {
        try {
            return mService.getInstrumentClusterInfo();
        } catch (RemoteException e) {
            return handleRemoteExceptionFromCarService(e, null);
        }
    }
}