mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-07-02 20:55:55 +00:00
Code Issues 1 Projects Releases Wiki Activity

basesrc: Annotate some of the virtual methods

Browse source
This commit is contained in:
Mathieu Duponchelle 2018-01-23 20:04:02 +01:00
parent bce246f39f
commit ac7434088e
1 changed files with 15 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
libs/gst/base/gstbasesrc.h
View file

@ -189,8 +189,14 @@ struct _GstBaseSrcClass {
gboolean (*start) (GstBaseSrc *src);
gboolean (*stop) (GstBaseSrc *src);
/* given a buffer, return start and stop time when it should be pushed
* out. The base class will sync on the clock using these times. */
/**
* GstBaseSrcClass::get_times:
* @start: (out):
* @end: (out):
*
* Given @buffer, return @start and @end time when it should be pushed
* out. The base class will sync on the clock using these times.
*/
void (*get_times) (GstBaseSrc *src, GstBuffer *buffer,
GstClockTime *start, GstClockTime *end);
@ -220,8 +226,13 @@ struct _GstBaseSrcClass {
/* notify subclasses of an event */
gboolean (*event) (GstBaseSrc *src, GstEvent *event);
/* ask the subclass to create a buffer with offset and size, the default
* implementation will call alloc and fill. */
/**
* GstBaseSrcClass::create:
* @buf: (out):
*
* Ask the subclass to create a buffer with @offset and @size, the default
* implementation will call alloc and fill.
*/
GstFlowReturn (*create) (GstBaseSrc *src, guint64 offset, guint size,
GstBuffer **buf);
/* ask the subclass to allocate an output buffer. The default implementation