mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-28 03:00:35 +00:00
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:
parent
2d19ed41c8
commit
927f261b1c
3 changed files with 12 additions and 10 deletions
|
@ -2200,19 +2200,21 @@ preroll_failed:
|
|||
}
|
||||
|
||||
/**
|
||||
* gst_base_sink_wait_eos:
|
||||
* gst_base_sink_wait:
|
||||
* @sink: the sink
|
||||
* @time: the running_time to be reached
|
||||
* @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
|
||||
* subclasses that use their own internal synchronisation but want to let the
|
||||
* EOS be handled by the base class.
|
||||
* This function will wait for preroll to complete and will then block until @time
|
||||
* is reached. It is usually called by subclasses that use their own internal
|
||||
* 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
|
||||
* receiving an EOS event in the ::event vmethod.
|
||||
* This function should only be called with the PREROLL_LOCK held (like when
|
||||
* 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.
|
||||
*
|
||||
* Returns: #GstFlowReturn
|
||||
|
@ -2220,7 +2222,7 @@ preroll_failed:
|
|||
* Since: 0.10.15
|
||||
*/
|
||||
GstFlowReturn
|
||||
gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
|
||||
gst_base_sink_wait (GstBaseSink * sink, GstClockTime time,
|
||||
GstClockTimeDiff * jitter)
|
||||
{
|
||||
GstClockReturn status;
|
||||
|
|
|
@ -246,7 +246,7 @@ guint64 gst_base_sink_get_throttle_time (GstBaseSink *sink);
|
|||
|
||||
GstClockReturn gst_base_sink_wait_clock (GstBaseSink *sink, GstClockTime time,
|
||||
GstClockTimeDiff * jitter);
|
||||
GstFlowReturn gst_base_sink_wait_eos (GstBaseSink *sink, GstClockTime time,
|
||||
GstFlowReturn gst_base_sink_wait (GstBaseSink *sink, GstClockTime time,
|
||||
GstClockTimeDiff *jitter);
|
||||
|
||||
G_END_DECLS
|
||||
|
|
|
@ -56,8 +56,8 @@ EXPORTS
|
|||
gst_base_sink_set_sync
|
||||
gst_base_sink_set_throttle_time
|
||||
gst_base_sink_set_ts_offset
|
||||
gst_base_sink_wait
|
||||
gst_base_sink_wait_clock
|
||||
gst_base_sink_wait_eos
|
||||
gst_base_sink_wait_preroll
|
||||
gst_base_src_get_blocksize
|
||||
gst_base_src_get_do_timestamp
|
||||
|
|
Loading…
Reference in a new issue