Merge pull request #245785 from valindrae/ga-closed-captions

Ga closed captions

Author: JamesJBarnett

articles/communication-services/how-tos/calling-sdk/includes/closed-captions/closed-captions-teams-interop-android.md

@@ -1,12 +1,12 @@
 ---
 title: include file
-description: Android how-to guide for enabling Closed captions during a call.
+description: Android how-to guide for enabling Closed captions during a Teams interop call.
 author: Kunaal
 ms.service: azure-communication-services
 ms.subservice: calling
 ms.topic: include
 ms.topic: include file
-ms.date: 03/20/2023
+ms.date: 07/21/20223
 ms.author: kpunjabi
 ---
 
@@ -16,46 +16,52 @@ ms.author: kpunjabi
 - An app with voice and video calling, refer to our [Voice](../../../../quickstarts/voice-video-calling/getting-started-with-calling.md) and [Video](../../../../quickstarts/voice-video-calling/get-started-with-video-calling.md) calling quickstarts.
 - [Access tokens](../../../../quickstarts/manage-teams-identity.md) for Microsoft 365 users. 
 - [Access tokens](../../../../quickstarts/identity/access-tokens.md) for External identity users.
-- For Translated captions, you need to have a [Teams premium](/MicrosoftTeams/teams-add-on-licensing/licensing-enhance-teams#meetings) license. 
+- For Translated captions, you need to have a [Teams premium](/MicrosoftTeams/teams-add-on-licensing/licensing-enhance-teams#meetings) license.  
 
 >[!NOTE]
 >Please note that you will need to have a voice calling app using ACS calling SDKs to access the closed captions feature that is described in this guide.
 
 ## Models
-| Name | Description |
-|------|-------------|
-| TeamsCaptionsCallFeature | API for TeamsCall captions |
-| StartCaptionOptions | Closed caption options like spoken language |
-| TeamsCaptionsListener | Listener for addOnCaptionsReceivedListener |
-| TeamsCaptionsInfo | Data object received for each TeamsCaptionsListener event |
+| Name                       | Description                                               |
+| -------------------------- | --------------------------------------------------------- |
+| CaptionsCallFeature        | API for captions call feature                             |
+| TeamsCaptions              | API for Teams captions                                    |
+| StartCaptionOptions        | Closed caption options like spoken language               |
+| TeamsCaptionsListener      | Listener for TeamsCaptions addOnCaptionsReceivedListener  |
+| TeamsCaptionsReceivedEvent | Data object received for each TeamsCaptionsListener event |
 
 ## Get closed captions feature 
 
-### External Identity users
+### External Identity users and Microsoft 365 users
 
-If you're building an application that allows ACS users to join a Teams meeting 
+If you're building an application that allows users to join a Teams meeting 
 
 ``` java
-TeamsCaptionsCallFeature captionsCallFeature = call.feature(Features.TEAMS_CAPTIONS);
-```
-
-### Microsoft 365 users 
-
-If you're building an application for Microsoft 365 Users using ACS SDK. 
-
-``` java
-TeamsCaptionsCallFeature captionsCallFeature = teamsCall.feature(Features.TEAMS_CAPTIONS); 
+CaptionsCallFeature captionsCallFeature = call.feature(Features.CAPTIONS);
+captionsCallFeature.getCaptions().whenComplete(
+    ((captions, throwable) -> {
+        if (throwable == null) {
+            CallCaptions callCaptions = captions;
+            if (captions.getCaptionsType() == CaptionsType.TEAMS_CAPTIONS) {
+            // teams captions
+            TeamsCaptions teamsCaptions = (TeamsCaptions) captions;
+            }
+        } else {
+        // get captions failed
+        // throwable is the exception/cause
+        }
+    }));
 ```
 
 ## Subscribe to listeners
 
-### Add a listener to receive captions active/inactive status
+### Add a listener to receive captions enabled/disabled status
 
 ``` java
-public void addOnIsCaptionsActiveChangedListener() {
-    captionsCallFeature.addOnCaptionsActiveChangedListener( (PropertyChangedEvent args) -> {
-        if(captionsCallFeature.isCaptionsFeatureActive()) {
-        
+public void addOnIsCaptionsEnabledChangedListener() {
+    teamsCaptions.addOnCaptionsEnabledChangedListener( (PropertyChangedEvent args) -> {
+        if(teamsCaptions.isEnabled()) {
+            // captions enabled
         }
     });
 }
@@ -64,23 +70,57 @@ public void addOnIsCaptionsActiveChangedListener() {
 ### Add listener for captions data received
 
 ``` java 
-TeamsCaptionsListener captionsListener = (TeamsCaptionsInfo captionsInfo) -> {
-
+TeamsCaptionsListener captionsListener = (TeamsCaptionsReceivedEvent args) -> {
+  // Information about the speaker.
+  // CallerInfo participantInfo = args.getSpeaker();
+  // The original text with no transcribed.
+  // args.getSpokenText();
+  // language identifier for the captions text.
+  // args.getCaptionLanguage();
+  // language identifier for the speaker.
+  // args.getSpokenLanguage();
+  // The transcribed text.
+  // args.getCaptionText();
+  // Timestamp denoting the time when the corresponding speech was made.
+  // args.getTimestamp();
+  // CaptionsResultType is Partial if text contains partially spoken sentence.
+  // It is set to Final once the sentence has been completely transcribed.
+  // args.getResultType() == CaptionsResultType.FINAL;
 }; 
 public void addOnCaptionsReceivedListener() {
-  captionsCallFeature.addOnCaptionsReceivedListener(captionsListener); 
+  teamsCaptions.addOnCaptionsReceivedListener(captionsListener); 
+}
+```
+
+### Add a listener to receive active spoken language changed status
+
+``` java
+public void addOnActiveSpokenLanguageChangedListener() {
+    teamsCaptions.addOnActiveSpokenLanguageChangedListener( (PropertyChangedEvent args) -> {
+       // teamsCaptions.getActiveSpokenLanguage()
+    });
+}
+```
+
+### Add a listener to receive active caption language changed status
+
+``` java
+public void addOnActiveCaptionLanguageChangedListener() {
+    teamsCaptions.addOnActiveCaptionLanguageChangedListener( (PropertyChangedEvent args) -> {
+       // teamsCaptions.getActiveCaptionLanguage()
+    });
 }
 ```
 
 ## Start captions
 
-Once you've got all your listeners setup, you can now start captions.
+Once you've set up all your listeners, you can now start adding captions.
 
 ``` java
 public void startCaptions() {
     StartCaptionsOptions startCaptionsOptions = new StartCaptionsOptions();
     startCaptionsOptions.setSpokenLanguage("en-us");
-    captionsCallFeature.startCaptions(startCaptionsOptions).whenComplete((result, error) -> {
+    teamsCaptions.startCaptions(startCaptionsOptions).whenComplete((result, error) -> {
         if (error != null) {
         }
     });
@@ -91,7 +131,7 @@ public void startCaptions() {
 
 ``` java
 public void stopCaptions() {
-    captionsCallFeature.stopCaptions().whenComplete((result, error) -> {
+    teamsCaptions.stopCaptions().whenComplete((result, error) -> {
         if (error != null) {
         }
     });
@@ -102,28 +142,26 @@ public void stopCaptions() {
 
 ``` java
 public void removeOnCaptionsReceivedListener() {
-    captionsCallFeature.removeOnCaptionsReceivedListener(captionsListener);
+    teamsCaptions.removeOnCaptionsReceivedListener(captionsListener);
 }
 ```
 
-## Spoken language support
-
-### Get a list of supported spoken languages 
+## Spoken language support 
 
+### Get list of supported spoken languages
 Get a list of supported spoken languages that your users can select from when enabling closed captions. 
 
 ``` java
 // bcp 47 formatted language code
-captionsCallFeature.getSupportedSpokenLanguages();
+teamsCaptions.getSupportedSpokenLanguages();
 ```
 
 ### Set spoken language 
-
 When the user selects the spoken language, your app can set the spoken language that it expects captions to be generated from. 
 
 ``` java 
 public void setSpokenLanguage() {
-    captionsCallFeature.setSpokenLanguage("en-us").whenComplete((result, error) -> {
+    teamsCaptions.setSpokenLanguage("en-us").whenComplete((result, error) -> {
         if (error != null) {
         }
     });
@@ -138,18 +176,15 @@ If your organization has an active Teams premium license, then your ACS users ca
 
 ``` java
 // ISO 639-1 formatted language code
-captionsCallFeature.getSupportedCaptionLanguages();
+teamsCaptions.getSupportedCaptionLanguages();
 ```
 ### Set caption language 
 
 ``` java
 public void setCaptionLanguage() {
-    captionsCallFeature.setCaptionLanguage("en").whenComplete((result, error) -> {
+    teamsCaptions.setCaptionLanguage("en").whenComplete((result, error) -> {
         if (error != null) {
         }
     });
 }
 ```
-
-
-