feat(llc): added mirror parameter to CameraConstraints (#641)

* added mirror parameter to CameraConstraints

* Update packages/stream_video/CHANGELOG.md

Co-authored-by: Deven Joshi <[email protected]>

* changed mirror to enum

---------

Co-authored-by: Deven Joshi <[email protected]>

Author: Brazol

packages/stream_video/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Unreleased
+✅ Added
+
+* Added `mirror` parameter to `CameraConstraints`, which determines whether the camera for the given track should be mirrored or not. When set as null the default is true when `facingMode` is set to `user` and false when facingMode is set to `environment`.
+
 ## 0.3.6
 ✅ Added
 

packages/stream_video/lib/src/webrtc/media/camera_constraints.dart

@@ -1,32 +1,38 @@
 import '../../platform_detector/platform_detector.dart';
 import '../model/rtc_video_parameters.dart';
 import 'constraints/facing_mode.dart';
+import 'constraints/mirror_mode.dart';
 import 'video_constraints.dart';
 
 /// Options used when creating a video track that captures the camera.
+/// [mirror]: Whether the video should be mirrored. If set to null, the default is true when facingMode is user and false when facingMode is environment.
 class CameraConstraints extends VideoConstraints {
   const CameraConstraints({
-    super.deviceId,
     this.facingMode = FacingMode.user,
+    this.mirrorMode = MirrorMode.defaultMode,
+    super.deviceId,
     super.maxFrameRate,
     super.params = RtcVideoParametersPresets.h720_16x9,
   });
 
   CameraConstraints.from({required VideoConstraints constraints})
       : facingMode = FacingMode.user,
+        mirrorMode = MirrorMode.defaultMode,
         super(
           deviceId: constraints.deviceId,
           maxFrameRate: constraints.maxFrameRate,
           params: constraints.params,
         );
 
   final FacingMode facingMode;
+  final MirrorMode mirrorMode;
 
   @override
   Map<String, dynamic> toMap() {
     final constraints = <String, dynamic>{
       ...super.toMap(),
       'facingMode': facingMode.alias,
+      'mirror': mirrorMode.name,
     };
     if (deviceId != null) {
       if (CurrentPlatform.isWeb) {
@@ -52,11 +58,13 @@ class CameraConstraints extends VideoConstraints {
     FacingMode? facingMode,
     String? deviceId,
     double? maxFrameRate,
+    MirrorMode? mirrorMode,
   }) =>
       CameraConstraints(
         params: params ?? this.params,
         facingMode: facingMode ?? this.facingMode,
         deviceId: deviceId ?? this.deviceId,
         maxFrameRate: maxFrameRate ?? this.maxFrameRate,
+        mirrorMode: mirrorMode ?? this.mirrorMode,
       );
 }

packages/stream_video/lib/src/webrtc/media/constraints/mirror_mode.dart

@@ -0,0 +1,5 @@
+enum MirrorMode {
+  on,
+  off,
+  defaultMode,
+}

packages/stream_video/lib/src/webrtc/media/media_constraints.dart

@@ -8,6 +8,7 @@ export 'audio_constraints.dart';
 export 'camera_constraints.dart';
 export 'constraints/camera_position.dart';
 export 'constraints/facing_mode.dart';
+export 'constraints/mirror_mode.dart';
 export 'screen_share_constraints.dart';
 export 'video_constraints.dart';
 

packages/stream_video_flutter/README.md

@@ -60,7 +60,7 @@ Here are some of the features we support:
 | Push notification providers support                  | ✅   | ✅       |                                                |
 | Call recording                                       | ✅   | ✅       |                                                |
 | Broadcasting to HLS                                  | ✅   | ✅       |                                                |
-| Picture in picture support                           | ❌   | ❌       | In the Roadmap, part of the next major release |
+| Picture in picture support                           | ❌   | ✅       | In the Roadmap, part of the next major release |
 
 
 ### Known Issues

packages/stream_video_flutter/lib/src/renderer/video_renderer.dart

@@ -87,7 +87,12 @@ class StreamVideoRenderer extends StatelessWidget {
     } else if (videoTrack is RtcLocalTrack<CameraConstraints>) {
       final isBackCamera =
           videoTrack.mediaConstraints.facingMode == FacingMode.environment;
-      mirror = !isBackCamera;
+
+      mirror = switch (videoTrack.mediaConstraints.mirrorMode) {
+        MirrorMode.defaultMode => mirror && !isBackCamera,
+        MirrorMode.on => true,
+        MirrorMode.off => false
+      };
     }
 
     return VideoTrackRenderer(