Add comments

GetStream · Dec 19, 2024 · c5a8414 · c5a8414
1 parent d09a77a
commit c5a8414
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/...re/src/main/kotlin/io/getstream/video/android/core/closedcaptions/ClosedCaptionManager.kt b/...re/src/main/kotlin/io/getstream/video/android/core/closedcaptions/ClosedCaptionManager.kt
@@ -57,6 +57,17 @@ class ClosedCaptionManager(private var config: ClosedCaptionsConfig = ClosedCapt
         MutableStateFlow(emptyList())
     val closedCaptions: StateFlow<List<CallClosedCaption>> = _closedCaptions.asStateFlow()
 
+    /**
+     *  Holds the current closed caption mode for the video call. This object contains information about closed
+     *  captioning feature availability. This state is updated dynamically based on the server's transcription
+     *  setting which is [org.openapitools.client.models.TranscriptionSettingsResponse.closedCaptionMode]
+     *
+     *  Possible values:
+     *  - [ClosedCaptionMode.Available]: Closed captions are available and can be enabled.
+     *  - [ClosedCaptionMode.Disabled]: Closed captions are explicitly disabled.
+     *  - [ClosedCaptionMode.AutoOn]: Closed captions are automatically enabled as soon as user joins the call
+     *  - [ClosedCaptionMode.Unknown]: Represents an unrecognized or unsupported mode.
+     */
     private val _ccMode =
         MutableStateFlow<ClosedCaptionMode>(ClosedCaptionMode.Disabled)
     val ccMode: StateFlow<ClosedCaptionMode> = _ccMode.asStateFlow()