electron/docs/tutorial/using-pepper-flash-plugin.md

83 lines
2.6 KiB
Markdown
Raw Normal View History

# Using Pepper Flash Plugin
Electron supports the Pepper Flash plugin. To use the Pepper Flash plugin in
2015-09-01 02:23:43 +00:00
Electron, you should manually specify the location of the Pepper Flash plugin
and then enable it in your application.
2015-09-01 02:23:43 +00:00
## Prepare a Copy of Flash Plugin
2016-06-18 13:26:26 +00:00
On macOS and Linux, the details of the Pepper Flash plugin can be found by
navigating to `chrome://flash` in the Chrome browser. Its location and version
2015-09-01 02:23:43 +00:00
are useful for Electron's Pepper Flash support. You can also copy it to another
location.
2015-09-01 02:23:43 +00:00
## Add Electron Switch
You can directly add `--ppapi-flash-path` and `--ppapi-flash-version` to the
2015-09-01 02:23:43 +00:00
Electron command line or by using the `app.commandLine.appendSwitch` method
before the app ready event. Also, turn on `plugins` option of `BrowserWindow`.
2015-09-01 02:23:43 +00:00
For example:
```javascript
2018-09-13 16:10:51 +00:00
const { app, BrowserWindow } = require('electron')
const path = require('path')
// Specify flash path, supposing it is placed in the same directory with main.js.
let pluginName
switch (process.platform) {
case 'win32':
pluginName = 'pepflashplayer.dll'
break
case 'darwin':
pluginName = 'PepperFlashPlayer.plugin'
break
case 'linux':
pluginName = 'libpepflashplayer.so'
break
}
app.commandLine.appendSwitch('ppapi-flash-path', path.join(__dirname, pluginName))
2016-04-25 13:45:56 +00:00
// Optional: Specify flash version, for example, v17.0.0.169
app.commandLine.appendSwitch('ppapi-flash-version', '17.0.0.169')
app.whenReady().then(() => {
let win = new BrowserWindow({
width: 800,
height: 600,
webPreferences: {
plugins: true
}
})
win.loadURL(`file://${__dirname}/index.html`)
// Something else
})
```
You can also try loading the system wide Pepper Flash plugin instead of shipping
the plugins yourself, its path can be received by calling
`app.getPath('pepperFlashSystemPlugin')`.
2015-09-01 02:23:43 +00:00
## Enable Flash Plugin in a `<webview>` Tag
Add `plugins` attribute to `<webview>` tag.
2015-09-01 02:23:43 +00:00
```html
<webview src="https://www.adobe.com/software/flash/about/" plugins></webview>
```
## Troubleshooting
You can check if Pepper Flash plugin was loaded by inspecting
`navigator.plugins` in the console of devtools (although you can't know if the
plugin's path is correct).
The architecture of Pepper Flash plugin has to match Electron's one. On Windows,
a common error is to use 32bit version of Flash plugin against 64bit version of
Electron.
On Windows the path passed to `--ppapi-flash-path` has to use `\` as path
delimiter, using POSIX-style paths will not work.
For some operations, such as streaming media using RTMP, it is necessary to grant wider permissions to players `.swf` files. One way of accomplishing this, is to use [nw-flash-trust](https://github.com/szwacz/nw-flash-trust).