パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v0.0.5

flutter_live_activities

ライブアクティビティ用のFlutterプラグイン。[ダイナミックアイランドUI]および[ロック画面/バナーUI]の作成、更新、アクション処理に使用します

iOS
30日間ダウンロード
1630
いいね数
47
Pub ポイント
150

パッケージをインストール

flutter pub add flutter_live_activities

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

iOSでライブアクティビティを作成および管理できるFlutterプラグインで、Dynamic Islandとロック画面/バナーUIの両方をサポートしています。リアルタイムでの更新とアクションを通じたユーザーインタラクションを可能にし、ユーザーのホーム画面またはロック画面にダイナミックでインタラクティブなコンテンツを直接表示することで、アプリのエンゲージメントを高めます。このプラグインは、iOSデバイス向けのFlutterアプリにシームレスに統合されます。

用途

  • リアルタイム追跡表示
  • ライブスポーツスコアの更新
  • 音楽再生コントロール
  • ライドシェアリングのステータス更新
  • 配達進捗のお知らせ

主な機能

  • ダイナミックアイランド対応
  • ロック画面/バナー統合
  • リアルタイムのアクティビティ更新
  • ユーザー操作に対する処理
  • iOS専用プラットフォーム互換性

適している対象

  • リアルタイムのステータス更新を必要とするアプリ
  • フィットネスとナビゲーションアプリ
  • メディアおよびエンターテインメントアプリ
  • ライドシェアリングおよび配達サービス
  • インタラクティブなiOS最優先のアプリケーション

注意事項

  • iOS専用 – Android対応なし
  • iOS 16+ を必要とします
  • Appleのライブアクティビティフレームワークに限定
  • 継続的な更新によるバッテリーへの影響
  • バックグラウンド実行の適切な処理が必要です

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Flutter Live Activities

Flutter plugin for Live Activities. Use to create, update and handling action for [DynamicIsland UI] and [Lock screen/banner UI]

English | 中文说明

pub package GitHub stars GitHub forks FlutterCandies

This plugin requires notification permission

1. Add a Widget to the iOS project
  • Directory structure
2. Edit Runner/Info.plist and live_activity_test/Info.plist

both add:

<plist version="1.0">
<dict>
    ...
	<key>NSSupportsLiveActivities</key>
	<true/>
    ...
</dict>
</plist>
3. Create a data channel in widget swift file

live_activity_test/live_activity_testLiveActivity.swift

import ActivityKit
import SwiftUI
import WidgetKit

// Custom data model
struct TestData {
    var text: String

    init?(JSONData data: [String: String]) {
        self.text = data["text"] ?? ""
    }

    init(text: String) {
        self.text = text
    }
}

// Data channel  <-  Must!
struct FlutterLiveActivities: ActivityAttributes, Identifiable {
    public typealias LiveData = ContentState

    public struct ContentState: Codable, Hashable {
        var data: [String: String]
    }

    var id = UUID()
}

@available(iOSApplicationExtension 16.1, *)
struct live_activity_testLiveActivity: Widget {
    var body: some WidgetConfiguration {
        // Binding
        ActivityConfiguration(for: FlutterLiveActivities.self) { context in

            // Lock screen/banner UI goes here

            // Json to model
            let data = TestData(JSONData: context.state.data)

            // UI
            VStack {
                Text(data?.text ?? "")
            }
            .activityBackgroundTint(Color.cyan)
            .activitySystemActionForegroundColor(Color.black)
        } dynamicIsland: { context in
            // Json to model
            let data = TestData(JSONData: context.state.data)

            // DynamicIsland
            return DynamicIsland {
                // Expanded UI goes here.  Compose the expanded UI through
                // various regions, like leading/trailing/center/bottom
                DynamicIslandExpandedRegion(.leading) {
                    Text("Leading")
                }
                DynamicIslandExpandedRegion(.trailing) {
                    Text("Trailing")
                }
                DynamicIslandExpandedRegion(.bottom) {
                    // Show data from flutter
                    Text(data?.text ?? "")
                }
            } compactLeading: {
                Text("L")
            } compactTrailing: {
                Text("T")
            } minimal: {
                Text("Min")
            }
            .keylineTint(Color.red)
        }
    }
}

For more layout information, please refer to: live activities

4. APIs
import 'package:flutter_live_activities/flutter_live_activities.dart';

...

final FlutterLiveActivities _liveActivities = FlutterLiveActivities();

String? _activityId;
  • Check if the Live Activities function is enabled
await _liveActivities.areActivitiesEnabled();
  • Get launch url
await _liveActivities.getInitUri()
  • Create a Live Activity
_activityId = await _liveActivities.createActivity(<String, String>{'text': 'Hello World'});
  • Update a Live Activity
if(_activityId != null) {
    await _liveActivities.updateActivity(_activityId!, <String, String>{'text': 'Update Hello World'});
}

The updated dynamic data for both ActivityKit updates and remote push notification updates can’t exceed 4KB in size. doc

For more solutions, please refer to live_activities

  • End a Live Activity
if(_activityId != null) {
    await _liveActivities.endActivity(_activityId!);
}
  • End all Live Activities
await _liveActivities.endAllActivities();
  • Get all Live Activities id
await _liveActivities.getAllActivities()
5. Deeplink
  • The default urlScheme is fla

FlutterLiveActivities({this.urlScheme = 'fla'})

  • Add urlScheme in your project
  • Swift code:
@available(iOSApplicationExtension 16.1, *)
struct live_activity_testLiveActivity: Widget {
    var body: some WidgetConfiguration {
        ActivityConfiguration(for: FlutterLiveActivities.self) { context in
            let data = TestData(JSONData: context.state.data)

            // Lock screen/banner UI goes here

            VStack(alignment: .leading) {
                Text(data?.text ?? "")
                HStack {
                    // Create an action via `Link`
                    Link(destination: URL(string: "fla://xx.xx/tap/A")!) {
                        Text("A")
                            .frame(width: 40, height: 40)
                            .background(.blue)
                    }
                    // Create an action via `Link`
                    Link(destination: URL(string: "fla://xx.xx/tap/B")!) {
                        Text("B")
                            .frame(width: 40, height: 40)
                            .background(.blue)
                    }
                    // Create an action via `Link`
                    Link(destination: URL(string: "fla://xx.xx/tap/C")!) {
                        Text("C")
                            .frame(width: 40, height: 40)
                            .background(.blue)
                    }
                }
                .frame(width: .infinity, height: .infinity)
            }
            .padding(20)
            .activityBackgroundTint(Color.cyan)
            .activitySystemActionForegroundColor(Color.black)

        } dynamicIsland: { context in

            let data = TestData(JSONData: context.state.data)

            return DynamicIsland {
                DynamicIslandExpandedRegion(.bottom) {
                    // Create an action via `Link`
                    Link(destination: URL(string: "fla://xxxxxxx.xxxxxx")!) {
                        Text(data?.text ?? "")
                            .background(.red)
                    }
                }
            } compactLeading: {
                Text("L")
            } compactTrailing: {
                Text("T")
            } minimal: {
                Text("Min")
            }
            .widgetURL(URL(string: "fla://www.apple.com")) // or use widgetURL
            .keylineTint(Color.red)
        }
    }
}
  • Dart code:
_subscription ??= _liveActivities.uriStream().listen((String? uri) {
    dev.log('deeplink uri: $uri');
});
6. Display image

Due to block size limitations. We can't send metadata to LiveActivities

LiveActivities does not support async loading, so we can't use AsyncImage or read local file

Solution from Developer Forums: 716902

  • Add group config (Paid account required)
  • Add group id both Runner and Widget
  • Send image to group:

Dart code:

Future<void> _sendImageToGroup() async {
    const String url = 'https://cdn.iconscout.com/icon/free/png-256/flutter-2752187-2285004.png';

    final String? path = await ImageHelper.getFilePathFromUrl(url);

    if (path != null) {
        _liveActivities.sendImageToGroup(
            id: 'test-img',
            filePath: path,
            groupId: 'group.live_example',
        );
    }
}

Swift code:

DynamicIslandExpandedRegion(.leading) {
    if let imageContainer = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: "group.live_example")?.appendingPathComponent("test-img"), /// Use id here
        let uiImage = UIImage(contentsOfFile: imageContainer.path())
    {
        Image(uiImage: uiImage)
            .resizable()
            .frame(width: 53, height: 53)
            .cornerRadius(13)
    } else {
        Text("Leading")
    }
}

カテゴリー

依存関係

依存関係一覧 1 件

  • plugin_platform_interface^2.0.2

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。