Commit dddcc31c authored by Tim-Philipp Müller's avatar Tim-Philipp Müller 🐠

docs: fix up docs a bit

parent 259d10db
......@@ -57,6 +57,7 @@ Windows. It is released under the GNU Library General Public License
</para>
<xi:include href="xml/gst.xml" />
<xi:include href="xml/gstallocator.xml" />
<xi:include href="xml/gstatomicqueue.xml" />
<xi:include href="xml/gstbin.xml" />
<xi:include href="xml/gstbuffer.xml" />
......
......@@ -546,7 +546,6 @@ gst_clock_set_timeout
gst_clock_id_get_time
gst_clock_id_wait
gst_clock_id_wait_async
gst_clock_id_wait_async_full
gst_clock_id_unschedule
gst_clock_id_compare_func
gst_clock_id_ref
......@@ -1100,21 +1099,16 @@ gst_ghost_pad_get_target
gst_ghost_pad_construct
gst_ghost_pad_unlink_default
gst_ghost_pad_link_default
gst_ghost_pad_activate_mode_default
gst_ghost_pad_internal_activate_mode_default
gst_proxy_pad_get_internal
gst_proxy_pad_event_default
gst_proxy_pad_query_default
gst_proxy_pad_iterate_internal_links_default
gst_proxy_pad_chain_default
gst_proxy_pad_chain_list_default
gst_proxy_pad_getrange_default
gst_proxy_pad_unlink_default
<SUBSECTION Standard>
GstGhostPadClass
GST_GHOST_PAD
......@@ -1458,6 +1452,7 @@ gst_message_new_toc
gst_message_parse_toc
gst_message_new_reset_time
gst_message_parse_reset_time
gst_message_new_stream_start
GstStructureChangeType
gst_message_new_structure_change
......@@ -1638,7 +1633,6 @@ GstPadLinkReturn
GST_PAD_LINK_FAILED
GST_PAD_LINK_SUCCESSFUL
GstPadLinkCheck
GST_PAD_LINK_CHECK_DEFAULT
GstFlowReturn
GstPadMode
......@@ -1747,6 +1741,7 @@ gst_pad_set_activatemode_function
gst_pad_set_activatemode_function_full
GstPadActivateModeFunction
gst_pad_needs_reconfigure
gst_pad_check_reconfigure
gst_pad_mark_reconfigure
......@@ -1788,6 +1783,8 @@ gst_pad_set_element_private
gst_pad_get_element_private
gst_pad_create_stream_id
gst_pad_create_stream_id_printf
gst_pad_create_stream_id_printf_valist
GstPadForwardFunction
gst_pad_forward
......@@ -1850,11 +1847,14 @@ GST_PAD_NEEDS_RECONFIGURE
GST_PAD_HAS_PENDING_EVENTS
GST_PAD_IS_PROXY_ALLOCATION
GST_PAD_IS_PROXY_CAPS
GST_PAD_IS_PROXY_SCHEDULING
GST_PAD_NEEDS_PARENT
GST_PAD_SET_PROXY_ALLOCATION
GST_PAD_UNSET_PROXY_ALLOCATION
GST_PAD_SET_PROXY_CAPS
GST_PAD_UNSET_PROXY_CAPS
GST_PAD_SET_PROXY_SCHEDULING
GST_PAD_UNSET_PROXY_SCHEDULING
GST_PAD_IS_IN_GETCAPS
GST_PAD_MODE_ACTIVATE
......@@ -2479,6 +2479,8 @@ GstTagFlag
GstTagForeachFunc
GstTagMergeFunc
GstTagScope
GST_TAG_TITLE
GST_TAG_TITLE_SORTNAME
GST_TAG_ARTIST
......@@ -2575,6 +2577,8 @@ gst_tag_list_new_empty
gst_tag_list_new_valist
gst_tag_list_new_from_string
gst_tag_list_free
gst_tag_list_get_scope
gst_tag_list_set_scope
gst_tag_list_to_string
gst_tag_list_is_empty
gst_tag_list_is_equal
......@@ -2630,10 +2634,12 @@ GST_TAG_MODE_IS_VALID
GST_TYPE_TAG_LIST
GST_TYPE_TAG_FLAG
GST_TYPE_TAG_MERGE_MODE
GST_TYPE_TAG_SCOPE
<SUBSECTION Private>
gst_tag_list_get_type
gst_tag_flag_get_type
gst_tag_merge_mode_get_type
gst_tag_scope_get_type
</SECTION>
......@@ -2755,7 +2761,6 @@ gst_toc_merge_tags
gst_toc_set_tags
gst_toc_dump
gst_toc_entry_new
gst_toc_entry_new_with_pad
gst_toc_entry_ref
gst_toc_entry_unref
gst_toc_entry_copy
......@@ -2781,10 +2786,12 @@ GST_TOC_ENTRY_TYPE_IS_SEQUENCE
GST_TYPE_TOC
GST_TYPE_TOC_ENTRY
GST_TYPE_TOC_ENTRY_TYPE
GST_TYPE_TOC_SCOPE
<SUBSECTION Private>
gst_toc_get_type
gst_toc_entry_get_type
gst_toc_entry_type_get_type
gst_toc_scope_get_type
</SECTION>
......@@ -2987,9 +2994,11 @@ gst_date_time_get_time_zone_offset
gst_date_time_get_second
gst_date_time_get_year
gst_date_time_new
gst_date_time_new_ymd
gst_date_time_new_ym
gst_date_time_new_y
gst_date_time_new_from_unix_epoch_local_time
gst_date_time_new_from_unix_epoch_utc
gst_date_time_new_ymd
gst_date_time_new_local_time
gst_date_time_new_now_local_time
gst_date_time_new_now_utc
......@@ -3002,9 +3011,6 @@ gst_date_time_has_second
gst_date_time_has_time
gst_date_time_has_year
gst_date_time_new_y
gst_date_time_new_ym
gst_date_time_new
gst_date_time_new_from_iso8601_string
gst_date_time_to_iso8601_string
......
......@@ -1344,7 +1344,7 @@ gst_buffer_resize_range (GstBuffer * buffer, guint idx, gint length,
* @info: (out): info about the mapping
* @flags: flags for the mapping
*
* This function fills @idx with the #GstMapInfo of all merged memory
* This function fills @info with the #GstMapInfo of all merged memory
* blocks in @buffer.
*
* @flags describe the desired access of the memory. When @flags is
......@@ -1355,10 +1355,10 @@ gst_buffer_resize_range (GstBuffer * buffer, guint idx, gint length,
* automatically be created and returned. The readonly copy of the
* buffer memory will then also be replaced with this writable copy.
*
* The memory in @idx should be unmapped with gst_buffer_unmap() after
* The memory in @info should be unmapped with gst_buffer_unmap() after
* usage.
*
* Returns: %TRUE if the map succeeded and @idx contains valid data.
* Returns: %TRUE if the map succeeded and @info contains valid data.
*/
gboolean
gst_buffer_map (GstBuffer * buffer, GstMapInfo * info, GstMapFlags flags)
......
......@@ -571,11 +571,14 @@ wrong_config:
*
* @config is a #GstStructure that contains the configuration parameters for
* the pool. A default and mandatory set of parameters can be configured with
* gst_buffer_pool_config_set(). This function takes ownership of @config.
* gst_buffer_pool_config_set_params(), gst_buffer_pool_config_set_allocator()
* and gst_buffer_pool_config_add_option().
*
* If the parameters in @config can not be set exactly, this function returns
* FALSE and will try to update as much state as possible. The new state can
* then be retrieved and refined with gst_buffer_pool_config_get().
* then be retrieved and refined with gst_buffer_pool_get_config().
*
* This function takes ownership of @config.
*
* Returns: TRUE when the configuration could be set.
*/
......
......@@ -60,6 +60,7 @@ typedef void (* GstControlBindingConvert) (GstControlBinding *binding, gdouble s
/**
* GstControlBinding:
* @name: name of the property of this binding
* @pspec: #GParamSpec for this property
*
* The instance structure of #GstControlBinding.
*/
......@@ -67,8 +68,8 @@ struct _GstControlBinding {
GstObject parent;
/*< public >*/
gchar *name; /* name of the property */
GParamSpec *pspec; /* GParamSpec for this property */
gchar *name;
GParamSpec *pspec;
/*< private >*/
GstObject *object; /* GstObject owning the property
......@@ -81,7 +82,6 @@ struct _GstControlBinding {
/**
* GstControlBindingClass:
* @parent_class: Parent class
* @convert: Class method to convert control-values
*
* The class structure of #GstControlBinding.
*/
......
......@@ -1611,7 +1611,8 @@ gst_event_parse_sink_message (GstEvent * event, GstMessage ** msg)
* stream. A new stream-id should only be created for a stream if the upstream
* stream is split into (potentially) multiple new streams, e.g. in a demuxer,
* but not for every single element in the pipeline.
* gst_util_create_stream_id() can be used to create a stream-id.
* gst_pad_create_stream_id() or gst_pad_create_stream_id_printf() can be
* used to create a stream-id.
*
* Returns: (transfer full): the new STREAM_START event.
*/
......
......@@ -179,7 +179,7 @@ typedef struct {
guint8 *data;
gsize size;
gsize maxsize;
/*< private >*/
/*< protected >*/
gpointer user_data[4];
} GstMapInfo;
......
......@@ -89,7 +89,14 @@ typedef struct _GstMessage GstMessage;
* strategy for Quality of Service reasons.
* @GST_MESSAGE_PROGRESS: A progress message.
* @GST_MESSAGE_TOC: A new table of contents (TOC) was found or previously found TOC
* was updated. Since:
* was updated.
* @GST_MESSAGE_RESET_TIME: Message to request resetting the pipeline's
* running time from the pipeline. This is an internal message which
* applications will likely never receive.
* @GST_MESSAGE_STREAM_START: Message indicating start of a new stream. Useful
* e.g. when using playbin in gapless playback mode, to get notified when
* the next title actually starts playing (which will be some time after
* the URI for the next title has been set).
* @GST_MESSAGE_ANY: mask for all of the above messages.
*
* The different message types that are available.
......
......@@ -104,6 +104,7 @@ _priv_gst_mini_object_initialize (void)
/**
* gst_mini_object_init: (skip)
* @mini_object: a #GstMiniObject
* @flags: initial #GstMiniObjectFlags
* @type: the #GType of the mini-object to create
* @copy_func: the copy function, or NULL
* @dispose_func: the dispose function, or NULL
......
......@@ -73,7 +73,8 @@ typedef void (*GstMiniObjectFreeFunction) (GstMiniObject *obj);
* @obj: the mini object
*
* A #GstMiniObjectNotify function can be added to a mini object as a
* callback that gets triggered with gst_mini_object_notify().
* callback that gets triggered when gst_mini_object_unref() drops the
* last ref and @obj is about to be freed.
*/
typedef void (*GstMiniObjectNotify) (gpointer user_data, GstMiniObject * obj);
......
......@@ -739,6 +739,10 @@ gst_tag_list_new_empty (void)
* function. The tag list will make copies of any arguments passed
* (e.g. strings, buffers).
*
* After creation you might also want to set a #GstTagScope on the returned
* taglist to signal if the contained tags are global or stream tags. By
* default stream scope is assumes. See gst_tag_list_set_scope().
*
* Free-function: gst_tag_list_unref
*
* Returns: (transfer full): a new #GstTagList. Free with gst_tag_list_unref()
......@@ -792,7 +796,7 @@ gst_tag_list_new_valist (va_list var_args)
* @scope: new scope for @list
*
* Sets the scope of @list to @scope. By default the scope
* of a taglist is #GST_TAG_SCOPE_STREAM.
* of a taglist is stream scope.
*
*/
void
......
......@@ -213,7 +213,7 @@ gboolean gst_tag_is_fixed (const gchar * tag);
/* tag lists */
/**
* GstTagEventScope:
* GstTagScope:
* @GST_TAG_SCOPE_STREAM: tags specific to this single stream
* @GST_TAG_SCOPE_GLOBAL: global tags for the complete medium
*
......
......@@ -35,28 +35,31 @@
*
* Using TOC is very easy. Firstly, create #GstToc structure which represents root
* contents of the source. You can also attach TOC-specific tags to it. Then fill
* it with #GstTocEntry entries by appending them to #GstToc.entries #GstTocEntry.subentries
* lists. You should use GST_TOC_ENTRY_TYPE_CHAPTER for generic TOC entry and
* GST_TOC_ENTRY_TYPE_EDITION for the entries which are considered to be alternatives
* (like DVD angles, Matroska editions and so on).
* it with #GstTocEntry entries by appending them to the #GstToc using
* gst_toc_append_entry(), and appending subentries to a #GstTocEntry using
* gst_toc_entry_append_sub_entry().
*
* Note that root level of the TOC can contain only either editions or chapters. You
* should not mix them together at the same level. Otherwise you will get serialization
* /deserialization errors. Make sure that no one of the entries has negative start and
* stop values.
*
* Please, use #GstToc.info and #GstTocEntry.info fields in that way: create a #GstStructure,
* put all info related to your element there and put this structure into the info field under
* the name of your element. Some fields in the info structure can be used for internal purposes,
* so you should use it in the way described above to not to overwrite already existent fields.
*
* Use gst_event_new_toc() to create a new TOC #GstEvent, and gst_event_parse_toc() to
* parse received TOC event. Use gst_event_new_toc_select() to create a new TOC select #GstEvent,
* and gst_event_parse_toc_select() to parse received TOC select event. The same rule for
* the #GstMessage: gst_message_new_toc() to create new TOC #GstMessage, and
* gst_message_parse_toc() to parse received TOC message. Also you can create a new TOC query
* with gst_query_new_toc(), set it with gst_query_set_toc() and parse it with
* gst_query_parse_toc().
* gst_message_parse_toc() to parse received TOC message.
*
* TOCs can have global scope or current scope. Global scope TOCs contain
* all entries that can possibly be selected using a toc select event, and
* are what an application is usually interested in. TOCs with current scope
* only contain the parts of the TOC relevant to the currently selected/playing
* stream; the current scope TOC is used by downstream elements such as muxers
* to write correct TOC entries when transcoding files, for example. When
* playing a DVD, the global TOC would contain a hierarchy of all titles,
* chapters and angles, for example, while the current TOC would only contain
* the chapters for the currently playing title if playback of a specific
* title was requested.
*/
#ifdef HAVE_CONFIG_H
......@@ -421,7 +424,7 @@ gst_toc_entry_copy (const GstTocEntry * entry)
* Copy #GstToc with all subentries (deep copy).
*
* Returns: newly allocated #GstToc in case of success, NULL otherwise;
* free it when done with gst_toc_free().
* free it when done with gst_toc_unref().
*/
static GstToc *
gst_toc_copy (const GstToc * toc)
......
......@@ -3536,7 +3536,8 @@ gst_util_fraction_compare (gint a_n, gint a_d, gint b_n, gint b_d)
g_return_val_if_reached (0);
}
/** gst_pad_create_stream_id:
/**
* gst_pad_create_stream_id_printf_valist:
* @pad: A source #GstPad
* @parent: Parent #GstElement of @pad
* @stream_id: (allow-none): The stream-id
......@@ -3640,7 +3641,8 @@ gst_pad_create_stream_id_printf_valist (GstPad * pad, GstElement * parent,
return new_stream_id;
}
/** gst_pad_create_stream_id:
/**
* gst_pad_create_stream_id_printf:
* @pad: A source #GstPad
* @parent: Parent #GstElement of @pad
* @stream_id: (allow-none): The stream-id
......@@ -3677,7 +3679,8 @@ gst_pad_create_stream_id_printf (GstPad * pad, GstElement * parent,
return new_stream_id;
}
/** gst_pad_create_stream_id:
/**
* gst_pad_create_stream_id:
* @pad: A source #GstPad
* @parent: Parent #GstElement of @pad
* @stream_id: (allow-none): The stream-id
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment