mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-03-13 23:22:54 +00:00
Code Issues 1 Projects Releases Wiki Activity

Documentation updates

Browse source 
Original commit message from CVS:
Documentation updates
This commit is contained in:
Wim Taymans 2001-01-01 17:25:43 +00:00
parent a2c260761d
commit 4328a30762
7 changed files with 323 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
docs/gst/gstreamer-sections.txt
View file

@ -37,26 +37,37 @@ gst_main_quit
<SECTION>
<FILE>gstinfo</FILE>
<TITLE>gstinfo</TITLE>
GST_DEBUG_ENABLED
GST_DEBUG_PREFIX
DEBUG
DEBUG_NOPREFIX
DEBUG_ENTER
DEBUG_SET_STRING
DEBUG_ENTER_STRING
DEBUG_LEAVE
DEBUG_LEAVE_STRING
GST_DEBUG_PAD_NAME
GST_DEBUG_FUNCPTR
GST_DEBUG_FUNCPTR_NAME
GstInfoHandler
gst_get_category_name
gst_info_get_categories
gst_info_set_categories
gst_info_enable_category
gst_info_disable_category
gst_default_info_handler
INFO
INFO_ELEMENT
GstErrorHandler
GST_INFO_ENABLED
GST_INFO
GST_INFO_ELEMENT
gst_debug_get_categories
gst_debug_set_categories
gst_debug_enable_category
gst_debug_disable_category
GST_DEBUG_SET_STRING
GST_DEBUG_ENTER
GST_DEBUG_ENTER_STRING
GST_DEBUG_LEAVE
GST_DEBUG_LEAVE_STRING
GST_DEBUG_NOPREFIX
GST_DEBUG
GST_DEBUG_ENABLE_CATEGORIES
GST_DEBUG_FUNCPTR
GST_DEBUG_PREFIX
GST_DEBUG_ENABLED
GST_DEBUG_FUNCPTR_NAME
GST_DEBUG_PAD_NAME
GST_ERROR
GST_ERROR_OBJECT
gst_default_error_handler
ERROR
ERROR_OBJECT
GstInfoHandler
GstErrorHandler
</SECTION>
<SECTION>
@ -183,6 +194,7 @@ gst_element_get_pad
gst_element_get_pad_list
gst_element_get_padtemplate_list
gst_element_add_ghost_pad
gst_element_remove_ghost_pad
gst_element_connect
gst_element_set_state
gst_element_error
@ -292,6 +304,7 @@ GstPadChainFunction
GstPadGetFunction
GstPadGetRegionFunction
GstPadQoSFunction
GstPadEOSFunction
GstPadPushFunction
GstPadPullFunction
@ -307,6 +320,7 @@ gst_pad_set_chain_function
gst_pad_set_get_function
gst_pad_set_getregion_function
gst_pad_set_qos_function
gst_pad_set_eos_function
gst_pad_set_caps_list
gst_pad_get_caps_list
gst_pad_get_caps_by_name
@ -326,6 +340,8 @@ gst_pad_pull
gst_pad_pull_region
gst_pad_pullregion
gst_pad_handle_qos
gst_pad_set_eos
gst_pad_eos
gst_pad_save_thyself
gst_pad_load_and_connect

9
docs/gst/tmpl/gstelement.sgml
View file

@ -298,6 +298,15 @@ circumstances.
@pad:
<!-- ##### FUNCTION gst_element_remove_ghost_pad ##### -->
<para>
</para>
@element:
@pad:
<!-- ##### FUNCTION gst_element_connect ##### -->
<para>

242
docs/gst/tmpl/gstinfo.sgml
View file

@ -15,47 +15,48 @@ to your application.
</para>
<!-- ##### MACRO GST_DEBUG_ENABLED ##### -->
<!-- ##### FUNCTION gst_get_category_name ##### -->
<para>
</para>
@category:
@Returns:
<!-- ##### MACRO GST_DEBUG_PREFIX ##### -->
<!-- ##### FUNCTION gst_info_get_categories ##### -->
<para>
</para>
@format:
@args...:
@Returns:
<!-- ##### MACRO GST_DEBUG_PAD_NAME ##### -->
<!-- ##### FUNCTION gst_info_set_categories ##### -->
<para>
</para>
@pad:
@categories:
<!-- ##### MACRO GST_DEBUG_FUNCPTR ##### -->
<!-- ##### FUNCTION gst_info_enable_category ##### -->
<para>
</para>
@ptr:
@category:
<!-- ##### MACRO GST_DEBUG_FUNCPTR_NAME ##### -->
<!-- ##### FUNCTION gst_info_disable_category ##### -->
<para>
</para>
@ptr:
@category:
<!-- ##### USER_FUNCTION GstInfoHandler ##### -->
<!-- ##### FUNCTION gst_default_info_handler ##### -->
<para>
</para>
@ -69,7 +70,210 @@ to your application.
@string:
<!-- ##### FUNCTION gst_default_info_handler ##### -->
<!-- ##### MACRO GST_INFO_ENABLED ##### -->
<para>
</para>
<!-- ##### MACRO GST_INFO ##### -->
<para>
</para>
@cat:
@format:
@args...:
<!-- ##### MACRO GST_INFO_ELEMENT ##### -->
<para>
</para>
@cat:
@element:
@format:
@args...:
<!-- ##### FUNCTION gst_debug_get_categories ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_debug_set_categories ##### -->
<para>
</para>
@categories:
<!-- ##### FUNCTION gst_debug_enable_category ##### -->
<para>
</para>
@category:
<!-- ##### FUNCTION gst_debug_disable_category ##### -->
<para>
</para>
@category:
<!-- ##### MACRO GST_DEBUG_SET_STRING ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO GST_DEBUG_ENTER ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO GST_DEBUG_ENTER_STRING ##### -->
<para>
</para>
<!-- ##### MACRO GST_DEBUG_LEAVE ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO GST_DEBUG_LEAVE_STRING ##### -->
<para>
</para>
<!-- ##### MACRO GST_DEBUG_NOPREFIX ##### -->
<para>
</para>
@cat:
@format:
@args...:
<!-- ##### MACRO GST_DEBUG ##### -->
<para>
</para>
@cat:
@format:
@args...:
<!-- ##### MACRO GST_DEBUG_ENABLE_CATEGORIES ##### -->
<para>
</para>
<!-- ##### MACRO GST_DEBUG_FUNCPTR ##### -->
<para>
</para>
@ptr:
<!-- ##### MACRO GST_DEBUG_PREFIX ##### -->
<para>
</para>
@format:
@args...:
<!-- ##### MACRO GST_DEBUG_ENABLED ##### -->
<para>
</para>
<!-- ##### MACRO GST_DEBUG_FUNCPTR_NAME ##### -->
<para>
</para>
@ptr:
<!-- ##### MACRO GST_DEBUG_PAD_NAME ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_ERROR ##### -->
<para>
</para>
@element:
@format:
@args...:
<!-- ##### MACRO GST_ERROR_OBJECT ##### -->
<para>
</para>
@element:
@object:
@format:
@args...:
<!-- ##### FUNCTION gst_default_error_handler ##### -->
<para>
</para>
@file:
@function:
@line:
@debug_string:
@element:
@object:
@string:
<!-- ##### USER_FUNCTION GstInfoHandler ##### -->
<para>
</para>
@ -97,17 +301,3 @@ to your application.
@string:
<!-- ##### FUNCTION gst_default_error_handler ##### -->
<para>
</para>
@file:
@function:
@line:
@debug_string:
@element:
@object:
@string:

35
docs/gst/tmpl/gstpad.sgml
View file

@ -76,6 +76,15 @@ the function that will be called when a QoS message is sent.
@qos_message: the message
<!-- ##### USER_FUNCTION GstPadEOSFunction ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
<para>
@ -197,6 +206,15 @@ Destroy the pad
@qos:
<!-- ##### FUNCTION gst_pad_set_eos_function ##### -->
<para>
</para>
@pad:
@eos:
<!-- ##### FUNCTION gst_pad_set_caps_list ##### -->
<para>
@ -373,6 +391,23 @@ Destroy the pad
@qos_message:
<!-- ##### FUNCTION gst_pad_set_eos ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### MACRO gst_pad_eos ##### -->
<para>
</para>
@pad:
<!-- ##### FUNCTION gst_pad_save_thyself ##### -->
<para>

24
docs/gst/tmpl/gstreamer-unused.sgml
View file

@ -878,12 +878,6 @@ This macro unsets the given state on the element.
@obj: Element to unset state of.
@flag: State to unset, can be any number of bits in guint32.
<!-- ##### STRUCT GstDiskSrc ##### -->
<para>
</para>
<!-- ##### MACRO GST_SRC_FLAGS ##### -->
<para>
This macro returns the entire set of flags for the object.
@ -891,6 +885,12 @@ This macro returns the entire set of flags for the object.
@obj: GstSrc to return flags for.
<!-- ##### STRUCT GstDiskSrc ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_sink_get_type ##### -->
<para>
@ -1738,12 +1738,6 @@ Flags for the GstSrc element
@Returns:
<!-- ##### TYPEDEF GstPropsListFactory[] ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_pad_get_type_id ##### -->
<para>
@ -1752,6 +1746,12 @@ Flags for the GstSrc element
@pad:
@Returns:
<!-- ##### TYPEDEF GstPropsListFactory[] ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:See_Also ##### -->
<para>

8
gst/gstelement.c
View file

@ -201,6 +201,14 @@ gst_element_add_ghost_pad (GstElement *element, GstPad *pad)
gtk_signal_emit (GTK_OBJECT (element), gst_element_signals[NEW_GHOST_PAD], pad);
}
/**
* gst_element_remove_ghost_pad:
* @element: element to remove the ghost pad from
* @pad: ghost pad to remove
*
* removes a ghost pad from an element
*
*/
void
gst_element_remove_ghost_pad (GstElement *element, GstPad *pad)
{

10
gst/gstpad.c
View file

@ -347,7 +347,7 @@ gst_pad_set_qos_function (GstPad *pad,
/**
* gst_pad_set_eos_function:
* @pad: the pad to set the eos function for
* @qos: the eos function
* @eos: the eos function
*
* Set the given EOS function for the pad
*/
@ -1080,6 +1080,14 @@ gst_pad_eos_func(GstPad *pad)
return TRUE;
}
/**
* gst_pad_set_eos:
* @pad: the pad to set to eos
*
* sets the given pad to the eos state
*
* Returns: TRUE if it succeeded
*/
gboolean
gst_pad_set_eos(GstPad *pad)
{