Interface AudioCardOptions

interface AudioCardOptions {
    controlUserMedia?: ((options: ControlMediaOptions) => Promise<void>);
    customStyle?: CSSProperties;
    name: string;
    barColor?: string;
    textColor?: string;
    imageSource?: string;
    roundedImage?: boolean;
    imageStyle?: CSSProperties;
    showControls?: boolean;
    showInfo?: boolean;
    videoInfoComponent?: ReactNode;
    videoControlsComponent?: ReactNode;
    controlsPosition?: ControlsPosition;
    infoPosition?: InfoPosition;
    participant: Participant;
    backgroundColor?: string;
    audioDecibels?: AudioDecibels;
    parameters: AudioCardParameters;
    cardProps?: HTMLAttributes<HTMLDivElement>;
    infoOverlayProps?: HTMLAttributes<HTMLDivElement>;
    nameContainerProps?: HTMLAttributes<HTMLDivElement>;
    nameTextProps?: HTMLAttributes<HTMLParagraphElement>;
    waveformContainerProps?: HTMLAttributes<HTMLDivElement>;
    waveformBarStyle?: CSSProperties;
    waveformBarProps?: HTMLAttributes<HTMLDivElement>;
    waveformHeights?: {
        silent?: number;
        active?: number;
    };
    waveformDurations?: number[];
    waveformBarCount?: number;
    renderWaveformBar?: ((options: {
        index: number;
        isActive: boolean;
        height: number;
        style: CSSProperties;
        props: HTMLAttributes<HTMLDivElement>;
    }) => ReactNode);
    controlsOverlayProps?: HTMLAttributes<HTMLDivElement>;
    controlButtonProps?: {
        audio?: ButtonHTMLAttributes<HTMLButtonElement>;
        video?: ButtonHTMLAttributes<HTMLButtonElement>;
    };
    audioEnabledIcon?: ReactNode;
    audioDisabledIcon?: ReactNode;
    videoEnabledIcon?: ReactNode;
    videoDisabledIcon?: ReactNode;
    fallbackMiniCardProps?: Partial<MiniCardOptions>;
    imageProps?: ImgHTMLAttributes<HTMLImageElement>;
    showWaveformWhenMuted?: boolean;
}

Properties

controlUserMedia? customStyle? name barColor? textColor? imageSource? roundedImage? imageStyle? showControls? showInfo? videoInfoComponent? videoControlsComponent? controlsPosition? infoPosition? participant backgroundColor? audioDecibels? parameters cardProps? infoOverlayProps? nameContainerProps? nameTextProps? waveformContainerProps? waveformBarStyle? waveformBarProps? waveformHeights? waveformDurations? waveformBarCount? renderWaveformBar? controlsOverlayProps? controlButtonProps? audioEnabledIcon? audioDisabledIcon? videoEnabledIcon? videoDisabledIcon? fallbackMiniCardProps? imageProps? showWaveformWhenMuted?

Properties

OptionalcontrolUserMedia

controlUserMedia?: ((options: ControlMediaOptions) => Promise<void>)

OptionalcustomStyle

customStyle?: CSSProperties

name

name: string

OptionalbarColor

barColor?: string

OptionaltextColor

textColor?: string

OptionalimageSource

imageSource?: string

OptionalroundedImage

roundedImage?: boolean

OptionalimageStyle

imageStyle?: CSSProperties

OptionalshowControls

showControls?: boolean

OptionalshowInfo

showInfo?: boolean

OptionalvideoInfoComponent

videoInfoComponent?: ReactNode

OptionalvideoControlsComponent

videoControlsComponent?: ReactNode

OptionalcontrolsPosition

controlsPosition?: ControlsPosition

OptionalinfoPosition

infoPosition?: InfoPosition

participant

participant: Participant

OptionalbackgroundColor

backgroundColor?: string

OptionalaudioDecibels

audioDecibels?: AudioDecibels

parameters

parameters: AudioCardParameters

OptionalcardProps

cardProps?: HTMLAttributes<HTMLDivElement>

OptionalinfoOverlayProps

infoOverlayProps?: HTMLAttributes<HTMLDivElement>

OptionalnameContainerProps

nameContainerProps?: HTMLAttributes<HTMLDivElement>

OptionalnameTextProps

nameTextProps?: HTMLAttributes<HTMLParagraphElement>

OptionalwaveformContainerProps

waveformContainerProps?: HTMLAttributes<HTMLDivElement>

OptionalwaveformBarStyle

waveformBarStyle?: CSSProperties

OptionalwaveformBarProps

waveformBarProps?: HTMLAttributes<HTMLDivElement>

OptionalwaveformHeights

waveformHeights?: {
    silent?: number;
    active?: number;
}

OptionalwaveformDurations

waveformDurations?: number[]

OptionalwaveformBarCount

waveformBarCount?: number

OptionalrenderWaveformBar

renderWaveformBar?: ((options: {
    index: number;
    isActive: boolean;
    height: number;
    style: CSSProperties;
    props: HTMLAttributes<HTMLDivElement>;
}) => ReactNode)

OptionalcontrolsOverlayProps

controlsOverlayProps?: HTMLAttributes<HTMLDivElement>

OptionalcontrolButtonProps

controlButtonProps?: {
    audio?: ButtonHTMLAttributes<HTMLButtonElement>;
    video?: ButtonHTMLAttributes<HTMLButtonElement>;
}

OptionalaudioEnabledIcon

audioEnabledIcon?: ReactNode

OptionalaudioDisabledIcon

audioDisabledIcon?: ReactNode

OptionalvideoEnabledIcon

videoEnabledIcon?: ReactNode

OptionalvideoDisabledIcon

videoDisabledIcon?: ReactNode

OptionalfallbackMiniCardProps

fallbackMiniCardProps?: Partial<MiniCardOptions>

OptionalimageProps

imageProps?: ImgHTMLAttributes<HTMLImageElement>

OptionalshowWaveformWhenMuted

showWaveformWhenMuted?: boolean

Settings

Member Visibility

On This Page

Properties