@100mslive/react-native-hms 0.9.9 → 0.9.91

package/lib/typescript/classes/HMSSDK.d.ts

@@ -14,6 +14,9 @@ import type { HMSVideoViewMode } from './HMSVideoViewMode';
 import type { HMSTrackSettings } from './HMSTrackSettings';
 import type { HMSRTMPConfig } from './HMSRTMPConfig';
 import type { HMSHLSConfig } from './HMSHLSConfig';
+import type { HMSAudioDevice } from './HMSAudioDevice';
+import type { HMSAudioMode } from './HMSAudioMode';
+import type { HMSAudioMixingMode } from './HMSAudioMixingMode';
 interface HmsViewProps {
     trackId: string;
     style?: ViewStyle;
@@ -47,6 +50,7 @@ export declare class HMSSDK {
     onLocalVideoStatsDelegate?: any;
     onRemoteAudioStatsDelegate?: any;
     onRemoteVideoStatsDelegate?: any;
+    onAudioDeviceChangedDelegate?: any;
     constructor(id: string);
     /**
      * - Returns an instance of [HMSSDK]{@link HMSSDK}
@@ -129,13 +133,14 @@ export declare class HMSSDK {
      */
     previewForRole: (role: HMSRole) => Promise<any>;
     /**
-     * - HmsView is react component that takes one track and starts showing that track on a tile.
+     * - HmsView is react component that takes trackId and starts showing that track on a tile.
      * - The appearance of tile is completely customizable with style prop.
-     * - scale type can determine how the incoming video will fit in the canvas check {@link HMSVideoViewMode} for more information.
+     * - Scale type can determine how the incoming video will fit in the canvas check {@link HMSVideoViewMode} for more information.
+     * - Mirror to flip the video vertically.
      *
      * checkout {@link https://www.100ms.live/docs/react-native/v2/features/render-video} for more info
      *
-     * @param {HmsComponentProps}
+     * @param {HmsViewProps}
      * @memberof HMSSDK
      */
     HmsView: React.ForwardRefExoticComponent<HmsViewProps & React.RefAttributes<any>>;
@@ -215,7 +220,7 @@ export declare class HMSSDK {
      * @param {HMSHLSConfig}
      * @memberof HMSSDK
      */
-    startHLSStreaming: (data: HMSHLSConfig) => Promise<any>;
+    startHLSStreaming: (data?: HMSHLSConfig) => Promise<any>;
     /**
      * - stopHLSStreaming function stops the ongoing HLSStreams.
      * - we get the response of this function in onRoomUpdate as HLS_STREAMING_STATE_UPDATED.
@@ -242,7 +247,7 @@ export declare class HMSSDK {
     changeRole: (peer: HMSPeer, role: HMSRole, force?: boolean) => Promise<any>;
     /**
      * - This function can be used to manipulate mute status of any track.
-     * - Targeted peer affected by this action will get a callback in {@link onChangeTrackStateRequestListener}.
+     * - Targeted peer affected by this action will get a callback in onChangeTrackStateRequestListener.
      *
      * * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-track-state} for more info
      *
@@ -254,7 +259,7 @@ export declare class HMSSDK {
      * - changeTrackStateForRoles is an enhancement on the functionality of {@link changeTrackState}.
      * - We can change mute status for all the tracks of peers having a particular role.
      * - @param source determines the source of the track ex. video, audio etc.
-     * - The peers affected by this action will get a callback in {@link onChangeTrackStateRequestListener}.
+     * - The peers affected by this action will get a callback in onChangeTrackStateRequestListener.
      *
      * @memberof HMSSDK
      */
@@ -295,7 +300,7 @@ export declare class HMSSDK {
      */
     acceptRoleChange: () => Promise<any>;
     /**
-     * - setPlaybackForAllAudio is an extension of the abilities of {@link setPlaybackAllowed} in
+     * - setPlaybackForAllAudio is an extension of the abilities of setPlaybackAllowed in
      * {@link HMSRemoteAudioTrack}, it sets mute status for all peers in the room
      *
      * checkout {@link https://www.100ms.live/docs/react-native/v2/features/playback-allowed} for more info
@@ -382,6 +387,94 @@ export declare class HMSSDK {
      * @memberof HMSSDK
      */
     disableRTCStats: () => void;
+    /**
+     * - This wrapper function is used to start streaming device audio, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-stream-device-audio-from-the-app} for more info.
+     *
+     * @param {HMSAudioMixingMode}
+     * @memberof HMSSDK
+     */
+    startAudioshare: (audioMixingMode: HMSAudioMixingMode) => Promise<any>;
+    /**
+     * - This wrapper function returns true if audio is being shared and vice versa, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-get-audio-share-status} for more info.
+     *
+     * @memberof HMSSDK
+     */
+    isAudioShared: () => Promise<any>;
+    /**
+     * - This wrapper function is used to stop streaming device audio, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-stop-audio-sharing} for more info.
+     *
+     * @memberof HMSSDK
+     */
+    stopAudioshare: () => Promise<any>;
+    /**
+     * - This wrapper function returns the current audio mixing mode, currently available only for android.
+     *
+     * @memberof HMSSDK
+     * @return HMSAudioMixingMode
+     */
+    getAudioMixingMode: () => Promise<any>;
+    /**
+     * - This wrapper function used to change the mode while the user is streaming audio, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-change-mode} for more info
+     *
+     * @param {HMSAudioMixingMode}
+     * @memberof HMSSDK
+     */
+    setAudioMixingMode: (audioMixingMode: HMSAudioMixingMode) => Promise<any>;
+    /**
+     * - This wrapper function returns the array of audio output devices which is of
+     * type {@link HMSAudioDevice[]}, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#get-list-of-audio-device} for more info
+     *
+     * @memberof HMSSDK
+     * @return HMSAudioDevice[]
+     */
+    getAudioDevicesList: () => Promise<any>;
+    /**
+     * - This wrapper function returns the current audio output device which is of
+     * type {@link HMSAudioDevice}, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#get-current-focussed-device} for more info
+     *
+     * @memberof HMSSDK
+     * @return HMSAudioDevice
+     */
+    getAudioOutputRouteType: () => Promise<any>;
+    /**
+     * - This wrapper function used to switch output to device other than the default, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#switch-audio-focus-to-another-device} for more info
+     *
+     * @param {HMSAudioDevice}
+     * @memberof HMSSDK
+     */
+    switchAudioOutput: (audioDevice: HMSAudioDevice) => any;
+    /**
+     * - This wrapper function used to change Audio Mode manually, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-mode-change} for more info
+     *
+     * @param {HMSAudioMode}
+     * @memberof HMSSDK
+     */
+    setAudioMode: (audioMode: HMSAudioMode) => any;
+    /**
+     * - This is a wrapper function which adds a listener which is triggered when audio output device is switched, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#adding-a-listener} for more info
+     *
+     * @param {Function}
+     * @memberof HMSSDK
+     */
+    setAudioDeviceChangeListener: (callback: Function) => any;
     /**
      * - This is a prototype event listener that takes action and listens for updates related to that particular action
      *
@@ -436,5 +529,10 @@ export declare class HMSSDK {
     onLocalVideoStatsListener: (data: any) => void;
     onRemoteAudioStatsListener: (data: any) => void;
     onRemoteVideoStatsListener: (data: any) => void;
+    onAudioDeviceChangedListener: (data: {
+        id: string;
+        device: string;
+        audioDevicesList: string[];
+    }) => void;
 }
 export {};

package/lib/typescript/classes/HMSUpdateListenerActions.d.ts

@@ -16,5 +16,6 @@ export declare enum HMSUpdateListenerActions {
     ON_LOCAL_AUDIO_STATS = "ON_LOCAL_AUDIO_STATS",
     ON_LOCAL_VIDEO_STATS = "ON_LOCAL_VIDEO_STATS",
     ON_REMOTE_AUDIO_STATS = "ON_REMOTE_AUDIO_STATS",
-    ON_REMOTE_VIDEO_STATS = "ON_REMOTE_VIDEO_STATS"
+    ON_REMOTE_VIDEO_STATS = "ON_REMOTE_VIDEO_STATS",
+    ON_AUDIO_DEVICE_CHANGED = "ON_AUDIO_DEVICE_CHANGED"
 }

package/lib/typescript/index.d.ts

@@ -62,5 +62,8 @@ export * from './classes/HMSMessageRecipient';
 export * from './classes/HMSMessageRecipientType';
 export * from './classes/HMSNetworkQuality';
 export * from './classes/HMSRtmpVideoResolution';
+export * from './classes/HMSAudioDevice';
+export * from './classes/HMSAudioMode';
+export * from './classes/HMSAudioMixingMode';
 import { HMSSDK as HmsManager } from './classes/HMSSDK';
 export default HmsManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@100mslive/react-native-hms",
-  "version": "0.9.9",
+  "version": "0.9.91",
   "description": "The React Native package for 100ms SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/react-native-hms.podspec

@@ -16,5 +16,5 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
   s.dependency "React-Core"
-  s.dependency "HMSSDK", "0.3.2"
+  s.dependency "HMSSDK", "0.3.3"
 end

package/src/classes/HMSAudioDevice.ts

@@ -0,0 +1,7 @@
+export enum HMSAudioDevice {
+  SPEAKER_PHONE = 'SPEAKER_PHONE',
+  WIRED_HEADSET = 'WIRED_HEADSET',
+  EARPIECE = 'EARPIECE',
+  BLUETOOTH = 'BLUETOOTH',
+  AUTOMATIC = 'AUTOMATIC',
+}

package/src/classes/HMSAudioMixingMode.ts

@@ -0,0 +1,5 @@
+export enum HMSAudioMixingMode {
+  TALK_ONLY = 'TALK_ONLY',
+  TALK_AND_MUSIC = 'TALK_AND_MUSIC',
+  MUSIC_ONLY = 'MUSIC_ONLY',
+}

package/src/classes/HMSAudioMode.ts

@@ -0,0 +1,7 @@
+export enum HMSAudioMode {
+  MODE_NORMAL = 0,
+  MODE_RINGTONE = 1,
+  MODE_IN_CALL = 2,
+  MODE_IN_COMMUNICATION = 3,
+  MODE_CALL_SCREENING = 4,
+}

package/src/classes/HMSEncoder.ts

@@ -27,6 +27,7 @@ import { HMSRtmpStreamingState } from './HMSRtmpStreamingState';
 import { HMSServerRecordingState } from './HMSServerRecordingState';
 import { HMSMessage } from './HMSMessage';
 import { HMSMessageRecipient } from './HMSMessageRecipient';
+import { HMSException } from './HMSException';
 
 export class HMSEncoder {
   static encodeHmsRoom(room: HMSRoom, id: string) {
@@ -497,4 +498,15 @@ export class HMSEncoder {
       recipientRoles: this.encodeHmsRoles(data?.recipientRoles),
     });
   }
+
+  static encodeHMSException(data: any) {
+    return new HMSException({
+      code: data?.error?.code,
+      description: data?.error?.description,
+      message: data?.error?.message,
+      name: data?.error?.name,
+      action: data?.error?.action,
+      isTerminal: data?.error?.isTerminal,
+    });
+  }
 }

package/src/classes/HMSException.ts

@@ -1,33 +1,24 @@
 export class HMSException {
-  public error: {
+  code: number;
+  description: string;
+  message: string;
+  name: string;
+  action: string;
+  isTerminal: boolean;
+
+  constructor(params: {
     code: number;
     description: string;
-    localizedDescription: string;
     message: string;
     name: string;
     action: string;
-  };
-  public event: string;
-
-  constructor(params: {
-    error: {
-      code: number;
-      description: string;
-      localizedDescription: string;
-      message: string;
-      name: string;
-      action: string;
-    };
-    event: string;
+    isTerminal: boolean;
   }) {
-    this.error = {
-      code: params.error.code,
-      description: params.error.description,
-      localizedDescription: params.error.localizedDescription,
-      message: params.error.message,
-      name: params.error.name,
-      action: params.error.action,
-    };
-    this.event = params.event;
+    this.code = params.code;
+    this.description = params.description;
+    this.message = params.message;
+    this.name = params.name;
+    this.action = params.action;
+    this.isTerminal = params.isTerminal;
   }
 }

package/src/classes/HMSHLSConfig.ts

@@ -3,11 +3,11 @@ import type { HMSHLSRecordingConfig } from './HMSHLSRecordingConfig';
 
 export class HMSHLSConfig {
   hlsRecordingConfig?: HMSHLSRecordingConfig;
-  meetingURLVariants: Array<HMSHLSMeetingURLVariant>;
+  meetingURLVariants?: Array<HMSHLSMeetingURLVariant>;
 
   constructor(params: {
     hlsRecordingConfig?: HMSHLSRecordingConfig;
-    meetingURLVariants: Array<HMSHLSMeetingURLVariant>;
+    meetingURLVariants?: Array<HMSHLSMeetingURLVariant>;
   }) {
     this.hlsRecordingConfig = params.hlsRecordingConfig;
     this.meetingURLVariants = params.meetingURLVariants;

package/src/classes/HMSPermissions.ts

@@ -4,8 +4,9 @@ export class HMSPermissions {
   unmute?: boolean;
   mute?: boolean;
   changeRole?: boolean;
-  recording?: boolean;
-  streaming?: boolean;
+  browserRecording?: boolean;
+  hlsStreaming?: boolean;
+  rtmpStreaming?: boolean;
 
   constructor(params?: {
     endRoom?: boolean;
@@ -13,8 +14,9 @@ export class HMSPermissions {
     unmute?: boolean;
     mute?: boolean;
     changeRole?: boolean;
-    recording?: boolean;
-    streaming?: boolean;
+    browserRecording?: boolean;
+    hlsStreaming?: boolean;
+    rtmpStreaming?: boolean;
   }) {
     if (params) {
       this.endRoom = params.endRoom;
@@ -22,8 +24,9 @@ export class HMSPermissions {
       this.unmute = params.unmute;
       this.mute = params.mute;
       this.changeRole = params.changeRole;
-      this.recording = params.recording;
-      this.streaming = params.streaming;
+      this.browserRecording = params.browserRecording;
+      this.hlsStreaming = params.hlsStreaming;
+      this.rtmpStreaming = params.rtmpStreaming;
     }
   }
 }