From c5a841481961f95ad570333bc15414bc9ecdd679 Mon Sep 17 00:00:00 2001 From: rahul_lohra Date: Thu, 19 Dec 2024 17:20:57 +0530 Subject: [PATCH] Add comments --- .../core/closedcaptions/ClosedCaptionManager.kt | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/closedcaptions/ClosedCaptionManager.kt b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/closedcaptions/ClosedCaptionManager.kt index 37b408e869..d16ded3055 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/closedcaptions/ClosedCaptionManager.kt +++ b/stream-video-android-core/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> = _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.Disabled) val ccMode: StateFlow = _ccMode.asStateFlow()