Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ description: Complete API reference for Flutter library components
sidebar:
group:
hideIndex: true
products:
- realtime
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkAudioIndicatorIconWidget
description: API reference for RtkAudioIndicatorIconWidget component (Flutter Library)
products:
- realtime
---

A widget that displays the audio status of a participant in a RealtimeKit meeting.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkChatIconWidget
description: API reference for RtkChatIconWidget component (Flutter Library)
products:
- realtime
---

A widget that displays a chat icon, navigates to the chat page when pressed, and marks all messages as read.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkJoinButton
description: API reference for RtkJoinButton component (Flutter Library)
products:
- realtime
---

A button widget for joining a RealtimeKit meeting room. Provides visual feedback during the joining process.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkLeaveButton
description: API reference for RtkLeaveButton component (Flutter Library)
products:
- realtime
---

A button widget for leaving a RealtimeKit meeting. Displays a confirmation dialog to prevent accidental meeting exits.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkLeaveMeetingDialog
description: API reference for RtkLeaveMeetingDialog component (Flutter Library)
products:
- realtime
---

A dialog widget for confirming the action of leaving a RealtimeKit meeting. Provides a prompt with cancel and leave options, and displays an additional end-meeting option for hosts.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkMeetingTitle
description: API reference for RtkMeetingTitle component (Flutter Library)
products:
- realtime
---

A widget that displays the title of a RealtimeKit meeting. Integrates with the RealtimeKit design system for consistent styling.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkNameTag
description: API reference for RtkNameTag component (Flutter Library)
products:
- realtime
---

A widget that displays the name tag of a participant within a participant tile.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkParticipantTile
description: API reference for RtkParticipantTile component (Flutter Library)
products:
- realtime
---

A widget that displays a participant's video or avatar within a meeting environment. Automatically shows the video feed when available and falls back to the participant's avatar.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkParticipantsIconWidget
description: API reference for RtkParticipantsIconWidget component (Flutter Library)
products:
- realtime
---

A widget that displays a participants icon and navigates to the participants list when pressed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkPluginIconWidget
description: API reference for RtkPluginIconWidget component (Flutter Library)
products:
- realtime
---

A widget that displays a plugins icon and navigates to the plugins list when pressed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkPluginsScreen
description: API reference for RtkPluginsScreen component (Flutter Library)
products:
- realtime
---

A pre-built plugins screen that lists available plugins with the ability to turn them on or off.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkPollsIconWidget
description: API reference for RtkPollsIconWidget component (Flutter Library)
products:
- realtime
---

A widget that displays a polls icon and navigates to the polls list when pressed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkPollsScreen
description: API reference for RtkPollsScreen component (Flutter Library)
products:
- realtime
---

A pre-built polls screen for displaying and interacting with meeting polls.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkProvider
description: API reference for RtkProvider component (Flutter Library)
products:
- realtime
---

A foundational widget that initializes and provides the RealtimeKit environment for a Flutter application. `RtkProvider` acts as a context wrapper that sets up design tokens, client configurations, and UI Kit information required by RealtimeKit components.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkSelfAudioToggleButton
description: API reference for RtkSelfAudioToggleButton component (Flutter Library)
products:
- realtime
---

A toggle button widget for controlling microphone audio state during a meeting. Allows users to mute or unmute their microphone.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkSelfVideoToggleButton
description: API reference for RtkSelfVideoToggleButton component (Flutter Library)
products:
- realtime
---

A toggle button widget for controlling video state during a meeting. Allows users to turn their video on or off.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: navigation
title: RtkSetupScreen
description: API reference for RtkSetupScreen component (Flutter Library)
products:
- realtime
---

A pre-built setup screen shown before joining a meeting. Allows users to edit their display name and configure media settings.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: AppTheme
description: API reference for AppTheme component (iOS Library)
products:
- realtime
---

The application theme singleton that provides pre-configured appearance objects for UI components.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: DesignLibrary
description: API reference for DesignLibrary component (iOS Library)
products:
- realtime
---

The central design token library providing color, spacing, border width, and border radius tokens.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: GridView
description: API reference for GridView component (iOS Library)
products:
- realtime
---

A generic grid layout view that arranges child views in a responsive grid.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ description: Complete API reference for iOS library components
sidebar:
group:
hideIndex: true
products:
- realtime
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: MeetingViewController
description: API reference for MeetingViewController component (iOS Library)
products:
- realtime
---

The main meeting screen view controller.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkActiveTabSelectorView
description: API reference for RtkActiveTabSelectorView component (iOS Library)
products:
- realtime
---

A horizontally scrollable tab selector for switching between plugins and screen shares.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkAudioButtonControlBar
description: API reference for RtkAudioButtonControlBar component (iOS Library)
products:
- realtime
---

A control bar button that toggles the local microphone on and off.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkAvatarView
description: API reference for RtkAvatarView component (iOS Library)
products:
- realtime
---

A circular avatar view that displays a participant's profile image or name initials as a fallback.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkButton
description: API reference for RtkButton component (iOS Library)
products:
- realtime
---

A versatile button that follows the RTK Design System.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkClockView
description: API reference for RtkClockView component (iOS Library)
products:
- realtime
---

A label that displays the elapsed meeting time in `HH:MM:SS` format.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkControlBarButton
description: API reference for RtkControlBarButton component (iOS Library)
products:
- realtime
---

Base button class for control bar items.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkControlBar
description: API reference for RtkControlBar component (iOS Library)
products:
- realtime
---

Base control bar view with a More menu button and an End Call button.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkEndMeetingControlBarButton
description: API reference for RtkEndMeetingControlBarButton component (iOS Library)
products:
- realtime
---

A control bar button that ends or leaves the meeting.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkEventSelfListener
description: API reference for RtkEventSelfListener component (iOS Library)
products:
- realtime
---

A helper class that wraps self-participant and meeting event listeners with closure-based callbacks.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkImage
description: API reference for RtkImage component (iOS Library)
products:
- realtime
---

A struct that wraps a `UIImage` or a `URL` for image content.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkJoinButton
description: API reference for RtkJoinButton component (iOS Library)
products:
- realtime
---

A pre-configured button that joins the meeting.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkLabel
description: API reference for RtkLabel component (iOS Library)
products:
- realtime
---

A themed label that uses design token colors and fonts from the RTK Design System.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkLeaveDialog
description: API reference for RtkLeaveDialog component (iOS Library)
products:
- realtime
---

A dialog that presents leave and end meeting options.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkMeetingControlBar
description: API reference for RtkMeetingControlBar component (iOS Library)
products:
- realtime
---

Control bar for group calls that extends `RtkControlBar` with microphone and video toggle buttons.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkMeetingHeaderView
description: API reference for RtkMeetingHeaderView component (iOS Library)
products:
- realtime
---

Meeting header view that displays the meeting title, participant count, elapsed time clock, recording indicator, and camera switch button.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkMeetingNameTag
description: API reference for RtkMeetingNameTag component (iOS Library)
products:
- realtime
---

A name tag view that displays the participant name and a microphone status icon.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkMeetingTitleLabel
description: API reference for RtkMeetingTitleLabel component (iOS Library)
products:
- realtime
---

A label that displays the meeting title from the meeting metadata.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkMoreButtonControlBar
description: API reference for RtkMoreButtonControlBar component (iOS Library)
products:
- realtime
---

A control bar button that opens a bottom sheet menu with meeting actions such as chat, polls, and participant list.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkMoreMenu
description: API reference for RtkMoreMenu component (iOS Library)
products:
- realtime
---

A bottom sheet menu that displays meeting action options such as chat, polls, and participant list.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkNameTag
description: API reference for RtkNameTag component (iOS Library)
products:
- realtime
---

Base name tag view with an icon, title, and optional subtitle.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
pcx_content_type: reference
title: RtkNavigationBar
description: API reference for RtkNavigationBar component (iOS Library)
products:
- realtime
---

A navigation bar with a title label and a close or back button.
Expand Down
Loading
Loading