Skip to main content

RtkSelfVideoToggleButton

A custom Flutter widget designed for toggling video state in a video conference environment. This widget is part of the RealtimeKit UI and allows users to enable or disable their video during a meeting.

Usage​

Below is an example of how to integrate the RtkSelfVideoToggleButton into your Flutter app:

RtkSelfVideoToggleButton(
  meeting: yourMeetingInstance,
  onVideoToggle: () {
    // Code to execute after video toggle
  },
  iconSize: 24.0,
  iconColor: Colors.red,
  showLabel: true,
)

Properties​

  • meeting: (Required) An instance of RealtimeKitClient to manage video state and events.
  • onVideoToggle: (Optional) A callback that is called when the video toggle button is pressed.
  • iconSize: (Optional) Size of the icon inside the toggle button. If not specified, a default size is used.
  • iconColor: (Optional) Color of the icon inside the toggle button. If not specified, the default color from the design tokens is used.
  • showLabel: (Optional) A boolean to show or hide the label next to the icon. Default is false.
  • individualDesignToken: (Optional) An instance of RtkDesignTokens for customizing the appearance according to the Rtk Design System.

Design Token​

The widget utilizes RtkDesignTokens for theming, which allows customization following the RealtimeKit Design System. The designTokens can either be passed as a parameter or will default to the global design tokens.

Screenshot​