Function joinRoomOnMediaSFU

Asynchronously joins a room on MediaSFU.

This function sends a POST request to the MediaSFU API to join an existing room. It validates the provided credentials and constructs the appropriate API endpoint, including support for the Community Edition via a custom localLink.

Throws

Throws an error if the request fails or if the provided credentials are invalid.

Example

const response = await joinRoomOnMediaSFU({
  payload: {
    action: 'join',
    meetingID: '123456',
    userName: 'user123',
  },
  apiUserName: 'yourAPIUSERNAME',
  apiKey: 'yourAPIKEY',
  localLink: 'http://localhost:3000', // Optional for Community Edition
});

if (response.success) {
  console.log('Joined room:', response.data);
} else {
  console.error('Failed to join room:', response.data?.error);
}

joinRoomOnMediaSFU(options): Promise<{
data: null | CreateJoinRoomResponse | CreateJoinRoomError;
success: boolean;
}>
Parameters
- options: {
      payload: CreateMediaSFURoomOptions | JoinMediaSFURoomOptions;
      apiUserName: string;
      apiKey: string;
      localLink?: string;
  }
  Configuration options for joining the room.
  - payload: CreateMediaSFURoomOptions | JoinMediaSFURoomOptions
    The payload containing the room details and action (join or create).
  - apiUserName: string
    The API username, used for authentication.
  - apiKey: string
    The API key, used for authentication.
  - OptionallocalLink?: string
    The local link for Community Edition users. If provided, it overrides the default API URL.
Returns Promise<{
data: null | CreateJoinRoomResponse | CreateJoinRoomError;
success: boolean;
}>
A promise resolving to an object containing the API response:
- data: The response object, either CreateJoinRoomResponse or CreateJoinRoomError.
- success: Boolean indicating whether the operation was successful.
- Defined in src/methods/utils/joinRoomOnMediaSFU.ts:97

Function joinRoomOnMediaSFU

Throws

Example

Parameters

payload: CreateMediaSFURoomOptions | JoinMediaSFURoomOptions

apiUserName: string

apiKey: string

`Optional`localLink?: string

Returns Promise<{
data: null | CreateJoinRoomResponse | CreateJoinRoomError;
success: boolean;
}>

Settings

Function joinRoomOnMediaSFU

Throws

Example

Parameters

payload: CreateMediaSFURoomOptions | JoinMediaSFURoomOptions

apiUserName: string

apiKey: string

OptionallocalLink?: string

Returns Promise<{ data: null | CreateJoinRoomResponse | CreateJoinRoomError; success: boolean; }>

Settings

`Optional`localLink?: string

Returns Promise<{
data: null | CreateJoinRoomResponse | CreateJoinRoomError;
success: boolean;
}>