mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 08:46:40 +00:00
Code Issues 1 Projects Releases Wiki Activity

some more docs cleanup

Browse source 
Original commit message from CVS:
some more docs cleanup
This commit is contained in:
Thomas Vander Stichele 2005-06-19 10:54:12 +00:00
parent 67fcf37209
commit 0944ac134b
7 changed files with 197 additions and 147 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -4,6 +4,10 @@
# <SECTION> # <SECTION>
# <FILE>gstxxx</FILE> # <FILE>gstxxx</FILE>
# <TITLE>GstXxx</TITLE> # <TITLE>GstXxx</TITLE>
# typedefs
# macros
# constructor
# methods
# <SUBSECTION Standard> # <SUBSECTION Standard>
# <SUBSECTION Private> # <SUBSECTION Private>
# </SECTION> # </SECTION>
@ -18,10 +22,6 @@ gst_init_check
gst_init_with_popt_table gst_init_with_popt_table
gst_init_check_with_popt_table gst_init_check_with_popt_table
gst_init_get_popt_table gst_init_get_popt_table
gst_use_threads
gst_has_threads
gst_main
gst_main_quit
<SUBSECTION Private> <SUBSECTION Private>
#GstPoptOption #GstPoptOption
</SECTION> </SECTION>
@ -31,22 +31,24 @@ gst_main_quit
<TITLE>GstBin</TITLE> <TITLE>GstBin</TITLE>
GstBin GstBin
GstBinFlags GstBinFlags
gst_bin_new gst_bin_new
gst_bin_add gst_bin_add
gst_bin_add_many
gst_bin_remove gst_bin_remove
gst_bin_remove_many
gst_bin_get_by_name gst_bin_get_by_name
gst_bin_get_by_name_recurse_up gst_bin_get_by_name_recurse_up
gst_bin_get_list
gst_bin_get_by_interface gst_bin_get_by_interface
gst_bin_get_all_by_interface
gst_bin_iterate gst_bin_iterate_elements
gst_bin_use_clock gst_bin_iterate_recurse
gst_bin_get_clock gst_bin_iterate_sinks
gst_bin_auto_clock gst_bin_iterate_all_by_interface
gst_bin_sync_children_state
gst_bin_child_state_change <SUBSECTION>
gst_bin_add_many
gst_bin_remove_many
<SUBSECTION Standard> <SUBSECTION Standard>
GstBinClass GstBinClass
GST_BIN GST_BIN
@ -56,15 +58,18 @@ GST_BIN_CLASS
GST_IS_BIN_CLASS GST_IS_BIN_CLASS
GST_BIN_GET_CLASS GST_BIN_GET_CLASS
GST_TYPE_BIN_FLAGS GST_TYPE_BIN_FLAGS
<SUBSECTION Private> <SUBSECTION Private>
gst_bin_get_type gst_bin_get_type
gst_bin_flags_get_type gst_bin_flags_get_type
</SECTION> </SECTION>
<SECTION> <SECTION>
<FILE>gstbuffer</FILE> <FILE>gstbuffer</FILE>
<TITLE>GstBuffer</TITLE> <TITLE>GstBuffer</TITLE>
GstBuffer GstBuffer
gst_buffer_new gst_buffer_new
gst_buffer_new_and_alloc gst_buffer_new_and_alloc
@ -77,42 +82,37 @@ GST_BUFFER_FLAG_UNSET
gst_buffer_set_data gst_buffer_set_data
GST_BUFFER_DATA GST_BUFFER_DATA
GST_BUFFER_SIZE GST_BUFFER_SIZE
GST_BUFFER_MAXSIZE
GST_BUFFER_TIMESTAMP GST_BUFFER_TIMESTAMP
GST_BUFFER_DURATION GST_BUFFER_DURATION
GST_BUFFER_OFFSET GST_BUFFER_OFFSET
GST_BUFFER_OFFSET_END GST_BUFFER_OFFSET_END
gst_buffer_ref gst_buffer_ref
gst_buffer_ref_by_count
gst_buffer_unref gst_buffer_unref
gst_buffer_stamp
gst_buffer_copy gst_buffer_copy
gst_buffer_is_writable gst_buffer_is_writable
gst_buffer_copy_on_write gst_buffer_make_writable
gst_buffer_replace
gst_buffer_get_caps
gst_buffer_set_caps
gst_buffer_create_sub gst_buffer_create_sub
gst_buffer_join
gst_buffer_merge
gst_buffer_span
gst_buffer_is_span_fast gst_buffer_is_span_fast
gst_buffer_default_free gst_buffer_span
gst_buffer_default_copy
GST_BUFFER_TRACE_NAME GST_BUFFER_TRACE_NAME
GST_BUFFER_REFCOUNT
GST_BUFFER_REFCOUNT_VALUE
GST_BUFFER_COPY_FUNC
GST_BUFFER_FREE_FUNC
GST_BUFFER_FREE_DATA_FUNC
GstBufferFreeDataFunc
GST_BUFFER_PRIVATE
GST_BUFFER_OFFSET_NONE GST_BUFFER_OFFSET_NONE
GST_BUFFER_MAXSIZE_NONE
GST_BUFFER_DURATION_IS_VALID GST_BUFFER_DURATION_IS_VALID
GST_BUFFER_TIMESTAMP_IS_VALID GST_BUFFER_TIMESTAMP_IS_VALID
GST_BUFFER_OFFSET_IS_VALID GST_BUFFER_OFFSET_IS_VALID
GST_BUFFER_OFFSET_END_IS_VALID GST_BUFFER_OFFSET_END_IS_VALID
GST_BUFFER_MAXSIZE_IS_VALID
<SUBSECTION>
gst_buffer_stamp
gst_buffer_join
gst_buffer_merge
<SUBSECTION Standard> <SUBSECTION Standard>
GST_BUFFER GST_BUFFER
@ -127,6 +127,9 @@ gst_buffer_flag_get_type
<SECTION> <SECTION>
<FILE>gstcaps</FILE> <FILE>gstcaps</FILE>
<TITLE>GstCaps</TITLE> <TITLE>GstCaps</TITLE>
GstCaps
GstStaticCaps
GST_CAPS_FLAGS_ANY GST_CAPS_FLAGS_ANY
GST_CAPS_ANY GST_CAPS_ANY
GST_CAPS_NONE GST_CAPS_NONE
@ -136,44 +139,34 @@ GST_CAPS_IS_SIMPLE
gst_caps_is_simple gst_caps_is_simple
GST_DEBUG_CAPS GST_DEBUG_CAPS
GST_STATIC_CAPS GST_STATIC_CAPS
GstCaps
GstStaticCaps
gst_caps_new_empty gst_caps_new_empty
gst_caps_new_any gst_caps_new_any
gst_caps_new_simple gst_caps_new_simple
gst_caps_new_full gst_caps_new_full
gst_caps_new_full_valist gst_caps_new_full_valist
gst_caps_copy gst_caps_copy
gst_caps_free
gst_static_caps_get gst_static_caps_get
gst_caps_append gst_caps_append
gst_caps_append_structure gst_caps_append_structure
gst_caps_split_one
gst_caps_get_size gst_caps_get_size
gst_caps_get_structure gst_caps_get_structure
gst_caps_copy_1
gst_caps_set_simple gst_caps_set_simple
gst_caps_set_simple_valist gst_caps_set_simple_valist
gst_caps_is_any gst_caps_is_any
gst_caps_is_empty gst_caps_is_empty
gst_caps_is_chained
gst_caps_is_fixed gst_caps_is_fixed
gst_caps_is_equal gst_caps_is_equal
gst_caps_is_equal_fixed
gst_caps_is_always_compatible gst_caps_is_always_compatible
gst_caps_is_subset gst_caps_is_subset
gst_caps_intersect gst_caps_intersect
gst_caps_union gst_caps_union
gst_caps_normalize gst_caps_normalize
gst_caps_simplify
gst_caps_do_simplify gst_caps_do_simplify
gst_caps_save_thyself gst_caps_save_thyself
gst_caps_load_thyself gst_caps_load_thyself
gst_caps_replace gst_caps_replace
gst_caps_to_string gst_caps_to_string
gst_caps_from_string gst_caps_from_string
gst_caps_structure_fixate_field_nearest_int
gst_caps_structure_fixate_field_nearest_double
gst_caps_subtract gst_caps_subtract
<SUBSECTION Standard> <SUBSECTION Standard>
GST_CAPS GST_CAPS
@ -1423,6 +1416,8 @@ gst_structure_get_double
gst_structure_get_string gst_structure_get_string
gst_structure_to_string gst_structure_to_string
gst_structure_from_string gst_structure_from_string
gst_caps_structure_fixate_field_nearest_int
gst_caps_structure_fixate_field_nearest_double
<SUBSECTION Standard> <SUBSECTION Standard>
GST_STRUCTURE GST_STRUCTURE
GST_IS_STRUCTURE GST_IS_STRUCTURE

77
docs/gst/tmpl/gstbin.sgml
View file

@ -106,16 +106,6 @@ Will be emmited if an element was removed from this bin.
@Returns: @Returns:
<!-- ##### FUNCTION gst_bin_add_many ##### -->
<para>
</para>
@bin:
@element_1:
@Varargs:
<!-- ##### FUNCTION gst_bin_remove ##### --> <!-- ##### FUNCTION gst_bin_remove ##### -->
<para> <para>
@ -126,16 +116,6 @@ Will be emmited if an element was removed from this bin.
@Returns: @Returns:
<!-- ##### FUNCTION gst_bin_remove_many ##### -->
<para>
</para>
@bin:
@element_1:
@Varargs:
<!-- ##### FUNCTION gst_bin_get_by_name ##### --> <!-- ##### FUNCTION gst_bin_get_by_name ##### -->
<para> <para>
@ -166,3 +146,60 @@ Will be emmited if an element was removed from this bin.
@Returns: @Returns:
<!-- ##### FUNCTION gst_bin_iterate_elements ##### -->
<para>
</para>
@bin:
@Returns:
<!-- ##### FUNCTION gst_bin_iterate_recurse ##### -->
<para>
</para>
@bin:
@Returns:
<!-- ##### FUNCTION gst_bin_iterate_sinks ##### -->
<para>
</para>
@bin:
@Returns:
<!-- ##### FUNCTION gst_bin_iterate_all_by_interface ##### -->
<para>
</para>
@bin:
@interface:
@Returns:
<!-- ##### FUNCTION gst_bin_add_many ##### -->
<para>
</para>
@bin:
@element_1:
@Varargs:
<!-- ##### FUNCTION gst_bin_remove_many ##### -->
<para>
</para>
@bin:
@element_1:
@Varargs:

98
docs/gst/tmpl/gstbuffer.sgml
View file

@ -241,15 +241,6 @@ will be freed.
@buf: a #GstBuffer to unref. @buf: a #GstBuffer to unref.
<!-- ##### FUNCTION gst_buffer_stamp ##### -->
<para>
</para>
@dest:
@src:
<!-- ##### MACRO gst_buffer_copy ##### --> <!-- ##### MACRO gst_buffer_copy ##### -->
<para> <para>
Copies the given buffer using the copy function of the parent GstData structure. Copies the given buffer using the copy function of the parent GstData structure.
@ -267,6 +258,41 @@ Tests if you can safely write data into a buffer's data array.
@buf: a #GstBuffer to check @buf: a #GstBuffer to check
<!-- ##### MACRO gst_buffer_make_writable ##### -->
<para>
</para>
@buf:
<!-- ##### MACRO gst_buffer_replace ##### -->
<para>
</para>
@obuf:
@nbuf:
<!-- ##### FUNCTION gst_buffer_get_caps ##### -->
<para>
</para>
@buffer:
@Returns:
<!-- ##### FUNCTION gst_buffer_set_caps ##### -->
<para>
</para>
@buffer:
@caps:
<!-- ##### FUNCTION gst_buffer_create_sub ##### --> <!-- ##### FUNCTION gst_buffer_create_sub ##### -->
<para> <para>
@ -278,17 +304,7 @@ Tests if you can safely write data into a buffer's data array.
@Returns: @Returns:
<!-- ##### FUNCTION gst_buffer_join ##### --> <!-- ##### FUNCTION gst_buffer_is_span_fast ##### -->
<para>
</para>
@buf1:
@buf2:
@Returns:
<!-- ##### FUNCTION gst_buffer_merge ##### -->
<para> <para>
</para> </para>
@ -310,16 +326,6 @@ Tests if you can safely write data into a buffer's data array.
@Returns: @Returns:
<!-- ##### FUNCTION gst_buffer_is_span_fast ##### -->
<para>
</para>
@buf1:
@buf2:
@Returns:
<!-- ##### MACRO GST_BUFFER_TRACE_NAME ##### --> <!-- ##### MACRO GST_BUFFER_TRACE_NAME ##### -->
<para> <para>
The name used for tracing memory allocations The name used for tracing memory allocations
@ -334,13 +340,6 @@ The name used for tracing memory allocations
<!-- ##### MACRO GST_BUFFER_MAXSIZE_NONE ##### -->
<para>
</para>
<!-- ##### MACRO GST_BUFFER_DURATION_IS_VALID ##### --> <!-- ##### MACRO GST_BUFFER_DURATION_IS_VALID ##### -->
<para> <para>
Tests if the duration is known. Tests if the duration is known.
@ -373,11 +372,32 @@ Tests if the timestamp is known.
@buffer: @buffer:
<!-- ##### MACRO GST_BUFFER_MAXSIZE_IS_VALID ##### --> <!-- ##### FUNCTION gst_buffer_stamp ##### -->
<para> <para>
</para> </para>
@buffer: @dest:
@src:
<!-- ##### FUNCTION gst_buffer_join ##### -->
<para>
</para>
@buf1:
@buf2:
@Returns:
<!-- ##### FUNCTION gst_buffer_merge ##### -->
<para>
</para>
@buf1:
@buf2:
@Returns:

58
docs/gst/tmpl/gstcaps.sgml
View file

@ -14,6 +14,24 @@ Structure describing sets of media formats
</para> </para>
<!-- ##### STRUCT GstCaps ##### -->
<para>
</para>
@type:
@refcount:
@flags:
@structs:
<!-- ##### STRUCT GstStaticCaps ##### -->
<para>
</para>
@caps:
@string:
<!-- ##### MACRO GST_CAPS_FLAGS_ANY ##### --> <!-- ##### MACRO GST_CAPS_FLAGS_ANY ##### -->
<para> <para>
Flags that this caps has no specific content, but can contain anything. Flags that this caps has no specific content, but can contain anything.
@ -91,24 +109,6 @@ templates.
@Returns: a new #GstCaps instance @Returns: a new #GstCaps instance
<!-- ##### STRUCT GstCaps ##### -->
<para>
</para>
@type:
@refcount:
@flags:
@structs:
<!-- ##### STRUCT GstStaticCaps ##### -->
<para>
</para>
@caps:
@string:
<!-- ##### FUNCTION gst_caps_new_empty ##### --> <!-- ##### FUNCTION gst_caps_new_empty ##### -->
<para> <para>
@ -376,28 +376,6 @@ templates.
@Returns: @Returns:
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_int ##### -->
<para>
</para>
@structure:
@field_name:
@target:
@Returns:
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_double ##### -->
<para>
</para>
@structure:
@field_name:
@target:
@Returns:
<!-- ##### FUNCTION gst_caps_subtract ##### --> <!-- ##### FUNCTION gst_caps_subtract ##### -->
<para> <para>

22
docs/gst/tmpl/gststructure.sgml
View file

@ -368,3 +368,25 @@ Generic structure containing fields of names and values
@Returns: @Returns:
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_int ##### -->
<para>
</para>
@structure:
@field_name:
@target:
@Returns:
<!-- ##### FUNCTION gst_caps_structure_fixate_field_nearest_double ##### -->
<para>
</para>
@structure:
@field_name:
@target:
@Returns:

8
gst/gstbin.h
View file

@ -72,13 +72,13 @@ typedef enum {
#define GST_BIN_CHILDREN_COOKIE(bin) (GST_BIN_CAST(bin)->children_cookie); #define GST_BIN_CHILDREN_COOKIE(bin) (GST_BIN_CAST(bin)->children_cookie);
struct _GstBin { struct _GstBin {
GstElement element; GstElement element;
/*< public >*/ /* with LOCK */ /*< public >*/ /* with LOCK */
/* our children, subclass are supposed to update these /* our children, subclass are supposed to update these
* fields to reflect their state with _iterate_*() */ * fields to reflect their state with _iterate_*() */
gint numchildren; gint numchildren;
GList *children; GList *children;
guint32 children_cookie; guint32 children_cookie;
/*< private >*/ /*< private >*/
@ -118,7 +118,7 @@ GstElement* gst_bin_get_by_interface (GstBin *bin, GType interface);
GstIterator* gst_bin_iterate_elements (GstBin *bin); GstIterator* gst_bin_iterate_elements (GstBin *bin);
GstIterator* gst_bin_iterate_recurse (GstBin *bin); GstIterator* gst_bin_iterate_recurse (GstBin *bin);
GstIterator* gst_bin_iterate_sinks (GstBin *bin); GstIterator* gst_bin_iterate_sinks (GstBin *bin);
GstIterator* gst_bin_iterate_all_by_interface (GstBin *bin, GType interface); GstIterator* gst_bin_iterate_all_by_interface (GstBin *bin, GType interface);
G_END_DECLS G_END_DECLS

2
gst/gstbuffer.h
View file

@ -58,13 +58,11 @@ typedef struct _GstBufferClass GstBufferClass;
#define GST_BUFFER_MALLOCDATA(buf) (GST_BUFFER(buf)->malloc_data) #define GST_BUFFER_MALLOCDATA(buf) (GST_BUFFER(buf)->malloc_data)
#define GST_BUFFER_OFFSET_NONE ((guint64)-1) #define GST_BUFFER_OFFSET_NONE ((guint64)-1)
#define GST_BUFFER_MAXSIZE_NONE ((guint)0)
#define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer))) #define GST_BUFFER_DURATION_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_DURATION (buffer)))
#define GST_BUFFER_TIMESTAMP_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer))) #define GST_BUFFER_TIMESTAMP_IS_VALID(buffer) (GST_CLOCK_TIME_IS_VALID (GST_BUFFER_TIMESTAMP (buffer)))
#define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE) #define GST_BUFFER_OFFSET_IS_VALID(buffer) (GST_BUFFER_OFFSET (buffer) != GST_BUFFER_OFFSET_NONE)
#define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE) #define GST_BUFFER_OFFSET_END_IS_VALID(buffer) (GST_BUFFER_OFFSET_END (buffer) != GST_BUFFER_OFFSET_NONE)
#define GST_BUFFER_MAXSIZE_IS_VALID(buffer) (GST_BUFFER_MAXSIZE (buffer) != GST_BUFFER_MAXSIZE_NONE)
/** /**
* GstBufferFlag: * GstBufferFlag: