Function MediasfuConference

MediasfuConference component optimizes the media experience for conferences. Participants can share media (audio, video, screen share) with each other. Participants can chat with each other and engage in polls and breakout rooms, share screens, and more during the conference.

Component

Example

<MediasfuConference
  PrejoinPage={CustomPrejoinPage}
  localLink="https://localhost:3000"
  connectMediaSFU={true}
  credentials={{ apiUserName: "user", apiKey: "key" }}
  useLocalUIMode={true}
  seedData={seedData}
  useSeed={true}
  imgSrc="https://example.com/logo.png"
  sourceParameters={{ key: value }}
  updateSourceParameters={updateSourceParameters}
  returnUI={true}
  noUIPreJoinOptions={customPreJoinOptions}
  joinMediaSFURoom={joinRoomOnMediaSFU}
  createMediaSFURoom={createRoomOnMediaSFU}
/>

Description

This component handles the main logic for joining a media conference room using WebRTC and Mediasoup. It manages the state and references for various parameters required for the conference, including user credentials, room details, media settings, and recording options.

The component also provides methods for updating state to initial values, joining a room using a socket, and handling various media and room-related functionalities.

Properties

propTypes? displayName?

Properties

OptionalpropTypes

propTypes?: any

Ignored by React.

Deprecated

Only kept in types for backwards compatibility. Will be removed in a future major release.

OptionaldisplayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Example


const MyComponent: FC = () => {
  return <div>Hello!</div>
}

MyComponent.displayName = 'MyAwesomeComponent'

Settings

Member Visibility

On This Page

Properties