Function MiniAudioPlayer

MiniAudioPlayer component is a React functional component that renders an audio player and optionally a mini audio component for visualizing audio waveforms.

Component

Example

// Import and use MiniAudioPlayer in a React component
import { MiniAudioPlayer } from 'mediasfu-reactjs';

const WaveformVisualizer = ({ stream }: { stream: MediaStream }) => (
  <canvas width="300" height="50" />
);

const App = () => {
  const stream = useMediaStream(); // Custom hook to get MediaStream
  const parameters = {
    // Mocked parameters with required functions
    getUpdatedAllParams: () => updatedParameters,
    reUpdateInter: () => {},
    updateParticipantAudioDecibels: () => {},
    breakOutRoomStarted: false,
    breakOutRoomEnded: false,
    limitedBreakRoom: [],
  };

  return (
    <MiniAudioPlayer
      stream={stream}
      consumer={consumer}
      remoteProducerId="producer123"
      parameters={parameters}
      MiniAudioComponent={WaveformVisualizer}
      miniAudioProps={{ color: 'blue' }}
    />
  );
};

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