hms_room_kit library

This file contains the exports for the hms_room_kit package

Classes

AppDebugConfig

The AppDebugConfig class contains the debug configuration for the UI

AudioModeSelectDialog

The AudioModeSelectDialog is a dialog that allows the user to select the current audio output route

AudioModeSelectDialogState

The state of the AudioModeSelectDialog

Constant

This class contains the constants used throughout the application

HMSIOSScreenshareConfig

100ms HMSIOSScreenshareConfig

HMSPrebuilt

HMSPrebuilt is the main widget that is used to render the prebuilt It takes following parameters: roomCode - The room code of the room to join options - The options for the prebuilt for more details check the HMSPrebuiltOptions class

HMSPrebuiltOptions

HMSPrebuiltOptions is a class that is used to pass the options to the prebuilt It takes following parameters: userName - The name of the user userId - The id of the user endPoints - The token and init endpoints debugInfo - To enable the debug mode for the prebuilt iOSScreenshareConfig - Screen share Config, to enable screen share for iOS enableNoiseCancellation - To enable noise cancellation in prebuilt

HMSSubtitleText

HMSSubtitleText returns a text widget with the default theme The paramters and their default values are as follows: text - The text to be displayed, this is a required parameter textColor - The color of the text, this is a required parameter letterSpacing - The spacing between the letters, default value is 0.4 lineHeight - The height of the line, default value is 16 fontSize - The size of the font, default value is 14 fontWeight - The weight of the font, default value is FontWeight.w400 textOverflow - The overflow of the text, default value is TextOverflow.ellipsis textAlign - The alignment of the text, default value is TextAlign.left

HMSTextStyle

HMSTextStyle returns a text style TextStyle is returned on the basis of the font family selected on the prebuilt dashboard If no font family is selected, then the default font family returned is Inter It takes following parameters: fontSize - The size of the font color - The color of the text fontWeight - The weight of the font fontStyle - The style of the font letterSpacing - The spacing between the letters height - The height of the line

HMSThemeColors

The HMSThemeColors class contains the color constants used in the UI

HMSTitleText

HMSTitleText is a widget that is used to render the title text It takes following parameters: text is the text to be rendered, this is a required parameter textColor is the color of the text, this is a required parameter letterSpacing is the spacing between the letters, default value is 0.5 lineHeight is the height of the line, default value is 24 fontSize is the size of the font, default value is 16 fontWeight is the weight of the font, default value is FontWeight.w600 textOverflow is the overflow of the text, default value is TextOverflow.ellipsis maxLines are the max number of lines that HMSTitleText will render after that it will overflow

Utilities

This class contains the utility functions used in the app

Enums

HMSAudioMode

Audio mode for the local user.

Extensions

HMSAudioModeValues on HMSAudioMode

Extension for HMSAudioMode enum

Properties

avatarColors ↔ List<Color>

This list contains colors for the avatar A random color gets picked based on the first alphabet of the name

getter/setter pair

borderColor ↔ Color

borderColor is the color of the border of the app

getter/setter pair

defaultAvatarColor ↔ Color

defaultAvatarColor is the color of the default avatar

getter/setter pair

dialogcontentColor ↔ Color

dialogcontentColor is the color of the content of the dialog

getter/setter pair

dividerColor ↔ Color

dividerColor is the color of the divider

getter/setter pair

enabledTextColor ↔ Color

enabledTextColor is the color of the enabled text

getter/setter pair

errorColor ↔ Color

themeButtonColor is the color of the button

getter/setter pair

hmsdefaultColor ↔ Color

hmsdefaultColor is the default color of the app

getter/setter pair

hmsHintColor ↔ Color

hmsHintColor is the color of the hint text

getter/setter pair

hmsWhiteColor ↔ Color

hmsWhiteColor is the color of the white text

getter/setter pair

iconColor ↔ Color

iconColor should be set to white when the theme is dark and black when the theme is light By default it is set to white since the default theme is dark.

getter/setter pair

moreSettingsButtonColor ↔ Color

moreSettingsButtonColor is the color of the more settings button

getter/setter pair

popupButtonBorderColor ↔ Color

popupButtonBorderColor is the color of the border of the popup button

getter/setter pair

themeBottomSheetColor ↔ Color

themeBottomSheetColor is the color of the bottom sheet

getter/setter pair

themeDefaultColor ↔ Color

themeDefaultColor is the default color of the app

getter/setter pair

themeDisabledTextColor ↔ Color

themeDisabledTextColor is the color of the disabled text

getter/setter pair

themeHintColor ↔ Color

themeHintColor is the color of the hint text

getter/setter pair

themeHMSBorderColor ↔ Color

themeHMSBorderColor is the color of the border of the app

getter/setter pair

themeScreenBackgroundColor ↔ Color

themeScreenBackgroundColor is the color of the background of the app

getter/setter pair

themeSubHeadingColor ↔ Color

themeSubHeadingColor is the color of the subheading

getter/setter pair

themeSurfaceColor ↔ Color

themeSurfaceColor is the color of the surface of the app

getter/setter pair

themeTileNameColor ↔ Color

themeTileNameColor is the color of the name of the tile

getter/setter pair

Functions

updateColor(ThemeMode mode) → void

updateColor is used to update the colors of the app based on the theme mode is the current theme mode