@picsa/capacitor-video-player 7.1.0

package/dist/esm/definitions.d.ts

@@ -0,0 +1,322 @@
+import { PluginListenerHandle } from '@capacitor/core';
+export interface CapacitorVideoPlayerPlugin {
+    /**
+     * Echo
+     *
+     */
+    echo(options: capEchoOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Initialize a video player
+     *
+     */
+    initPlayer(options: capVideoPlayerOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Return if a given playerId is playing
+     *
+     */
+    isPlaying(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Play the current video from a given playerId
+     *
+     */
+    play(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Pause the current video from a given playerId
+     *
+     */
+    pause(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Get the duration of the current video from a given playerId
+     *
+     */
+    getDuration(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Get the current time of the current video from a given playerId
+     *
+     */
+    getCurrentTime(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Set the current time to seek the current video to from a given playerId
+     *
+     */
+    setCurrentTime(options: capVideoTimeOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Get the volume of the current video from a given playerId
+     *
+     */
+    getVolume(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Set the volume of the current video to from a given playerId
+     *
+     */
+    setVolume(options: capVideoVolumeOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Get the muted of the current video from a given playerId
+     *
+     */
+    getMuted(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Set the muted of the current video to from a given playerId
+     *
+     */
+    setMuted(options: capVideoMutedOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Set the rate of the current video from a given playerId
+     *
+     */
+    setRate(options: capVideoRateOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Get the rate of the current video from a given playerId
+     *
+     */
+    getRate(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;
+    /**
+     * Stop all players playing
+     *
+     */
+    stopAllPlayers(): Promise<capVideoPlayerResult>;
+    /**
+     * Show controller
+     *
+     */
+    showController(): Promise<capVideoPlayerResult>;
+    /**
+     * isControllerIsFullyVisible
+     *
+     */
+    isControllerIsFullyVisible(): Promise<capVideoPlayerResult>;
+    /**
+     * Exit player
+     *
+     */
+    exitPlayer(): Promise<capVideoPlayerResult>;
+    /**
+     * Register event listener
+     */
+    addListener(event: VideoEventName, callback: (e: capVideoListener) => void): Promise<PluginListenerHandle>;
+    /**
+     * Register event listener
+     */
+    addListener(event: 'jeepCapVideoPlayerExit', callback: (e: capVideoListenerExit) => void): Promise<PluginListenerHandle>;
+    removeAllListeners(): Promise<void>;
+}
+export interface capEchoOptions {
+    /**
+     *  String to be echoed
+     */
+    value?: string;
+}
+export interface capVideoPlayerOptions {
+    /**
+     * Player mode
+     *  - "fullscreen"
+     *  - "embedded" (Web only)
+     */
+    mode?: string;
+    /**
+     * The url of the video to play
+     */
+    url?: string;
+    /**
+     * The url of subtitle associated with the video
+     */
+    subtitle?: string;
+    /**
+     * The language of subtitle
+     * see https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers
+     */
+    language?: string;
+    /**
+     * SubTitle Options
+     */
+    subtitleOptions?: SubTitleOptions;
+    /**
+     * Id of DIV Element parent of the player
+     */
+    playerId?: string;
+    /**
+     * Initial playing rate
+     */
+    rate?: number;
+    /**
+     * Exit on VideoEnd (iOS, Android)
+     * default: true
+     */
+    exitOnEnd?: boolean;
+    /**
+     * Loop on VideoEnd when exitOnEnd false (iOS, Android)
+     * default: false
+     */
+    loopOnEnd?: boolean;
+    /**
+     * Picture in Picture Enable (iOS, Android)
+     * default: true
+     */
+    pipEnabled?: boolean;
+    /**
+     * Background Mode Enable (iOS, Android)
+     * default: true
+     */
+    bkmodeEnabled?: boolean;
+    /**
+     * Show Controls Enable (iOS, Android)
+     * default: true
+     */
+    showControls?: boolean;
+    /**
+     * Display Mode ["all", "portrait", "landscape"] (iOS, Android)
+     * default: "all"
+     */
+    displayMode?: string;
+    /**
+     * Component Tag or DOM Element Tag (React app)
+     */
+    componentTag?: string;
+    /**
+     * Player Width (mode "embedded" only)
+     */
+    width?: number;
+    /**
+     * Player height (mode "embedded" only)
+     */
+    height?: number;
+    /**
+     * Headers for the request (iOS, Android)
+     * by Manuel García Marín (https://github.com/PhantomPainX)
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * Title shown in the player (Android)
+     * by Manuel García Marín (https://github.com/PhantomPainX)
+     */
+    title?: string;
+    /**
+     * Subtitle shown below the title in the player (Android)
+     * by Manuel García Marín (https://github.com/PhantomPainX)
+     */
+    smallTitle?: string;
+    /**
+     * ExoPlayer Progress Bar and Spinner color (Android)
+     * by Manuel García Marín (https://github.com/PhantomPainX)
+     * Must be a valid hex color code
+     * default: #FFFFFF
+     */
+    accentColor?: string;
+    /**
+     * Chromecast enable/disable (Android)
+     * by Manuel García Marín (https://github.com/PhantomPainX)
+     * default: true
+     */
+    chromecast?: boolean;
+    /**
+     * Artwork url to be shown in Chromecast player
+     * by Manuel García Marín (https://github.com/PhantomPainX)
+     * default: ""
+     */
+    artwork?: string;
+}
+export interface capVideoPlayerIdOptions {
+    /**
+     * Id of DIV Element parent of the player
+     */
+    playerId?: string;
+}
+export interface capVideoRateOptions {
+    /**
+     * Id of DIV Element parent of the player
+     */
+    playerId?: string;
+    /**
+     * Rate value
+     */
+    rate?: number;
+}
+export interface capVideoVolumeOptions {
+    /**
+     * Id of DIV Element parent of the player
+     */
+    playerId?: string;
+    /**
+     * Volume value between [0 - 1]
+     */
+    volume?: number;
+}
+export interface capVideoTimeOptions {
+    /**
+     * Id of DIV Element parent of the player
+     */
+    playerId?: string;
+    /**
+     * Video time value you want to seek to
+     */
+    seektime?: number;
+}
+export interface capVideoMutedOptions {
+    /**
+     * Id of DIV Element parent of the player
+     */
+    playerId?: string;
+    /**
+     * Muted value true or false
+     */
+    muted?: boolean;
+}
+export interface capVideoListener {
+    /**
+     * Id of DIV Element parent of the player
+     */
+    fromPlayerId?: string;
+    /**
+     * Video current time when listener trigerred
+     */
+    currentTime?: number;
+}
+export interface capVideoListenerExit {
+    dismiss?: boolean;
+    currentTime: number;
+}
+export interface capExitListener {
+    /**
+     * Dismiss value true or false
+     */
+    dismiss?: boolean;
+    /**
+     * Video current time when listener trigerred
+     */
+    currentTime?: number;
+}
+export interface capVideoPlayerResult {
+    /**
+     * result set to true when successful else false
+     */
+    result?: boolean;
+    /**
+     * method name
+     */
+    method?: string;
+    /**
+     * value returned
+     */
+    value?: any;
+    /**
+     * message string
+     */
+    message?: string;
+}
+export interface SubTitleOptions {
+    /**
+     * Foreground Color in RGBA (default rgba(255,255,255,1)
+     */
+    foregroundColor?: string;
+    /**
+     * Background Color in RGBA (default rgba(0,0,0,1)
+     */
+    backgroundColor?: string;
+    /**
+     * Font Size in pixels (default 16)
+     */
+    fontSize?: number;
+}
+export type VideoEventName = 'jeepCapVideoPlayerReady' | 'jeepCapVideoPlayerPlay' | 'jeepCapVideoPlayerPause' | 'jeepCapVideoPlayerEnded';

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":""}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { CapacitorVideoPlayerPlugin } from './definitions';
+declare const CapacitorVideoPlayer: CapacitorVideoPlayerPlugin;
+export * from './definitions';
+export { CapacitorVideoPlayer };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const CapacitorVideoPlayer = registerPlugin('CapacitorVideoPlayer', {
+    web: () => import('./web').then(m => new m.CapacitorVideoPlayerWeb()),
+});
+export * from './definitions';
+export { CapacitorVideoPlayer };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,oBAAoB,GAAG,cAAc,CACzC,sBAAsB,EACtB;IACE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,uBAAuB,EAAE,CAAC;CACtE,CACF,CAAC;AAEF,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/esm/web-utils/video-types.d.ts

@@ -0,0 +1,16 @@
+export type videoExtension = keyof typeof videoTypes;
+export type videoMimeType = (typeof videoTypes)[videoExtension];
+export declare const videoTypes: {
+    readonly mp4: "video/mp4";
+    readonly webm: "video/webm";
+    readonly cmaf: "video/mp4";
+    readonly cmfv: "video/mp4";
+    readonly m3u8: "application/x-mpegURL";
+    readonly ogg: "video/ogg";
+    readonly ogv: "video/ogg";
+    readonly mov: "video/quicktime";
+    readonly avi: "video/x-msvideo";
+    readonly mkv: "video/x-matroska";
+    readonly flv: "video/x-flv";
+    readonly wmv: "video/x-ms-wmv";
+};

package/dist/esm/web-utils/video-types.js

@@ -0,0 +1,15 @@
+export const videoTypes = {
+    mp4: 'video/mp4',
+    webm: 'video/webm',
+    cmaf: 'video/mp4',
+    cmfv: 'video/mp4',
+    m3u8: 'application/x-mpegURL',
+    ogg: 'video/ogg',
+    ogv: 'video/ogg',
+    mov: 'video/quicktime',
+    avi: 'video/x-msvideo',
+    mkv: 'video/x-matroska',
+    flv: 'video/x-flv',
+    wmv: 'video/x-ms-wmv',
+};
+//# sourceMappingURL=video-types.js.map

package/dist/esm/web-utils/video-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"video-types.js","sourceRoot":"","sources":["../../../src/web-utils/video-types.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,GAAG,EAAE,WAAW;IAChB,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,uBAAuB;IAC7B,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,aAAa;IAClB,GAAG,EAAE,gBAAgB;CACb,CAAC"}

package/dist/esm/web-utils/videoplayer.d.ts

@@ -0,0 +1,30 @@
+export declare class VideoPlayer {
+    videoEl: HTMLVideoElement | undefined;
+    pipMode: boolean;
+    pipWindow: Window | undefined;
+    isPlaying: boolean | undefined;
+    private _url;
+    private _playerId;
+    private _container;
+    private _mode;
+    private _width;
+    private _height;
+    private _zIndex;
+    private _initial;
+    private _videoType;
+    private _videoContainer;
+    private _firstReadyToPlay;
+    private _isEnded;
+    private _videoRate;
+    private _videoExitOnEnd;
+    private _videoLoopOnEnd;
+    constructor(mode: string, url: string, playerId: string, rate: number, exitOnEnd: boolean, loopOnEnd: boolean, container: any, zIndex: number, width?: number, height?: number);
+    initialize(): Promise<void>;
+    private createVideoElement;
+    private _goFullscreen;
+    private _setPlayer;
+    private _getVideoType;
+    private _doHide;
+    private _createEvent;
+    private _closeFullscreen;
+}