Flutter SDK Guide

Flutter SDK install, join a channel, events and platform support.

Interface sections generated from the public SDK definitions

Version v1.1.0 · Updated 2026-10-26 · revision 1

The Flutter platform is Dart with the RtcEngine shape (isomorphic with Android/iOS): RtcEngine + RtcEngineEventHandler, with return values wrapped in Future.

Prerequisites#

• Flutter 3.22+, Dart 3.4+.
• Native permissions per platform: CAMERA/RECORD_AUDIO on Android, NSCameraUsageDescription/NSMicrophoneUsageDescription on iOS.
• You already have an appId and a token service (see Enable services and get credentials).

Install#

# pubspec.yaml — local path dependency (not yet published to pub.dev)
dependencies:
  nimeet_rtc:
    path: ../ni-meet/sdk/flutter

Get a token#

A Flutter client must not hold customerSecret; tokens are issued by your backend and injected on the Flutter side through a TokenProvider:

final provider = FallbackTokenProvider([
  CallbackTokenProvider((channel, uid, role) => authApi.fetchRtcToken(channel, uid, role)),
  StaticTokenProvider(Platform.environment['NIMEET_TEST_TOKEN'] ?? ''),
]);

Join a channel#

import 'package:nimeet_rtc/nimeet_rtc.dart';

class MeetingController extends RtcEngineEventHandler {
  late final RtcEngine engine;

  Future<void> start(String appId, String token) async {
    engine = await RtcEngine.create(RtcEngineConfig(appId: appId));
    engine.registerEventHandler(this);

    await engine.setChannelProfile(ChannelProfileType.channelProfileLiveBroadcasting);
    await engine.enableVideo();
    await engine.setupLocalVideo(const VideoCanvas(uid: 0));
    await engine.startPreview();

    await engine.joinChannel(
      token: token,
      channelId: 'weekly-sync',
      uid: 10001,
      options: const ChannelMediaOptions(clientRoleType: ClientRoleType.clientRoleBroadcaster),
    );
  }

  @override
  void onJoinChannelSuccess(RtcConnection connection, int elapsed) {
    // Join succeeded
  }

  @override
  void onUserJoined(RtcConnection connection, int remoteUid, int elapsed) {
    // A remote user joined
  }

  @override
  void onUserOffline(RtcConnection connection, int remoteUid, UserOfflineReasonType reason) {
    // A remote user left
  }

  @override
  void onTokenPrivilegeWillExpire(String token) {
    // After refreshing the token, call engine.renewToken(newToken)
  }
}

Publish and subscribe#

await engine.muteLocalAudioStream(true);   // mute the microphone
await engine.muteLocalVideoStream(true);   // turn off the local video
await engine.enableLocalVideo(false);      // stop capture
await engine.updateChannelMediaOptions(options);

Screen sharing: getScreenCaptureSources() enumerates sources → startScreenCapture(...); stop with stopScreenCapture().

Events#

RtcEngineEventHandler is the callback class; it covers onJoinChannelSuccess, onUserJoined, onUserOffline, onFirstRemoteVideoDecoded, onTokenPrivilegeWillExpire, onError, onConnectionStateChanged and others. Flutter callbacks return to the main isolate by default, so you can call setState directly.

Error handling#

• A failed Future throws RtcException (carrying code/sdkCode/message/retryable);
• Asynchronous errors go through the onError callback;
• Unimplemented capabilities throw -4 (ERR_NOT_SUPPORTED).

Troubleshooting#

Next steps#

• Full interfaces and overloads: API reference for this platform
• Error codes and troubleshooting: Error code table, FAQ
• Issue tokens on your server: Token authentication

Platform information

The public interfaces are aligned with the Agora flutter API; installation and runtime requirements are listed under Prerequisites above.

Availability

This platform's SDK: Generally available. The examples use the public API; runtime capability follows the published SDK package.

join-channel flow

The method names, parameter types and return values match the API reference for the same platform. Where a method has several overloads, the most common one is shown here; see the API reference for all overloads.

muteRemoteAudioStream(mute: int uid,required bool): Future
initialize(): Future
renewToken(token: String): Future
enableVideo(): Future
joinChannel(options: String token,required String channelId,required int uid,required ChannelMediaOptions): Future
leaveChannel(options?: LeaveChannelOptions?): Future
setChannelProfile(profile: ChannelProfileType): Future
setClientRole(options?: ClientRoleType role,ClientRoleOptions?): Future
setupLocalVideo(canvas: VideoCanvas): Future

Events and callbacks

Callbacks are registered on RtcEngineEventHandler; naming differs by platform, and the full list is in the API reference for the same platform.

Error codes

the platform REST layer uses REST error codes；the SDK layer maps connection/authentication failures to Agora error numbers, for the mapping table see SDK error identifiers per platform。