Skip to content

bcc-code/bccm-player

Repository files navigation

BccmPlayer - a flutter video player package

Note: this is not proper open source. See ./LICENSE

This is a video player primarily designed for video-heavy apps that need features like background playback, PiP, casting, analytics, etc.

Used by the apps Bible Kids and BCC Media.

Controls screenshot

Demo on android _ Casting screenshot

Documentation

For all the features to work correctly, it's vital that you read the docs. Documentation: https://bcc-code.github.io/bccm-player/

Difference from video_player/chewie/betterplayer, etc.

A major difference is that BccmPlayer uses hybrid composition platform views to display the video instead of textures. This means the video is rendered in the native view hierarchy without any intermediate steps, which has several benefits:

  • Native video performance
  • Subtitles are rendered by the native player (avplayer/exoplayer)
  • Can use native controls (showControls on [VideoPlatformView])

Platforms

  • iOS
  • Android
  • Web. Some groundwork is there, but it's not complete and it's not supported.

Features

  • Native video via hybrid composition
  • HLS, DASH, MP4 (anything exoplayer and avplayer supports)
  • Chromecast
  • Background playback
  • Picture in picture
  • Notification center
  • Audio track selection
  • Subtitle track selection
  • Fullscreen
  • NPAW/Youbora analytics
  • Metadata
  • HDR content (read HDR in the docs)

Example

import 'package:bccm_player/bccm_player.dart';
import 'package:flutter/material.dart';

class SimplePlayer extends StatefulWidget {
  const SimplePlayer({super.key});

  @override
  State<SimplePlayer> createState() => _SimplePlayerState();
}

class _SimplePlayerState extends State<SimplePlayer> {
  late BccmPlayerController playerController;

  @override
  void initState() {
    // You can also use the global "primary" controller: BccmPlayerController.primary;
    // The primary player has superpowers like notification player, background playback, casting, etc.
    playerController = BccmPlayerController(
      MediaItem(
        url: 'https://devstreaming-cdn.apple.com/videos/streaming/examples/adv_dv_atmos/main.m3u8',
        mimeType: 'application/x-mpegURL',
        metadata: MediaMetadata(title: 'Apple advanced (HLS/HDR)'),
      ),
    );
    playerController.initialize().then((_) => playerController.setMixWithOthers(true)); // if you want to play together with other videos
    super.initState();
  }

  @override
  void dispose() {
    playerController.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return ListView(
      children: [
        Column(
          children: [
            BccmPlayerView(
              playerController,
              //config: BccmPlayerViewConfig()
            ),
            ElevatedButton(
              onPressed: () {
                playerController.setPrimary();
              },
              child: const Text('Make primary'),
            ),
            ElevatedButton(
              onPressed: () {
                final currentMs = playerController.value.playbackPositionMs;
                if (currentMs != null) {
                  playerController.seekTo(Duration(milliseconds: currentMs + 20000));
                }
              },
              child: const Text('Skip 20 seconds'),
            ),
          ],
        ),
      ],
    );
  }
}