mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-30 05:31:15 +00:00
Code Issues 1 Projects Releases Wiki Activity

Doc fixes.

Browse source 
Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gstbuffer.h:
* gst/gstelement.c:
* gst/gstformat.c:
* gst/gstformat.h:
* gst/gstindex.h:
* gst/gstquery.c:
* gst/gstquery.h:
* gst/gstvalue.c:
Doc fixes.
This commit is contained in:
Wim Taymans 2005-11-20 14:50:43 +00:00
parent deacfd8e89
commit 10a32af38d
10 changed files with 118 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
ChangeLog
View file

@ -1,3 +1,42 @@
2005-11-20 Wim Taymans <wim@fluendo.com>
reviewed by: <delete if not using a buddy>
* docs/design/part-TODO.txt:
* docs/gst/gstreamer-sections.txt:
* gst/Makefile.am:
* gst/gst.h:
* gst/gstbuffer.h:
* gst/gstbus.c: (gst_bus_add_watch):
* gst/gstclock.c: (gst_clock_init), (gst_clock_set_master),
(gst_clock_get_master):
* gst/gstclock.h:
* gst/gstelement.c:
* gst/gstformat.c:
* gst/gstformat.h:
* gst/gstindex.h:
* gst/gstquery.c:
* gst/gstquery.h:
* gst/gstsystemclock.c: (gst_system_clock_init):
* gst/gstvalue.c:
* po/af.po:
* po/az.po:
* po/ca.po:
* po/cs.po:
* po/de.po:
* po/en_GB.po:
* po/fr.po:
* po/it.po:
* po/nb.po:
* po/nl.po:
* po/ru.po:
* po/sq.po:
* po/sr.po:
* po/sv.po:
* po/tr.po:
* po/uk.po:
* po/vi.po:
2005-11-20 Wim Taymans <wim@fluendo.com>
* docs/design/part-TODO.txt:

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

@ -190,7 +190,7 @@ gst_buffer_flag_get_type
GstCaps
GstStaticCaps
GST_CAPS_FLAGS_ANY
GstCapsFlags
GST_CAPS_ANY
GST_CAPS_NONE
GST_CAPS_REFCOUNT
@ -241,7 +241,9 @@ gst_caps_unref
GST_CAPS
GST_IS_CAPS
GST_TYPE_CAPS
GST_TYPE_CAPS_FLAGS
<SUBSECTION Private>
gst_caps_flags_get_type
gst_caps_get_type
</SECTION>
@ -355,8 +357,12 @@ gst_clock_get_resolution
gst_clock_get_time
gst_clock_new_single_shot_id
gst_clock_new_periodic_id
gst_clock_get_internal_time
gst_clock_adjust_unlocked
gst_clock_set_time_adjust
gst_clock_get_calibration
gst_clock_set_calibration
gst_clock_get_master
gst_clock_set_master
gst_clock_id_get_time
gst_clock_id_wait
gst_clock_id_wait_async
@ -456,7 +462,7 @@ gst_element_class_get_pad_template
gst_element_class_get_pad_template_list
gst_element_class_install_std_props
gst_element_class_set_details
gst_element_commit_state
gst_element_continue_state
gst_element_create_all_pads
gst_element_factory_can_sink_caps
gst_element_factory_can_src_caps
@ -690,6 +696,8 @@ GST_FORMAT_PERCENT_MAX
GST_FORMAT_PERCENT_SCALE
GstFormatDefinition
gst_format_get_name
gst_format_to_quark
gst_format_register
gst_format_get_by_nick
gst_formats_contains
@ -755,6 +763,7 @@ gst_index_set_group
gst_index_set_certainty
gst_index_get_certainty
gst_index_set_filter
gst_index_set_filter_full
gst_index_set_resolver
gst_index_get_writer_id
gst_index_add_format
@ -1181,6 +1190,7 @@ gst_pad_remove_event_probe
<SUBSECTION Element>
gst_pad_new
gst_pad_new_from_template
gst_pad_new_from_static_template
gst_pad_alloc_buffer
gst_pad_set_bufferalloc_function
@ -1312,7 +1322,6 @@ GST_PAD_DIRECTION
GST_PAD_CAPS
GST_PAD_PEER
GST_PAD_IS_LINKED
GST_PAD_IS_USABLE
GST_PAD_IS_SRC
GST_PAD_IS_SINK
@ -1532,6 +1541,9 @@ GstQueryType
GST_QUERY_TYPE_RATE_DEN
GstQueryTypeDefinition
gst_query_type_get_name
gst_query_type_to_quark
gst_query_type_register
gst_query_type_get_by_nick
gst_query_types_contains
@ -2039,10 +2051,7 @@ gst_util_dump_mem
gst_util_uint64_scale
gst_util_set_object_arg
gst_util_set_value_from_string
g_static_rec_cond_timed_wait
g_static_rec_cond_wait
<SUBSECTION Private>
GST_COMPILE_STATIC_REC_COND_WAIT
GST_HAVE_UNALIGNED_ACCESS
</SECTION>
@ -2143,6 +2152,10 @@ gst_value_register_subtract_func
gst_value_intersect
gst_value_can_intersect
gst_value_register_intersect_func
gst_value_array_append_value
gst_value_array_get_size
gst_value_array_get_value
gst_value_array_prepend_value
<SUBSECTION Standard>
<SUBSECTION Private>

1
gst/gstbuffer.h
View file

@ -181,7 +181,6 @@ typedef struct _GstBufferClass GstBufferClass;
/**
* GstBufferFlag:
* @GST_BUFFER_FLAG_READONLY: the buffer is read-only.
* @GST_BUFFER_FLAG_ORIGINAL: buffer is not a copy of another buffer.
* @GST_BUFFER_FLAG_PREROLL: the buffer is part of a preroll and should not be
* displayed.
* @GST_BUFFER_FLAG_DISCONT: the buffer marks a discontinuity in the stream.

23
gst/gstelement.c
View file

@ -1824,8 +1824,27 @@ nothing_aborted:
}
}
/* FIXME, this function is to be put in the .h file,
* gst_element_commit_state() should go away. */
/**
* gst_element_continue_state:
* @element: a #GstElement to continue the state change of.
* @ret: The previous state return value
*
* Commit the state change of the element and proceed to the next
* pending state if any. This function is used
* by elements that do asynchronous state changes.
* The core will normally call this method automatically when an
* element returned SUCCESS from the state change function.
* Elements that return ASYNC from the change_state function should
* eventually call this method from the streaming thread to signal
* successfull state change completion.
*
* If after calling this method the element still has not reached
* the pending state, the next state change is performed.
*
* Returns: The result of the commit state change.
*
* MT safe.
*/
GstStateChangeReturn
gst_element_continue_state (GstElement * element, GstStateChangeReturn ret)
{

16
gst/gstformat.c
View file

@ -75,6 +75,14 @@ _gst_format_initialize (void)
g_static_mutex_unlock (&mutex);
}
/**
* gst_format_get_name:
* @format: a #GstFormat
*
* Get a printable name for the given format. Do not modify or free.
*
* Returns: a reference to the static name of the format.
*/
const gchar *
gst_format_get_name (GstFormat format)
{
@ -85,6 +93,14 @@ gst_format_get_name (GstFormat format)
return def->nick;
}
/**
* gst_format_to_quark:
* @format: a #GstFormat
*
* Get the unique quark for the given format.
*
* Returns: the quark associated with the format
*/
GQuark
gst_format_to_quark (GstFormat format)
{

1
gst/gstformat.h
View file

@ -76,6 +76,7 @@ typedef struct _GstFormatDefinition GstFormatDefinition;
* @value: The unique id of this format
* @nick: A short nick of the format
* @description: A longer description of the format
* @quark: A quark for the nick
*
* A format definition
*/

1
gst/gstindex.h
View file

@ -244,6 +244,7 @@ struct _GstIndexGroup {
* GstIndexFilter:
* @index: The index being queried
* @entry: The entry to be added.
* @user_data: User data passed to the function.
*
* Function to filter out entries in the index.
*

18
gst/gstquery.c
View file

@ -100,6 +100,14 @@ _gst_query_initialize (void)
gst_query_get_type ();
}
/**
* gst_query_type_get_name:
* @query: the query type
*
* Get a printable name for the given query type. Do not modify or free.
*
* Returns: a reference to the static name of the query.
*/
const gchar *
gst_query_type_get_name (GstQueryType query)
{
@ -110,6 +118,14 @@ gst_query_type_get_name (GstQueryType query)
return def->nick;
}
/**
* gst_query_type_to_quark:
* @query: the query type
*
* Get the unique quark for the given query type.
*
* Returns: the quark associated with the query type
*/
GQuark
gst_query_type_to_quark (GstQueryType query)
{
@ -239,6 +255,8 @@ gst_query_type_register (const gchar * nick, const gchar * description)
* gst_query_type_get_by_nick:
* @nick: The nick of the query
*
* Get the query type registered with @nick.
*
* Returns: The query registered with @nick or #GST_QUERY_NONE
* if the query was not registered.
*/

1
gst/gstquery.h
View file

@ -80,6 +80,7 @@ typedef struct _GstQueryClass GstQueryClass;
* @value: the unique id of the Query type
* @nick: a short nick
* @description: a longer description of the query type
* @quark: the quark for the nick
*
* A Query Type definition
*/

2
gst/gstvalue.c
View file

@ -279,7 +279,7 @@ gst_value_list_prepend_value (GValue * value, const GValue * prepend_value)
* gst_value_list_concat:
* @dest: an uninitialized #GValue to take the result
* @value1: a #GValue
* @value1: a #GValue
* @value2: a #GValue
*
* Concatenates copies of @value1 and @value2 into a list. Values that are not
* of type #GST_TYPE_LIST are treated as if they were lists of length 1.