HMSSDK constructor

HMSSDK({
  1. HMSTrackSetting? hmsTrackSetting,
  2. HMSIOSScreenshareConfig? iOSScreenshareConfig,
  3. HMSLogSettings? hmsLogSettings,
  4. @Deprecated("Use iOSScreenshareConfig") String? appGroup,
  5. @Deprecated("Use iOSScreenshareConfig") String? preferredExtension,
  6. bool isPrebuilt = false,
})

The public interface of 100ms SDK. Create an instance of HMSSDK to start using the SDK.

Parameters:

hmsTrackSetting - To modify local peer's audio & video tracks settings. Only required for advanced use cases. Refer hmsTrackSetting guide here

iOSScreenshareConfig - It is required for starting Screen share (broadcast screen) in iOS. Refer iOS Screen share guide here

hmsLogSettings - It is used to set the Log Level setting. Refer hmsLogSettings guide here

appGroupDeprecated - It is required for starting Screen share (broadcast screen) in iOS. Refer iOS Screen share guide here

preferredExtensionDeprecated - It is required for starting Screen share (broadcast screen) in iOS. Refer iOS Screen share guide here

Note: [appGroup] and [preferredExtension] are deprecated use iOSScreenshareConfig instead.

Key Concepts

Room - A room represents real-time audio, and video sessions, the basic building block of the 100mslive Video SDK

Track - A track represents either the audio or video that makes up a stream

Peer - A peer represents all participants connected to a room. Peers can be "local" or "remote"

Broadcast - A local peer can send any message/data to all remote peers in the room

HMSSDK has other methods which the client app can use to get more info about the Room, Peer and Tracks

Refer HMSSDK quick start guide available here

Implementation

HMSSDK(
    {this.hmsTrackSetting,
    this.iOSScreenshareConfig,
    this.hmsLogSettings,
    @Deprecated("Use iOSScreenshareConfig") this.appGroup,
    @Deprecated("Use iOSScreenshareConfig") this.preferredExtension,
    this.isPrebuilt = false});