Skip to content

Commit

Permalink
readme: Update docs on properties
Browse files Browse the repository at this point in the history
  • Loading branch information
aiden-jeffrey committed Oct 15, 2024
1 parent 9a411b6 commit b517cef
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,26 @@ GST_PLUGIN_PATH=Release:$GST_PLUGIN_PATH gst-launch-1.0 \
gst-launch-1.0 playbin uri=web+https://www.soundcloud.com/platform/sama
```

### Note on Global CEF Parameters

This note is only relevant if you want to run multiple cefsrc instances in the same process.

Prior releases of this plugin exposed some CEF properties that are in fact global to a single process.
We have now deprecated use of these as cefsrc element properties and instead exposed them as environment
variables. These properties are listed here for reference along with the env var that replaces them:

- `cef-cache-location` - set GST_CEF_CACHE_LOCATION instead
- `chrome-extra-flags` - set GST_CEF_CHROME_EXTRA_FLAGS
- `chromium-debug-port` - set GST_CEF_CHROME_EXTRA_FLAGS
- `gpu` - set GST_CEF_GPU_ENABLED
- `log-severity` - set GST_CEF_LOG_SEVERITY
- `sandbox` - set GST_CEF_SANDBOX

Note that if you do require pipelines / applications that run multiple `cefsrc` instances with differing
values for the above properties, we recommend running these source sections in a separate process and
bringing the resulting frames into your main process using something like the
[`ipc`](https://gstreamer.freedesktop.org/documentation/ipcpipeline/index.html?gi-language=c) plugins.

## Docker GPU Acceleration

This is simply a hint/note for those who want to use this plugin in a docker container with GPU acceleration. Your particular setup may vary. The following was tested on Ubuntu 22.04 with a Nvidia GPU. This assumes you have installed the Nvidia drivers, docker, and the Nvidia Container Toolkit. You may also need to configure your xorg.conf within the container to use the Nvidia GPU.
Expand Down

0 comments on commit b517cef

Please sign in to comment.