docs: Remove Flash (#6994)

Author: mister-ben

CONTRIBUTING.md

@@ -35,7 +35,6 @@ So you want to help out? Great! There's a number of ways you can get involved.
 There's also other Video.js projects where you can help. (check the [video.js org](https://github.com/videojs) for an up-to-date list of projects)
 
 * [Videojs.com](https://github.com/videojs/videojs.com)
-* [Video.js flash player](https://github.com/videojs/videojs-flash)
 * [HLS](https://github.com/videojs/videojs-contrib-hls)
 * [DASH](https://github.com/videojs/videojs-contrib-dash)
 * [Youtube Tech](https://github.com/videojs/videojs-youtube)
@@ -183,7 +182,6 @@ See [the following section](#running-a-local-web-server) for how to open the pag
 
 This ties in nicely with the sandbox directory. You can always open the `sandbox/index.html` file directly but in some cases it may not work properly.
 
-> Flash files (`.swf`) that are local and loaded into a locally accessed page (file:///) will NOT run.
 > To get around this you must use a local web server.
 
 To run the local webserver:

README.md

@@ -9,7 +9,7 @@
 
 [![NPM][npm-icon]][npm-link]
 
-> Video.js is a web video player built from the ground up for an HTML5 world. It supports HTML5 and Flash video, as well as YouTube and Vimeo (through [plugins][plugins]). It supports video playback on desktops and mobile devices. This project was started mid 2010, and the player is now used on over ~~50,000~~ ~~100,000~~ ~~200,000~~ [400,000 websites][builtwith].
+> Video.js is a web video player built from the ground up for an HTML5 world. It supports HTML5 video and Media Source Extensions, as well as other playback techs like YouTube and Vimeo (through [plugins][plugins]). It supports video playback on desktops and mobile devices. This project was started mid 2010, and the player is now used on over ~~50,000~~ ~~100,000~~ ~~200,000~~ ~~400,000~~ [600,000 websites][builtwith].
 
 ## Table of Contents
 

build/generate-example.js

@@ -1,15 +1,10 @@
 const path = require('path');
-const fs = require('fs');
 const sh = require('shelljs');
 const pkg = require('../package.json');
 
 const dest = path.join(__dirname, '..', 'docs', 'api');
-const vjsFlash = path.join(__dirname, '..', 'node_modules', 'videojs-flash');
-const vjsSwf = path.join('node_modules', 'videojs-swf');
 const distDest = path.join(dest, 'dist');
 const exampleDest = path.join(dest, 'test-example');
-const vjsFlashDest = path.join(dest, vjsFlash, 'dist');
-const swfDest = path.join(dest, vjsFlash, vjsSwf, 'dist');
 
 const cleanupExample = function() {
   sh.rm('-rf', distDest);
@@ -23,24 +18,13 @@ const generateExample = function({skipBuild} = {}) {
     sh.exec('npm run build');
   }
 
-  // make sure that the example, flash, and swf dests are available
+  // make sure that the example dest is available
   sh.mkdir('-p', exampleDest);
-  sh.mkdir('-p', vjsFlashDest);
-  sh.mkdir('-p', swfDest);
 
   // copy the `dist` dir
   sh.cp('-R', 'dist', path.join(dest, 'dist'));
   sh.rm(path.join(dest, 'dist', `video-js-${pkg.version}.zip`));
 
-  // copy videojs-flash
-  sh.cp(path.join(vjsFlash, 'dist', 'videojs-flash.js'), vjsFlashDest);
-  // copy videojs-swf
-  if (fs.existsSync(path.join(vjsFlash, vjsSwf, 'dist', 'video-js.swf'))) {
-    sh.cp(path.join(vjsFlash, vjsSwf, 'dist', 'video-js.swf'), swfDest);
-  } else {
-    sh.cp(path.join(vjsSwf, 'dist', 'video-js.swf'), swfDest);
-  }
-
   const filepaths = sh.find(path.join(__dirname, '..', 'sandbox', '**', '*.*'))
     .filter((filepath) => path.extname(filepath) === '.example');
 

composer.json

@@ -1,11 +1,10 @@
 {
     "name": "videojs/video.js",
-    "description": "An HTML5 and Flash video player with a common API and skin for both.",
+    "description": "An HTML5 video player.",
     "type": "library",
     "keywords": [
         "videojs",
         "html5",
-        "flash",
         "video",
         "player"
     ],

docs/examples/elephantsdream/descriptions.en.vtt

@@ -156,7 +156,7 @@ The elevator begins to drop down another shaft, coming to rest as it slams into
 
 39
 00:06:26.500 --> 00:06:28.000
-A camera flashes.
+A camera briefly illumiates.
 
 40
 00:06:28.010 --> 00:06:34.000

docs/guides/faq.md

@@ -47,7 +47,7 @@
 Video.js is an extendable framework/library around the native video element. It does the following:
 
 * Offers a plugin API so that different types of video can be handed to the native
-  video element (e.g. [HLS][hls], [Flash][flash], HTML5 video, etc).
+  video element (e.g. [HLS][hls], HTML5 video, etc).
 * Unifies the native video API across browsers (polyfilling support for features
   if necessary)
 * Offers an extendable and themable UI
@@ -161,16 +161,7 @@ on using that option.
 
 ## Q: How can I play RTMP video in Video.js?
 
-RTMP requires Flash to play back. You'll need both a browser that supports Flash and the Flash tech.
-
-In Video.js version 6, the Flash tech is not included by default and is available as a separate [videojs-flash package][flash]. In previous versions it was builtin to Video.js.
-
-The RTMP source should be set with an appropriate type -- `rtmp/mp4` or `rtmp/flv`.
-Be aware of that Video.js splits the connection url and stream name with the `&` character, for example: `rtmp://example.com/live&foo` or `rtmp://example.com/fms&mp4:path/to/file.mp4`.
-
-If the server requires query parameters for authentication, these should be added to the connection part URL, for example `rtmp://example.com/live?token=1234&foo`.
-
-Bear in mind that mobile browsers do not support Flash, and modern desktop browsers make it increasingly difficult to use Flash or disable it by default for your end users. Consider moving to a modern format such as HLS or DASH.
+It is no longer possible to play RTMP as it requires Flash, and [Flash has reached end of life][flash-eol]. No browser supports it.
 
 ## Q: How can I hide the links to my video/subtitles/audio/tracks?
 
@@ -221,7 +212,6 @@ See the [Video.js GitHub wiki][skins-list].
 ## Q: Does Video.js work as an audio only player?
 
 Yes! It can be used to play audio only files in a `<video>` or `<audio>` tag.
-Note that audio-only sources do not work with the Flash playback tech.
 
 ## Q: Does Video.js support audio tracks?
 
@@ -253,8 +243,7 @@ Like HLS, DASH streams require [CORS headers][cors].
 
 ## Q: Does Video.js support live video?
 
-Yes! Common formats for live are HLS or historically RTMP.
-HLS is supported via [videojs-http-streaming][hls] and RTMP via [videojs-flash][flash].
+Yes! Common formats for live are HLS or DASH. In the past RTMP was commonly used for live, but it is no longer possible to play in any browser.
 
 ## Q: Can Video.js play YouTube videos?
 
@@ -302,7 +291,7 @@ Yes! See [ReactJS integration example][react-guide].
 
 [eme]: https://github.com/videojs/videojs-contrib-eme
 
-[flash]: https://github.com/videojs/videojs-flash
+[flash-eol]: https://www.adobe.com/products/flashplayer/end-of-life.html
 
 [generator]: https://github.com/videojs/generator-videojs-plugin
 

docs/guides/options.md

@@ -51,8 +51,6 @@
   * [${componentName}](#componentname)
 * [Tech Options](#tech-options)
   * [${techName}](#techname)
-  * [flash](#flash)
-    * [swf](#swf)
   * [html5](#html5)
     * [nativeControlsForTouch](#nativecontrolsfortouch-1)
     * [nativeAudioTracks](#nativeaudiotracks)
@@ -560,27 +558,7 @@ videojs('my-player', {
 
 > Type: `Object`
 
-Video.js playback technologies (i.e. "techs") can be given custom options as part of the options passed to the `videojs` function. They should be passed under the _lower-case variant of the tech name_ (e.g. `"flash"` or `"html5"`).
-
-### `flash`
-
-#### `swf`
-
-Specifies where the Video.js SWF file is located for the `Flash` tech:
-
-```js
-videojs('my-player', {
-  flash: {
-    swf: '//path/to/videojs.swf'
-  }
-});
-```
-
-However, changing the global defaults is generally more appropriate:
-
-```js
-videojs.options.flash.swf = '//path/to/videojs.swf'
-```
+Video.js playback technologies (i.e. "techs") can be given custom options as part of the options passed to the `videojs` function. They should be passed under the _lower-case variant of the tech name_ (e.g. `"html5"`).
 
 ### `html5`
 

docs/guides/player-workflows.md

@@ -77,7 +77,7 @@ Suggests that a player or component was removed from the DOM without using `disp
 
 ## Showing and Hiding a Player
 
-It is not recommended that you attempt to toggle the visibility or display of a Video.js player. Doing so can be particularly problematic when it comes to the Flash tech. Instead, players should be created and [disposed](#removing-players) as needed.
+It is not recommended that you attempt to toggle the visibility or display of a Video.js player. Instead, players should be created and [disposed](#removing-players) as needed.
 
 This is relevant to use cases such as displaying a player in a modal/overlay. Rather than keeping a hidden Video.js player in a DOM element, it's recommended that you create the player when the modal opens and dispose it when the modal closes.
 

docs/guides/tech.md

@@ -1,10 +1,10 @@
 # Playback Technology ("Tech")
 
-Playback Technology refers to the specific browser or plugin technology used to play the video or audio. When using HTML5, the playback technology is the video or audio element. When using Flash from [videojs-flash][flash], the playback technology is the video-js.swf Flash object. When using the [videojs-youtube][youtube] tech, the playback technology is the You Tube player. The tech also includes an API wrapper to translate between the Video.js controls and API to the specific playback technology used.
+Playback Technology refers to the specific browser or plugin technology used to play the video or audio. When using HTML5, the playback technology is the video or audio element. When using the [videojs-youtube][youtube] tech, the playback technology is the YouTube player. The tech also includes an API wrapper to translate between the Video.js controls and API to the specific playback technology used.
 
 Essentially we're using html5 and plugins only as video decoders, and using HTML and JavaScript to create a consistent API and skinning experience across all of them.
 
-In addition to techs there are source handlers. Source handlers add the capability to play additional source types to techs. For example, the [videojs-contrib-hls][hls] source handler enables the HTML5 and Flash techs to play HLS.
+In addition to techs there are source handlers. Source handlers add the capability to play additional source types to techs. For example, the [http-streaming][http-streaming] source handler (included with Video.js 7+ by default) enables the HTML5 tech to play HLS and DASH.
 
 ## Building an API Wrapper
 
@@ -46,14 +46,14 @@ When additional techs are added they are automatically added to the `techOrder`.
 ### Tag Method:
 
 ```html
-<video data-setup='{"techOrder": ["html5", "flash", "other supported tech"]}'>
+<video data-setup='{"techOrder": ["html5", "other supported tech"]}'>
 ```
 
 ### Object Method:
 
 ```js
 videojs("videoID", {
-  techOrder: ["html5", "flash", "other supported tech"]
+  techOrder: ["html5", "other supported tech"]
 });
 ```
 
@@ -75,6 +75,8 @@ Techs can check if they have this capability by checking the `canOverridePoster`
 
 When Video.js is given an array of sources, which to use is determined by finding the first supported source / tech combination. Each tech will be queried in the order specified in `techOrder` whether it can play the first source. The first match wins. If no tech can play the first source, then the next will be tested. It's important to set the `type` of each source correctly for this test to be accurate.
 
+> These example use the obsolete [Flash tech][flash-eol], for illustration of tech ordering with techs which have a greater degree of overlap in sources they can play
+
 For example, given the following video element, assuming the [videojs-flash][flash] tech and [videojs-contrib-hls][hls] source handler are available:
 
 ```html
@@ -121,38 +123,14 @@ This time, we have videojs-flash but not videojs-contrib-hls:
 
 ## Flash Technology
 
-The Flash playback tech was previously included in Video.js core and was included in the default `techOrder`. As of version 6, the Flash tech was moved to a separate [videojs-flash plugin][flash] which you would need to include if you still need to use Flash.
-
-It's increasingly likely that end users don't have Flash or their browser has either disabled it or puts a click-to-play or other barrier to using it, so it's strongly recommended to use an alternative such as HLS.
-
-### Enabling RTMP Streaming Playback
-
-In order to force the Flash tech to choose streaming playback, you need to provide a valid streaming source **before other valid Flash video sources**. This is necessary because of the source selection algorithm, where playback tech chooses the first possible source object with a valid type. Valid streaming `type` values include `rtmp/mp4` and `rtmp/flv`. The streaming `src` value requires valid connection and stream strings, separated by an `&`. An example of supplying a streaming source through your HTML markup might look like:
-
-```html
-<source src="rtmp://your.streaming.provider.net/cfx/st/&mp4:path/to/video.mp4" type="rtmp/mp4">
-<source src="http://your.static.provider.net/path/to/video.mp4" type="video/mp4">
-<source src="http://your.static.provider.net/path/to/video.webm" type="video/webm">
-```
-
-You may optionally use the last `/` as the separator between connection and stream strings, for example:
+Flash is no longer supported as it has reached [flash-eol][end of life]
 
-```html
-<source src="rtmp://your.streaming.provider.net/cfx/st/mp4:video.mp4" type="rtmp/mp4">
-```
-
-All four RTMP protocols are valid in the `src` (RTMP, RTMPT, RTMPE, and RTMPS).
-
-#### A note on sandboxing and security
-
-In some environments, such as Electron and NW.js apps, stricter policies are enforced, and `.swf` files won’t be able to communicate with the outside world out of the box. To stream media, you have to add them to a special manifest of trusted files. [nw-flash-trust](https://github.com/szwacz/nw-flash-trust) makes this job easy.
-
-Browsers also prevent the Flash tech from working when you load a page from the filesystem (with the `file:` protocol) and also in sandboxed iframes.
-
-[flash]: https://github.com/videojs/videojs-flash
+[flash-eol]: https://www.adobe.com/products/flashplayer/end-of-life.html
 
 [hls]: https://github.com/videojs/videojs-contrib-hls
 
+[http-streaming]: https://github.com/videojs/http-streaming
+
 [mse]: https://en.wikipedia.org/wiki/Media_Source_Extensions
 
 [youtube]: https://github.com/videojs/videojs-youtube

docs/guides/text-tracks.md

@@ -163,7 +163,7 @@ metadataTrack.addEventListener('cuechange', function() {
 
 ## Emulated Text Tracks
 
-By default, Video.js will use native text tracks and fall back to emulated text tracks if the native functionality is broken, incomplete, or non-existent. The Flash tech will always use the emulated text track functionality.
+By default, Video.js will use native text tracks and fall back to emulated text tracks if the native functionality is broken, incomplete, or non-existent.
 
 The Video.js API and TextTrack objects were modeled after the W3C specification. Video.js uses [Mozilla's vtt.js](https://github.com/mozilla/vtt.js) library to parse and display emulated text tracks.