feat(LLC): Support for transcription added to SDK (#701)

* Support for transcription added to SDK

* transcription docs

Author: Brazol

docusaurus/docs/Flutter/06-ui-cookbook/13-transcriptions.mdx

@@ -0,0 +1,17 @@
+# Transcriptions
+
+Enabling your application to provide a transcript for a call can be very useful for your users. We understand though, that this can be a difficult feature to implement/support.
+
+This is why, the Flutter Video SDK comes with out of the box Transcription support that you can easily manage.
+
+First thing you can do is access the transcriptions settings as they have been configured from the dashboard. The `mode` property defines the feature's availability with:
+
+- `available`: the feature is available for your call and can be enabled.
+
+- `disabled`: the feature is not available for your call. In this case, it's a good idea to "hide" any UI element you have related to transcription.
+
+- `autoOn`: the feature is available and it will be enabled automatically, once the user is connected on the call.
+
+Second thing you can do is to start/stop the transcription itself. This can be done by calling the `call.startTranscription()` and `call.stopTranscription()` methods.
+
+Transcription file is saved whenever you stop the transcription or end the call. You can then access the transcription files by calling the `call.listTranscriptions()` method.

dogfooding/lib/core/repos/token_service.dart

@@ -19,7 +19,7 @@ enum Environment {
   demo(
     'Demo',
     'demo',
-    'demo.getstream.io',
+    'pronto.getstream.io',
     aliases: [''],
   ),
   staging(

packages/stream_video/lib/src/call/call.dart

@@ -389,6 +389,10 @@ class Call {
       return _stateManager.coordinatorCallRecordingStarted(event);
     } else if (event is CoordinatorCallRecordingStoppedEvent) {
       return _stateManager.coordinatorCallRecordingStopped(event);
+    } else if (event is CoordinatorCallTranscriptionStartedEvent) {
+      return _stateManager.coordinatorCallTranscriptionStarted(event);
+    } else if (event is CoordinatorCallTranscriptionStoppedEvent) {
+      return _stateManager.coordinatorCallTranscriptionStopped(event);
     } else if (event is CoordinatorCallBroadcastingStartedEvent) {
       return _stateManager.coordinatorCallBroadcastingStarted(event);
     } else if (event is CoordinatorCallBroadcastingStoppedEvent) {
@@ -1482,6 +1486,30 @@ class Call {
     return result;
   }
 
+  Future<Result<None>> startTranscription() async {
+    final result = await _permissionsManager.startTranscription();
+
+    if (result.isSuccess) {
+      _stateManager.setCallTranscribing(isTranscribing: true);
+    }
+
+    return result;
+  }
+
+  Future<Result<List<CallTranscription>>> listTranscriptions() async {
+    return _permissionsManager.listTranscriptions();
+  }
+
+  Future<Result<None>> stopTranscription() async {
+    final result = await _permissionsManager.stopTranscription();
+
+    if (result.isSuccess) {
+      _stateManager.setCallTranscribing(isTranscribing: false);
+    }
+
+    return result;
+  }
+
   /// Starts the broadcasting of the call.
   Future<Result<String?>> startHLS() async {
     final result = await _permissionsManager.startBroadcasting();
@@ -1776,7 +1804,8 @@ class Call {
   }
 
   Future<Result<None>> setSubscriptions(
-      List<SubscriptionChange> changes) async {
+    List<SubscriptionChange> changes,
+  ) async {
     final result = await _session?.setSubscriptions(changes) ??
         Result.error('Session is null');
 

packages/stream_video/lib/src/call/call_events.dart

@@ -449,6 +449,38 @@ class StreamCallRecordingStoppedEvent extends StreamCallEvent {
       ];
 }
 
+/// Event that is triggered when the transcription is started for a call.
+class StreamCallTranscriptionStartedEvent extends StreamCallEvent {
+  const StreamCallTranscriptionStartedEvent(
+    super.callCid, {
+    required this.createdAt,
+  });
+
+  final DateTime createdAt;
+
+  @override
+  List<Object?> get props => [
+        ...super.props,
+        createdAt,
+      ];
+}
+
+/// Event that is triggered when the transcription is stopped for a call.
+class StreamCallTranscriptionStoppedEvent extends StreamCallEvent {
+  const StreamCallTranscriptionStoppedEvent(
+    super.callCid, {
+    required this.createdAt,
+  });
+
+  final DateTime createdAt;
+
+  @override
+  List<Object?> get props => [
+        ...super.props,
+        createdAt,
+      ];
+}
+
 /// Event that is triggered when the broadcasting is started for a call.
 class StreamCallBroadcastingStartedEvent extends StreamCallEvent {
   const StreamCallBroadcastingStartedEvent(
@@ -811,6 +843,16 @@ extension CoordinatorCallEventX on CoordinatorCallEvent {
           event.callCid,
           createdAt: event.createdAt,
         ),
+      final CoordinatorCallTranscriptionStartedEvent event =>
+        StreamCallTranscriptionStartedEvent(
+          event.callCid,
+          createdAt: event.createdAt,
+        ),
+      final CoordinatorCallTranscriptionStoppedEvent event =>
+        StreamCallTranscriptionStoppedEvent(
+          event.callCid,
+          createdAt: event.createdAt,
+        ),
       final CoordinatorCallBroadcastingStartedEvent event =>
         StreamCallBroadcastingStartedEvent(
           event.callCid,

packages/stream_video/lib/src/call/permissions/permissions_manager.dart

@@ -134,9 +134,9 @@ class PermissionsManager {
   }
 
   Future<Result<List<CallRecording>>> listRecordings() async {
-    _logger.d(() => '[queryRecordings] Call $callCid');
+    _logger.d(() => '[listRecordings] Call $callCid');
     final result = await coordinatorClient.listRecordings(callCid);
-    _logger.v(() => '[queryRecordings] result: $result');
+    _logger.v(() => '[listRecordings] result: $result');
     return result;
   }
 
@@ -151,6 +151,35 @@ class PermissionsManager {
     return result;
   }
 
+  Future<Result<None>> startTranscription() async {
+    if (!hasPermission(CallPermission.startTranscriptionCall)) {
+      _logger.w(() => '[startTranscription] rejected (no permission)');
+      return Result.error('Cannot start transcription (no permission)');
+    }
+    _logger.d(() => '[startTranscription] no args');
+    final result = await coordinatorClient.startTranscription(callCid);
+    _logger.v(() => '[startTranscription] result: $result');
+    return result;
+  }
+
+  Future<Result<List<CallTranscription>>> listTranscriptions() async {
+    _logger.d(() => '[listTranscriptions] Call $callCid');
+    final result = await coordinatorClient.listTranscriptions(callCid);
+    _logger.v(() => '[listTranscriptions] result: $result');
+    return result;
+  }
+
+  Future<Result<None>> stopTranscription() async {
+    if (!hasPermission(CallPermission.startTranscriptionCall)) {
+      _logger.w(() => '[stopTranscription] rejected (no permission)');
+      return Result.error('Cannot stop transcription (no permission)');
+    }
+    _logger.d(() => '[stopTranscription] no args');
+    final result = await coordinatorClient.stopTranscription(callCid);
+    _logger.v(() => '[stopTranscription] result: $result');
+    return result;
+  }
+
   Future<Result<String?>> startBroadcasting() async {
     if (!hasPermission(CallPermission.startBroadcastCall)) {
       _logger.w(() => '[startBroadcasting] rejected (no permission)');

packages/stream_video/lib/src/call/session/call_session.dart

@@ -751,14 +751,17 @@ class CallSession extends Disposable {
     VisibilityChange visibilityChange,
   ) async {
     _logger.d(
-        () => '[updateViewportVisibility] visibilityChange: $visibilityChange');
+      () => '[updateViewportVisibility] visibilityChange: $visibilityChange',
+    );
     return _vvBuffer.post(visibilityChange);
   }
 
   Future<Result<None>> updateViewportVisibilities(
     List<VisibilityChange> visibilityChanges,
   ) async {
-    _logger.d(() => '[updateViewportVisibilities] changes: $visibilityChanges');
+    _logger.d(
+      () => '[updateViewportVisibilities] changes: $visibilityChanges',
+    );
     // Nothing to do here, this is handled by the UI
     return const Result.success(none);
   }
@@ -767,7 +770,8 @@ class CallSession extends Disposable {
     List<SubscriptionChange> subscriptionChanges,
   ) async {
     _logger.d(
-        () => '[setSubscriptions] subscriptionChanges: $subscriptionChanges');
+      () => '[setSubscriptions] subscriptionChanges: $subscriptionChanges',
+    );
 
     final participants = stateManager.callState.callParticipants;
     final exclude = {SfuTrackType.video, SfuTrackType.screenShare};
@@ -794,7 +798,8 @@ class CallSession extends Disposable {
     SubscriptionChange subscriptionChange,
   ) async {
     _logger.d(
-        () => '[updateSubscription] subscriptionChange: $subscriptionChange');
+      () => '[updateSubscription] subscriptionChange: $subscriptionChange',
+    );
     return _saBuffer.post(subscriptionChange);
   }
 

packages/stream_video/lib/src/call/state/mixins/state_call_actions_mixin.dart

@@ -19,6 +19,13 @@ mixin StateCallActionsMixin on StateNotifier<CallState> {
     );
   }
 
+  void setCallTranscribing({required bool isTranscribing}) {
+    _logger.e(() => '[setCallTranscribing] isTranscribing:$isTranscribing');
+    state = state.copyWith(
+      isTranscribing: isTranscribing,
+    );
+  }
+
   void setCallBroadcasting({
     required bool isBroadcasting,
     String? hlsPlaylistUrl,

packages/stream_video/lib/src/call/state/mixins/state_coordinator_mixin.dart

@@ -12,7 +12,6 @@ import '../../../models/disconnect_reason.dart';
 final _logger = taggedLogger(tag: 'SV:CoordNotifier');
 
 mixin StateCoordinatorMixin on StateNotifier<CallState> {
-
   void coordinatorCallAccepted(
     CoordinatorCallAcceptedEvent event,
   ) {
@@ -181,6 +180,40 @@ mixin StateCoordinatorMixin on StateNotifier<CallState> {
     );
   }
 
+  void coordinatorCallTranscriptionStarted(
+    CoordinatorCallTranscriptionStartedEvent event,
+  ) {
+    final status = state.status;
+    if (status is! CallStatusActive) {
+      _logger.w(
+        () =>
+            '[coordinatorCallTranscriptionStarted] rejected (status is not Active)',
+      );
+      return;
+    }
+
+    state = state.copyWith(
+      isTranscribing: true,
+    );
+  }
+
+  void coordinatorCallTranscriptionStopped(
+    CoordinatorCallTranscriptionStoppedEvent event,
+  ) {
+    final status = state.status;
+    if (status is! CallStatusActive) {
+      _logger.w(
+        () =>
+            '[coordinatorCallTranscriptionStopped] rejected (status is not Active)',
+      );
+      return;
+    }
+
+    state = state.copyWith(
+      isTranscribing: false,
+    );
+  }
+
   void coordinatorCallBroadcastingStarted(
     CoordinatorCallBroadcastingStartedEvent event,
   ) {

packages/stream_video/lib/src/call/state/mixins/state_lifecycle_mixin.dart

@@ -94,6 +94,7 @@ mixin StateLifecycleMixin on StateNotifier<CallState> {
       isBackstage: data.metadata.details.backstage,
       isBroadcasting: data.metadata.details.broadcasting,
       isRecording: data.metadata.details.recording,
+      isTranscribing: data.metadata.details.transcribing,
     );
   }
 
@@ -121,6 +122,7 @@ mixin StateLifecycleMixin on StateNotifier<CallState> {
       isBackstage: data.metadata.details.backstage,
       isBroadcasting: data.metadata.details.broadcasting,
       isRecording: data.metadata.details.recording,
+      isTranscribing: data.metadata.details.transcribing,
       audioOutputDevice: callConnectOptions.audioOutputDevice,
       audioInputDevice: callConnectOptions.audioInputDevice,
     );
@@ -149,6 +151,7 @@ mixin StateLifecycleMixin on StateNotifier<CallState> {
       isBackstage: data.metadata.details.backstage,
       isBroadcasting: data.metadata.details.broadcasting,
       isRecording: data.metadata.details.recording,
+      isTranscribing: data.metadata.details.transcribing,
     );
   }
 
@@ -182,6 +185,7 @@ mixin StateLifecycleMixin on StateNotifier<CallState> {
       isBackstage: data.metadata.details.backstage,
       isBroadcasting: data.metadata.details.broadcasting,
       isRecording: data.metadata.details.recording,
+      isTranscribing: data.metadata.details.transcribing,
     );
   }
 

packages/stream_video/lib/src/coordinator/coordinator_client.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: comment_references
+
 import '../../open_api/video/coordinator/api.dart' as open;
 import '../models/call_cid.dart';
 import '../models/call_metadata.dart';
@@ -143,6 +145,19 @@ abstract class CoordinatorClient {
   /// Stops recording for the call described by the given [callCid].
   Future<Result<None>> stopRecording(StreamCallCid callCid);
 
+  /// Starts transcription for the call described by the given [callCid].
+  Future<Result<None>> startTranscription(
+    StreamCallCid callCid, {
+    String? transcriptionExternalStorage,
+  });
+
+  Future<Result<List<open.CallTranscription>>> listTranscriptions(
+    StreamCallCid callCid,
+  );
+
+  /// Stops transcription for the call described by the given [callCid].
+  Future<Result<None>> stopTranscription(StreamCallCid callCid);
+
   /// Starts broadcasting for the call described by the given [callCid].
   Future<Result<String?>> startBroadcasting(StreamCallCid callCid);