projects
/
platform
/
upstream
/
gstreamer.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
aggregator: Assert if the sink/src pad type that is to be used is not a GstAggregator...
[platform/upstream/gstreamer.git]
/
libs
/
gst
/
base
/
gstindex.c
diff --git
a/libs/gst/base/gstindex.c
b/libs/gst/base/gstindex.c
index
a0505cc
..
bfc7cb1
100644
(file)
--- a/
libs/gst/base/gstindex.c
+++ b/
libs/gst/base/gstindex.c
@@
-16,16
+16,17
@@
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 5
9 Temple Place - Suite 330
,
- * Boston, MA 0211
1-1307
, USA.
+ * Free Software Foundation, Inc., 5
1 Franklin St, Fifth Floor
,
+ * Boston, MA 0211
0-1301
, USA.
*/
/**
* SECTION:gstindex
*/
/**
* SECTION:gstindex
+ * @title: GstIndexEntry
* @short_description: Generate indexes on objects
* @see_also: #GstIndexFactory
*
* @short_description: Generate indexes on objects
* @see_also: #GstIndexFactory
*
- * GstIndex is used to generate a stream index of one or more elements
+ *
#
GstIndex is used to generate a stream index of one or more elements
* in a pipeline.
*
* Elements will overload the set_index and get_index virtual methods in
* in a pipeline.
*
* Elements will overload the set_index and get_index virtual methods in
@@
-304,7
+305,7
@@
gst_index_new (void)
{
GstIndex *index;
{
GstIndex *index;
- index = g_object_new
v (gst_index_get_type (), 0
, NULL);
+ index = g_object_new
(gst_index_get_type ()
, NULL);
return index;
}
return index;
}
@@
-312,7
+313,7
@@
gst_index_new (void)
/**
* gst_index_commit:
* @index: the index to commit
/**
* gst_index_commit:
* @index: the index to commit
- * @id: the writer that commited the index
+ * @id: the writer that commit
t
ed the index
*
* Tell the index that the writer with the given id is done
* with this index and is not going to write any more entries
*
* Tell the index that the writer with the given id is done
* with this index and is not going to write any more entries
@@
-368,7
+369,7
@@
gst_index_new_group (GstIndex * index)
*
* Set the current groupnumber to the given argument.
*
*
* Set the current groupnumber to the given argument.
*
- * Returns:
TRUE if the operation succeeded,
FALSE if the group
+ * Returns:
%TRUE if the operation succeeded, %
FALSE if the group
* did not exist.
*/
gboolean
* did not exist.
*/
gboolean
@@
-496,8
+497,6
@@
gst_index_set_resolver (GstIndex * index,
*
* Lets the app register a custom function to map index
* ids to writer descriptions.
*
* Lets the app register a custom function to map index
* ids to writer descriptions.
- *
- * Since: 0.10.18
*/
void
gst_index_set_resolver_full (GstIndex * index, GstIndexResolver resolver,
*/
void
gst_index_set_resolver_full (GstIndex * index, GstIndexResolver resolver,
@@
-573,7
+572,7
@@
gst_index_entry_free (GstIndexEntry * entry)
* @format: the format to add to the index
*
* Adds a format entry into the index. This function is
* @format: the format to add to the index
*
* Adds a format entry into the index. This function is
- * used to map dynamic GstFormat ids to their original
+ * used to map dynamic
#
GstFormat ids to their original
* format key.
*
* Free-function: gst_index_entry_free
* format key.
*
* Free-function: gst_index_entry_free
@@
-678,7
+677,7
@@
gst_index_gtype_resolver (GstIndex * index, GstObject * writer,
/**
* gst_index_get_writer_id:
* @index: the index to get a unique write id for
/**
* gst_index_get_writer_id:
* @index: the index to get a unique write id for
- * @writer: the GstObject to allocate an id for
+ * @writer: the
#
GstObject to allocate an id for
* @id: a pointer to a gint to hold the id
*
* Before entries can be added to the index, a writer
* @id: a pointer to a gint to hold the id
*
* Before entries can be added to the index, a writer
@@
-689,13
+688,11
@@
gst_index_gtype_resolver (GstIndex * index, GstObject * writer,
* to a string. That string will be used to register or look up an id
* in the index.
*
* to a string. That string will be used to register or look up an id
* in the index.
*
- * <note>
- * The caller must not hold @writer's #GST_OBJECT_LOCK, as the default
- * resolver may call functions that take the object lock as well, and
- * the lock is not recursive.
- * </note>
+ * > The caller must not hold @writer's GST_OBJECT_LOCK(), as the default
+ * > resolver may call functions that take the object lock as well, and
+ * > the lock is not recursive.
*
*
- * Returns: TRUE if the writer would be mapped to an id.
+ * Returns:
%
TRUE if the writer would be mapped to an id.
*/
gboolean
gst_index_get_writer_id (GstIndex * index, GstObject * writer, gint * id)
*/
gboolean
gst_index_get_writer_id (GstIndex * index, GstObject * writer, gint * id)
@@
-775,9
+772,9
@@
gst_index_add_entry (GstIndex * index, GstIndexEntry * entry)
* gst_index_add_associationv:
* @index: the index to add the entry to
* @id: the id of the index writer
* gst_index_add_associationv:
* @index: the index to add the entry to
* @id: the id of the index writer
- * @flags: optinal flags for this entry
+ * @flags: opti
o
nal flags for this entry
* @n: number of associations
* @n: number of associations
- * @list: list of associations
+ * @list:
(array length=n):
list of associations
*
* Associate given format/value pairs with each other.
*
*
* Associate given format/value pairs with each other.
*
@@
-814,7
+811,7
@@
gst_index_add_associationv (GstIndex * index, gint id,
* gst_index_add_association:
* @index: the index to add the entry to
* @id: the id of the index writer
* gst_index_add_association:
* @index: the index to add the entry to
* @id: the id of the index writer
- * @flags: optinal flags for this entry
+ * @flags: opti
o
nal flags for this entry
* @format: the format of the value
* @value: the value
* @...: other format/value pairs or 0 to end the list
* @format: the format of the value
* @value: the value
* @...: other format/value pairs or 0 to end the list
@@
-920,7
+917,7
@@
gst_index_compare_func (gconstpointer a, gconstpointer b, gpointer user_data)
*
* Finds the given format/value in the index
*
*
* Finds the given format/value in the index
*
- * Returns:
the entry associated with the value or
NULL if the
+ * Returns:
(nullable): the entry associated with the value or %
NULL if the
* value was not found.
*/
GstIndexEntry *
* value was not found.
*/
GstIndexEntry *
@@
-951,7
+948,7
@@
gst_index_get_assoc_entry (GstIndex * index, gint id,
* Finds the given format/value in the index with the given
* compare function and user_data.
*
* Finds the given format/value in the index with the given
* compare function and user_data.
*
- * Returns:
the entry associated with the value or
NULL if the
+ * Returns:
(nullable): the entry associated with the value or %
NULL if the
* value was not found.
*/
GstIndexEntry *
* value was not found.
*/
GstIndexEntry *
@@
-983,7
+980,7
@@
gst_index_get_assoc_entry_full (GstIndex * index, gint id,
*
* Gets alternative formats associated with the indexentry.
*
*
* Gets alternative formats associated with the indexentry.
*
- * Returns: TRUE if there was a value associated with the given
+ * Returns:
%
TRUE if there was a value associated with the given
* format.
*/
gboolean
* format.
*/
gboolean