Variable MiniAudioPlayer`Const`

MiniAudioPlayer: React.FC<MiniAudioPlayerOptions> = ...

MiniAudioPlayer component is a React Native component for playing audio streams and optionally a mini audio component for visualizing audio waveforms.

Component

Param: props

The properties for the MiniAudioPlayer component.

Param: props.stream

The media stream to be played by the audio player.

Param: props.consumer

The consumer object for consuming media.

Param: props.remoteProducerId

The ID of the remote producer.

Param: props.parameters

The parameters object containing various settings and methods.

Param: props.parameters.getUpdatedAllParams

Function to get updated parameters.

Param: props.parameters.reUpdateInter

Function to re-update interaction parameters.

Param: props.parameters.updateParticipantAudioDecibels

Function to update participant audio decibels.

Param: props.parameters.breakOutRoomStarted

Flag indicating if the breakout room has started.

Param: props.parameters.breakOutRoomEnded

Flag indicating if the breakout room has ended.

Param: props.parameters.limitedBreakRoom

Array of limited breakout room participants.

Param: props.MiniAudioComponent

An optional component to render for audio visualization.

Param: props.miniAudioProps

Additional properties to pass to the MiniAudioComponent.

Returns

The rendered MiniAudioPlayer component.

Example

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

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' }}
    />
  );
};