mirrors/gst-plugins-rs
mirrors/gst-plugins-rs
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs.git synced 2024-05-20 09:18:15 +00:00
Code Issues Projects Releases Wiki Activity

webrtcsink: README: add documentation for custom signaller

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs/-/merge_requests/1340>
This commit is contained in:
Maksym Khomenko 2023-09-28 18:19:50 +03:00
parent a9719cada2
commit e4096b5157
3 changed files with 31 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
net/webrtc/README.md
View file

@ -28,10 +28,10 @@ set of streams to any number of consumers, `webrtcsink` (which wraps
* Application-provided signalling: `webrtcsink` can be instantiated by an
application with a custom signaller. That signaller must be a GObject, and
must implement the `Signallable` interface as defined
[here](src/webrtcsink/mod.rs). The [default signaller](src/signaller/mod.rs)
[here](src/signaller/mod.rs). The [default signaller](src/signaller/imp.rs)
can be used as an example.
An [example project] is also available to use as a boilerplate for
An [example](examples/webrtcsink-custom-signaller/README.md) is also available to use as a boilerplate for
implementing and using a custom signaller.
* Sandboxed consumers: when a consumer is added, its encoder / payloader /

7
net/webrtc/examples/README.md
View file

@ -1,6 +1,6 @@
# webrtcsink examples
Collection (1-sized for now) of webrtcsink examples
Collection of webrtcsink examples
## webrtcsink-stats-server
@ -16,3 +16,8 @@ cargo run --example webrtcsink-stats-server
Once it is running, follow the instruction in the webrtcsink-stats folder to
run an example client.
## webrtcsink-custom-signaller
An example of custom signaller implementation, see the corresponding
[README](webrtcsink-custom-signaller/README.md) for more details on code and usage.

23
net/webrtc/examples/webrtcsink-custom-signaller/README.md Normal file
View file

@ -0,0 +1,23 @@
# WebRTCSink custom signaller
A simple application that consist of two parts:
* main executable, which demonstrates how to instantiate WebRTCSink with a custom signaller
* `signaller` module, which provides all the required boilerplate code
and stub implementations needed to create a custom signaller
Run with:
``` shell
cargo run --example webrtcsink-custom-signaller
```
The expected output is a not-implemented panic (from `imp::Signaller::start` function):
```text
thread 'tokio-runtime-worker' panicked at 'not implemented', net/webrtc/examples/webrtcsink-custom-signaller/signaller/imp.rs:14:9
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
```
Simply implement the methods in [imp.rs](signaller/imp.rs) and you should be good
to go!