shareplay 1.0.1

shareplay: ^1.0.1 copied to clipboard

A Flutter plugin to use iOS 15.0+ real-time connection SharePlay on a FaceTime call 🎥.

🧐 What is it ? #

This plugin use official iOS GroupActivities API.

share_play can be used to communicate data over devices in a Flutter apps using iOS SharePlay features.

Why using iOS SharePlay?

• ⚡️ It's fast.
• 🍀 Reliable (using Apple server).
• 💰 It's "free" (including in your paid Apple Developer subscription).
• 😌 Very easy to implement (in 3 lines of code you can share data!).
• 🙌 Works accros iOS, macOS & tvOS.

⚠️ share_play is only intended to use with iOS 15.0+! It will simply do nothing on other platform & < iOS 15.0

👻 Getting started #

ℹ️ You can check into the example repository for a full example.

• Open the Xcode workspace project ios/Runner.xcworkspace.
• Enable "Group Activities" capabilities on the main Runner app.

• Import share_play & create an instance of the Plugin.

import 'package:shareplay/shareplay.dart';

// [...]

final _shareplayPlugin = SharePlay();

ℹ️ Quick start #

• Add listener when a new message is received (in initState() method for ex).

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

  _shareplayPlugin.dataStream().listen((data) {
    // do what you want here :)
  });
}

• Start a new activity 🏁.

_shareplayPlugin.start(title: 'My Activity');

• Join activity from another device 📲.

_shareplayPlugin.join();

ℹ️ By tapping on the SharePlay banner on top of the screen, you don't need to call join() method!

• Send your first message.

_shareplayPlugin.send('Hello from Flutter');

ℹ️ For more, check documentation below or example.

📘 Documentation #

👥 Contributions #

Contributions are welcome. Contribute by creating a PR or create an issue 🎉.

🎯 Roadmap #

• Add method to check if SharePlay is available.
• Display a custom error when SharePlay is not available on older iOS version.
• Implement prepareForActivation() method.
• Create stream to handle message data & new session created.
• Get local data like participant & session state.
• Leave & end activity.
• Send a message accros SharePlay.
• Join an activity.
• Start a new activity.