Hiyve Components - v1.0.0
    Preparing search index...

    Interface AudioLevelMonitorProps

    Props for the AudioLevelMonitor component.

    The AudioLevelMonitor visualizes real-time audio levels from a MediaStream. It supports three visualization modes (bars, waveform, meter) and configurable colors and styles for customization.

    <AudioLevelMonitor
      stream={audioStream}
      mode="bars"
      barCount={24}
      width={300}
      height={60}
      showPeak
    />
    interface AudioLevelMonitorProps {
        barCount?: number;
        colors?: Partial<AudioLevelMonitorColors>;
        height?: string | number;
        mode?: "meter" | "bars" | "waveform";
        onError?: (error: Error) => void;
        orientation?: "horizontal" | "vertical";
        showPeak?: boolean;
        stream?: MediaStream | null;
        styles?: Partial<AudioLevelMonitorStyles>;
        sx?: SxProps<Theme>;
        width?: string | number;
    }
    Index

    Properties

    barCount? colors? height? mode? onError? orientation? showPeak? stream? styles? sx? width?

    Properties

    barCount?: number

    Number of bars in the visualization (default: 20)

    colors?: Partial<AudioLevelMonitorColors>

    Custom colors

    height?: string | number

    Height of the monitor (default: 40)

    mode?: "meter" | "bars" | "waveform"

    Display mode (default: 'bars')

    onError?: (error: Error) => void

    Callback when an error occurs during audio analysis

    orientation?: "horizontal" | "vertical"

    Orientation (default: 'horizontal')

    showPeak?: boolean

    Show peak indicator (default: true)

    stream?: MediaStream | null

    Audio stream to monitor

    styles?: Partial<AudioLevelMonitorStyles>

    Custom styles

    sx?: SxProps<Theme>

    MUI sx styling prop

    width?: string | number

    Width of the monitor (default: 200)

    Settings

    Member Visibility

    On This Page

    Properties