feat(full-screen-manager): adding more API methods for fine tunning

wix-incubator · Sep 21, 2018 · 9168ec2 · 9168ec2
1 parent 7e93167
commit 9168ec2
Show file tree

Hide file tree

Showing 2 changed files with 216 additions and 0 deletions.
diff --git a/docs/player-public-methods.md b/docs/player-public-methods.md
@@ -1355,6 +1355,106 @@ Return object with internal debug info
   </table>
 </div>
 
+## enableExitFullScreenOnPause()
+
+```javascript
+player.play();
+player.enableExitFullScreenOnPause();
+player.enterFullScreen();
+console.log(player.isInFullScreen) // true
+player.pause();
+console.log(player.isInFullScreen) // false
+```
+
+Allow player try to exit full screen on pause
+
+## disableExitFullScreenOnPause()
+
+```javascript
+player.play();
+player.disableExitFullScreenOnPause();
+player.enterFullScreen();
+console.log(player.isInFullScreen) // true
+player.pause();
+console.log(player.isInFullScreen) // true
+```
+
+Disallow player to exit full screen on pause
+
+## enableExitFullScreenOnEnd()
+
+```javascript
+player.play();
+player.enableExitFullScreenOnEnd();
+player.enterFullScreen();
+console.log(player.isInFullScreen) // true
+console.log(player.isEnded); // true
+console.log(player.isInFullScreen) // false
+```
+
+Allow player try to exit full screen on end
+
+## disableExitFullScreenOnEnd()
+
+```javascript
+player.play();
+player.disableExitFullScreenOnEnd();
+player.enterFullScreen();
+console.log(player.isInFullScreen) // true
+console.log(player.isEnded); // true
+console.log(player.isInFullScreen) // true
+```
+
+Disallow player try to exit full screen on end
+
+## enableEnterFullScreenOnPlay()
+
+```javascript
+player.enableEnterFullScreenOnPlay();
+console.log(player.isInFullScreen) // false
+player.play();
+console.log(player.isInFullScreen) // true
+```
+
+Allow player try to exit full screen on end
+
+## disableEnterFullScreenOnPlay()
+
+```javascript
+player.disableEnterFullScreenOnPlay();
+console.log(player.isInFullScreen) // false
+player.play();
+console.log(player.isInFullScreen) // false
+```
+
+Disallow player try to exit full screen on end
+
+## enablePauseVideoOnFullScreenExit()
+
+```javascript
+player.play();
+player.enablePauseVideoOnFullScreenExit();
+player.enterFullScreen();
+console.log(player.isInFullScreen) // true
+player.pause();
+console.log(player.isInFullScreen) // false
+```
+
+Allow player try to exit full screen on end
+
+## disablePauseVideoOnFullScreenExit()
+
+```javascript
+player.play();
+player.enablePauseVideoOnFullScreenExit();
+player.enterFullScreen();
+console.log(player.isInFullScreen) // true
+player.pause();
+console.log(player.isInFullScreen) // true
+```
+
+Disallow player try to exit full screen on end
+
 ## enterFullScreen()
 
 ```javascript

diff --git a/src/modules/full-screen-manager/full-screen-manager.ts b/src/modules/full-screen-manager/full-screen-manager.ts
@@ -141,6 +141,122 @@ export default class FullScreenManager implements IFullScreenManager {
     }
   }
 
+  /**
+   * Allow player try to exit full screen on pause
+   * @example
+   * player.play();
+   * player.enableExitFullScreenOnPause();
+   * player.enterFullScreen();
+   * console.log(player.isInFullScreen) // true
+   * player.pause();
+   * console.log(player.isInFullScreen) // false
+   */
+  @playerAPI()
+  enableExitFullScreenOnPause() {
+    this._exitFullScreenOnPause = true;
+  }
+
+  /**
+   * Disallow player to exit full screen on pause
+   * @example
+   * player.play();
+   * player.disableExitFullScreenOnPause();
+   * player.enterFullScreen();
+   * console.log(player.isInFullScreen) // true
+   * player.pause();
+   * console.log(player.isInFullScreen) // true
+   */
+  @playerAPI()
+  disableExitFullScreenOnPause() {
+    this._exitFullScreenOnPause = false;
+  }
+
+  /**
+   * Allow player try to exit full screen on end
+   * @example
+   * player.play();
+   * player.enableExitFullScreenOnEnd();
+   * player.enterFullScreen();
+   * console.log(player.isInFullScreen) // true
+   * console.log(player.isEnded); // true
+   * console.log(player.isInFullScreen) // false
+   */
+  @playerAPI()
+  enableExitFullScreenOnEnd() {
+    this._exitFullScreenOnEnd = true;
+  }
+
+  /**
+   * Disallow player try to exit full screen on end
+   * @example
+   * player.play();
+   * player.disableExitFullScreenOnEnd();
+   * player.enterFullScreen();
+   * console.log(player.isInFullScreen) // true
+   * console.log(player.isEnded); // true
+   * console.log(player.isInFullScreen) // true
+   */
+  @playerAPI()
+  disableExitFullScreenOnEnd() {
+    this._exitFullScreenOnPause = false;
+  }
+
+  /**
+   * Allow player try to exit full screen on end
+   * @example
+   * player.enableEnterFullScreenOnPlay();
+   * console.log(player.isInFullScreen) // false
+   * player.play();
+   * console.log(player.isInFullScreen) // true
+   */
+  @playerAPI()
+  enableEnterFullScreenOnPlay() {
+    this._enterFullScreenOnPlay = true;
+  }
+
+  /**
+   * Disallow player try to exit full screen on end
+   * @example
+   * player.disableEnterFullScreenOnPlay();
+   * console.log(player.isInFullScreen) // false
+   * player.play();
+   * console.log(player.isInFullScreen) // false
+   */
+  @playerAPI()
+  disableEnterFullScreenOnPlay() {
+    this._enterFullScreenOnPlay = false;
+  }
+
+  /**
+   * Allow player try to exit full screen on end
+   * @example
+   * player.play();
+   * player.enablePauseVideoOnFullScreenExit();
+   * player.enterFullScreen();
+   * console.log(player.isInFullScreen) // true
+   * player.pause();
+   * console.log(player.isInFullScreen) // false
+   */
+  @playerAPI()
+  enablePauseVideoOnFullScreenExit() {
+    this._pauseVideoOnFullScreenExit = true;
+  }
+
+  /**
+   * Disallow player try to exit full screen on end
+   * @example
+   * player.play();
+   * player.enablePauseVideoOnFullScreenExit();
+   * player.enterFullScreen();
+   * console.log(player.isInFullScreen) // true
+   * player.pause();
+   * console.log(player.isInFullScreen) // true
+   */
+  @playerAPI()
+  disablePauseVideoOnFullScreenExit() {
+    this._pauseVideoOnFullScreenExit = false;
+  }
+
   /**
    * Player would try to enter fullscreen mode.
    * Behavior of fullscreen mode on different platforms may differ.