* gst_structure_remove_fields().
*
* Strings in structures must be ASCII or UTF-8 encoded. Other encodings are
- * not allowed. Strings may be NULL however.
+ * not allowed. Strings may be %NULL however.
*
* Be aware that the current #GstCaps / #GstStructure serialization into string
* has limited support for nested #GstCaps / #GstStructure fields. It can only
* Creates a new #GstStructure with the given name. Parses the
* list of variable arguments and sets fields to the values listed.
* Variable arguments should be passed as field name, field type,
- * and value. Last variable argument should be NULL.
+ * and value. Last variable argument should be %NULL.
*
* Free-function: gst_structure_free
*
*
* Checks if the structure has the given name
*
- * Returns: TRUE if @name matches the name of the structure.
+ * Returns: %TRUE if @name matches the name of the structure.
*/
gboolean
gst_structure_has_name (const GstStructure * structure, const gchar * name)
*
* Parses the variable arguments and sets fields accordingly.
* Variable arguments should be in the form field name, field type
- * (as a GType), value(s). The last variable argument should be NULL.
+ * (as a GType), value(s). The last variable argument should be %NULL.
*/
void
gst_structure_set (GstStructure * structure, const gchar * field, ...)
* passed using the GQuark for the field name. This allows more efficient
* setting of the structure if the caller already knows the associated
* quark values.
- * The last variable argument must be NULL.
+ * The last variable argument must be %NULL.
*/
void
gst_structure_id_set (GstStructure * structure, GQuark field, ...)
* gst_structure_id_set(). Basically a convenience wrapper around
* gst_structure_new_id_empty() and gst_structure_id_set().
*
- * The last variable argument must be NULL (or 0).
+ * The last variable argument must be %NULL (or 0).
*
* Free-function: gst_structure_free
*
* gst_structure_remove_fields:
* @structure: a #GstStructure
* @fieldname: the name of the field to remove
- * @...: NULL-terminated list of more fieldnames to remove
+ * @...: %NULL-terminated list of more fieldnames to remove
*
* Removes the fields with the given names. If a field does not exist, the
* argument is ignored.
* gst_structure_remove_fields_valist:
* @structure: a #GstStructure
* @fieldname: the name of the field to remove
- * @varargs: NULL-terminated list of more fieldnames to remove
+ * @varargs: %NULL-terminated list of more fieldnames to remove
*
* va_list form of gst_structure_remove_fields().
*/
* Calls the provided function once for each field in the #GstStructure. The
* function must not modify the fields. Also see gst_structure_map_in_place().
*
- * Returns: TRUE if the supplied function returns TRUE For each of the fields,
- * FALSE otherwise.
+ * Returns: %TRUE if the supplied function returns %TRUE For each of the fields,
+ * %FALSE otherwise.
*/
gboolean
gst_structure_foreach (const GstStructure * structure,
* contrast to gst_structure_foreach(), the function may modify but not delete the
* fields. The structure must be mutable.
*
- * Returns: TRUE if the supplied function returns TRUE For each of the fields,
- * FALSE otherwise.
+ * Returns: %TRUE if the supplied function returns %TRUE For each of the fields,
+ * %FALSE otherwise.
*/
gboolean
gst_structure_map_in_place (GstStructure * structure,
*
* Check if @structure contains a field named @field.
*
- * Returns: TRUE if the structure contains a field with the given name
+ * Returns: %TRUE if the structure contains a field with the given name
*/
gboolean
gst_structure_id_has_field (const GstStructure * structure, GQuark field)
*
* Check if @structure contains a field named @fieldname.
*
- * Returns: TRUE if the structure contains a field with the given name
+ * Returns: %TRUE if the structure contains a field with the given name
*/
gboolean
gst_structure_has_field (const GstStructure * structure,
*
* Check if @structure contains a field named @field and with GType @type.
*
- * Returns: TRUE if the structure contains a field with the given name and type
+ * Returns: %TRUE if the structure contains a field with the given name and type
*/
gboolean
gst_structure_id_has_field_typed (const GstStructure * structure,
*
* Check if @structure contains a field named @fieldname and with GType @type.
*
- * Returns: TRUE if the structure contains a field with the given name and type
+ * Returns: %TRUE if the structure contains a field with the given name and type
*/
gboolean
gst_structure_has_field_typed (const GstStructure * structure,
* given field. Caller is responsible for making sure the field exists
* and has the correct type.
*
- * Returns: TRUE if the value could be set correctly. If there was no field
+ * Returns: %TRUE if the value could be set correctly. If there was no field
* with @fieldname or the existing field did not contain a boolean, this
- * function returns FALSE.
+ * function returns %FALSE.
*/
gboolean
gst_structure_get_boolean (const GstStructure * structure,
* inconsistent with e.g. gst_structure_get_string() which doesn't return a
* copy of the string).
*
- * Returns: TRUE if the value could be set correctly. If there was no field
+ * Returns: %TRUE if the value could be set correctly. If there was no field
* with @fieldname or the existing field did not contain a data, this function
- * returns FALSE.
+ * returns %FALSE.
*/
gboolean
gst_structure_get_date (const GstStructure * structure, const gchar * fieldname,
* (note: this is inconsistent with e.g. gst_structure_get_string()
* which doesn't return a copy of the string).
*
- * Returns: TRUE if the value could be set correctly. If there was no field
+ * Returns: %TRUE if the value could be set correctly. If there was no field
* with @fieldname or the existing field did not contain a data, this function
- * returns FALSE.
+ * returns %FALSE.
*/
gboolean
gst_structure_get_date_time (const GstStructure * structure,
* of the given field. Caller is responsible for making sure the field exists
* and has the correct type.
*
- * Returns: TRUE if the value could be set correctly. If there was no field
+ * Returns: %TRUE if the value could be set correctly. If there was no field
* with @fieldname or the existing field did not contain a #GstClockTime, this
- * function returns FALSE.
+ * function returns %FALSE.
*/
gboolean
gst_structure_get_clock_time (const GstStructure * structure,
* given field. Caller is responsible for making sure the field exists
* and has the correct type.
*
- * Returns: TRUE if the value could be set correctly. If there was no field
+ * Returns: %TRUE if the value could be set correctly. If there was no field
* with @fieldname or the existing field did not contain a double, this
- * function returns FALSE.
+ * function returns %FALSE.
*/
gboolean
gst_structure_get_double (const GstStructure * structure,
* The string should not be modified, and remains valid until the next
* call to a gst_structure_*() function with the given structure.
*
- * Returns: a pointer to the string or NULL when the field did not exist
+ * Returns: a pointer to the string or %NULL when the field did not exist
* or did not contain a string.
*/
const gchar *
* given field. Caller is responsible for making sure the field exists,
* has the correct type and that the enumtype is correct.
*
- * Returns: TRUE if the value could be set correctly. If there was no field
+ * Returns: %TRUE if the value could be set correctly. If there was no field
* with @fieldname or the existing field did not contain an enum of the given
- * type, this function returns FALSE.
+ * type, this function returns %FALSE.
*/
gboolean
gst_structure_get_enum (const GstStructure * structure,
* corresponding to the value of the given field. Caller is responsible
* for making sure the field exists and has the correct type.
*
- * Returns: TRUE if the values could be set correctly. If there was no field
+ * Returns: %TRUE if the values could be set correctly. If there was no field
* with @fieldname or the existing field did not contain a GstFraction, this
- * function returns FALSE.
+ * function returns %FALSE.
*/
gboolean
gst_structure_get_fraction (const GstStructure * structure,
* @string: a string representation of a #GstStructure
*
* Creates a #GstStructure from a string representation.
- * If end is not NULL, a pointer to the place inside the given string
+ * If end is not %NULL, a pointer to the place inside the given string
* where parsing ended will be returned.
*
* The current implementation of serialization will lead to unexpected results
*
* Free-function: gst_structure_free
*
- * Returns: (transfer full): a new #GstStructure or NULL when the string could
+ * Returns: (transfer full): a new #GstStructure or %NULL when the string could
* not be parsed. Free with gst_structure_free() after use.
*
* Since: 1.2
* @end: (out) (allow-none) (transfer none) (skip): pointer to store the end of the string in.
*
* Creates a #GstStructure from a string representation.
- * If end is not NULL, a pointer to the place inside the given string
+ * If end is not %NULL, a pointer to the place inside the given string
* where parsing ended will be returned.
*
* Free-function: gst_structure_free
*
- * Returns: (transfer full): a new #GstStructure or NULL when the string could
+ * Returns: (transfer full): a new #GstStructure or %NULL when the string could
* not be parsed. Free with gst_structure_free() after use.
*/
GstStructure *
* Fixates a #GstStructure by changing the given field to the nearest
* integer to @target that is a subset of the existing field.
*
- * Returns: TRUE if the structure could be fixated
+ * Returns: %TRUE if the structure could be fixated
*/
gboolean
gst_structure_fixate_field_nearest_int (GstStructure * structure,
* Fixates a #GstStructure by changing the given field to the nearest
* double to @target that is a subset of the existing field.
*
- * Returns: TRUE if the structure could be fixated
+ * Returns: %TRUE if the structure could be fixated
*/
gboolean
gst_structure_fixate_field_nearest_double (GstStructure * structure,
* Fixates a #GstStructure by changing the given @field_name field to the given
* @target boolean if that field is not fixed yet.
*
- * Returns: TRUE if the structure could be fixated
+ * Returns: %TRUE if the structure could be fixated
*/
gboolean
gst_structure_fixate_field_boolean (GstStructure * structure,
* Fixates a #GstStructure by changing the given @field_name field to the given
* @target string if that field is not fixed yet.
*
- * Returns: TRUE if the structure could be fixated
+ * Returns: %TRUE if the structure could be fixated
*/
gboolean
gst_structure_fixate_field_string (GstStructure * structure,
* fraction to @target_numerator/@target_denominator that is a subset
* of the existing field.
*
- * Returns: TRUE if the structure could be fixated
+ * Returns: %TRUE if the structure could be fixated
*/
gboolean
gst_structure_fixate_field_nearest_fraction (GstStructure * structure,
*
* Fixates a #GstStructure by changing the given field with its fixated value.
*
- * Returns: TRUE if the structure field could be fixated
+ * Returns: %TRUE if the structure field could be fixated
*/
gboolean
gst_structure_fixate_field (GstStructure * structure, const char *field_name)
/* our very own version of G_VALUE_LCOPY that allows NULL return locations
* (useful for message parsing functions where the return location is user
- * supplied and the user may pass NULL if the value isn't of interest) */
+ * supplied and the user may pass %NULL if the value isn't of interest) */
#define GST_VALUE_LCOPY(value, var_args, flags, __error, fieldname) \
G_STMT_START { \
const GValue *_value = (value); \
* valist-variant of gst_structure_get(). Look at the documentation of
* gst_structure_get() for more details.
*
- * Returns: TRUE, or FALSE if there was a problem reading any of the fields
+ * Returns: %TRUE, or %FALSE if there was a problem reading any of the fields
*/
gboolean
gst_structure_get_valist (const GstStructure * structure,
* valist-variant of gst_structure_id_get(). Look at the documentation of
* gst_structure_id_get() for more details.
*
- * Returns: TRUE, or FALSE if there was a problem reading any of the fields
+ * Returns: %TRUE, or %FALSE if there was a problem reading any of the fields
*/
gboolean
gst_structure_id_get_valist (const GstStructure * structure,
* Parses the variable arguments and reads fields from @structure accordingly.
* Variable arguments should be in the form field name, field type
* (as a GType), pointer(s) to a variable(s) to hold the return value(s).
- * The last variable argument should be NULL.
+ * The last variable argument should be %NULL.
*
* For refcounted (mini)objects you will receive a new reference which
* you must release with a suitable _unref() when no longer needed. For
* strings and boxed types you will receive a copy which you will need to
* release with either g_free() or the suitable function for the boxed type.
*
- * Returns: FALSE if there was a problem reading any of the fields (e.g.
+ * Returns: %FALSE if there was a problem reading any of the fields (e.g.
* because the field requested did not exist, or was of a type other
- * than the type specified), otherwise TRUE.
+ * than the type specified), otherwise %TRUE.
*/
gboolean
gst_structure_get (const GstStructure * structure, const char *first_fieldname,
* Parses the variable arguments and reads fields from @structure accordingly.
* Variable arguments should be in the form field id quark, field type
* (as a GType), pointer(s) to a variable(s) to hold the return value(s).
- * The last variable argument should be NULL (technically it should be a
- * 0 quark, but we require NULL so compilers that support it can check for
- * the NULL terminator and warn if it's not there).
+ * The last variable argument should be %NULL (technically it should be a
+ * 0 quark, but we require %NULL so compilers that support it can check for
+ * the %NULL terminator and warn if it's not there).
*
* This function is just like gst_structure_get() only that it is slightly
* more efficient since it saves the string-to-quark lookup in the global
* strings and boxed types you will receive a copy which you will need to
* release with either g_free() or the suitable function for the boxed type.
*
- * Returns: FALSE if there was a problem reading any of the fields (e.g.
+ * Returns: %FALSE if there was a problem reading any of the fields (e.g.
* because the field requested did not exist, or was of a type other
- * than the type specified), otherwise TRUE.
+ * than the type specified), otherwise %TRUE.
*/
gboolean
gst_structure_id_get (const GstStructure * structure, GQuark first_field_id,
*
* Tests if the two #GstStructure are equal.
*
- * Returns: TRUE if the two structures have the same name and field.
+ * Returns: %TRUE if the two structures have the same name and field.
**/
gboolean
gst_structure_is_equal (const GstStructure * structure1,
projects / platform / upstream / gstreamer.git / blobdiff