diff --git a/net/quinn/src/quinnquicsink/mod.rs b/net/quinn/src/quinnquicsink/mod.rs index 198ddd94..53a1c814 100644 --- a/net/quinn/src/quinnquicsink/mod.rs +++ b/net/quinn/src/quinnquicsink/mod.rs @@ -7,6 +7,19 @@ // // SPDX-License-Identifier: MPL-2.0 +/** + * element-quinnquicsink: + * @short-description: Send data over the network via QUIC + * + * ## Example sender pipeline + * ```bash + * gst-launch-1.0 -v -e audiotestsrc num-buffers=512 ! \ + * audio/x-raw,format=S16LE,rate=48000,channels=2,layout=interleaved ! opusenc ! \ + * quinnquicsink server-name="quic.net" client-address="127.0.0.1" client-port=6001 \ + * server-address="127.0.0.1" server-port=6000 certificate-file="certificates/fullchain.pem" \ + * private-key-file="certificates/privkey.pem" + * ``` + */ use gst::glib; use gst::prelude::*; diff --git a/net/quinn/src/quinnquicsrc/mod.rs b/net/quinn/src/quinnquicsrc/mod.rs index 0acf7876..203095fa 100644 --- a/net/quinn/src/quinnquicsrc/mod.rs +++ b/net/quinn/src/quinnquicsrc/mod.rs @@ -7,6 +7,19 @@ // // SPDX-License-Identifier: MPL-2.0 +/** + * element-quinnquicsrc: + * @short-description: Receive data over the network via QUIC + * + * ## Example receiver pipeline + * ```bash + * gst-launch-1.0 -v -e quinnquicsrc caps=audio/x-opus server-name="quic.net" \ + * certificate-file="certificates/fullchain.pem" private-key-file="certificates/privkey.pem" \ + * server-address="127.0.0.1" server-port=6000 ! opusparse ! opusdec ! \ + * audio/x-raw,format=S16LE,rate=48000,channels=2,layout=interleaved ! \ + * audioconvert ! autoaudiosink + * ``` + */ use gst::glib; use gst::prelude::*;