Getter Methods

The HMSSDK instance provides several 'Getter' methods for obtaining the latest data of a Room, which can be used to update stale data in the app and re-render the user interface.

Let's look at the methods one by one:

getRoom

The getRoom method is used to obtain information about the room you are currently in. This method returns a promise that resolves with an HMSRoom object.

try {
  // Latest `HMSRoom` object
  const room: HMSRoom = await hmsInstance.getRoom();

  console.log('getRoom Success: ', room);
} catch(error) {
  console.log('getRoom Error: ', error);
}

getSessionMetaData

The getSessionMetaData method is used to retrieve the currently set session metadata. If no metadata has been set on the session, this method returns null.

try {
  const sessionMetadata: string | null = await hmsInstance.getSessionMetaData();

  console.log('getSessionMetaData Success: ', sessionMetadata);
} catch (error) {
  console.log('getSessionMetaData Error: ', error);
}

The setSessionMetaData method can be used to set session metadata.

getRoles

The getRoles method is used to retrieve all of the roles available in the current room. This method returns a promise that resolves with a list of HMSRole objects.

try {
  const roles: HMSRole[] = await hmsInstance.getRoles();

  console.log('getRoles Success: ', roles);
} catch (error) {
  console.log('getRoles Error: ', error);
}

getLocalPeer

The getLocalPeer method is used to retrieve the updated local peer object. This method returns a promise that resolves with a HMSLocalPeer object.

try {
  const localPeer: HMSLocalPeer = await hmsInstance.getLocalPeer();

  console.log('getLocalPeer Success: ', localPeer);
} catch (error) {
  console.log('getLocalPeer Error: ', error);
}

getRemotePeers

The getRemotePeers method is used to retrieve all of the peers present in the current room. This method returns a promise that resolves with a list of HMSRemotePeer objects.

try {
  const remotePeers: HMSRemotePeer[] = await hmsInstance.getRemotePeers();

  console.log('getRemotePeers Success: ', remotePeers);
} catch (error) {
  console.log('getRemotePeers Error: ', error);
}

isScreenShared

The isScreenShared method is used to retrieve the current 'screen sharing' status of the local peer. This method returns a promise that resolves to true if screen is being shared and false otherwise.

try {
  const screenShareStatus: boolean = await hmsInstance.isScreenShared();

  console.log('isScreenShared Success: ', screenShareStatus);
} catch (error) {
  console.log('isScreenShared Error: ', error);
}

isPipModeSupported [Android Only]

The isPipModeSupported method is used to determine if the Android device supports Picture-In-Picture mode. This method returns a promise that resolves to true if PIP mode is supported and false otherwise.

try {
  const isPIPSupported = await hmsInstance.isPipModeSupported();

  console.log('isPipModeSupported Success: ', isPIPSupported);
} catch (error) {
  console.log('isPipModeSupported Error: ', error);
}

getAudioDevicesList [Android Only]

The getAudioDevicesList method is used to retrieve a list of available audio output devices on the device. This method returns a promise that resolves with a list of HMSAudioDevice enum values.

Note that this method is only available on the Android platform.

export enum HMSAudioDevice {
  SPEAKER_PHONE = 'SPEAKER_PHONE',
  WIRED_HEADSET = 'WIRED_HEADSET',
  EARPIECE = 'EARPIECE',
  BLUETOOTH = 'BLUETOOTH',
  AUTOMATIC = 'AUTOMATIC',
}

...

try {
  const audioDevicesList: HMSAudioDevice[] = await hmsInstance.getAudioDevicesList();

  console.log('getAudioDevicesList Success: ', audioDevicesList);
} catch (error) {
  console.log('getAudioDevicesList Error: ', error);
}

getAudioOutputRouteType [Android Only]

The getAudioOutputRouteType method is used to retrieve the 'current audio output route type' on the device. This method returns a promise that resolves with HMSAudioDevice enum value.

Note that this method is only available on the Android platform.

export enum HMSAudioDevice {
  SPEAKER_PHONE = 'SPEAKER_PHONE',
  WIRED_HEADSET = 'WIRED_HEADSET',
  EARPIECE = 'EARPIECE',
  BLUETOOTH = 'BLUETOOTH',
  AUTOMATIC = 'AUTOMATIC',
}

...

try {
  const currentAudioOutputDevice: HMSAudioDevice = await hmsInstance.getAudioOutputRouteType();

  console.log('getAudioOutputRouteType Success: ', currentAudioOutputDevice);
} catch (error) {
  console.log('getAudioOutputRouteType Error: ', error);
}

isAudioShared [Android Only]

The isAudioShared method is used to retrieve the current 'audio sharing' status of the local peer. This method returns a promise that resolves to true if audio is being shared and false otherwise.

try {
  const audioShareStatus: boolean = await hmsInstance.isAudioShared();

  console.log('isAudioShared Success: ', audioShareStatus);
} catch (error) {
  console.log('isAudioShared Error: ', error);
}

getAudioMixingMode [Android Only]

The getAudioMixingMode method is used to retrieve the current 'Audio Streaming mode' of the local peer. This method returns a promise that resolves with a value of the HMSAudioMixingMode enum.

Audio Streaming mode of the local peer can be of following types:

1. HMSAudioMixingMode.TALK_ONLY: Only data captured by the microphone will be streamed in the room.
2. HMSAudioMixingMode.TALK_AND_MUSIC: Data captured by the microphone and the audio currently being played back on the device will be streamed in the room.
3. HMSAudioMixingMode.MUSIC_ONLY: Only the audio currently being played back on the device will be streamed in the room.

Note that this method is only available on the Android platform.

export enum HMSAudioMixingMode {
  TALK_ONLY = 'TALK_ONLY',
  TALK_AND_MUSIC = 'TALK_AND_MUSIC',
  MUSIC_ONLY = 'MUSIC_ONLY',
}

...

try {
  const currentAudioMixingMode: HMSAudioMixingMode = await hmsInstance.getAudioMixingMode();

  console.log('getAudioMixingMode Success: ', currentAudioMixingMode);
} catch (error) {
  console.log('getAudioMixingMode Error: ', error);
}