Class HMSConfig

Represents the configuration needed to join a room in the HMS ecosystem.

This class encapsulates all necessary details required to initiate a connection to a room, including user identification, authentication token, optional endpoint for different server connections, metadata for additional information about the connection, and a flag to capture network quality during the preview phase.

See

https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/join

Param

The configuration parameters.

Param

The username of the participant.

Param

The authentication token for room access.

Param

Optional. The endpoint URL for the connection.

Param

Optional. Additional metadata associated with the Local Peer.

Param

Optional. Flag to capture network quality in the preview phase.

Example

const config = new HMSConfig({
 username: 'username',
 authToken: 'authToken',
 metadata: 'metadata',
 captureNetworkQualityInPreview: true,
});
Copy