Function MediasfuWebinar

MediasfuWebinar component optimized for webinars. Main focus is placed on the host with large screen area dedicated to the host. 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 webinar.

Component

Example

<MediasfuWebinar
  PrejoinPage={WelcomePage}
  credentials={{ apiUserName: 'username', apiKey: 'apikey' }}
  useLocalUIMode={false}
  seedData={{}}
  useSeed={false}
  imgSrc='https://mediasfu.com/images/logo192.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 webinar room using WebRTC and Mediasoup. It manages the state and references for various parameters required for the webinar, 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? contextTypes? defaultProps? displayName?

Properties

OptionalpropTypes

propTypes?: WeakValidationMap<MediasfuWebinarOptions>

Used to declare the types of the props accepted by the component. These types will be checked during rendering and in development only.

We recommend using TypeScript instead of checking prop types at runtime.

See

React Docs

OptionalcontextTypes

contextTypes?: ValidationMap<any>

Deprecated

Lets you specify which legacy context is consumed by this component.

See

Legacy React Docs

OptionaldefaultProps

defaultProps?: Partial<MediasfuWebinarOptions>

Used to define default values for the props accepted by the component.

See

React Docs

Example

type Props = { name?: string }

const MyComponent: FC<Props> = (props) => {
  return <div>{props.name}</div>
}

MyComponent.defaultProps = {
  name: 'John Doe'
}

Deprecated

Use values for destructuring assignments instead.

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