net/webrtc: improve documentation layout

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs/-/merge_requests/1239>
This commit is contained in:
Mathieu Duponchelle 2023-06-09 01:06:36 +02:00
parent 063871a1eb
commit 64056c5527
4 changed files with 39 additions and 4 deletions

View file

@ -3,8 +3,10 @@
/** /**
* plugin-rswebrtc: * plugin-rswebrtc:
* @title: Rust WebRTC elements
* @short_description: A collection of high level WebRTC elements wrapping webrtcbin
* *
* This plugin implements a high level WebRTC sink and source. * {{ net/webrtc/README.md[2:233] }}
* *
* Since: plugins-rs-0.9 * Since: plugins-rs-0.9
*/ */

View file

@ -2,6 +2,12 @@ mod iface;
mod imp; mod imp;
use gst::glib; use gst::glib;
/**
* GstRSWebRTCSignallableIface:
* @title: Interface for WebRTC signalling protocols
*
* Interface that WebRTC elements can implement their own protocol with.
*/
use once_cell::sync::Lazy; use once_cell::sync::Lazy;
// Expose traits and objects from the module itself so it exactly looks like // Expose traits and objects from the module itself so it exactly looks like
// generated bindings // generated bindings

View file

@ -1,11 +1,36 @@
// SPDX-License-Identifier: MPL-2.0 // SPDX-License-Identifier: MPL-2.0
use crate::signaller::Signallable; use crate::signaller::Signallable;
/** /**
* element-webrtcsink: * SECTION:element-webrtcsink
* @symbols:
* - GstBaseWebRTCSink
* - GstRSWebRTCSignallableIface
* *
* {{ net/webrtc/README.md[2:190] }} * `webrtcsink` is an element that can be used to serve media streams
* to multiple consumers through WebRTC.
* *
* It uses a signaller that implements the protocol supported by the default
* signalling server we additionally provide, take a look at the subclasses of
* #GstBaseWebRTCSink for other supported protocols, or implement your own.
*
* See the [documentation of the plugin](plugin-rswebrtc) for more information
* on features and usage.
*/
/**
* GstBaseWebRTCSink:
* @title: Base class for WebRTC producers
*
* Base class for WebRTC sinks to implement and provide their own protocol for.
*/
/**
* GstRSWebRTCSignallableIface:
* @title: Interface for WebRTC signalling protocols
*
* Interface that WebRTC elements can implement their own protocol with.
*/ */
use gst::glib; use gst::glib;
use gst::prelude::*; use gst::prelude::*;

View file

@ -1,6 +1,8 @@
// SPDX-License-Identifier: MPL-2.0 // SPDX-License-Identifier: MPL-2.0
/** /**
* element-webrtcsrc: * SECTION:element-webrtcsrc
* @symbols:
* - GstWebRTCSrcPad
* *
* `webrtcsrc` is the source counterpart of the #webrtcsink element and can be * `webrtcsrc` is the source counterpart of the #webrtcsink element and can be
* used to receive streams from it, it can also be used to easily playback WebRTC * used to receive streams from it, it can also be used to easily playback WebRTC