Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 1.59 KB

File metadata and controls

41 lines (31 loc) · 1.59 KB
pcx_content_type reference
title RtkAudioVisualizer
description API reference for RtkAudioVisualizer component (React Native Library)

Displays an audio visualizer with animated bars representing a participant's audio levels.

Properties

Property Type Required Default Description
participant Peer | RTKParticipant - The participant whose audio to visualize
iconPack IconPack defaultIconPack Custom icon pack for icons
isScreenshare boolean false Whether this is a screenshare audio visualizer
size 'lg' | 'md' | 'sm' | 'xl' 'sm' Size of the visualizer
variant 'bar' 'bar' Visual variant of the visualizer

Usage Examples

Basic Usage

import { RtkAudioVisualizer } from "@cloudflare/realtimekit-react-native-ui";

function MyComponent() {
	return <RtkAudioVisualizer participant={participant} />;
}

With Properties

import { RtkAudioVisualizer } from "@cloudflare/realtimekit-react-native-ui";

function MyComponent() {
	return (
		<RtkAudioVisualizer participant={participant} size="md" variant="bar" />
	);
}