Agora RTC Engine

https://github.com/agoraio-extensions/agora-flutter-sdk
Admin
Agora RTC Engine is a Flutter plugin that enables real-time voice and video communications in...
Tokens:43,768
Snippets:249
Trust Score:8.7
License:MIT
Update:2 hours ago
Show doc for...
Tokens:
Raw
### Run flutter pub get

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/example/README.md

Install the project dependencies before running the sample.

```bash
flutter pub get
```

--------------------------------

### CMakeLists.txt for Windows Flutter Example

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/example/windows/CMakeLists.txt

Configures the Windows build for the Agora Flutter SDK example. Sets the binary name, build types, Unicode definitions, and standard settings. Includes Flutter managed directory, runner, and generated plugins. Defines installation rules to copy the executable, ICU data, Flutter library, plugin libraries, assets, and AOT library into the bundle directory.

```cmake
cmake_minimum_required(VERSION 3.14)
project(agora_rtc_engine_example LANGUAGES CXX)

set(BINARY_NAME "agora_rtc_engine_example")

cmake_policy(SET CMP0063 NEW)

set(CMAKE_INSTALL_RPATH "$ORIGIN/lib")

# Configure build options.
get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
if(IS_MULTICONFIG)
  set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release"
    CACHE STRING "" FORCE)
else()
  if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
    set(CMAKE_BUILD_TYPE "Debug" CACHE
      STRING "Flutter build mode" FORCE)
    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
      "Debug" "Profile" "Release")
  endif()
endif()

set(CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /DEBUG")
set(CMAKE_SHARED_LINKER_FLAGS_RELEASE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE} /DEBUG")

set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}")
set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}")
set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}")
set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}")

# Use Unicode for all projects.
add_definitions(-DUNICODE -D_UNICODE)

# Compilation settings that should be applied to most targets.
function(APPLY_STANDARD_SETTINGS TARGET)
  target_compile_features(${TARGET} PUBLIC cxx_std_17)
  target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100")
  target_compile_options(${TARGET} PRIVATE /EHsc)
  target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0")
  target_compile_definitions(${TARGET} PRIVATE "$<$<CONFIG:Debug>:_DEBUG>")
endfunction()

set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter")

# Flutter library and tool build rules.
add_subdirectory(${FLUTTER_MANAGED_DIR})

# Application build
add_subdirectory("runner")

# Generated plugin build rules, which manage building the plugins and adding
# them to the application.
include(flutter/generated_plugins.cmake)


# === Installation ===
# Support files are copied into place next to the executable, so that it can
# run in place. This is done instead of making a separate bundle (as on Linux)
# so that building and running from within Visual Studio will work.
set(BUILD_BUNDLE_DIR "$<TARGET_FILE_DIR:${BINARY_NAME}>")
# Make the "install" step default, as it's required to run.
set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1)
if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
  set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE)
endif()

set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data")
set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}")

install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}"
  COMPONENT Runtime)

install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}"
  COMPONENT Runtime)

install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
  COMPONENT Runtime)

if(PLUGIN_BUNDLED_LIBRARIES)
  install(FILES "${PLUGIN_BUNDLED_LIBRARIES}"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()

# Fully re-copy the assets directory on each build to avoid having stale files
# from a previous install.
set(FLUTTER_ASSET_DIR_NAME "flutter_assets")
install(CODE "
  file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\")
  " COMPONENT Runtime)
install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}"
  DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime)

# Install the AOT library on non-Debug builds only.
install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}"
  CONFIGURATIONS Profile;Release
  COMPONENT Runtime)
```

--------------------------------

### Install plugin bundled libraries

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/linux/CMakeLists.txt

Iterates over PLUGIN_BUNDLED_LIBRARIES and installs each bundled library into the bundle lib directory under the Runtime component.

```cmake
foreach(bundled_library ${PLUGIN_BUNDLED_LIBRARIES})
  install(FILES "${bundled_library}"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endforeach(bundled_library)
```

--------------------------------

### Define install bundle data and lib directories

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/linux/CMakeLists.txt

Sets the INSTALL_BUNDLE_DATA_DIR and INSTALL_BUNDLE_LIB_DIR variables to the data and lib subdirectories under the install prefix.

```cmake
set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data")
set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib")
```

--------------------------------

### Clean build bundle directory before install

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/linux/CMakeLists.txt

Adds an install script that removes the build bundle directory recursively before each installation. This ensures a clean bundle every time.

```cmake
install(CODE "
  file(REMOVE_RECURSE \"${BUILD_BUNDLE_DIR}/\")
  " COMPONENT Runtime)
```

--------------------------------

### Set bundle directory and install prefix

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/linux/CMakeLists.txt

Defines the build bundle directory and sets the CMake install prefix to the bundle directory if it is still at its default value. This ensures the application is installed as a relocatable bundle in the build directory.

```cmake
set(BUILD_BUNDLE_DIR "${PROJECT_BINARY_DIR}/bundle")
if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
  set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE)
endif()
```

--------------------------------

### Install Flutter assets with clean re-copy in CMakeLists.txt

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/rendering_test/linux/CMakeLists.txt

Removes the existing flutter_assets directory before installing a fresh copy on each build to avoid stale files. The install(CODE) block runs at install time and targets the Runtime component.

```cmake
# Fully re-copy the assets directory on each build to avoid having stale files
# from a previous install.
set(FLUTTER_ASSET_DIR_NAME "flutter_assets")
install(CODE "
  file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\")
  " COMPONENT Runtime)
install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}"
  DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime)
```

--------------------------------

### Installation and bundle configuration

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/integration_test_app/windows/CMakeLists.txt

Configures the install step to be default and sets the install prefix to the build bundle directory so the app can run in place from Visual Studio. Defines data and library install directories.

```cmake
# === Installation ===
# Support files are copied into place next to the executable, so that it can
# run in place. This is done instead of making a separate bundle (as on Linux)
# so that building and running from within Visual Studio will work.
set(BUILD_BUNDLE_DIR "$<TARGET_FILE_DIR:${BINARY_NAME}>")
# Make the "install" step default, as it's required to run.
set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1)
if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
  set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE)
endif()

set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data")
set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}")
```

--------------------------------

### Install binary, ICU data, and Flutter library

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/linux/CMakeLists.txt

Installs the application binary, the Flutter ICU data file, and the Flutter library into the appropriate bundle directories, all under the Runtime component.

```cmake
install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}"
  COMPONENT Runtime)

install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}"
  COMPONENT Runtime)

install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
  COMPONENT Runtime)
```

--------------------------------

### Installation rules for Windows Flutter app

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/iris_tester/example/windows/CMakeLists.txt

Defines the installation steps for the Windows build, copying support files next to the executable so it can run in place from Visual Studio. Installs the binary, ICU data, Flutter library, plugin libraries, assets, and the AOT library (Profile/Release only).

```cmake
# === Installation ===
# Support files are copied into place next to the executable, so that it can
# run in place. This is done instead of making a separate bundle (as on Linux)
# so that building and running from within Visual Studio will work.
set(BUILD_BUNDLE_DIR "$<TARGET_FILE_DIR:${BINARY_NAME}>")
# Make the "install" step default, as it's required to run.
set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1)
if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
  set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE)
endif()

set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data")
set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}")

install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}"
  COMPONENT Runtime)

install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}"
  COMPONENT Runtime)

install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
  COMPONENT Runtime)

if(PLUGIN_BUNDLED_LIBRARIES)
  install(FILES "${PLUGIN_BUNDLED_LIBRARIES}"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()

# Fully re-copy the assets directory on each build to avoid having stale files
# from a previous install.
set(FLUTTER_ASSET_DIR_NAME "flutter_assets")
install(CODE "
  file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\")
  " COMPONENT Runtime)
install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}"
  DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime)

# Install the AOT library on non-Debug builds only.
install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}"
  CONFIGURATIONS Profile;Release
  COMPONENT Runtime)

```

--------------------------------

### Setup, Start, Stop, and Dispose PiP Controller

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/docs/integration/Picture-in-Picture.md

Use this Dart snippet to manage the Picture-in-Picture lifecycle with AgoraPipController. It covers setup, start (user-initiated on iOS), stop, cleanup, and disposal. Note that pipDispose() only cleans PiP resources, while dispose() invalidates the controller and should be called to prevent memory leaks.

```dart
// Setup PiP
await _pipController.pipSetup(options);

// Start PiP (iOS: Must be user-initiated)
// Important: On iOS, Picture-in-Picture playback must only be initiated in response to explicit user actions (e.g. tapping a button).
// Starting PiP programmatically or automatically may result in App Store rejection.
// For more details, see Apple's guidelines on [Handle User-Initiated Requests](https://developer.apple.com/documentation/avkit/adopting-picture-in-picture-in-a-custom-player?language=objc#Handle-User-Initiated-Requests).
await _pipController.pipStart();

// Stop PiP
await _pipController.pipStop();

// Cleanup PiP resources
// This will stop PiP mode and dispose any native views created by the PiP controller.
// To use PiP functionality again, you'll need to call pipSetup with new options.
// Note that this method only cleans up PiP-related resources - it does not dispose the controller itself.
await _pipController.pipDispose();

// Dispose controller (prevent memory leaks)
// This will stop PiP mode, dispose any native views created by the PiP controller,
// and clean up associated resources. After calling dispose(), this AgoraPipController
// instance becomes invalid and should not be used again. Create a new instance if you
// need to use PiP functionality again.
await _pipController.dispose();
```

--------------------------------

### Agora Flutter SDK: Simpler Example (main.dart)

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/example/example.md

Complete Flutter app demonstrating a basic video call using the Agora RTC engine. It requests microphone and camera permissions, initializes the engine with a live broadcasting profile, registers event handlers for join/user events, and displays local and remote video views. Replace the appId, token, and channel placeholders before running.

```dart
import 'dart:async';

import 'package:agora_rtc_engine/agora_rtc_engine.dart';
import 'package:flutter/material.dart';
import 'package:permission_handler/permission_handler.dart';

const appId = "<-- Insert App Id -->";
const token = "<-- Insert Token -->";
const channel = "<-- Insert Channel Name -->";

void main() => runApp(const MaterialApp(home: MyApp()));

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  int? _remoteUid;
  bool _localUserJoined = false;
  late RtcEngine _engine;

  @override
  void initState() {
    super.initState();
    initAgora();
  }

  Future<void> initAgora() async {
    // retrieve permissions
    await [Permission.microphone, Permission.camera].request();

    //create the engine
    _engine = createAgoraRtcEngine();
    await _engine.initialize(const RtcEngineContext(
      appId: appId,
      channelProfile: ChannelProfileType.channelProfileLiveBroadcasting,
    ));

    _engine.registerEventHandler(
      RtcEngineEventHandler(
        onJoinChannelSuccess: (RtcConnection connection, int elapsed) {
          debugPrint("local user ${connection.localUid} joined");
          setState(() {
            _localUserJoined = true;
          });
        },
        onUserJoined: (RtcConnection connection, int remoteUid, int elapsed) {
          debugPrint("remote user $remoteUid joined");
          setState(() {
            _remoteUid = remoteUid;
          });
        },
        onUserOffline: (RtcConnection connection, int remoteUid,
            UserOfflineReasonType reason) {
          debugPrint("remote user $remoteUid left channel");
          setState(() {
            _remoteUid = null;
          });
        },
        onTokenPrivilegeWillExpire: (RtcConnection connection, String token) {
          debugPrint(
              '[onTokenPrivilegeWillExpire] connection: ${connection.toJson()}, token: $token');
        },
      ),
    );

    await _engine.setClientRole(role: ClientRoleType.clientRoleBroadcaster);
    await _engine.enableVideo();
    await _engine.startPreview();

    await _engine.joinChannel(
      token: token,
      channelId: channel,
      uid: 0,
      options: const ChannelMediaOptions(),
    );
  }

  @override
  void dispose() {
    super.dispose();

    _dispose();
  }

  Future<void> _dispose() async {
    await _engine.leaveChannel();
    await _engine.release();
  }

  // Create UI with local view and remote view
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Agora Video Call'),
      ),
      body: Stack(
        children: [
          Center(
            child: _remoteVideo(),
          ),
          Align(
            alignment: Alignment.topLeft,
            child: SizedBox(
              width: 100,
              height: 150,
              child: Center(
                child: _localUserJoined
                    ? AgoraVideoView(
                        controller: VideoViewController(
                          rtcEngine: _engine,
                          canvas: const VideoCanvas(uid: 0),
                        ),
                      )
                    : const CircularProgressIndicator(),
              ),
            ),
          ),
        ],
      ),
    );
  }

  // Display remote user's video
  Widget _remoteVideo() {
    if (_remoteUid != null) {
      return AgoraVideoView(
        controller: VideoViewController.remote(
          rtcEngine: _engine,
          canvas: VideoCanvas(uid: _remoteUid),
          connection: const RtcConnection(channelId: channel),
        ),
      );
    } else {
      return const Text(
        'Please wait for remote user to join',
        textAlign: TextAlign.center,
      );
    }
  }
}

```

--------------------------------

### Install application and Flutter runtime files

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/integration_test_app/windows/CMakeLists.txt

Installs the application executable, the Flutter ICU data file, and the Flutter library into the bundle directories. Also installs any plugin-bundled libraries if defined.

```cmake
install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}"
  COMPONENT Runtime)

install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}"
  COMPONENT Runtime)

install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
  COMPONENT Runtime)

if(PLUGIN_BUNDLED_LIBRARIES)
  install(FILES "${PLUGIN_BUNDLED_LIBRARIES}"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
```

--------------------------------

### Install Flutter assets and AOT library in CMake

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/linux/CMakeLists.txt

Configures installation of Flutter assets and the AOT library for a Linux Flutter app. Removes stale assets before copying, and installs the AOT library only on non-Debug builds.

```cmake
# Fully re-copy the assets directory on each build to avoid having stale files
# from a previous install.
set(FLUTTER_ASSET_DIR_NAME "flutter_assets")
install(CODE "
  file(REMOVE_RECURSE "${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}")
  " COMPONENT Runtime)
install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}"
  DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime)

# Install the AOT library on non-Debug builds only.
if(NOT CMAKE_BUILD_TYPE MATCHES "Debug")
  install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
```

--------------------------------

### Run rendering test on Web

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/rendering_test/README.md

Use this command to run the rendering test on the web. Requires ChromeDriver setup as per the Flutter docs. Replace <APP_ID> with your Agora App ID.

```bash
flutter drive --driver=test_driver/integration_test.dart \
    --target=integration_test/agora_video_view_render_test.dart \
    --dart-define=TEST_APP_ID="<APP_ID>" \
    -d web-server
```

--------------------------------

### CMake install rules for Flutter assets and AOT library

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/rendering_test/windows/CMakeLists.txt

Defines install rules for a Windows Flutter application. It removes and re-copies the flutter_assets directory on each build to avoid stale files, and installs the AOT library only for Profile and Release configurations.

```cmake
# Fully re-copy the assets directory on each build to avoid having stale files
# from a previous install.
set(FLUTTER_ASSET_DIR_NAME "flutter_assets")
install(CODE "
  file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\")
  " COMPONENT Runtime)
install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}"
  DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime)

# Install the AOT library on non-Debug builds only.
install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}"
  CONFIGURATIONS Profile;Release
  COMPONENT Runtime)
```

--------------------------------

### Install Flutter assets and AOT library in CMake

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/integration_test_app/windows/CMakeLists.txt

Configures the Windows installer to fully re-copy the Flutter assets directory on each build to avoid stale files, and installs the AOT library only on Profile and Release configurations.

```cmake
# Fully re-copy the assets directory on each build to avoid having stale files
# from a previous install.
set(FLUTTER_ASSET_DIR_NAME "flutter_assets")
install(CODE "
  file(REMOVE_RECURSE "${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}")
  " COMPONENT Runtime)
install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}"
  DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime)

# Install the AOT library on non-Debug builds only.
install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}"
  CONFIGURATIONS Profile;Release
  COMPONENT Runtime)
```

--------------------------------

### Bundle system VCRUNTIME DLLs to avoid DLL Hell

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/integration_test_app/windows/CMakeLists.txt

Installs the system VCRUNTIME and MSVCP DLLs from C:/Windows/System32 into the bundle to prevent loading incompatible versions from PATH. Each DLL is installed only if it exists.

```cmake
# Fix for DLL Hell: Bundle system VCRUNTIME to avoid loading incompatible versions from PATH
set(SYSTEM_VCRUNTIME_DIR "C:/Windows/System32")
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/vcruntime140.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/vcruntime140.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/vcruntime140_1.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/vcruntime140_1.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/msvcp140.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/msvcp140.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/msvcp140_1.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/msvcp140_1.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/msvcp140_2.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/msvcp140_2.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/msvcp140_codecvt_ids.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/msvcp140_codecvt_ids.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
```

--------------------------------

### Install AOT library on non-Debug builds in CMakeLists.txt

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/rendering_test/linux/CMakeLists.txt

Installs the AOT library only when CMAKE_BUILD_TYPE is not Debug. The file is placed in INSTALL_BUNDLE_LIB_DIR under the Runtime component.

```cmake
# Install the AOT library on non-Debug builds only.
if(NOT CMAKE_BUILD_TYPE MATCHES "Debug")
  install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
```

--------------------------------

### CMakeLists.txt for Windows Flutter Application

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/rendering_test/windows/CMakeLists.txt

Configures the Windows build for a Flutter application, including Flutter managed files, runner, and generated plugins. Sets up installation rules to copy support files next to the executable and bundles system VCRUNTIME DLLs to avoid DLL Hell.

```cmake
# Flutter library and tool build rules.
set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter")
add_subdirectory(${FLUTTER_MANAGED_DIR})

# Application build; see runner/CMakeLists.txt.
add_subdirectory("runner")

# Generated plugin build rules, which manage building the plugins and adding
# them to the application.
include(flutter/generated_plugins.cmake)


# === Installation ===
# Support files are copied into place next to the executable, so that it can
# run in place. This is done instead of making a separate bundle (as on Linux)
# so that building and running from within Visual Studio will work.
set(BUILD_BUNDLE_DIR "$<TARGET_FILE_DIR:${BINARY_NAME}>")
# Make the "install" step default, as it's required to run.
set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1)
if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
  set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE)
endif()

set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data")
set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}")

install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}"
  COMPONENT Runtime)

install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}"
  COMPONENT Runtime)

install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
  COMPONENT Runtime)

if(PLUGIN_BUNDLED_LIBRARIES)
  install(FILES "${PLUGIN_BUNDLED_LIBRARIES}"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()

# Fix for DLL Hell: Bundle system VCRUNTIME to avoid loading incompatible versions from PATH
set(SYSTEM_VCRUNTIME_DIR "C:/Windows/System32")
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/vcruntime140.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/vcruntime140.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/vcruntime140_1.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/vcruntime140_1.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/msvcp140.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/msvcp140.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/msvcp140_1.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/msvcp140_1.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/msvcp140_2.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/msvcp140_2.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
if(EXISTS "${SYSTEM_VCRUNTIME_DIR}/msvcp140_codecvt_ids.dll")
  install(FILES "${SYSTEM_VCRUNTIME_DIR}/msvcp140_codecvt_ids.dll"
    DESTINATION "${INSTALL_BUNDLE_LIB_DIR}"
    COMPONENT Runtime)
endif()
```

--------------------------------

### Extend AgoraPIPFlutterFragmentActivity for PiP support

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/docs/integration/Picture-in-Picture.md

Alternative to AgoraPIPFlutterActivity: extend AgoraPIPFlutterFragmentActivity to get the same automatic PiP behavior when using a FragmentActivity.

```kotlin
import io.agora.agora_rtc_ng.AgoraPIPFlutterFragmentActivity

class MainActivity: AgoraPIPFlutterFragmentActivity() {
    ...
}
```

--------------------------------

### Update screenshot on Web

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/rendering_test/README.md

Use this command to update the golden screenshot on the web. Requires ChromeDriver setup. Set the environment variable UPDATE_GOLDEN to "true" before running the test.

```bash
export UPDATE_GOLDEN="true"
flutter drive --driver=test_driver/integration_test.dart \
    --target=integration_test/agora_video_view_render_test.dart \
    --dart-define=TEST_APP_ID="<APP_ID>" \
    -d web-server
```

--------------------------------

### CMake configuration for Windows runner executable

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/example/windows/runner/CMakeLists.txt

Defines the Windows runner executable target with required source files, standard settings, compile definitions, and linking to Flutter libraries. Used in the example's Windows runner build.

```cmake
cmake_minimum_required(VERSION 3.14)
project(runner LANGUAGES CXX)

add_executable(${BINARY_NAME} WIN32
  "flutter_window.cpp"
  "main.cpp"
  "utils.cpp"
  "win32_window.cpp"
  "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc"
  "Runner.rc"
  "runner.exe.manifest"
)
apply_standard_settings(${BINARY_NAME})
target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX")
target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app)
target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}")
add_dependencies(${BINARY_NAME} flutter_assemble)
```

--------------------------------

### Apply standard settings and link dependencies

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/rendering_test/linux/CMakeLists.txt

Applies the standard build settings to the executable and links the Flutter library and GTK package.

```CMake
apply_standard_settings(${BINARY_NAME})
```

```CMake
target_link_libraries(${BINARY_NAME} PRIVATE flutter)
target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK)
```

--------------------------------

### Apply standard settings to application target

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/linux/CMakeLists.txt

Calls the apply_standard_settings function on the BINARY_NAME target to apply the standard build settings.

```cmake
apply_standard_settings(${BINARY_NAME})
```

--------------------------------

### Initialize RtcEngine and Create PiP Controller

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/docs/integration/Picture-in-Picture.md

Sets up the Agora RTC engine and creates a PiP controller. Requires an initialized RtcEngine with your app configuration before calling createPipController().

```dart
import 'package:agora_rtc_engine/agora_rtc_engine.dart';

// Declare controllers
late final RtcEngine _engine;
late final AgoraPipController _pipController;

// Create and initialize RtcEngine
_engine = createAgoraRtcEngine();
await _engine.initialize(RtcEngineContext(
  // ... configuration
));

// Create PiP controller
_pipController = _engine.createPipController();
```

--------------------------------

### Run rendering test on macOS/Windows

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/rendering_test/README.md

Use this command to run the rendering test on macOS or Windows. Replace <APP_ID> with your Agora App ID.

```bash
flutter test integration_test/agora_video_view_render_test.dart \
    --dart-define=TEST_APP_ID="<APP_ID>"
```

--------------------------------

### Include iris_web from Agora CDN for Testing

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/README.md

Alternative HTML snippet to directly depend on the Agora CDN for testing purposes, using the provided URL.

```html
<!-- <your-project>/web/index.html -->
<!DOCTYPE html>
<html>
...
<body>
  ...
  <script src="https://download.agora.io/sdk/release/iris-web-rtc_n450_w4220_0.8.6.js"></script>
</body>
</html>
```

--------------------------------

### Web Project Structure for iris_web Integration

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/README.md

Shows the required file layout for including the iris_web JavaScript artifact in the web/index.html file.

```text
<your-project>
|__web
   |__index.html
   |__iris-web-rtc_<x.y.z>.js
```

--------------------------------

### Run rendering test on Android/iOS

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/rendering_test/README.md

Use this command to run the rendering test on Android or iOS devices. Replace <APP_ID> with your Agora App ID.

```bash
flutter drive --driver=test_driver/integration_test.dart \
    --target=integration_test/agora_video_view_render_test.dart \
    --dart-define=TEST_APP_ID="<APP_ID>"
```

--------------------------------

### Define application executable target

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/linux/CMakeLists.txt

Creates an executable target named BINARY_NAME with source files main.cc, my_application.cc, and the generated plugin registrant. Changing BINARY_NAME is not recommended as it may break flutter run.

```cmake
add_executable(${BINARY_NAME}
  "main.cc"
  "my_application.cc"
  "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc"
)
```

--------------------------------

### Project-level CMake configuration for Windows Flutter app

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/iris_tester/example/windows/CMakeLists.txt

Configures the CMake project for the Windows runner of the iris_tester_example Flutter application. Sets the binary name, enables modern CMake policies, defines build configurations (Debug, Profile, Release), and applies standard compilation settings including C++17, warnings as errors, and exception handling.

```cmake
# Project-level configuration.
cmake_minimum_required(VERSION 3.14)
project(iris_tester_example LANGUAGES CXX)

# The name of the executable created for the application. Change this to change
# the on-disk name of your application.
set(BINARY_NAME "iris_tester_example")

# Explicitly opt in to modern CMake behaviors to avoid warnings with recent
# versions of CMake.
cmake_policy(SET CMP0063 NEW)

# Define build configuration option.
get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
if(IS_MULTICONFIG)
  set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release"
    CACHE STRING "" FORCE)
else()
  if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
    set(CMAKE_BUILD_TYPE "Debug" CACHE
      STRING "Flutter build mode" FORCE)
    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
      "Debug" "Profile" "Release")
  endif()
endif()
# Define settings for the Profile build mode.
set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}")
set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}")
set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}")
set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}")

# Use Unicode for all projects.
add_definitions(-DUNICODE -D_UNICODE)

# Compilation settings that should be applied to most targets.
#
# Be cautious about adding new options here, as plugins use this function by
# default. In most cases, you should add new options to specific targets instead
# of modifying this function.
function(APPLY_STANDARD_SETTINGS TARGET)
  target_compile_features(${TARGET} PUBLIC cxx_std_17)
  target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100")
  target_compile_options(${TARGET} PRIVATE /EHsc)
  target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0")
  target_compile_definitions(${TARGET} PRIVATE "$<$<CONFIG:Debug>:_DEBUG>")
endfunction()

# Flutter library and tool build rules.
set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter")
add_subdirectory(${FLUTTER_MANAGED_DIR})

# Application build; see runner/CMakeLists.txt.
add_subdirectory("runner")

# Generated plugin build rules, which manage building the plugins and adding
# them to the application.
include(flutter/generated_plugins.cmake)

```

--------------------------------

### Configure Flutter managed directory and GTK dependency

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/rendering_test/linux/CMakeLists.txt

Adds the Flutter managed subdirectory and finds the GTK+ 3 package using PkgConfig, required for the Linux desktop build.

```CMake
set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter")
add_subdirectory(${FLUTTER_MANAGED_DIR})
```

```CMake
find_package(PkgConfig REQUIRED)
pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0)
```

--------------------------------

### CMake configuration for rendering_test Windows project

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/rendering_test/windows/CMakeLists.txt

Project-level CMake configuration for the Windows rendering_test application. Sets the binary name, enables modern CMake policies, defines build configurations (Debug, Profile, Release), and applies standard compilation settings with Unicode and C++17.

```cmake
# Project-level configuration.
cmake_minimum_required(VERSION 3.14)
project(rendering_test LANGUAGES CXX)

# The name of the executable created for the application. Change this to change
# the on-disk name of your application.
set(BINARY_NAME "rendering_test")

# Explicitly opt in to modern CMake behaviors to avoid warnings with recent
# versions of CMake.
cmake_policy(SET CMP0063 NEW)

# Define build configuration option.
get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
if(IS_MULTICONFIG)
  set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release"
    CACHE STRING "" FORCE)
else()
  if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
    set(CMAKE_BUILD_TYPE "Debug" CACHE
      STRING "Flutter build mode" FORCE)
    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
      "Debug" "Profile" "Release")
  endif()
endif()
# Define settings for the Profile build mode.
set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}")
set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}")
set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}")
set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}")

# Use Unicode for all projects.
add_definitions(-DUNICODE -D_UNICODE)

# Compilation settings that should be applied to most targets.
#
# Be cautious about adding new options here, as plugins use this function by
# default. In most cases, you should add new options to specific targets instead
# of modifying this function.
function(APPLY_STANDARD_SETTINGS TARGET)
  target_compile_features(${TARGET} PUBLIC cxx_std_17)
  target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100")
  target_compile_options(${TARGET} PRIVATE /EHsc)
  target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0")
  target_compile_definitions(${TARGET} PRIVATE "$<$<CONFIG:Debug>:_DEBUG>")
endfunction()
```

--------------------------------

### Find GTK package using PkgConfig

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/linux/CMakeLists.txt

Finds the PkgConfig package and uses it to locate the GTK+ 3.0 library as an imported target.

```cmake
find_package(PkgConfig REQUIRED)
pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0)
```

--------------------------------

### Configure PiP State Observer and Check Support

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/docs/integration/Picture-in-Picture.md

Registers a state change observer and checks PiP support. Use pipIsSupported() to verify device capability and pipIsAutoEnterSupported() to check if automatic PiP entry is available.

```dart
_pipController.registerPipStateChangedObserver(AgoraPipStateChangedObserver(
  onPipStateChanged: (state, error) {
    // Handle state changes
  },
));

// Check PiP support
var isPipSupported = await _pipController.pipIsSupported();
var isPipAutoEnterSupported = await _pipController.pipIsAutoEnterSupported();
```

--------------------------------

### Android Manifest Permissions for Agora Video SDK

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/README.md

Required permissions for Android to use camera, microphone, and network. Includes Bluetooth permissions for Bluetooth devices and BLUETOOTH_CONNECT for Android 12+.

```xml
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

<!-- The Agora SDK requires Bluetooth permissions in case users are using Bluetooth devices. -->
<uses-permission android:name="android.permission.BLUETOOTH" />
<!-- For Android 12 and above devices, the following permission is also required. -->
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
```

--------------------------------

### Include iris_web Script in index.html

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/README.md

HTML snippet to include the downloaded iris_web JavaScript file in the web/index.html. Replace <x.y.z> with the actual version.

```html
<!-- <your-project>/web/index.html -->
<!DOCTYPE html>
<html>
...
<body>
  ...
  <script src="iris-web-rtc_<x.y.z>.js"></script>
</body>
</html>
```

--------------------------------

### Configure PiP contentViewLayout, videoStreams, and controlStyle in Flutter

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/docs/integration/Picture-in-Picture.md

Sets up the PiP window layout, video streams, and control style for an Agora Flutter app. The contentViewLayout defines a grid (row x column) with padding and spacing, effective only when contentView is 0. The videoStreams array lists local and remote streams with native views; the view property is replaced by the SDK. controlStyle 2 hides playback controls and is recommended for conferencing.

```dart
contentViewLayout: AgoraPipContentViewLayout(
       padding: 0,
       spacing: 2,
       row: 2,
       column: 2,
     ),
```

```dart
videoStreams: [
       AgoraPipVideoStream(
         connection: RtcConnection(
           channelId: 'channelId',
           localUid: 0,
         ),
         canvas: const VideoCanvas(
           uid: 0,
           view: 0, // will be replaced by native view
           sourceType: VideoSourceType.videoSourceCamera,
           setupMode: VideoViewSetupMode.videoViewSetupAdd,
           renderMode: RenderModeType.renderModeHidden,
           // ... other properties
         ),
       ),
       ..._remoteUsers.entries.map((entry) => AgoraPipVideoStream(
             connection: entry.value,
             canvas: VideoCanvas(
                 uid: entry.key,
                 view: 0, // will be replaced by native view
                 sourceType: VideoSourceType.videoSourceRemote,
                 setupMode: VideoViewSetupMode.videoViewSetupAdd,
                 renderMode: RenderModeType.renderModeHidden),
                 // ... other properties
           )),
     ],
```

```dart
controlStyle: 2,
```

--------------------------------

### Project-level CMake configuration for fake_test_app

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/windows/CMakeLists.txt

Sets up the CMake project for the Windows runner of fake_test_app, including minimum CMake version, project name, binary name, and modern CMake policy. Defines build configuration types (Debug, Profile, Release) and profile build settings.

```cmake
# Project-level configuration.
cmake_minimum_required(VERSION 3.14)
project(fake_test_app LANGUAGES CXX)

# The name of the executable created for the application. Change this to change
# the on-disk name of your application.
set(BINARY_NAME "fake_test_app")

# Explicitly opt in to modern CMake behaviors to avoid warnings with recent
# versions of CMake.
cmake_policy(SET CMP0063 NEW)

# Define build configuration option.
get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
if(IS_MULTICONFIG)
  set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release"
    CACHE STRING "" FORCE)
else()
  if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
    set(CMAKE_BUILD_TYPE "Debug" CACHE
      STRING "Flutter build mode" FORCE)
    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS
      "Debug" "Profile" "Release")
  endif()
endif()
# Define settings for the Profile build mode.
set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}")
set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}")
set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}")
set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}")

# Use Unicode for all projects.
add_definitions(-DUNICODE -D_UNICODE)

# Compilation settings that should be applied to most targets.
#
# Be cautious about adding new options here, as plugins use this function by
# default. In most cases, you should add new options to specific targets instead
# of modifying this function.
function(APPLY_STANDARD_SETTINGS TARGET)
  target_compile_features(${TARGET} PUBLIC cxx_std_17)
  target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100")
  target_compile_options(${TARGET} PRIVATE /EHsc)
  target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0")
  target_compile_definitions(${TARGET} PRIVATE "$<$<CONFIG:Debug>:_DEBUG>")
endfunction()

# Flutter library and tool build rules.
set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter")
add_subdirectory(${FLUTTER_MANAGED_DIR})

# Application build; see runner/CMakeLists.txt.
add_subdirectory("runner")

# Generated plugin build rules, which manage building the plugins and adding
# them to the application.
include(flutter/generated_plugins.cmake)

```

--------------------------------

### Configure PiP Options for iOS

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/docs/integration/Picture-in-Picture.md

iOS-specific PiP options. Set autoEnterEnabled for seamless background transition, preferredContentWidth/Height to match your video view size, sourceContentView to the view containing video content for smooth animations (0 uses root view), and contentView to 0 for automatic video stream management.

```dart
AgoraPipOptions options = AgoraPipOptions(
  // Setting autoEnterEnabled to true enables seamless transition to PiP mode when the app enters background,
  // providing the best user experience recommended by both Android and iOS platforms.
  autoEnterEnabled: isPipAutoEnterSupported,

  // Use preferredContentWidth and preferredContentHeight to set the size of the PIP window.
  // These values determine the initial dimensions and can be adjusted while PIP is active.
  // For optimal user experience, we recommend matching these dimensions to your video view size.
  // The system may adjust the final window size to maintain system constraints.
  preferredContentWidth: 1080,
  preferredContentHeight: 720,

  // The sourceContentView determines the source frame for the PiP animation and restore target.
  // Pass 0 to use the app's root view. For optimal animation, set this to the view containing
  // your video content. The system uses this view for the PiP enter/exit animations and as the
  // restore target when returning to the app or stopping PiP.
  sourceContentView: 0,

  // The contentView determines which view will be displayed in the PIP window.
  // If you pass 0, the PIP controller will automatically manage and display all video streams.
  // If you pass a specific view ID, you become responsible for managing the content shown in the PIP window.
  contentView: 0, // force to use native view
);
```

--------------------------------

### Link dependencies to application target

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/linux/CMakeLists.txt

Links the flutter library and the GTK imported target to the application executable.

```cmake
target_link_libraries(${BINARY_NAME} PRIVATE flutter)
target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK)
```

--------------------------------

### Set runtime output directory for binary

Source: https://github.com/agoraio-extensions/agora-flutter-sdk/blob/main/test_shard/fake_test_app/linux/CMakeLists.txt

Configures the CMake target property RUNTIME_OUTPUT_DIRECTORY to place the built binary in a subdirectory named intermediates_do_not_run. This prevents users from running the unbundled copy directly, ensuring resources are in the correct relative locations.

```cmake
set_target_properties(${BINARY_NAME}
  PROPERTIES
  RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/intermediates_do_not_run"
)
```
Tokens:
Raw