@capgo/capacitor-video-player 7.0.0

package/dist/esm/definitions.d.ts

@@ -0,0 +1,307 @@
+export interface VideoPlayerPlugin {
+    /**
+     * 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>;
+}
+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
+     */
+    playerId?: string;
+    /**
+     * Video current time when listener trigerred
+     */
+    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;
+}

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

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const VideoPlayer = registerPlugin('VideoPlayer', {
+    web: () => import('./web').then((m) => new m.VideoPlayerWeb()),
+});
+export * from './definitions';
+export { VideoPlayer };
+//# 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,WAAW,GAAG,cAAc,CAAoB,aAAa,EAAE;IACnE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,CAAC;CAC/D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { VideoPlayerPlugin } from './definitions';\n\nconst VideoPlayer = registerPlugin<VideoPlayerPlugin>('VideoPlayer', {\n  web: () => import('./web').then((m) => new m.VideoPlayerWeb()),\n});\n\nexport * from './definitions';\nexport { VideoPlayer };\n"]}

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

@@ -0,0 +1,4 @@
+export type videoExtension = 'mp4' | 'webm' | 'cmaf' | 'cmfv' | 'm3u8';
+export type videoMimeType = 'video/mp4' | 'application/x-mpegURL';
+export declare const possibleQueryParameterExtensions: string[];
+export declare const videoTypes: Record<videoExtension, videoMimeType>;

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

@@ -0,0 +1,9 @@
+export const possibleQueryParameterExtensions = ['file', 'extension', 'filetype', 'type', 'ext'];
+export const videoTypes = {
+    mp4: 'video/mp4',
+    webm: 'video/mp4',
+    cmaf: 'video/mp4',
+    cmfv: 'video/mp4',
+    m3u8: 'application/x-mpegURL',
+};
+//# 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":"AAEA,MAAM,CAAC,MAAM,gCAAgC,GAAa,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAE3G,MAAM,CAAC,MAAM,UAAU,GAA0C;IAC/D,GAAG,EAAE,WAAW;IAChB,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,uBAAuB;CAC9B,CAAC","sourcesContent":["export type videoExtension = 'mp4' | 'webm' | 'cmaf' | 'cmfv' | 'm3u8';\nexport type videoMimeType = 'video/mp4' | 'application/x-mpegURL';\nexport const possibleQueryParameterExtensions: string[] = ['file', 'extension', 'filetype', 'type', 'ext'];\n\nexport const videoTypes: Record<videoExtension, videoMimeType> = {\n  mp4: 'video/mp4',\n  webm: 'video/mp4',\n  cmaf: 'video/mp4',\n  cmfv: 'video/mp4',\n  m3u8: 'application/x-mpegURL',\n};\n"]}

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;
+}