Android 11 以降では、クイック アクセス デバイス コントロール機能により、ユーザーはデフォルトのランチャーから 3 つの操作内で、照明、エアコン、カメラなどの外部デバイスをユーザー アフォーダンスからすばやく表示して操作できます。デバイスの OEM は、使用するランチャーを選択します。デバイス アグリゲータ(Google Home など)やサードパーティ ベンダーのアプリは、このスペースに表示するデバイスを提供できます。このページでは、このスペースにデバイス コントロールを表示し、コントロール アプリにリンクする方法について説明します。
このサポートを追加するには、ControlsProviderService
を作成して宣言します。事前定義されたコントロール タイプに基づいてアプリがサポートするコントロールを作成し、それらのコントロールのパブリッシャーを作成します。
ユーザー インターフェース
デバイスは、[デバイス コントロール] の下にテンプレート化されたウィジェットとして表示されます。次の図に示すように、5 つのデバイス コントロール ウィジェットを使用できます。
|
|
|
|
|
ウィジェットを長押しするとアプリに移動し、より細かい操作が可能です。各ウィジェットのアイコンと色をカスタマイズできますが、ユーザー エクスペリエンスを最適にするために、デフォルト セットがデバイスと一致する場合はデフォルトのアイコンと色を使用します。
サービスを作成する
このセクションでは、ControlsProviderService
の作成方法について説明します。このサービスは、Android UI の [デバイス コントロール] 領域に表示する必要があるデバイス コントロールがアプリに含まれていることを Android システム UI に伝えます。
ControlsProviderService
API は、リアクティブ ストリーム GitHub プロジェクトで定義され、Java 9 フロー インターフェースに実装されているリアクティブ ストリームに精通していることを前提としています。この API は、次のコンセプトに基づいて構築されています。
- パブリッシャー: アプリケーションがパブリッシャーです。
- サブスクライバー: システム UI はサブスクライバーであり、パブリッシャーにさまざまなコントロールをリクエストできます。
- 購読: ニュース メディアがシステム UI にアップデートを送信できる期間。パブリッシャーまたはサブスクライバーは、このウィンドウを閉じることができます。
サービスを宣言する
アプリは、アプリ マニフェストでサービス(MyCustomControlService
など)を宣言する必要があります。
サービスには ControlsProviderService
のインテント フィルタが含まれている必要があります。このフィルタにより、アプリはシステム UI にコントロールを提供できるようになります。
また、システム UI のコントロールに表示される label
も必要です。
次の例は、サービスを宣言する方法を示しています。
<service
android:name="MyCustomControlService"
android:label="My Custom Controls"
android:permission="android.permission.BIND_CONTROLS"
android:exported="true"
>
<intent-filter>
<action android:name="android.service.controls.ControlsProviderService" />
</intent-filter>
</service>
次に、MyCustomControlService.kt
という名前の新しい Kotlin ファイルを作成し、ControlsProviderService()
を拡張します。
Kotlin
class MyCustomControlService : ControlsProviderService() { ... }
Java
public class MyCustomJavaControlService extends ControlsProviderService { ... }
正しいコントロール タイプを選択する
API には、コントロールを作成するためのビルダー メソッドが用意されています。ビルダーにデータを入力するには、制御するデバイスと、ユーザーによる操作方法を決定します。次の手順を行います。
- コントロールが表すデバイスのタイプを選択します。
DeviceTypes
クラスは、サポートされているすべてのデバイスの列挙です。このタイプは、UI でデバイスのアイコンと色を決定するために使用されます。 - ユーザー向けの名前、デバイスの位置情報(キッチンなど)、コントロールに関連付けられたその他の UI テキスト要素を決定します。
- ユーザー インタラクションをサポートする最適なテンプレートを選択します。コントロールには、アプリケーションから
ControlTemplate
が割り当てられます。このテンプレートは、コントロールの状態と、利用可能な入力方法(ControlAction
)を直接ユーザーに示します。次の表に、利用可能なテンプレートの一部と、テンプレートでサポートされるアクションを示します。
テンプレート | アクション | 説明 |
ControlTemplate.getNoTemplateObject()
|
None
|
アプリはこれを使用してコントロールに関する情報を伝えることはできますが、ユーザーはこれを操作できません。 |
ToggleTemplate
|
BooleanAction
|
有効状態と無効状態を切り替えられるコントロールを表します。BooleanAction オブジェクトには、ユーザーがコントロールをタップしたときに、リクエストされた新しい状態を表すように変化するフィールドが含まれています。 |
RangeTemplate
|
FloatAction
|
指定された最小値、最大値、ステップ値を持つスライダー ウィジェットを表します。ユーザーがスライダーを操作すると、更新された値を持つ新しい FloatAction オブジェクトをアプリに返します。 |
ToggleRangeTemplate
|
BooleanAction, FloatAction
|
このテンプレートは ToggleTemplate と RangeTemplate を組み合わせたものです。タッチイベントだけでなく、調光可能なライトの制御などのスライダーもサポートしています。
|
TemperatureControlTemplate
|
ModeAction, BooleanAction, FloatAction
|
このテンプレートでは、上記のアクションをカプセル化するだけでなく、ユーザーが暖房、冷房、暖房/冷房、エコ、オフなどのモードを設定できます。 |
StatelessTemplate
|
CommandAction
|
IR テレビのリモコンなど、タップ機能を備えているものの、状態を特定できないコントロールを示すために使用されます。このテンプレートを使用して、コントロールと状態の変化を集約したルーティンやマクロを定義できます。 |
この情報を使用して、コントロールを作成できます。
- コントロールの状態が不明な場合は
Control.StatelessBuilder
ビルダークラスを使用します。 - コントロールの状態がわかっている場合は
Control.StatefulBuilder
ビルダークラスを使用します。
たとえば、スマート電球とサーモスタットを制御するには、次の定数を MyCustomControlService
に追加します。
Kotlin
private const val LIGHT_ID = 1234 private const val LIGHT_TITLE = "My fancy light" private const val LIGHT_TYPE = DeviceTypes.TYPE_LIGHT private const val THERMOSTAT_ID = 5678 private const val THERMOSTAT_TITLE = "My fancy thermostat" private const val THERMOSTAT_TYPE = DeviceTypes.TYPE_THERMOSTAT class MyCustomControlService : ControlsProviderService() { ... }
Java
public class MyCustomJavaControlService extends ControlsProviderService { private final int LIGHT_ID = 1337; private final String LIGHT_TITLE = "My fancy light"; private final int LIGHT_TYPE = DeviceTypes.TYPE_LIGHT; private final int THERMOSTAT_ID = 1338; private final String THERMOSTAT_TITLE = "My fancy thermostat"; private final int THERMOSTAT_TYPE = DeviceTypes.TYPE_THERMOSTAT; ... }
コントロール用のパブリッシャーを作成する
コントロールを作成したら、次はパブリッシャーが必要です。パブリッシャーは、システム UI にコントロールの存在を通知します。ControlsProviderService
クラスには、アプリケーション コードでオーバーライドする必要がある 2 つのパブリッシャー メソッドがあります。
createPublisherForAllAvailable()
: アプリで使用できるすべてのコントロールのPublisher
を作成します。Control.StatelessBuilder()
を使用して、このパブリッシャーのControl
オブジェクトを作成します。createPublisherFor()
: 文字列識別子で識別される、指定されたコントロールのリストのPublisher
を作成します。これらのControl
オブジェクトをビルドするには、Control.StatefulBuilder
を使用します。これは、パブリッシャーが各コントロールに状態を割り当てる必要があるためです。
パブリッシャーを作成する
アプリが最初にシステム UI にコントロールを公開したとき、アプリは各コントロールの状態を認識しません。状態の取得には、デバイス プロバイダのネットワークで多数のホップが必要になるため、時間がかかることがあります。createPublisherForAllAvailable()
メソッドを使用して、使用可能なコントロールをシステムにアドバタイズします。各コントロールの状態が不明なため、このメソッドでは Control.StatelessBuilder
ビルダークラスを使用します。
コントロールが Android UI に表示されたら、ユーザーはお気に入りのコントロールを選択できます。
Kotlin コルーチンを使用して ControlsProviderService
を作成するには、build.gradle
に新しい依存関係を追加します。
Groovy
dependencies { implementation "org.jetbrains.kotlinx:kotlinx-coroutines-jdk9:1.6.4" }
Kotlin
dependencies { implementation("org.jetbrains.kotlinx:kotlinx-coroutines-jdk9:1.6.4") }
Gradle ファイルを同期したら、次のスニペットを Service
に追加して createPublisherForAllAvailable()
を実装します。
Kotlin
class MyCustomControlService : ControlsProviderService() { override fun createPublisherForAllAvailable(): Flow.Publisher= flowPublish { send(createStatelessControl(LIGHT_ID, LIGHT_TITLE, LIGHT_TYPE)) send(createStatelessControl(THERMOSTAT_ID, THERMOSTAT_TITLE, THERMOSTAT_TYPE)) } private fun createStatelessControl(id: Int, title: String, type: Int): Control { val intent = Intent(this, MainActivity::class.java) .putExtra(EXTRA_MESSAGE, title) .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK) val action = PendingIntent.getActivity( this, id, intent, PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE ) return Control.StatelessBuilder(id.toString(), action) .setTitle(title) .setDeviceType(type) .build() } override fun createPublisherFor(controlIds: List ): Flow.Publisher { TODO() } override fun performControlAction( controlId: String, action: ControlAction, consumer: Consumer ) { TODO() } }
Java
public class MyCustomJavaControlService extends ControlsProviderService { private final int LIGHT_ID = 1337; private final String LIGHT_TITLE = "My fancy light"; private final int LIGHT_TYPE = DeviceTypes.TYPE_LIGHT; private final int THERMOSTAT_ID = 1338; private final String THERMOSTAT_TITLE = "My fancy thermostat"; private final int THERMOSTAT_TYPE = DeviceTypes.TYPE_THERMOSTAT; private boolean toggleState = false; private float rangeState = 18f; private final Map> controlFlows = new HashMap<>(); @NonNull @Override public Flow.Publisher createPublisherForAllAvailable() { List controls = new ArrayList<>(); controls.add(createStatelessControl(LIGHT_ID, LIGHT_TITLE, LIGHT_TYPE)); controls.add(createStatelessControl(THERMOSTAT_ID, THERMOSTAT_TITLE, THERMOSTAT_TYPE)); return FlowAdapters.toFlowPublisher(Flowable.fromIterable(controls)); } @NonNull @Override public Flow.Publisher createPublisherFor(@NonNull List controlIds) { ReplayProcessor updatePublisher = ReplayProcessor.create(); controlIds.forEach(control -> { controlFlows.put(control, updatePublisher); updatePublisher.onNext(createLight()); updatePublisher.onNext(createThermostat()); }); return FlowAdapters.toFlowPublisher(updatePublisher); } }
システム メニューを下にスワイプして、図 4 の [デバイス コントロール] ボタンを見つけます。
[デバイス コントロール] をタップすると、アプリを選択できる 2 番目の画面に移動します。アプリを選択すると、前のスニペットによって、新しいコントロールを表示するカスタム システム メニューが作成されます(図 5 を参照)。
次に、createPublisherFor()
メソッドを実装して、Service
に以下を追加します。
Kotlin
private val job = SupervisorJob() private val scope = CoroutineScope(Dispatchers.IO + job) private val controlFlows = mutableMapOf>() private var toggleState = false private var rangeState = 18f override fun createPublisherFor(controlIds: List ): Flow.Publisher { val flow = MutableSharedFlow (replay = 2, extraBufferCapacity = 2) controlIds.forEach { controlFlows[it] = flow } scope.launch { delay(1000) // Retrieving the toggle state. flow.tryEmit(createLight()) delay(1000) // Retrieving the range state. flow.tryEmit(createThermostat()) } return flow.asPublisher() } private fun createLight() = createStatefulControl( LIGHT_ID, LIGHT_TITLE, LIGHT_TYPE, toggleState, ToggleTemplate( LIGHT_ID.toString(), ControlButton( toggleState, toggleState.toString().uppercase(Locale.getDefault()) ) ) ) private fun createThermostat() = createStatefulControl( THERMOSTAT_ID, THERMOSTAT_TITLE, THERMOSTAT_TYPE, rangeState, RangeTemplate( THERMOSTAT_ID.toString(), 15f, 25f, rangeState, 0.1f, "%1.1f" ) ) private fun createStatefulControl(id: Int, title: String, type: Int, state: T, template: ControlTemplate): Control { val intent = Intent(this, MainActivity::class.java) .putExtra(EXTRA_MESSAGE, "$title $state") .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK) val action = PendingIntent.getActivity( this, id, intent, PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE ) return Control.StatefulBuilder(id.toString(), action) .setTitle(title) .setDeviceType(type) .setStatus(Control.STATUS_OK) .setControlTemplate(template) .build() } override fun onDestroy() { super.onDestroy() job.cancel() }
Java
@NonNull @Override public Flow.PublishercreatePublisherFor(@NonNull List controlIds) { ReplayProcessor updatePublisher = ReplayProcessor.create(); controlIds.forEach(control -> { controlFlows.put(control, updatePublisher); updatePublisher.onNext(createLight()); updatePublisher.onNext(createThermostat()); }); return FlowAdapters.toFlowPublisher(updatePublisher); } private Control createStatelessControl(int id, String title, int type) { Intent intent = new Intent(this, MainActivity.class) .putExtra(EXTRA_MESSAGE, title) .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); PendingIntent action = PendingIntent.getActivity( this, id, intent, PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE ); return new Control.StatelessBuilder(id + "", action) .setTitle(title) .setDeviceType(type) .build(); } private Control createLight() { return createStatefulControl( LIGHT_ID, LIGHT_TITLE, LIGHT_TYPE, toggleState, new ToggleTemplate( LIGHT_ID + "", new ControlButton( toggleState, String.valueOf(toggleState).toUpperCase(Locale.getDefault()) ) ) ); } private Control createThermostat() { return createStatefulControl( THERMOSTAT_ID, THERMOSTAT_TITLE, THERMOSTAT_TYPE, rangeState, new RangeTemplate( THERMOSTAT_ID + "", 15f, 25f, rangeState, 0.1f, "%1.1f" ) ); } private Control createStatefulControl(int id, String title, int type, T state, ControlTemplate template) { Intent intent = new Intent(this, MainActivity.class) .putExtra(EXTRA_MESSAGE, "$title $state") .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); PendingIntent action = PendingIntent.getActivity( this, id, intent, PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE ); return new Control.StatefulBuilder(id + "", action) .setTitle(title) .setDeviceType(type) .setStatus(Control.STATUS_OK) .setControlTemplate(template) .build(); }
この例の createPublisherFor()
メソッドには、アプリが行う必要がある処理(デバイスと通信してステータスを取得し、そのステータスをシステムに出力する)の疑似実装が含まれています。
createPublisherFor()
メソッドは、Kotlin のコルーチンとフローを使用して、必要な Reactive Streams API を満たします。手順は次のとおりです。
Flow
を作成します。- 1 秒待ちます。
- スマートライトの状態を作成して出力します。
- さらに 1 秒待ちます。
- サーモスタットの状態を作成して出力します。
アクションを処理する
performControlAction()
メソッドは、ユーザーが公開されたコントロールを操作したときにシグナル状態になります。送信される ControlAction
のタイプによってアクションが決まります。指定されたコントロールに対して適切なアクションを実行し、Android UI でデバイスの状態を更新する。
この例を完了するには、次のコードを Service
に追加します。
Kotlin
override fun performControlAction( controlId: String, action: ControlAction, consumer: Consumer) { controlFlows[controlId]?.let { flow -> when (controlId) { LIGHT_ID.toString() -> { consumer.accept(ControlAction.RESPONSE_OK) if (action is BooleanAction) toggleState = action.newState flow.tryEmit(createLight()) } THERMOSTAT_ID.toString() -> { consumer.accept(ControlAction.RESPONSE_OK) if (action is FloatAction) rangeState = action.newValue flow.tryEmit(createThermostat()) } else -> consumer.accept(ControlAction.RESPONSE_FAIL) } } ?: consumer.accept(ControlAction.RESPONSE_FAIL) }
Java
@Override public void performControlAction(@NonNull String controlId, @NonNull ControlAction action, @NonNull Consumerconsumer) { ReplayProcessor processor = controlFlows.get(controlId); if (processor == null) return; if (controlId.equals(LIGHT_ID + "")) { consumer.accept(ControlAction.RESPONSE_OK); if (action instanceof BooleanAction) toggleState = ((BooleanAction) action).getNewState(); processor.onNext(createLight()); } if (controlId.equals(THERMOSTAT_ID + "")) { consumer.accept(ControlAction.RESPONSE_OK); if (action instanceof FloatAction) rangeState = ((FloatAction) action).getNewValue() processor.onNext(createThermostat()); } }
アプリを実行し、[デバイス コントロール] メニューにアクセスして、ライトとサーモスタットのコントロールを確認します。