Android tv-casting-app: simplified command API

Author: sharadb-amazon

examples/tv-casting-app/APIs.md

@@ -693,7 +693,8 @@ discover available endpoints supported by a Casting Player.
 ### Connect to a Casting Player
 
 _{Complete Connection examples: [Linux](linux/simple-app-helper.cpp) |
-[iOS](darwin/TvCasting/TvCasting/MCConnectionExampleViewModel.swift)}_
+[Android](android/App/app/src/main/java/com/matter/casting/ConnectionExampleFragment.java)
+| [iOS](darwin/TvCasting/TvCasting/MCConnectionExampleViewModel.swift)}_
 
 Each `CastingPlayer` object created during
 [Discovery](#discover-casting-players) contains information such as
@@ -740,6 +741,40 @@ targetCastingPlayer->VerifyOrEstablishConnection(ConnectionHandler,
 ...
 ```
 
+On Android, the Casting Client may call `verifyOrEstablishConnection` on the
+`CastingPlayer` object it wants to connect to and accept or handle exceptions on
+the returned `CompletableFuture` object.
+
+```java
+private static final long MIN_CONNECTION_TIMEOUT_SEC = 3 * 60;
+...
+...
+
+EndpointFilter desiredEndpointFilter = new EndpointFilter(null, 65521, new ArrayList<DeviceTypeStruct>());
+
+// The desired commissioning window timeout and EndpointFilter are optional.
+CompletableFuture<Void> completableFuture = targetCastingPlayer.verifyOrEstablishConnection(MIN_CONNECTION_TIMEOUT_SEC, desiredEndpointFilter);
+completableFuture
+    .thenAccept(
+        (response) -> {
+            Log.i(TAG, "CompletableFuture.thenAccept(), connected to CastingPlayer with deviceId: " + targetCastingPlayer.getDeviceId());
+
+            getActivity().runOnUiThread(() -> {
+                connectionFragmentNextButton.setEnabled(true);
+            });
+        }
+    ).exceptionally(
+        exc -> {
+            Log.e(TAG, "CompletableFuture.exceptionally(), CastingPLayer connection failed: " + exc.getMessage());
+
+            getActivity().runOnUiThread(() -> {
+                connectionFragmentStatusTextView.setText("Casting Player connection failed due to: " + exc.getMessage());
+            });
+        return null;
+        }
+    );
+```
+
 On iOS, the Casting Client may call `verifyOrEstablishConnection` on the
 `MCCastingPlayer` object it wants to connect to and handle any `NSErrors` that
 may happen in the process.
@@ -774,6 +809,8 @@ func connect(selectedCastingPlayer: MCCastingPlayer?) {
 ### Select an Endpoint on the Casting Player
 
 _{Complete Endpoint selection examples: [Linux](linux/simple-app-helper.cpp) |
+[Android](android/App/app/src/main/java/com/matter/casting/ContentLauncherLaunchURLExampleFragment.java)
+|
 [iOS](darwin/TvCasting/TvCasting/MCContentLauncherLaunchURLExampleViewModel.swift)}_
 
 On a successful connection with a `CastingPlayer`, a Casting Client may select
@@ -800,6 +837,29 @@ if (it != endpoints.end())
 }
 ```
 
+On Android, it can select an `Endpoint` as shown below.
+
+```java
+private static final Integer SAMPLE_ENDPOINT_VID = 65521;
+...
+List<Endpoint> endpoints = selectedCastingPlayer.getEndpoints();
+if (endpoints == null) {
+    Log.e(TAG, "No Endpoints found on CastingPlayer");
+    return;
+}
+
+Endpoint endpoint = endpoints
+    .stream()
+    .filter(e -> SAMPLE_ENDPOINT_VID.equals(e.getVendorId()))
+    .findFirst()
+    .get();
+
+if (endpoint == null) {
+    Log.e(TAG, "No Endpoint with chosen vendorID: " + SAMPLE_ENDPOINT_VID + " found on CastingPlayer");
+    return;
+}
+```
+
 On iOS, it can select an `MCEndpoint` similarly and as shown below.
 
 ```swift
@@ -834,6 +894,8 @@ response types to use with these APIs:
 ### Issuing Commands
 
 _{Complete Command invocation examples: [Linux](linux/simple-app-helper.cpp) |
+[Android](android/App/app/src/main/java/com/matter/casting/ContentLauncherLaunchURLExampleFragment.java)
+|
 [iOS](darwin/TvCasting/TvCasting/MCContentLauncherLaunchURLExampleViewModel.swift)}_
 
 The Casting Client can get a reference to an `Endpoint` on a `CastingPlayer`,
@@ -880,6 +942,46 @@ void InvokeContentLauncherLaunchURL(matter::casting::memory::Strong<matter::cast
 }
 ```
 
+On Android, given an `Endpoint` endpoint, it can send a `LaunchURL` command
+(part of the Content Launcher cluster) by calling the `invoke` API on a
+`ContentLauncherClusterLaunchURLCommand`
+
+```java
+if (!endpoint.hasCluster(MatterClusters.ContentLauncherCluster.class)) {
+    Log.e(TAG, "Endpoint with chosen vendorID does not support ContentLauncher cluster");
+    return;
+}
+
+MatterClusters.ContentLauncherCluster cluster = endpoint.getCluster(MatterClusters.ContentLauncherCluster.class);
+MatterCommands.ContentLauncherClusterLaunchURLCommand command = cluster.getCommand(MatterCommands.ContentLauncherClusterLaunchURLCommand.class);
+if (command == null) {
+    Log.e(TAG, "ContentLauncher cluster on Endpoint with chosen vendorID does not support LaunchURL command");
+    return;
+}
+
+// create the request object from GUI inputs
+MatterCommands.ContentLauncherClusterLaunchURLRequest request = new MatterCommands.ContentLauncherClusterLaunchURLRequest();
+request.contentURL = ((EditText) getView().findViewById(R.id.contentUrlEditText)).getText().toString();
+request.displayString = ((EditText) getView().findViewById(R.id.contentDisplayStringEditText)).getText().toString();
+CompletableFuture<MatterCommands.ContentLauncherClusterResponse> responseFuture = command.invoke(request, 5000);
+responseFuture
+    .thenAccept(
+        response -> {
+            Log.d(TAG, "Command response " + response);
+            TextView launchUrlStatus = getView().findViewById(R.id.launchUrlStatus);
+            getActivity().runOnUiThread(() ->
+                launchUrlStatus.setText("Success! Response data: " + response.data));
+        }
+    ).exceptionally(
+        exc -> {
+            Log.e(TAG, "Command failure: " + exc.getMessage());
+            TextView launchUrlStatus = getView().findViewById(R.id.launchUrlStatus);
+            getActivity().runOnUiThread(() -> launchUrlStatus.setText("Command failure: " + exc.getMessage()));
+            return null;
+        }
+    );
+```
+
 On iOS, given an `MCEndpoint` endpoint, it can send a `LaunchURL` command (part
 of the Content Launcher cluster) by calling the `invoke` API on a
 `MCContentLauncherClusterLaunchURLCommand`
@@ -1042,10 +1144,8 @@ vendorIDAttribute!.read(nil) { context, before, after, err in
 
 ### Subscriptions
 
-_{Complete Attribute subscription examples:
-[Linux](linux/simple-app-helper.cpp)}_
-
-_{Complete Attribute Read examples: [Linux](linux/simple-app-helper.cpp) |
+_{Complete Attribute subscription examples: [Linux](linux/simple-app-helper.cpp)
+|
 [iOS](darwin/TvCasting/TvCasting/MCMediaPlaybackSubscribeToCurrentStateExampleViewModel.swift)}_
 
 A Casting Client may subscribe to an attribute on an `Endpoint` of the

examples/tv-casting-app/android/App/app/src/main/java/com/chip/casting/app/MainActivity.java

@@ -11,7 +11,9 @@
 import com.chip.casting.TvCastingApp;
 import com.chip.casting.util.GlobalCastingConstants;
 import com.chip.casting.util.PreferencesConfigurationManager;
+import com.matter.casting.ActionSelectorFragment;
 import com.matter.casting.ConnectionExampleFragment;
+import com.matter.casting.ContentLauncherLaunchURLExampleFragment;
 import com.matter.casting.DiscoveryExampleFragment;
 import com.matter.casting.InitializationExample;
 import com.matter.casting.core.CastingPlayer;
@@ -22,7 +24,8 @@ public class MainActivity extends AppCompatActivity
         ConnectionFragment.Callback,
         SelectClusterFragment.Callback,
         DiscoveryExampleFragment.Callback,
-        ConnectionExampleFragment.Callback {
+        ConnectionExampleFragment.Callback,
+        ActionSelectorFragment.Callback {
 
   private static final String TAG = MainActivity.class.getSimpleName();
 
@@ -73,9 +76,12 @@ public void handleCommissioningComplete() {
   @Override
   public void handleConnectionComplete(CastingPlayer castingPlayer) {
     Log.i(TAG, "MainActivity.handleConnectionComplete() called ");
+    showFragment(ActionSelectorFragment.newInstance(castingPlayer));
+  }
 
-    // TODO: Implement in following PRs. Select Cluster Fragment.
-    // showFragment(SelectClusterFragment.newInstance(tvCastingApp));
+  @Override
+  public void handleContentLauncherLaunchURLSelected(CastingPlayer selectedCastingPlayer) {
+    showFragment(ContentLauncherLaunchURLExampleFragment.newInstance(selectedCastingPlayer));
   }
 
   @Override
@@ -95,7 +101,10 @@ public void handleMediaPlaybackSelected() {
 
   @Override
   public void handleDisconnect() {
-    showFragment(CommissionerDiscoveryFragment.newInstance(tvCastingApp));
+    showFragment(
+        GlobalCastingConstants.ChipCastingSimplified
+            ? DiscoveryExampleFragment.newInstance()
+            : CommissionerDiscoveryFragment.newInstance(tvCastingApp));
   }
 
   /**

examples/tv-casting-app/android/App/app/src/main/java/com/chip/casting/util/GlobalCastingConstants.java

@@ -6,5 +6,5 @@ public class GlobalCastingConstants {
   public static final int SetupPasscode = 20202021;
   public static final int Discriminator = 0xF00;
   public static final boolean ChipCastingSimplified =
-      false; // set this flag to true to demo simplified casting APIs
+      true; // set this flag to true to demo simplified casting APIs
 }

examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ActionSelectorFragment.java

@@ -0,0 +1,97 @@
+/*
+ *   Copyright (c) 2024 Project CHIP Authors
+ *   All rights reserved.
+ *
+ *   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 com.matter.casting;
+
+import android.os.Bundle;
+import android.util.Log;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.view.ViewGroup;
+import androidx.annotation.Nullable;
+import androidx.fragment.app.Fragment;
+import com.R;
+import com.matter.casting.core.CastingPlayer;
+
+/** An interstitial {@link Fragment} to select one of the supported media actions to perform */
+public class ActionSelectorFragment extends Fragment {
+  private static final String TAG = ActionSelectorFragment.class.getSimpleName();
+
+  private final CastingPlayer selectedCastingPlayer;
+
+  private View.OnClickListener selectContentLauncherButtonClickListener;
+  private View.OnClickListener disconnectButtonClickListener;
+
+  public ActionSelectorFragment(CastingPlayer selectedCastingPlayer) {
+    this.selectedCastingPlayer = selectedCastingPlayer;
+  }
+
+  /**
+   * Use this factory method to create a new instance of this fragment using the provided
+   * parameters.
+   *
+   * @param selectedCastingPlayer CastingPlayer that the casting app connected to
+   * @return A new instance of fragment SelectActionFragment.
+   */
+  public static ActionSelectorFragment newInstance(CastingPlayer selectedCastingPlayer) {
+    return new ActionSelectorFragment(selectedCastingPlayer);
+  }
+
+  @Override
+  public void onCreate(Bundle savedInstanceState) {
+    super.onCreate(savedInstanceState);
+  }
+
+  @Override
+  public View onCreateView(
+      LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
+    ActionSelectorFragment.Callback callback = (ActionSelectorFragment.Callback) this.getActivity();
+    this.selectContentLauncherButtonClickListener =
+        v -> {
+          Log.d(TAG, "handle() called on selectContentLauncherButtonClickListener");
+          callback.handleContentLauncherLaunchURLSelected(selectedCastingPlayer);
+        };
+
+    this.disconnectButtonClickListener =
+        v -> {
+          Log.d(TAG, "Disconnecting from current casting player");
+          selectedCastingPlayer.disconnect();
+          callback.handleDisconnect();
+        };
+
+    return inflater.inflate(R.layout.fragment_matter_action_selector, container, false);
+  }
+
+  @Override
+  public void onViewCreated(View view, @Nullable Bundle savedInstanceState) {
+    super.onViewCreated(view, savedInstanceState);
+    Log.d(TAG, "ActionSelectorFragment.onViewCreated called");
+    getView()
+        .findViewById(R.id.selectContentLauncherLaunchURLButton)
+        .setOnClickListener(selectContentLauncherButtonClickListener);
+
+    getView().findViewById(R.id.disconnectButton).setOnClickListener(disconnectButtonClickListener);
+  }
+
+  /** Interface for notifying the host. */
+  public interface Callback {
+    /** Notifies listener to trigger transition on selection of Content Launcher cluster */
+    void handleContentLauncherLaunchURLSelected(CastingPlayer selectedCastingPlayer);
+
+    /** Notifies listener to trigger transition on click of the Disconnect button */
+    void handleDisconnect();
+  }
+}

examples/tv-casting-app/android/App/app/src/main/java/com/matter/casting/ConnectionExampleFragment.java

@@ -100,24 +100,26 @@ public void onViewCreated(View view, @Nullable Bundle savedInstanceState) {
                   new EndpointFilter(null, 65521, new ArrayList<DeviceTypeStruct>());
               // The desired commissioning window timeout and EndpointFilter are optional.
               CompletableFuture<Void> completableFuture =
-                  targetCastingPlayer.VerifyOrEstablishConnection(
+                  targetCastingPlayer.verifyOrEstablishConnection(
                       MIN_CONNECTION_TIMEOUT_SEC, desiredEndpointFilter);
 
               Log.d(TAG, "onViewCreated() verifyOrEstablishConnection() called");
 
+              Log.d(
+                  TAG,
+                  "onViewCreated() verifyOrEstablishConnection() completableFuture == null? "
+                      + (completableFuture == null));
+
               completableFuture
-                  .thenRun(
-                      () -> {
+                  .thenAccept(
+                      (response) -> {
                         Log.i(
                             TAG,
-                            "CompletableFuture.thenRun(), connected to CastingPlayer with deviceId: "
+                            "CompletableFuture.thenAccept(), connected to CastingPlayer with deviceId: "
                                 + targetCastingPlayer.getDeviceId());
                         getActivity()
                             .runOnUiThread(
                                 () -> {
-                                  connectionFragmentStatusTextView.setText(
-                                      "Connected to Casting Player with device name: "
-                                          + targetCastingPlayer.getDeviceName());
                                   connectionFragmentNextButton.setEnabled(true);
                                 });
                       })