Giter VIP home page Giter VIP logo

nativescript-videoplayer's Introduction

npm npm

NativeScript Video Player ๐ŸŽฌ

A NativeScript plugin to provide the ability to play local and remote videos.

Platform controls used:

Android iOS
Android VideoView iOS AVPlayer

Sample Usage

            Sample 1             |              Sample 2

-------------------------------------| ------------------------------------- Sample Usage | Sample 2

Installation

From your command prompt/terminal go to your app's root folder and execute:

tns plugin add nativescript-videoplayer

Usage

<Page xmlns="http://schemas.nativescript.org/tns.xsd"
      xmlns:VideoPlayer="nativescript-videoplayer">
        <StackLayout>
               
            <VideoPlayer:Video id="nativeVideoPlayer"
            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>

Angular Native (NativeScript Angular) Usage

// somewhere at top of your component or bootstrap file
import {registerElement} from "nativescript-angular/element-registry";
registerElement("VideoPlayer", () => require("nativescript-videoplayer").Video);
// documentation: https://docs.nativescript.org/angular/plugins/angular-third-party.html#simple-elements

With AngularNative you have to explicitly close all components so the correct template code is below.

  <VideoPlayer
      src="https://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"
      autoplay="true" 
      height="300"></VideoPlayer>

Attributes

  • 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.

  • 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.

  • loadingComplete - (function) - optional ANDROID ONLY

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

  • seekToTimeComplete - (function) - optional IOS ONLY

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

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

Android only

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

Contributors

nativescript-videoplayer's People

Contributors

bradmartin avatar bnussey avatar alexziskind1 avatar juanmcampos avatar nathanaela avatar ivshti avatar

Watchers

James Cloos avatar AngularNinja.com avatar  avatar

Forkers

deadbrainviv

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.