summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNazar Mokrynskyi <nazar@mokrynskyi.com>2020-08-19 14:51:17 +0300
committerTim-Philipp Müller <tim@centricular.com>2020-10-12 13:02:07 +0100
commit80b30f85b4eabcf1970387fbddeb12692b424a4f (patch)
tree44851f64bdc64ad08a8bf68ce51bb695196d86b9
parentc723624e1e43dd2b48bd91d39e6cd95a053da120 (diff)
downloadgstreamer-plugins-bad-80b30f85b4eabcf1970387fbddeb12692b424a4f.tar.gz
rtmp2sink: add docs section with since marker on new stop-commands property
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/merge_requests/1628>
-rw-r--r--docs/meson.build1
-rw-r--r--gst/rtmp2/gstrtmp2sink.c7
-rw-r--r--gst/rtmp2/rtmp/rtmpclient.h9
3 files changed, 17 insertions, 0 deletions
diff --git a/docs/meson.build b/docs/meson.build
index 09ee1358f..3a91edbd7 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -233,6 +233,7 @@ foreach plugin_name: list_plugin_res.stdout().split(':')
join_paths(root_rel, 'ext/*/*.cc'),
join_paths(root_rel, 'ext/*/*.hh'),
join_paths(root_rel, 'gst/*/*.[ch]'),
+ join_paths(root_rel, 'gst/rtmp2/*/*.[ch]'),
],
dependencies: [gst_dep, plugins],
install: false,
diff --git a/gst/rtmp2/gstrtmp2sink.c b/gst/rtmp2/gstrtmp2sink.c
index 41b728c47..72026eb87 100644
--- a/gst/rtmp2/gstrtmp2sink.c
+++ b/gst/rtmp2/gstrtmp2sink.c
@@ -231,6 +231,13 @@ gst_rtmp2_sink_class_init (GstRtmp2SinkClass * klass)
g_param_spec_boxed ("stats", "Stats", "Retrieve a statistics structure",
GST_TYPE_STRUCTURE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
+ /**
+ * GstRtmp2Sink:stop-commands:
+ *
+ * Which commands (if any) to send on EOS event before closing connection
+ *
+ * Since: 1.18
+ */
g_object_class_install_property (gobject_class, PROP_STOP_COMMANDS,
g_param_spec_flags ("stop-commands", "Stop commands",
"RTMP commands to send on EOS event before closing connection",
diff --git a/gst/rtmp2/rtmp/rtmpclient.h b/gst/rtmp2/rtmp/rtmpclient.h
index d70574a1a..a96c0e6be 100644
--- a/gst/rtmp2/rtmp/rtmpclient.h
+++ b/gst/rtmp2/rtmp/rtmpclient.h
@@ -60,6 +60,15 @@ GType gst_rtmp_authmod_get_type (void);
#define GST_RTMP_DEFAULT_STOP_COMMANDS (GST_RTMP_STOP_COMMANDS_FCUNPUBLISH | \
GST_RTMP_STOP_COMMANDS_DELETE_STREAM) /* FCUnpublish + deleteStream */
+/**
+ * GstRtmpStopCommands:
+ * @GST_RTMP_STOP_COMMANDS_NONE: Don't send any commands
+ * @GST_RTMP_STOP_COMMANDS_FCUNPUBLISH: Send FCUnpublish command
+ * @GST_RTMP_STOP_COMMANDS_CLOSE_STREAM: Send closeStream command
+ * @GST_RTMP_STOP_COMMANDS_DELETE_STREAM: Send deleteStream command
+ *
+ * Since: 1.18
+ */
typedef enum
{
GST_RTMP_STOP_COMMANDS_NONE = 0,