aws_ivs_realtime 0.1.0

Flutter plugin for Amazon IVS Real-Time (Stages): native stage video grid, optional SigV4 control-plane helpers, and IVS Chat WebSocket session utilities.

aws_ivs_realtime

Flutter plugin for Amazon IVS Real-Time (Stages) on Android and iOS, with Dart helpers for:

• Native stage MethodChannel + platform view (join / leave / setPublish / mute)
• Optional SigV4 control plane (IvsAwsSigV4ControlPlane) or your backend by implementing IvsLiveControlPlane
• IVS Chat WebSocket session (IvsChatSession)
• Runtime microphone/camera requests via permission_handler

Repository: github.com/vipulbansal/aws_ivs_realtime · Issues: github.com/vipulbansal/aws_ivs_realtime/issues

Requirements

Platform	Minimum	Notes
Android	API 28	RECORD_AUDIO, CAMERA when publishing
iOS	14.0	NSMicrophoneUsageDescription, NSCameraUsageDescription

Native SDKs: Android Maven ivs-broadcast stages AAR (1.41.0 in this repo); iOS CocoaPods AmazonIVSBroadcast/Stages (~> 1.36.0 in the podspec—align when CocoaPods publishes newer series).

Install

From pub.dev (when published):

dependencies:
  aws_ivs_realtime: ^0.1.0

From Git:

dependencies:
  aws_ivs_realtime:
    git:
      url: https://github.com/vipulbansal/aws_ivs_realtime.git

Android

Merge permissions into your app AndroidManifest.xml (see example/android/app/src/main/AndroidManifest.xml).

iOS

Set usage strings in Info.plist (see example/ios/Runner/Info.plist). In your Podfile, use at least iOS 14 and, if CocoaPods requires it, use_modular_headers! (see example/ios/Podfile).

permission_handler on iOS: you must add preprocessor flags so microphone/camera code is compiled into permission_handler_apple; otherwise Permission.microphone / Permission.camera never show the system dialog. Copy the GCC_PREPROCESSOR_DEFINITIONS block from example/ios/Podfile post_install (PERMISSION_MICROPHONE=1, PERMISSION_CAMERA=1).

Usage

import 'package:aws_ivs_realtime/aws_ivs_realtime.dart';

final stage = IvsRealtimePlatform();
await stage.join(token: participantToken, publish: isHost);

// Platform view:
AndroidView(viewType: AwsIvsRealtimePlatformView.viewType, ...)
// or UiKitView on iOS with the same viewType.

See the example/ app for a full lobby, full-screen live, and chat demo, including SigV4 (client-side) vs backend control plane wiring.

Documentation

For architecture, channel contract, token flow, and troubleshooting, see DOCUMENTATION.md.

Contributing

Issues and pull requests are welcome in vipulbansal/aws_ivs_realtime.

Publishing (maintainers)

To publish this package on pub.dev, set homepage, repository, and issue_tracker in pubspec.yaml (and the podspec homepage if needed) to real URLs, then from the package root run dart pub publish. Do not ship IAM credentials in example or app code.

License

See LICENSE.