Function MediasfuBroadcast

MediasfuBroadcast component optimizes the media experience for broadcasting events. Only the host can share media (audio, video, no screen share support) with participants. Participants can view the host's media and chat with each other. It manages various states and references related to the media session, including user credentials, room details, participants, and recording parameters.

Component

Example

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

Description

This component handles the broadcast functionalities for MediaSFU, including joining rooms, managing participants, and handling media streams. It uses various hooks and methods to manage state and perform actions such as joining a room, updating initial values, and handling media streams.

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