@100mslive/react-native-room-kit/lib/module/HMSInstanceSetup.js

100ms Room Kit provides simple & easy to use UI components to build Live Streaming & Video Conferencing experiences in your apps.

import { HMSAudioTrackSettings, HMSCameraFacing, HMSIOSAudioMode, HMSLogAlarmManager, HMSLogger, HMSLogLevel, HMSLogSettings, HMSNoiseCancellationPlugin, HMSSDK, HMSTrackSettings, HMSTrackSettingsInitState, HMSVideoTrackSettings } from '@100mslive/react-native-hms';
import React, { useEffect } from 'react';
import { batch, useDispatch } from 'react-redux';
import { VideoPlugin } from './modules/videoPluginWrapper';
import { getJoinConfig } from './utils';
import { saveUserData, setHMSInstance, setNoiseCancellationPlugin, setVideoPlugin } from './redux/actions';
import { FullScreenIndicator } from './components/FullScreenIndicator';
import { clearConfig } from './hooks-util';
import { store } from './redux';
const getTrackSettings = (noiseCancellationPlugin, videoPlugin) => {
  const joinConfig = getJoinConfig();

  /**
   * Customize local peer's Audio track settings before Joining the Room.
   *
   * Checkout Track Settings docs for more details {@link https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/track/track-settings}
   */
  let audioSettings = new HMSAudioTrackSettings({
    initialState: joinConfig.mutedAudio ? HMSTrackSettingsInitState.MUTED : HMSTrackSettingsInitState.UNMUTED,
    audioSource: joinConfig.audioMixer ? ['mic_node', 'screen_broadcast_audio_receiver_node'] : undefined,
    /**
     * `audioMode` param allows you to capture audio in its highest quality
     * by disabling voice processing and increasing the maximum bandwidth limit
     *
     * Checkout Music Mode docs for more details {@link https://www.100ms.live/docs/react-native/v2/how-to-guides/configure-your-device/microphone/music-mode}
     */
    audioMode: joinConfig.musicMode ? HMSIOSAudioMode.MUSIC : undefined,
    /**
     * The noise cancellation plugin to use for the audio track.
     * @type {HMSNoiseCancellationPlugin}
     *
     * Checkout Music Mode docs for more details {@link https://www.100ms.live/docs/ios/v2/how-to-guides/extend-capabilities/plugins/noise-cancellation}
     */
    noiseCancellationPlugin
  });

  /**
   * Customize local peer's Video track settings before Joining the Room.
   *
   * Checkout Track Settings docs for more details {@link https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/track/track-settings}
   */
  let videoSettings = new HMSVideoTrackSettings({
    initialState: joinConfig.mutedVideo ? HMSTrackSettingsInitState.MUTED : HMSTrackSettingsInitState.UNMUTED,
    cameraFacing: HMSCameraFacing.FRONT,
    disableAutoResize: joinConfig.autoResize,
    forceSoftwareDecoder: joinConfig.softwareDecoder,
    videoPlugin: videoPlugin || undefined
  });
  return new HMSTrackSettings({
    video: videoSettings,
    audio: audioSettings
  });
};
const getLogSettings = () => {
  return new HMSLogSettings({
    level: HMSLogLevel.VERBOSE,
    isLogStorageEnabled: true,
    maxDirSizeInBytes: HMSLogAlarmManager.DEFAULT_DIR_SIZE
  });
};
const getIOSBuildConfig = () => store.getState().user.iosBuildConfig || {};

/**
 * Regular Usage:
 * const hmsInstance = await HMSSDK.build();
 * @returns
 */
const getHmsInstance = async (noiseCancellationPlugin, videoPlugin) => {
  /**
   * Only required for advanced use-case features like iOS Screen/Audio Share, Android Software Echo Cancellation, etc
   * NOT required for any other features.
   * @link https://www.100ms.live/docs/react-native/v2/advanced-features/track-settings
   */
  const trackSettings = getTrackSettings(noiseCancellationPlugin, videoPlugin);

  /**
   * Regular Usage:
   * const hmsInstance = await HMSSDK.build();
   *
   *
   * Advanced Usage Example:
   * @param {trackSettings} trackSettings is an optional value only required to enable features like iOS Screen/Audio Share, Android Software Echo Cancellation, etc
   *
   * @param {appGroup} appGroup is an optional value only required for implementing Screen & Audio Share on iOS. They are not required for Android. DO NOT USE if your app does not implements Screen or Audio Share on iOS.
   *
   * @param {preferredExtension} preferredExtension is an optional value only required for implementing Screen & Audio Share on iOS. They are not required for Android. DO NOT USE if your app does not implements Screen or Audio Share on iOS.
   *
   *
   * const trackSettings = getTrackSettings();
   * const hmsInstance = await HMSSDK.build({
   *  trackSettings,
   *  appGroup: 'group.reactnativehms', // required for iOS Screenshare, not required for Android
   *  preferredExtension: 'RNHMSExampleBroadcastUpload', // required for iOS Screenshare, not required for Android
   * });
   */

  const logSettings = getLogSettings();
  const {
    appGroup,
    preferredExtension
  } = getIOSBuildConfig();
  const hmsInstance = await HMSSDK.build({
    logSettings,
    trackSettings,
    haltPreviewJoinForPermissionsRequestOnAndroid: true,
    appGroup,
    preferredExtension,
    isPrebuilt: true
  });
  const logger = new HMSLogger();
  logger.updateLogLevel(HMSLogLevel.VERBOSE, true);
  hmsInstance.setLogger(logger);
  return hmsInstance;
};
export const HMSInstanceSetup = () => {
  const dispatch = useDispatch();
  useEffect(() => {
    let ignore = false;
    const setupHMSInstance = async () => {
      clearConfig();
      const noiseCancellationPlugin = new HMSNoiseCancellationPlugin();
      const videoPlugin = VideoPlugin ? new VideoPlugin.HMSVirtualBackgroundPlugin() : null;
      getHmsInstance(noiseCancellationPlugin, videoPlugin).then(hmssdkInstance => {
        if (!ignore) {
          // If this component is mounted
          // save instance in store
          batch(() => {
            dispatch(setHMSInstance(hmssdkInstance));
            dispatch(setNoiseCancellationPlugin(noiseCancellationPlugin));
            if (videoPlugin) {
              dispatch(setVideoPlugin(videoPlugin));
            }
            // TODO: remove this from user reducer
            dispatch(saveUserData({
              hmsInstance: hmssdkInstance
            }));
          });
        } else {
          // If this component is not mounted when this response is received
          // that means Root componnet is unmounted, we can destroy instance safely
          hmssdkInstance.leave().finally(() => hmssdkInstance.destroy());
        }
      }).catch(error => {
        // TODO: Handle this gracefully, inform library user about this
        console.warn('Get HMS Instance Error: ', error);
      });
    };
    setupHMSInstance();
    return () => {
      ignore = true;
    };
  }, []);
  return /*#__PURE__*/React.createElement(FullScreenIndicator, null);
};
//# sourceMappingURL=HMSInstanceSetup.js.map