amphitheatre 0.0.3

A Flutter video player and editor.

amphitheatre

A Flutter video player and editor.

Amphitheatre	AmphitheatreEditor

	Android	iOS
Supported Versions	SDK 21+	13.0+ *
Supported Devices (as of Jan 3, 2025)	99.7%	96.8%

* NB: support for older versions can be implemented if needed, it has been omitted at present for simplicity of the platform channel implementation.

Quick Start

First, refer to Setup for the video_player package to ensure the media can be played from your desired source.

Then, construct an Amphitheatre. For convenience, you can use the Amphitheatre.launch function to simply launch a new screen with the player:

/// Launches a screen with the Amphitheatre video player.
void showVideo({ required final File myVideo }) {
  Amphitheatre.launch(
    context,
    controller: AmphitheatreController(
      controller: VideoPlayerController.file(myVideo),
      info: AmphitheatreVideoInfo(
        title: "Title of the video",
        subtitle: "This is a subtitle.",
        description:
        "This is a long form description of the video. Lorem ipsum dolor sit amet.",
      ),
    ),
  );
}

...and similarly for the editor:

/// Launchers a screen with the Amphitheatre editor.
/// 
/// Returns a path to the output file (with the edited video)
/// on success, returns null on failure (or if the user closes
/// the screen without accepting changes).
Future<String?> editVideo({ required final File myVideo }) async {
  return await AmphitheatreEditor.launch(
    context,
    controller: AmphitheatreController(
      controller: VideoPlayerController.file(
        _chosenVideo!,
      ),
    ),
  );
}

Alternatively, you can either use Amphitheatre.consume to have Amphitheatre assume control of an AmphitheatreController that you pass in - or you can simply use Amphitheatre with a controller that you manage as part of your own widget's lifecycle (and likewise with the AmphitheatreEditor).

Localization (l10n) Support

This package has built-in support for flutter_localizations, with the long-term goal of getting any community-sourced localizations merged into this repository so that applications can benefit from them automatically. (PRs welcome!)

We will provide our own 'official' localizations for the package if we write our own, which will be done on an 'as-needed' basis and will aim to review/merge community translations on a 'best-effort' basis.

To activate the library's localization, add the AmphitheatreLocalization delegate to your MaterialApp:

void main() {
  runApp(
    MaterialApp(
      home: const MyAppHome(),
      debugShowCheckedModeBanner: false,
      
      // Add this property:
      localizationsDelegates: [
        // This adds the AmphitheatreLocalizations delegate.
        AmphitheatreLocalizations.delegate,
        // This ensures you retain Flutter's built-in localization.
        // See here for details:
        // https://docs.flutter.dev/ui/accessibility-and-internationalization/internationalization
        ...GlobalMaterialLocalizations.delegates,
      ],
    ),
  );
}

Development

Adding translations

Don't forget to run the following command after updating any of the .arb files:

flutter gen-l10n