From 416ce16f26b39c76ab35e1ef6a75dc41ec69f75b Mon Sep 17 00:00:00 2001
From: Andy Wingo <wingo@oblong.net>
Date: Tue, 28 Apr 2009 18:48:33 +0200
Subject: [PATCH] [baseaudiosink] add docs for can-activate-pull
* gst-libs/gst/audio/gstbaseaudiosink.c: Add documentation for
can-activate-pull.
---
gst-libs/gst/audio/gstbaseaudiosink.c | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/gst-libs/gst/audio/gstbaseaudiosink.c b/gst-libs/gst/audio/gstbaseaudiosink.c
index eb56fb4703..cb48605b8c 100644
--- a/gst-libs/gst/audio/gstbaseaudiosink.c
+++ b/gst-libs/gst/audio/gstbaseaudiosink.c
@@ -204,6 +204,18 @@ gst_base_audio_sink_class_init (GstBaseAudioSinkClass * klass)
GST_TYPE_BASE_AUDIO_SINK_SLAVE_METHOD, DEFAULT_SLAVE_METHOD,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+ /**
+ * GstBaseAudioSink:can-activate-pull
+ *
+ * If set to #TRUE, the baseaudiosink will attempt to activate its upstream
+ * peer in pull mode, before falling back to push mode.
+ * When set to #FALSE, push mode will be assumed.
+ * Pull mode is not enabled by default, as it interferes with clock slaving
+ * and trick modes.
+ * not required.
+ *
+ * Since: 0.10.23
+ */
g_object_class_install_property (gobject_class, PROP_CAN_ACTIVATE_PULL,
g_param_spec_boolean ("can-activate-pull", "Allow Pull Scheduling",
"Allow pull-based scheduling", DEFAULT_CAN_ACTIVATE_PULL,