Flutter屏幕共享插件imin_vice_screen的使用

Flutter屏幕共享插件imin_vice_screen的使用

imin_vice_screen 是一个用于在Android平台上使用imin屏幕共享SDK的Flutter插件。

资源

• Pub Package
• GitHub Repository

平台支持

开始使用

安装

在 pubspec.yaml 文件中添加依赖：

dependencies:
  imin_vice_screen: ^0.0.1

或者直接运行命令：

flutter pub add imin_vice_screen

示例文件夹

查看 example 文件夹以获取完整的示例代码。

如何使用

1. 在主入口区分主屏和副屏

void main() {
  var defaultRouteName = window.defaultRouteName;
  if ("viceMain" == defaultRouteName) {
    viceScreenMain(); 
  } else {
    defaultMain();
  }
}

// 主屏UI
void defaultMain() {
  runApp(MainApp());
}

// 副屏UI
void viceScreenMain() {
  runApp(SubApp());
}

2. 使用封装能力在主屏和副屏之间通信

2.1 主屏到副屏

import 'package:imin_vice_screen/imin_vice_screen.dart';
final _iminViceScreenPlugin = IminViceScreen();

/// 发送消息
_iminViceScreenPlugin.sendMsgToViceScreen("data", params: {"params": "123"});

/// 接收副屏消息
_iminViceScreenPlugin.mainStream.listen((event) {
  print("主屏接收数据: ${event}");
});

2.2 副屏到主屏

import 'package:imin_vice_screen/imin_vice_screen.dart';
final _iminViceScreenPlugin = IminViceScreen();

/// 发送消息
_iminViceScreenPlugin.sendMsgToMainScreen("data", params: {"params": "456"});

/// 接收主屏消息
_iminViceScreenPlugin.viceStream.listen((event) {
  print("副屏接收数据: ${event}");
});

3. 检查是否支持双屏

bool isSupportMultipleScreen = await _iminViceScreenPlugin.isMultipleScreen();
print("是否支持多屏: $isSupportMultipleScreen");

4. 检查当前应用是否有悬浮窗口权限

bool checkOverlayPermission = await _iminViceScreenPlugin.checkOverlayPermission();
print("检查悬浮窗口权限: $checkOverlayPermission");

5. 请求悬浮窗口权限以设置副屏为持久窗口

await _iminViceScreenPlugin.requestOverlayPermission();

6. 打开和关闭副屏

await _iminViceScreenPlugin.doubleScreenOpen(); /// 打开
await _iminViceScreenPlugin.doubleScreenClose(); /// 关闭

初始化完成后副屏显示

在 android/values/attrs.xml 中添加配置：

<!-- 是否在初始化时自动显示副屏 -->
<bool name="autoShowSubScreenWhenInit">true</bool>

LCD副屏显示

1. LCD初始化

import 'package:imin_vice_screen/enums.dart';
import 'package:imin_vice_screen/imin_vice_screen.dart';
final iminViceScreenPlugin = IminViceScreen();

await iminViceScreenPlugin.sendLCDCommand(LCDCommand.initLCD); // 初始化LCD
await iminViceScreenPlugin.sendLCDCommand(LCDCommand.wakeLCD); // 唤醒LCD
await iminViceScreenPlugin.sendLCDCommand(LCDCommand.sleepLCD); // 睡眠LCD
await iminViceScreenPlugin.sendLCDCommand(LCDCommand.cleanScreenLCD); // 清屏

2. 发送字符串在副屏上显示

import 'package:imin_vice_screen/imin_vice_screen.dart';
final iminViceScreenPlugin = IminViceScreen();

await iminViceScreenPlugin.sendLCDString('你好世界');

3. 发送字符串在副屏上显示

import 'package:imin_vice_screen/imin_vice_screen.dart';
final iminViceScreenPlugin = IminViceScreen();

await iminViceScreenPlugin.sendLCDString('你好世界');

4. 发送多行副屏内容字符串

import 'package:imin_vice_screen/imin_vice_screen.dart';
final iminViceScreenPlugin = IminViceScreen();

await iminViceScreenPlugin.sendLCDMultiString(
  contents: ["很高兴见到你", "Des", "Hi"],
  aligns: [0, 1, 2]
);

5. 发送两行副屏内容字符串

import 'package:imin_vice_screen/imin_vice_screen.dart';
final iminViceScreenPlugin = IminViceScreen();

await iminViceScreenPlugin.sendLCDDoubleString(
  topText: '顶部内容',
  bottomText: '底部内容'
);

6. 发送图片在副屏上显示

import 'package:imin_vice_screen/imin_vice_screen.dart';
final iminViceScreenPlugin = IminViceScreen();

// 使用字节
Uint8List byte = await readFileBytes('assets/images/logo.png');
await iminViceScreenPlugin.sendLCDBitmap(byte);

// 或者使用URL
await iminViceScreenPlugin.sendLCDBitmap(
  'https://oss-sg.imin.sg/web/iMinPartner2/images/logo.png',
  pictureStyle: IminPictureStyle(
    width: 240,
    height: 320,
  )
);

7. 设置字体大小

import 'package:imin_vice_screen/imin_vice_screen.dart';
final iminViceScreenPlugin = IminViceScreen();

await iminViceScreenPlugin.setTextSize(15);

示例代码

import 'package:flutter/material.dart';
import 'pages/lcd_home.dart';
import 'pages/main_home.dart';
import 'pages/sub_home.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});
  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  bool hasSubSreen = false;

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      onGenerateRoute: (RouteSettings routeSettings) {
        return MaterialPageRoute<void>(
          settings: routeSettings,
          builder: (BuildContext context) {
            if (routeSettings.name == 'viceMain') {
              hasSubSreen = true;
              switch (routeSettings.name) {
                case SubHome.routeName:
                default:
                  return const SubHome();
              }
            } else {
              switch (routeSettings.name) {
                case MainHome.routeName:
                default:
                  return hasSubSreen ? const MainHome() : const LCDHome();
              }
            }
          },
        );
      },
    );
  }
}