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-11-22 19:41:00 +00:00
Code Issues Projects Releases Wiki Activity

doc: add docstrings for signaller object

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs/-/merge_requests/1419>
This commit is contained in:
Robert Ayrapetyan 2024-02-01 19:29:12 +00:00 committed by GStreamer Marge Bot
parent 7a72b2fc25
commit 972b9e5474
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
net/webrtc/src/signaller/imp.rs
View file

@ -493,21 +493,33 @@ impl ObjectImpl for Signaller {
static PROPS: Lazy<Vec<glib::ParamSpec>> = Lazy::new(|| { static PROPS: Lazy<Vec<glib::ParamSpec>> = Lazy::new(|| {
vec![ vec![
glib::ParamSpecString::builder("uri") glib::ParamSpecString::builder("uri")
.nick("Signaller URI")
.blurb("URI for connecting to the signaller server")
.flags(glib::ParamFlags::READWRITE) .flags(glib::ParamFlags::READWRITE)
.build(), .build(),
glib::ParamSpecString::builder("producer-peer-id") glib::ParamSpecString::builder("producer-peer-id")
.nick("Producer peer id")
.blurb("The peer id of the producer transmitted to the signaller server")
.flags(glib::ParamFlags::READWRITE) .flags(glib::ParamFlags::READWRITE)
.build(), .build(),
glib::ParamSpecString::builder("cafile") glib::ParamSpecString::builder("cafile")
.nick("Certificate Authority (CA) file")
.blurb("Certificate file used in TLS session")
.flags(glib::ParamFlags::READWRITE) .flags(glib::ParamFlags::READWRITE)
.build(), .build(),
glib::ParamSpecEnum::builder_with_default("role", WebRTCSignallerRole::Consumer) glib::ParamSpecEnum::builder_with_default("role", WebRTCSignallerRole::Consumer)
.nick("Role")
.blurb("Role within the session (Consumer, Producer or Listener)")
.flags(glib::ParamFlags::READWRITE) .flags(glib::ParamFlags::READWRITE)
.build(), .build(),
glib::ParamSpecString::builder("client-id") glib::ParamSpecString::builder("client-id")
.nick("Client id")
.blurb("The client id transmitted to the signaller server")
.flags(glib::ParamFlags::READABLE) .flags(glib::ParamFlags::READABLE)
.build(), .build(),
glib::ParamSpecBoxed::builder::<gst::Structure>("headers") glib::ParamSpecBoxed::builder::<gst::Structure>("headers")
.nick("HTTP headers")
.blurb("HTTP headers sent during the connection handshake")
.flags(glib::ParamFlags::READWRITE) .flags(glib::ParamFlags::READWRITE)
.build(), .build(),
] ]