Skip to content

Latest commit

 

History

History
228 lines (153 loc) · 8.08 KB

README.md

File metadata and controls

228 lines (153 loc) · 8.08 KB
Raw

@nstudio/nativescript-exoplayer

NativeScript plugin that uses the ExoPlayer video player on Android and AVPlayerViewController on iOS to play local and remote videos.

npm install @nstudio/nativescript-exoplayer

Platform controls used:

Android iOS
Google ExoPlayer iOS AVPlayer

For a 100% NativeScript plugin use the NativeScript-VideoPlayer.

Based on

This is based on the awesome NativeScript-VideoPlayer by Brad Martin (nStudio, llc); the Android side was re-written to use Google's enhanced ExoPlayer. The iOS side is the same thing as what was in the original NativeScript-VideoPlayer.

Since there is a lot of cases where you might still want a 100% NativeScript plugin, Brad and I decided to make this a separate plugin so that you can use the original NativeScript-VideoPlayer for those cases where you want a pure JavaScript plugin.

The Google ExoPlayer adds about a meg and a half plugin to the Android application.

Usage

<Page xmlns="http://schemas.nativescript.org/tns.xsd"
      xmlns:exoplayer="@nstudio/nativescript-exoplayer">
        <StackLayout>

            <exoplayer:Video id="nativeexoplayer"
            controls="true" finished="{{ videoFinished }}"
            loop="true" autoplay="false" height="280"
            src="~/videos/big_buck_bunny.mp4" />

            <!-- Remote file to test with https://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4 -->

        </StackLayout>
</Page>

NativeScript Angular Usage

// somewhere at top of your component or bootstrap file
import { registerElement } from "@nativescript/angular";
import { Video } from '@nstudio/nativescript-exoplayer';
registerElement("Video", () => Video);
  <Video
      src="https://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"
      autoplay="true"
      height="300"></Video>

Properties

  • src - required

Set the video file to play, for best performance use local video files if possible. The file must adhere to the platforms accepted video formats. For reference check the platform specs on playing videos.

  • srcType - (Android Only)
  • 0 = DETECT (from src)
  • 1 = SS
  • 2 = DASH
  • 3 = HLS
  • 4 = OTHER
  • enableSubtitles

By default, subtitle support is off. Use this flag to turn them on.

  • subtitles

Set .srt file with subtitles for given video. This can be local file or internet url. Currently only .srt format is supported.

  • autoplay - (boolean) - optional

Set if the video should start playing as soon as possible or to wait for user interaction.

  • finished - (function) - optional

Attribute to specify an event callback to execute when the video reaches the end of its duration.

  • controls - (boolean) - optional

Set to use the native video player's media playback controls.

  • muted - (boolean) - optional

Mutes the native video player.

  • loop - (boolean) - optional

Sets the native video player to loop once playback has finished.

  • backgroundAudio - (boolean) - optional

If set to true, the audio for the video won't pause any existing audio playing. Instead it will play simultaneously with the existing audio. This is similar to how instagram and facebook play their video audio.

  • fill - (VideoFill) - optional

Android: When set to VideoFill.aspectFill, the aspect ratio of the video will not be honored and it will fill the entire space available.

iOS:

  • VideoFill.default = AVLayerVideoGravityResize
  • VideoFill.aspect = AVLayerVideoGravityResizeAspect
  • VideoFill.aspectFill = AVLayerVideoGravityResizeAspectFill

See here for explanation.

  • playbackReady - (function) - optional

Attribute to specify an event callback to execute when the video is ready to play.

  • seekToTimeComplete - (function) - optional

Attribute to specify an event callback to execute when the video has finished seekToTime.

  • observeCurrentTime - (boolean) - optional

If set to true, currentTimeUpdated callback is possible.

  • currentTimeUpdated - (function) - optional

Attribute to specify an event callback to execute when the time is updated.

  • iosAudioSessionCategory - (string) - optional

(iOS only) Static attribute to specify the device audio session playback category. 'backgroundAudio' on the class instance must be false for this to take effect. Available categories:

  1. AVAudioSessionCategoryAmbient
  2. AVAudioSessionCategoryAudioProcessing
  3. AVAudioSessionCategoryMultiRoute
  4. AVAudioSessionCategoryPlayAndRecord
  5. AVAudioSessionCategoryPlayback
  6. AVAudioSessionCategoryRecord
  7. AVAudioSessionCategorySoloAmbient
  8. AVAudioSessionCategoryAudioProcessing (Deprecated in iOS 10)

Details for these categories can be found on the AVAudioSessionCategory documentation.

Example usage:

import { NgModule } from '@angular/core';
import { Video } from '@nstudio/nativescript-exoplayer';

@NgModule({
  // stuff
})
export class AppModule {
  constructor() {
    Video.iosAudioSessionCategory = 'AVAudioSessionCategoryPlayback';
  }
}

API

  • play() - Start playing the video
  • pause() - Pause the video
  • seekToTime(time: number) - Seek the video to a time (milliseconds)
  • getCurrentTime() - Returns the current time in the video duration (milliseconds)
  • getDuration() - Returns the duration of the video (milliseconds)
  • destroy() - Destroy the video player and free resources
  • mute(boolean) - Mute the current video
  • setVolume() - Set the volume - Must be between 0 and 1.
  • getVideoSize() - On iOS, this will return the size of the presentation layer and on Android, the size of the player view
  • getPlayer() - get the native Player instance

Android only

  • stop() - Stop the playback - this resets the player and remove the video src

Breaking Changes

  • Android will now attach/detach to the application suspend/resume and de-register/re-register video
  • Subtitle support will by default be disabled.

ExoPlayer Encryption (Android only)

Create a key based on the password "secret", outputs salt, key, and iv... (You can redirect to a file if you want)

  • openssl enc -aes-256-ctr -k secret -P --nosalt Will output because we aren't using a salt:
key=2BB80D537B1DA3E38BD30361AA855686BDE0EACD7162FEF6A25FE97BF527A25B
iv =015E42FF678B2B90B743111A396EF850

Normally you would not want to add the --nosalt, but to make this easier to follow as the key & iv will be the same with --nosalt Which would then give you output like this, but every difference in salt you get a different key/iv:

salt=42D57450DAF116BD
key=E8E82C95A1A4FEFE5334578678CAD5699091D34322FDD5811A786BE82961DD00
iv =ED07304DF8D0D0AFA2EB9B13D75BD817

Create the Encrypted video file

  • openssl enc --nosalt -aes-256-ctr -in small.mp4 -out video.enc -K 2BB80D537B1DA3E38BD30361AA855686BDE0EACD7162FEF6A25FE97BF527A25B -iv 015E42FF678B2B90B743111A396EF850
    • you can use -S <your_salt_value> to set the salt value instead of --nosalt

Contributors

License

Apache License Version 2.0