Skip to main content

RtkSelfAudioToggleButton

A toggle button widget designed for controlling the audio state in the video conference environment. This widget integrates with the RealtimeKit UI and allows users to enable or disable their microphone audio during a meeting.

Usage​

Here is a basic example of how to use the RtkSelfAudioToggleButton in your Flutter app:

RtkSelfAudioToggleButton(
  meeting: yourMeetingInstance,
  onAudioToggle: () {
    // Your code to handle toggle
  },
  iconSize: 24.0,
  iconColor: Colors.blue,
  showLabel: true,
)

Properties​

  • meeting: (Required) An instance of RealtimeKitClient to manage the audio state and events.
  • onAudioToggle: (Optional) A callback that gets called when the audio toggle button is pressed.
  • iconSize: (Optional) Size of the icon inside the toggle button. If not specified, the 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) 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 uses RtkDesignTokens for theming, which allows for customization according to the RealtimeKit Design System. The designToken can be passed as a parameter or will default to the global design token.

Screenshot​