basesink: wait_eos() -> wait()

Rename gst_base_sink_wait_eos() to gst_base_sink_wait() to avoid confusion and
introspection problems with the ::wait_eos vmethod. Also this method can be used
to wait for other things than EOS. Update the docs a little.
This commit is contained in:
Wim Taymans 2012-06-18 11:36:25 +02:00
parent 2d19ed41c8
commit 927f261b1c
3 changed files with 12 additions and 10 deletions

View file

@ -2200,19 +2200,21 @@ preroll_failed:
} }
/** /**
* gst_base_sink_wait_eos: * gst_base_sink_wait:
* @sink: the sink * @sink: the sink
* @time: the running_time to be reached * @time: the running_time to be reached
* @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
* *
* This function will block until @time is reached. It is usually called by * This function will wait for preroll to complete and will then block until @time
* subclasses that use their own internal synchronisation but want to let the * is reached. It is usually called by subclasses that use their own internal
* EOS be handled by the base class. * synchronisation but want to let some synchronization (like EOS) be handled
* by the base class.
* *
* This function should only be called with the PREROLL_LOCK held, like when * This function should only be called with the PREROLL_LOCK held (like when
* receiving an EOS event in the ::event vmethod. * receiving an EOS event in the ::event vmethod or when handling buffers in
* ::render).
* *
* The @time argument should be the running_time of when the EOS should happen * The @time argument should be the running_time of when the timeout should happen
* and will be adjusted with any latency and offset configured in the sink. * and will be adjusted with any latency and offset configured in the sink.
* *
* Returns: #GstFlowReturn * Returns: #GstFlowReturn
@ -2220,7 +2222,7 @@ preroll_failed:
* Since: 0.10.15 * Since: 0.10.15
*/ */
GstFlowReturn GstFlowReturn
gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time, gst_base_sink_wait (GstBaseSink * sink, GstClockTime time,
GstClockTimeDiff * jitter) GstClockTimeDiff * jitter)
{ {
GstClockReturn status; GstClockReturn status;

View file

@ -246,7 +246,7 @@ guint64 gst_base_sink_get_throttle_time (GstBaseSink *sink);
GstClockReturn gst_base_sink_wait_clock (GstBaseSink *sink, GstClockTime time, GstClockReturn gst_base_sink_wait_clock (GstBaseSink *sink, GstClockTime time,
GstClockTimeDiff * jitter); GstClockTimeDiff * jitter);
GstFlowReturn gst_base_sink_wait_eos (GstBaseSink *sink, GstClockTime time, GstFlowReturn gst_base_sink_wait (GstBaseSink *sink, GstClockTime time,
GstClockTimeDiff *jitter); GstClockTimeDiff *jitter);
G_END_DECLS G_END_DECLS

View file

@ -56,8 +56,8 @@ EXPORTS
gst_base_sink_set_sync gst_base_sink_set_sync
gst_base_sink_set_throttle_time gst_base_sink_set_throttle_time
gst_base_sink_set_ts_offset gst_base_sink_set_ts_offset
gst_base_sink_wait
gst_base_sink_wait_clock gst_base_sink_wait_clock
gst_base_sink_wait_eos
gst_base_sink_wait_preroll gst_base_sink_wait_preroll
gst_base_src_get_blocksize gst_base_src_get_blocksize
gst_base_src_get_do_timestamp gst_base_src_get_do_timestamp