Flutter Kinescope SDK

License

Flutter plugin for the Kinescope player.

This package supports Android and iOS and uses flutter_inappwebview under-the-hood.

Requirements

  • Android: minSdkVersion 17 and add support for androidx (see AndroidX Migration)
  • iOS: --ios-language swift, Xcode version >= 11

Usage

KinescopePlayer(
  controller: KinescopePlayerController(
    yourVideoId,
    parameters: const PlayerParameters(
      autoplay: true,
      muted: true,
      loop: true,
    ),
  ),
  aspectRatio: 16 / 10,
)

Available methods

Methods available for KinescopePlayerController.

MethodDescription
play()Plays the currently cued/loaded video.
pause()Pauses the currently playing video.
stop()Stops and cancels loading of the current video.
load(String videoId)Loads and plays the specified video.
getCurrentTime()Returns current position.
getDuration()Returns duration of video.
seekTo(Duration position)Seeks to a specified time in the video.
mute()Mutes the player.
ummute()Unmutes the player.
setVolume(double volume)Sets the volume of player. Works only on Android.

PlayerParameters

You can set initial Kinescope player parameters using PlayerParameters.

ParameterDescription
autoplaySpecifies whether the initial video will automatically start to play when the player loads. Default = false
mutedMutes the player. Default = true
loopRestart the video automatically after it's ended.
userAgentOverrides default UserAgent
externalIdAny string that represents a user on an external system. It's used in analytics. Default = ''
autofocusSet focus to player. Default = true
autoplayStart playback on load. Default = true
muted
playsinlinePlay video without full screen.
preloadPreload video metadata. Default = true
texttrackEnable subtitles on load.
dntDisable sent analytics.
backgroundDisable any controls. Set autoplay, muted, loop to true
tSeek the video to the time.
transparentTransparent background color.
speedbtnVisibility the playback rate button.
headerVisibility header
controlsVisibility controls.

For a more detailed usage example, go to example.

Installation

Add flutter_kinescope_sdk to your pubspec.yaml file:

dependencies:
  flutter_kinescope_sdk: ^0.1.2

Changelog

All notable changes to this project will be documented in this file.

License

Apache License, Version 2.0

Libraries

flutter_kinescope_sdk