mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-23 08:46:40 +00:00
more docs, fix compilation
Original commit message from CVS: * docs/gst/gstreamer-sections.txt: * gst/gstevent.c: * gst/gstevent.h: * gst/gstinfo.c: * gst/gstinfo.h: * gst/gstmessage.c: (gst_message_parse_state_changed): * gst/gstpad.c: * gst/gstpad.h: more docs, fix compilation
This commit is contained in:
parent
b6ea453bc1
commit
f9c812c51c
8 changed files with 48 additions and 11 deletions
12
ChangeLog
12
ChangeLog
|
@ -1,3 +1,15 @@
|
|||
2005-10-09 Stefan Kost <ensonic@users.sf.net>
|
||||
|
||||
* docs/gst/gstreamer-sections.txt:
|
||||
* gst/gstevent.c:
|
||||
* gst/gstevent.h:
|
||||
* gst/gstinfo.c:
|
||||
* gst/gstinfo.h:
|
||||
* gst/gstmessage.c: (gst_message_parse_state_changed):
|
||||
* gst/gstpad.c:
|
||||
* gst/gstpad.h:
|
||||
more docs, fix compilation
|
||||
|
||||
2005-10-09 Philippe Khalaf <burger@speedy.org>
|
||||
* gst/gstmessage.c:
|
||||
Fixed a few forgotten variables on previous commit
|
||||
|
|
|
@ -871,8 +871,6 @@ GST_DEBUG
|
|||
GST_LOG
|
||||
GST_DEBUG_FUNCPTR
|
||||
GST_DEBUG_FUNCPTR_NAME
|
||||
gst_debug_set_log_function
|
||||
gst_debug_reset_log_function
|
||||
gst_debug_print_stack_trace
|
||||
GST_TIME_FORMAT
|
||||
GST_TIME_ARGS
|
||||
|
|
|
@ -495,6 +495,10 @@ gst_event_new_filler (void)
|
|||
/* buffersize event */
|
||||
/**
|
||||
* gst_event_new_buffersize:
|
||||
* @format: buffer format
|
||||
* @minsize: minimum buffer size
|
||||
* @maxsize: maximum buffer size
|
||||
* @async: thread behavior
|
||||
*
|
||||
* Create a new buffersize event. The event is sent downstream and notifies
|
||||
* elements that they should provide a buffer of the specified dimensions.
|
||||
|
@ -520,6 +524,16 @@ gst_event_new_buffersize (GstFormat format, gint64 minsize,
|
|||
"async", G_TYPE_BOOLEAN, async, NULL));
|
||||
}
|
||||
|
||||
/**
|
||||
* gst_event_parse_buffersize:
|
||||
* @event: The event to query
|
||||
* @format: A pointer to store the format in
|
||||
* @minsize: A pointer to store the minsize in
|
||||
* @maxsize: A pointer to store the maxsize in
|
||||
* @async: A pointer to store the async-flag in
|
||||
*
|
||||
* Get the format, minsize, maxsize and async-flag in the buffersize event.
|
||||
*/
|
||||
void
|
||||
gst_event_parse_buffersize (GstEvent * event, GstFormat * format,
|
||||
gint64 * minsize, gint64 * maxsize, gboolean * async)
|
||||
|
|
|
@ -229,7 +229,7 @@ GType gst_event_get_type (void);
|
|||
*/
|
||||
#define gst_event_ref(ev) GST_EVENT (gst_mini_object_ref (GST_MINI_OBJECT (ev)))
|
||||
/**
|
||||
* gst_event_ref:
|
||||
* gst_event_unref:
|
||||
* @ev: The event to refcount
|
||||
*
|
||||
* Decrease the refcount of an event, freeing it if the refcount reaches 0.
|
||||
|
|
|
@ -1252,6 +1252,12 @@ __cyg_profile_func_exit (void *this_fn, void *call_site)
|
|||
g_free (name);
|
||||
}
|
||||
|
||||
/**
|
||||
* gst_debug_print_stack_trace:
|
||||
*
|
||||
* If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktracke is available for
|
||||
* gstreamer code, which can be printed with this function.
|
||||
*/
|
||||
void
|
||||
gst_debug_print_stack_trace (void)
|
||||
{
|
||||
|
|
|
@ -879,8 +879,6 @@ G_CONST_RETURN gchar *
|
|||
|
||||
#define _gst_debug_init() /* NOP */
|
||||
|
||||
#define gst_debug_set_log_function(func,data) /* NOP */
|
||||
#define gst_debug_reset_log_function(void) /* NOP */
|
||||
#define gst_debug_set_default_threshold(level) /* NOP */
|
||||
#define gst_debug_get_default_threshold() (GST_LEVEL_NONE)
|
||||
|
||||
|
|
11
gst/gstpad.c
11
gst/gstpad.c
|
@ -776,13 +776,12 @@ gst_pad_is_active (GstPad * pad)
|
|||
* is called when the operation succeeds; this happens right before the next
|
||||
* attempt at pushing a buffer on the pad.
|
||||
*
|
||||
* This can take a while as
|
||||
* the pad can only become blocked when real dataflow is happening.
|
||||
* This can take a while as the pad can only become blocked when real dataflow
|
||||
* is happening.
|
||||
* When the pipeline is stalled, for example in PAUSED, this can
|
||||
* take an indeterminate amount of time.
|
||||
* You can pass NULL as the callback to make this call block. Be
|
||||
* carefull with this blocking call as it might not return for
|
||||
* reasons stated above.
|
||||
* You can pass NULL as the callback to make this call block. Be careful with
|
||||
* this blocking call as it might not return for reasons stated above.
|
||||
*
|
||||
* Returns: TRUE if the pad could be blocked. This function can fail
|
||||
* if wrong parameters were passed or the pad was already in the
|
||||
|
@ -854,7 +853,7 @@ had_right_state:
|
|||
* @blocked: boolean indicating we should block or unblock
|
||||
*
|
||||
* Blocks or unblocks the dataflow on a pad. This function is
|
||||
* a shortcut for @gst_pad_set_blocked_async() with a NULL
|
||||
* a shortcut for gst_pad_set_blocked_async() with a NULL
|
||||
* callback.
|
||||
*
|
||||
* Returns: TRUE if the pad could be blocked. This function can fail
|
||||
|
|
10
gst/gstpad.h
10
gst/gstpad.h
|
@ -236,6 +236,16 @@ typedef GstFlowReturn (*GstPadBufferAllocFunction) (GstPad *pad, guint64 offset
|
|||
*/
|
||||
typedef gboolean (*GstPadDispatcherFunction) (GstPad *pad, gpointer data);
|
||||
|
||||
/**
|
||||
* GstPadBlockCallback:
|
||||
* @pad: the #GstPad that is blockend or unblocked.
|
||||
* @blocked: blocking state for the pad
|
||||
* @user_data: the gpointer to optional user data.
|
||||
*
|
||||
* Callback used by gst_pad_set_blocked_async(). Gets called when the blocking
|
||||
* operation succeeds.
|
||||
*/
|
||||
|
||||
typedef void (*GstPadBlockCallback) (GstPad *pad, gboolean blocked, gpointer user_data);
|
||||
|
||||
/**
|
||||
|
|
Loading…
Reference in a new issue