Released hms_room_kit 0.0.5 version

packages/hms_room_kit/lib/src/enums/meeting_mode.dart

@@ -1,2 +1,2 @@
-//enum to set the meeting flow
+///enum to set the meeting flow
 enum MeetingMode { single, hero, grid, audio, activeSpeaker, oneToOne }

packages/hms_room_kit/lib/src/enums/session_store_keys.dart

@@ -1,6 +1,6 @@
-//Enum to store the session metadata keys
-// PINNED_MESSAGE_SESSION_KEY: for pinning messages
-// SPOTLIGHT: for adding spotlight feature in application
+///Enum to store the session metadata keys
+/// PINNED_MESSAGE_SESSION_KEY: for pinning messages
+/// SPOTLIGHT: for adding spotlight feature in application
 enum SessionStoreKey { pinnedMessageSessionKey, spotlight, unknown }
 
 extension SessionStoreKeyValues on SessionStoreKey {

packages/hms_room_kit/lib/src/hls_viewer/hls_chat.dart

@@ -16,6 +16,7 @@ import 'package:tuple/tuple.dart';
 import 'package:hmssdk_flutter/hmssdk_flutter.dart';
 import 'package:url_launcher/url_launcher.dart';
 
+///[HLSChat] is a widget that displays the chat messages while in HLS Viewer mode
 class HLSChat extends StatefulWidget {
   const HLSChat({super.key});
 

packages/hms_room_kit/lib/src/hls_viewer/hls_player.dart

@@ -1,11 +1,15 @@
+///Package imports
 import 'package:flutter/material.dart';
 import 'package:hmssdk_flutter/hmssdk_flutter.dart';
-import 'package:hms_room_kit/src/hls_viewer/hls_stats_view.dart';
-import 'package:hms_room_kit/src/meeting/meeting_store.dart';
 import 'package:provider/provider.dart';
 
 //Project imports
+import 'package:hms_room_kit/src/hls_viewer/hls_stats_view.dart';
+import 'package:hms_room_kit/src/meeting/meeting_store.dart';
 
+///This widget is used to show the HLS Player
+///It uses the [HMSHLSPlayer] widget from the [hmssdk_flutter] package
+///It also uses the [HLSStatsView] widget to show the stats of the HLS Player
 class HLSPlayer extends StatelessWidget {
   final double? ratio;
   const HLSPlayer({Key? key, this.ratio}) : super(key: key);

packages/hms_room_kit/lib/src/hls_viewer/hls_player_store.dart

@@ -3,6 +3,10 @@ import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:hmssdk_flutter/hmssdk_flutter.dart';
 
+/// HLSPayerStore is a [ChangeNotifier] class which stores the state of the HLSPlayer
+/// and notifies the listeners when the state changes
+///
+/// This class is used to control the state of the HLSPlayer
 class HLSPlayerStore extends ChangeNotifier {
   ///This variable stores whether the application is in full screen or not
   bool isFullScreen = false;

packages/hms_room_kit/lib/src/hls_viewer/hls_stats_view.dart

@@ -4,6 +4,10 @@ import 'package:hms_room_kit/src/common/app_color.dart';
 import 'package:hms_room_kit/src/meeting/meeting_store.dart';
 import 'package:provider/provider.dart';
 
+///This widget shows the HLS stats of the HLS Stream
+///It uses the [MeetingStore] to get the stats
+///
+///It is used in the [HLSPlayer] widget to show the stats when the user enables the HLS Stats
 class HLSStatsView extends StatelessWidget {
   const HLSStatsView({super.key});
 

packages/hms_room_kit/lib/src/hls_viewer/hls_viewer_page.dart

@@ -18,6 +18,8 @@ import 'package:intl/intl.dart';
 import 'package:provider/provider.dart';
 import 'package:tuple/tuple.dart';
 
+/// This is the page that is shown when the user is viewing the HLS stream
+/// It contains the HLS player and the chat
 class HLSViewerPage extends StatefulWidget {
   const HLSViewerPage({
     Key? key,

packages/hms_room_kit/lib/src/hls_viewer/hls_waiting_ui.dart

@@ -4,6 +4,7 @@ import 'package:hms_room_kit/src/common/app_color.dart';
 import 'package:hms_room_kit/src/widgets/common_widgets/hms_subheading_text.dart';
 import 'package:hms_room_kit/src/widgets/common_widgets/hms_title_text.dart';
 
+///This widget is shown when the HLS Stream hasn't started yet
 class HLSWaitingUI extends StatelessWidget {
   const HLSWaitingUI({super.key});
 

packages/hms_room_kit/lib/src/hms_prebuilt.dart

@@ -2,6 +2,10 @@ import 'package:flutter/widgets.dart';
 import 'package:hms_room_kit/hms_room_kit.dart';
 import 'package:hms_room_kit/src/screen_controller.dart';
 
+/// [HMSPrebuilt] is a widget that contains the prebuilt
+/// - [roomCode] is the room code of the room to join
+/// - [options] is the options for the prebuilt
+/// For more details checkout the [HMSPrebuiltOptions] class
 class HMSPrebuilt extends StatelessWidget {
   ///The room code of the room to join
   final String roomCode;

packages/hms_room_kit/lib/src/hms_prebuilt_options.dart

@@ -1,5 +1,12 @@
 import 'package:hms_room_kit/hms_room_kit.dart';
 
+/// [HMSPrebuiltOptions] is a class that contains the options for the prebuilt
+/// - [userName] is the name of the user
+/// - [userId] is the id of the user
+/// - [endPoints] is the token and init endpoints
+/// - [debugInfo] is to enable the debug mode for the prebuilt
+/// - [iOSScreenshareConfig] is the screen share config, to enable screen share for iOS
+/// If you wish to enable screen share for iOS, you need to pass this config
 class HMSPrebuiltOptions {
   //The name of the user
   final String? userName;

packages/hms_room_kit/lib/src/hmssdk_interactor.dart

@@ -6,6 +6,8 @@ import 'dart:io';
 import 'package:hmssdk_flutter/hmssdk_flutter.dart';
 import 'package:hms_room_kit/src/common/utility_functions.dart';
 
+/// [HMSSDKInteractor] is a class that contains the methods to interact with the SDK.
+/// It is used to interact with the SDK.
 class HMSSDKInteractor {
   /// [hmsSDK] is the instance of the HMSSDK class which is used to interact with the SDK.
   late HMSSDK hmsSDK;

packages/hms_room_kit/lib/src/meeting/meeting_page.dart

@@ -30,6 +30,14 @@ import 'package:hms_room_kit/src/meeting/pip_view.dart';
 import 'package:provider/provider.dart';
 import 'package:tuple/tuple.dart';
 
+/// This is the main meeting page which is shown when the user joins a meeting
+/// It contains the main meeting UI and the meeting controls
+///
+/// The meeting UI is divided into 4 modes:
+/// 1. [FullScreenMode] - This is the default mode when the user joins the meeting
+/// 2. [HeroMode] - This mode is shown when the user taps on a participant's video
+/// 3. [OneToOneMode] - This mode is shown when the user taps on a participant's video in [HeroMode]
+/// 4. [AudioMode] - This mode is shown when the user taps on the audio button
 class MeetingPage extends StatefulWidget {
   final String meetingLink;
   final bool isRoomMute;

packages/hms_room_kit/lib/src/meeting/meeting_store.dart

@@ -22,6 +22,12 @@ import 'package:collection/collection.dart';
 //Project imports
 import 'package:hmssdk_flutter/hmssdk_flutter.dart';
 
+///Add comments in this class for better understanding
+///This class is responsible for storing the data related to the meeting
+///This class is also responsible for handling the events from the SDK
+///
+///This class extends ChangeNotifier so that it can notify the UI when the data changes
+///This class has WidgetsBindingObserver mixin so that it can listen to the app lifecycle events
 class MeetingStore extends ChangeNotifier
     with WidgetsBindingObserver
     implements

packages/hms_room_kit/lib/src/meeting/pip_view.dart

@@ -6,6 +6,7 @@ import 'package:hms_room_kit/src/widgets/peer_widgets/audio_level_avatar.dart';
 import 'package:provider/provider.dart';
 import 'package:tuple/tuple.dart';
 
+/// [PipView] is the widget to display the pip view of the meeting
 class PipView extends StatefulWidget {
   const PipView({super.key});
 

packages/hms_room_kit/lib/src/model/peer_track_node.dart

@@ -5,6 +5,17 @@ import 'package:flutter/foundation.dart';
 import 'package:hmssdk_flutter/hmssdk_flutter.dart';
 import 'package:hms_room_kit/src/model/rtc_stats.dart';
 
+///This class is used to store the peer and track information
+///
+///[uid] is the unique id of the peer
+///[peer] is the [HMSPeer] object of the peer
+///[track] is the [HMSVideoTrack] object of the peer
+///[isOffscreen] is used to check if the peer is onscreen or offscreen
+///[networkQuality] is the network quality of the peer
+///[stats] is the [RTCStats] object of the peer
+///[audioLevel] is the audio level of the peer
+///[pinTile] is used to check if the peer is pinned or not
+///[audioTrack] is the [HMSAudioTrack] object of the peer
 class PeerTrackNode extends ChangeNotifier {
   HMSPeer peer;
   String uid;
@@ -32,22 +43,26 @@ class PeerTrackNode extends ChangeNotifier {
     return 'PeerTrackNode{peerId: ${peer.peerId}, name: ${peer.name}, track: $track}, isVideoOn: $isOffscreen }';
   }
 
+  ///This method is used to notify the listeners
   void notify() {
     notifyListeners();
   }
 
+  ///This method is used to set whether the peer is onscreen or offscreen
   void setOffScreenStatus(bool currentState) {
     isOffscreen = currentState;
     notify();
   }
 
+  ///This method is used to set the audio level for the peer
   void setAudioLevel(int audioLevel) {
     this.audioLevel = audioLevel;
     if (!isOffscreen) {
       notify();
     }
   }
 
+  ///This method is used to set the network quality for the peer
   void setNetworkQuality(int? networkQuality) {
     if (networkQuality != null) {
       this.networkQuality = networkQuality;
@@ -57,27 +72,31 @@ class PeerTrackNode extends ChangeNotifier {
     }
   }
 
+  ///This method is used to set the audio stats for the peer
   void setHMSRemoteAudioStats(HMSRemoteAudioStats hmsRemoteAudioStats) {
     stats?.hmsRemoteAudioStats = hmsRemoteAudioStats;
     if (!isOffscreen) {
       notify();
     }
   }
 
+  ///This method is used to set the video stats for the peer
   void setHMSRemoteVideoStats(HMSRemoteVideoStats hmsRemoteVideoStats) {
     stats?.hmsRemoteVideoStats = hmsRemoteVideoStats;
     if (!isOffscreen) {
       notify();
     }
   }
 
+  ///This method is used to set the local video stats for the peer
   void setHMSLocalVideoStats(List<HMSLocalVideoStats> hmsLocalVideoStats) {
     stats?.hmsLocalVideoStats = hmsLocalVideoStats;
     if (!isOffscreen) {
       notify();
     }
   }
 
+  ///This method is used to set the local audio stats for the peer
   void setHMSLocalAudioStats(HMSLocalAudioStats hmsLocalAudioStats) {
     stats?.hmsLocalAudioStats = hmsLocalAudioStats;
     if (!isOffscreen) {

packages/hms_room_kit/lib/src/model/rtc_stats.dart

@@ -1,6 +1,10 @@
 //Project imports
 import 'package:hmssdk_flutter/hmssdk_flutter.dart';
 
+///This class contains the stats of the room
+///It contains the stats of the local peer and the remote peers
+///
+///For more details checkout the [HMSRemoteAudioStats], [HMSLocalVideoStats], [HMSRemoteVideoStats], [HMSLocalAudioStats] classes
 class RTCStats {
   HMSRemoteAudioStats? hmsRemoteAudioStats;
   List<HMSLocalVideoStats>? hmsLocalVideoStats;

packages/hms_room_kit/lib/src/preview/preview_join_button.dart

@@ -5,7 +5,7 @@ import 'package:hms_room_kit/src/preview/preview_store.dart';
 import 'package:hms_room_kit/src/service/app_debug_config.dart';
 import 'package:hms_room_kit/src/widgets/common_widgets/hms_title_text.dart';
 
-///[PreviewJoinButton] renders a button depending on the room state and 
+///[PreviewJoinButton] renders a button depending on the room state and
 ///user role
 ///If the user has permission to start the HLS Stream and stream is not already started
 ///then it renders a button with a live icon and text "Go Live" and on tap it calls join and startHLSStreaming methods

packages/hms_room_kit/lib/src/preview/preview_page.dart

@@ -23,7 +23,6 @@ import 'package:provider/provider.dart';
 ///[PreviewPage] is the screen where the user can preview it's camera, mic and audio outputs
 ///It also provides information about the room and the participants in the room
 class PreviewPage extends StatefulWidget {
-
   ///[name] is the name of the user joining the room
   final String name;
 
@@ -132,6 +131,7 @@ class _PreviewPageState extends State<PreviewPage> {
                   context: context, error: error);
             }
             return Scaffold(
+              backgroundColor: backgroundDefault,
               resizeToAvoidBottomInset: false,
               body: previewStore.isRoomJoinedAndHLSStarted
                   ? ListenableProvider.value(

packages/hms_room_kit/lib/src/preview/preview_permissions.dart

@@ -40,7 +40,8 @@ class _PreviewPermissionsState extends State<PreviewPermissions> {
   @override
   Widget build(BuildContext context) {
     Size size = MediaQuery.of(context).size;
-    return SizedBox(
+    return Container(
+      color: backgroundDefault,
       width: size.width,
       height: size.height,
       child: Stack(

packages/hms_room_kit/lib/src/screen_controller.dart

@@ -100,6 +100,7 @@ class _ScreenControllerState extends State<ScreenController> {
   @override
   Widget build(BuildContext context) {
     return Scaffold(
+      backgroundColor: backgroundDefault,
       body: isLoading
           ? Center(
               child: CircularProgressIndicator(

packages/hms_room_kit/pubspec.yaml

@@ -1,8 +1,8 @@
 name: hms_room_kit
 description: 100ms Room Kit provides simple & easy to use UI components to build Live Streaming & Video Conferencing experiences in your apps.
-version: 0.0.4
+version: 0.0.5
 homepage: https://www.100ms.live/
-repository: https://github.com/100mslive/100ms-flutter/tree/feature/prebuilt/packages/hms_room_kit
+repository: https://github.com/100mslive/100ms-flutter
 issue_tracker: https://github.com/100mslive/100ms-flutter/issues
 documentation: https://www.100ms.live/docs