5 KiB
webrtcsink examples
Collection of webrtcsink examples
webrtcsink-stats-server
A simple application that instantiates a webrtcsink and serves stats over websockets.
The application expects a signalling server to be running at ws://localhost:8443,
similar to the usage example in the main README.
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 for more details on code and usage.
WebRTC precise synchronization example
This example demonstrates a sender / receiver setup which ensures precise synchronization of multiple streams in a single session.
RFC 6051-style rapid synchronization of RTP streams is available as an option. Se the Instantaneous RTP synchronization... blog post for details about this mode and an example based on RTSP instead of WebRTC.
The examples can also be used for RFC 7273 NTP or PTP clock signalling and synchronization.
Finally, raw payloads (e.g. L24 audio) can be negotiated.
Signaller
The example uses the default WebRTC signaller. Launch it using the following command:
cargo run --bin gst-webrtc-signalling-server --no-default-features
Receiver
The receiver awaits for new audio & video stream publishers and render the streams using auto sink elements. Launch it using the following command:
cargo r --example webrtc-precise-sync-recv --no-default-features
The default configuration should work for a local test. For a multi-host setup, see the available options:
cargo r --example webrtc-precise-sync-recv --no-default-features -- --help
E.g.: the following will force avdec_h264 over hardware decoders, activate
debug logs for the receiver and connect to the signalling server at the
specified address:
GST_PLUGIN_FEATURE_RANK=avdec_h264:MAX \
WEBRTC_PRECISE_SYNC_RECV_LOG=debug \
cargo r --example webrtc-precise-sync-recv --no-default-features -- \
--server 192.168.1.22
Sender
The sender publishes audio & video test streams. Launch it using the following command:
cargo r --example webrtc-precise-sync-send --no-default-features
The default configuration should work for a local test. For a multi-host setup, to set the number of audio / video streams, to enable rapid synchronization or to force the video encoder, see the available options:
cargo r --example webrtc-precise-sync-send --no-default-features -- --help
E.g.: the following will force H264 and x264enc over hardware encoders,
activate debug logs for the sender and connect to the signalling server at the
specified address:
GST_PLUGIN_FEATURE_RANK=264enc:MAX \
WEBRTC_PRECISE_SYNC_SEND_LOG=debug \
cargo r --example webrtc-precise-sync-send --no-default-features -- \
--server 192.168.1.22 --video-caps video/x-h264
The pipeline latency
The --pipeline-latency argument configures a static latency of 1s by default.
This needs to be higher than the sum of the sender latency and the receiver
latency of the receiver with the highest latency. As this can't be known
automatically and depends on many factors, this has to be known for the overall
system and configured accordingly.
The default configuration is on the safe side and favors synchronization over low latency. Depending on the use case, shorter or larger values should be used.
RFC 7273 NTP or PTP clock signalling and synchronization
For RFC 7273 NTP or PTP clock signalling and synchronization, you can use commands such as:
Receiver
cargo r --example webrtc-precise-sync-recv --no-default-features -- \
--expect-clock-signalling
Sender
cargo r --example webrtc-precise-sync-send --no-default-features -- \
--clock ntp --do-clock-signalling \
--video-streams 0 --audio-streams 2
Raw payload
The sender can be instructed to send raw payloads.
This command will stream two stereo L24 streams:
cargo r --example webrtc-precise-sync-send --no-default-features -- \
--video-streams 0 \
--audio-streams 2 --audio-codecs L24
Launch the receiver with:
cargo r --example webrtc-precise-sync-recv --no-default-features
This can be used to stream multiple RAW video streams using specific CAPS for the streams and allowing fallback to VP8 & OPUS if remote doesn't support raw payloads:
cargo r --example webrtc-precise-sync-send --no-default-features -- \
--video-streams 2 --audio-streams 1 \
--video-codecs RAW --video-codecs VP8 --video-caps video/x-raw,format=I420,width=400 \
--audio-codecs L24 --audio-codecs OPUS --audio-caps audio/x-raw,rate=48000,channels=2