ウォッチフェイス サービスを構築する

ウォッチフェイスは、Wear OS アプリにパッケージされているサービスです。ユーザーが利用可能なウォッチフェイスを選択すると、ウォッチフェイスが表示され、サービスのコールバック メソッドが呼び出されます。

ウォッチフェイスのある Wear アプリをインストールすると、ユーザーはスマートウォッチでウォッチフェイス選択ツールを使用してウォッチフェイスを選択できます。また、ペア設定されているスマートフォンのコンパニオン アプリでも、ウォッチフェイスを選択できます。

このページでは、Wear OS プロジェクトを構成してウォッチフェイスを追加する方法と、ウォッチフェイス サービスを実装する方法について説明します。

ウォッチフェイス プロジェクトを作成する

Android Studio でウォッチフェイス用のプロジェクトを作成する手順は次のとおりです。

1. [File] > [New] > [New project] をクリックします。
2. [Select a project template] ウィンドウで [Wear] タブを選択し、オプションのリストから [Watch Face] を選択して、[Next] をクリックします。
3. [Configure your project] ウィンドウで、デフォルト値のまま [Finish] をクリックします。

Android Studio は、ウォッチフェイス サービス用の app モジュールを使用してプロジェクトを作成します。

依存関係

Android Studio は、必要なエントリを build.gradle ファイルに自動的に追加します。

AndroidX ウォッチフェイス ライブラリは現在利用できません。試すには、GitHub のコードサンプルをご覧ください。

ウェアラブル サポート ライブラリ API リファレンス

リファレンス ドキュメントには、ウォッチフェイスを実装する際に使用するクラスについての詳細な情報が記載されています。ウェアラブル サポート ライブラリについては、API リファレンス ドキュメントをご覧ください。

注: Wear OS の開発には Android Studio を使用することをおすすめします。Android Studio では、プロジェクトのセットアップ、ライブラリのインクルード、パッケージングを容易に行うことができます。

権限を宣言する

ウォッチフェイスには WAKE_LOCK 権限が必要です。Wear OS アプリとスマートフォン アプリの両方のマニフェスト ファイルで、manifest 要素に以下の権限を追加します。

<manifest ...>
    <uses-permission
        android:name="android.permission.WAKE_LOCK" />

    <!-- Required for complications to receive complication data and open the provider chooser. -->
    <uses-permission
        android:name="com.google.android.wearable.permission.RECEIVE_COMPLICATION_DATA"/>
    ...
</manifest>

長方形デバイスをサポートする

デフォルトでは、長方形デバイスのウォッチフェイスは正方形のエミュレーション モードで動作し、円形と正方形のデバイス向けに構築されたウォッチフェイスをサポートします。長方形デバイスを完全にサポートする場合は、次のコードサンプルに示すように、manifest のウォッチフェイス service に meta-data タグを作成し、android.service.wallpaper.square_mode を false に設定することで、この動作をオーバーライドします。

<manifest ...>
    <application ...>
        <service
            android:name=".MyWatchFace"
            android:label="My Watch Face"
            android:permission="android.permission.BIND_WALLPAPER">

            ...

            <meta-data
                android:name="android.service.wallpaper.square_mode"
                android:value="false" />
            ...
        </service>
    ...
    </application>
    ...
</manifest>

サービスとコールバック メソッドを実装する

Wear OS のウォッチフェイスは WatchFaceService として実装されます。WatchFaceService を実装するには、UserStyleSchema、ComplicationSlotsManager、WatchFace という 3 つのオブジェクトを作成する必要があります。

これら 3 つのオブジェクトは、WatchFaceService の 3 つの抽象メソッドをオーバーライドすることで指定します。

class CustomWatchFaceService : WatchFaceService() {

    /**
     * The specification of settings the watch face supports.
     * This is similar to a database schema.
     */
    override fun createUserStyleSchema(): UserStyleSchema = // ...

    /**
     * The complication slot configuration for the watchface.
     */
    override fun createComplicationSlotsManager(
        currentUserStyleRepository: CurrentUserStyleRepository
    ): ComplicationSlotsManager = // ...

    /**
     * The watch face itself, which includes the renderer for drawing.
     */
    override suspend fun createWatchFace(
        surfaceHolder: SurfaceHolder,
        watchState: WatchState,
        complicationSlotsManager: ComplicationSlotsManager,
        currentUserStyleRepository: CurrentUserStyleRepository
    ): WatchFace = // ...

}

<service
    android:name=".AnalogWatchFaceService"
    android:label="@string/analog_name"
    android:permission="android.permission.BIND_WALLPAPER" >
    <meta-data
        android:name="android.service.wallpaper"
        android:resource="@xml/watch_face" />
    <meta-data
        android:name="com.google.android.wearable.watchface.preview"
        android:resource="@drawable/preview_analog" />
    <meta-data
        android:name="com.google.android.wearable.watchface.preview_circular"
        android:resource="@drawable/preview_analog_circular" />
    <intent-filter>
        <action android:name="android.service.wallpaper.WallpaperService" />
        <category
            android:name=
            "com.google.android.wearable.watchface.category.WATCH_FACE" />
    </intent-filter>
</service>

<?xml version="1.0" encoding="UTF-8"?>
<wallpaper xmlns:android="http://schemas.android.com/apk/res/android" />