Table of contents   Introduction   Installation   Overview   Tutorials   Rules   Reference   Headers list   All declarations
Previous   Next
Upipe reference manual » API documentation » upipe/uref_attr.h header reference

upipe/uref_attr.h header reference

Upipe uref attributes handling More

Header inclusion  

Members  

Functions  

Description  

Upipe uref attributes handling

Members detail  

#define UREF_ATTR_INT(group, attr, name, desc)  

This macro is declared in upipe/uref_attr.h source file, line 1286.

#define UREF_ATTR_INT_SH(group, attr, type, desc)  

This macro is declared in upipe/uref_attr.h source file, line 1342.

#define UREF_ATTR_INT_VA(group, attr, format, desc, args_decl, args)  

This macro is declared in upipe/uref_attr.h source file, line 1381.

#define UREF_ATTR_OPAQUE(group, attr, name, desc)  

This macro is declared in upipe/uref_attr.h source file, line 178.

#define UREF_ATTR_OPAQUE_SH(group, attr, type, desc)  

This macro is declared in upipe/uref_attr.h source file, line 228.

#define UREF_ATTR_OPAQUE_VA(group, attr, format, desc, args_decl, args)  

This macro is declared in upipe/uref_attr.h source file, line 279.

#define UREF_ATTR_RATIONAL(group, attr, name, desc)  

This macro is declared in upipe/uref_attr.h source file, line 1426.

#define UREF_ATTR_RATIONAL_SH(group, attr, type, desc)  

This macro is declared in upipe/uref_attr.h source file, line 1466.

#define UREF_ATTR_RATIONAL_VA(group, attr, format, desc, args_decl, args)  

This macro is declared in upipe/uref_attr.h source file, line 1507.

#define UREF_ATTR_SMALL_UNSIGNED(group, attr, name, desc)  

This macro is declared in upipe/uref_attr.h source file, line 761.

#define UREF_ATTR_SMALL_UNSIGNED_SH(group, attr, type, desc)  

This macro is declared in upipe/uref_attr.h source file, line 833.

#define UREF_ATTR_SMALL_UNSIGNED_VA(group, attr, format, desc, args_decl, args)  

This macro is declared in upipe/uref_attr.h source file, line 905.

#define UREF_ATTR_STRING(group, attr, name, desc)  

This macro is declared in upipe/uref_attr.h source file, line 337.

#define UREF_ATTR_STRING_SH(group, attr, type, desc)  

This macro is declared in upipe/uref_attr.h source file, line 408.

#define UREF_ATTR_STRING_VA(group, attr, format, desc, args_decl, args)  

This macro is declared in upipe/uref_attr.h source file, line 480.

#define UREF_ATTR_TEMPLATE(utype, ctype)  

This macro is declared in upipe/uref_attr.h source file, line 57.

#define UREF_ATTR_UNSIGNED(group, attr, name, desc)  

This macro is declared in upipe/uref_attr.h source file, line 988.

#define UREF_ATTR_UNSIGNED_SH(group, attr, type, desc)  

This macro is declared in upipe/uref_attr.h source file, line 1059.

#define UREF_ATTR_UNSIGNED_UREF(group, attr, member, desc)  

This macro is declared in upipe/uref_attr.h source file, line 1207.

#define UREF_ATTR_UNSIGNED_VA(group, attr, format, desc, args_decl, args)  

This macro is declared in upipe/uref_attr.h source file, line 1131.

#define UREF_ATTR_VOID(group, attr, name, desc)  

This macro is declared in upipe/uref_attr.h source file, line 559.

#define UREF_ATTR_VOID_SH(group, attr, type, desc)  

This macro is declared in upipe/uref_attr.h source file, line 612.

#define UREF_ATTR_VOID_UREF(group, attr, flag, desc)  

This macro is declared in upipe/uref_attr.h source file, line 722.

#define UREF_ATTR_VOID_VA(group, attr, format, desc, args_decl, args)  

This macro is declared in upipe/uref_attr.h source file, line 666.

#define _UPIPE_UREF_ATTR_H_  

This macro is declared in upipe/uref_attr.h source file, line 31.

int uref_attr_cmp_priv(struct uref *uref1, struct uref *uref2)  

This function is declared in upipe/uref_attr.h source file, line 1543.

This function compares the private (internal pipe use) attribute in two refs.

Parameters list:

  • uref1: pointer to the first uref
  • uref2: pointer to the second uref

The return value is 0 if both attributes are absent or identical

int uref_attr_delete(struct uref *uref, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 144.

This function deletes an attribute.

Parameters list:

  • uref: pointer to the uref
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

void uref_attr_delete_priv(struct uref *uref)  

This function is declared in upipe/uref_attr.h source file, line 1543.

This function deletes the private (internal pipe use) attribute of a uref.

Parameters list:

  • uref: pointer to the uref

int uref_attr_delete_va(struct uref *uref, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 160.

This function deletes an attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_delete_va(struct uref *uref, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 164.

Documentation from alternate declaration:

This function deletes an attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_get_bool(struct uref *uref, bool *p, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 126.

This function returns the value of a bool attribute.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_get_bool_va(struct uref *uref, bool *p, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 126.

This function returns the value of a bool attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_get_float(struct uref *uref, double *p, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 131.

This function returns the value of a float attribute.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_get_float_va(struct uref *uref, double *p, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 131.

This function returns the value of a float attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_get_int(struct uref *uref, int64_t *p, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 130.

This function returns the value of a int attribute.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_get_int_va(struct uref *uref, int64_t *p, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 130.

This function returns the value of a int attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_get_opaque(struct uref *uref, struct udict_opaque *p, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 123.

This function returns the value of a opaque attribute.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_get_opaque_va(struct uref *uref, struct udict_opaque *p, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 123.

This function returns the value of a opaque attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_get_priv(struct uref *uref, uint64_t *p)  

This function is declared in upipe/uref_attr.h source file, line 1543.

This function returns the private (internal pipe use) attribute of a uref.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)

The return value is an error code

int uref_attr_get_rational(struct uref *uref, struct urational *p, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 132.

This function returns the value of a rational attribute.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_get_rational_va(struct uref *uref, struct urational *p, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 132.

This function returns the value of a rational attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_get_small_int(struct uref *uref, int8_t *p, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 128.

This function returns the value of a small_int attribute.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_get_small_int_va(struct uref *uref, int8_t *p, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 128.

This function returns the value of a small_int attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_get_small_unsigned(struct uref *uref, uint8_t *p, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 127.

This function returns the value of a small_unsigned attribute.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_get_small_unsigned_va(struct uref *uref, uint8_t *p, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 127.

This function returns the value of a small_unsigned attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_get_string(struct uref *uref, const char **p, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 124.

This function returns the value of a string attribute.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_get_string_va(struct uref *uref, const char **p, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 124.

This function returns the value of a string attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_get_unsigned(struct uref *uref, uint64_t *p, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 129.

This function returns the value of a unsigned attribute.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_get_unsigned_va(struct uref *uref, uint64_t *p, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 129.

This function returns the value of a unsigned attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_get_void(struct uref *uref, void **p, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 125.

This function returns the value of a void attribute.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_get_void_va(struct uref *uref, void **p, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 125.

This function returns the value of a void attribute, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_import(struct uref *uref, struct uref *uref_attr)  

This function is declared in upipe/uref_attr.h source file, line 48.

This function imports all attributes from a uref into another uref (see also udict_import).

Parameters list:

  • uref: overwritten uref
  • uref_attr: uref containing attributes to fetch

The return value is an error code

int uref_attr_match_priv(struct uref *uref, uint8_t min, uint8_t max)  

This function is declared in upipe/uref_attr.h source file, line 1543.

This function compares the private (internal pipe use) attribute to given values.

Parameters list:

  • uref: pointer to the uref
  • min: minimum value
  • max: maximum value

The return value is an error code

int uref_attr_set_bool(struct uref *uref, bool v, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 126.

This function sets the value of a bool attribute, optionally creating it.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_set_bool_va(struct uref *uref, bool v, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 126.

This function sets the value of a bool attribute, optionally creating it, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_set_float(struct uref *uref, double v, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 131.

This function sets the value of a float attribute, optionally creating it.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_set_float_va(struct uref *uref, double v, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 131.

This function sets the value of a float attribute, optionally creating it, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_set_int(struct uref *uref, int64_t v, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 130.

This function sets the value of a int attribute, optionally creating it.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_set_int_va(struct uref *uref, int64_t v, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 130.

This function sets the value of a int attribute, optionally creating it, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_set_opaque(struct uref *uref, struct udict_opaque v, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 123.

This function sets the value of a opaque attribute, optionally creating it.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_set_opaque_va(struct uref *uref, struct udict_opaque v, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 123.

This function sets the value of a opaque attribute, optionally creating it, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

void uref_attr_set_priv(struct uref *uref, uint64_t v)  

This function is declared in upipe/uref_attr.h source file, line 1543.

This function sets the private (internal pipe use) attribute of a uref.

Parameters list:

  • uref: pointer to the uref
  • v: value to set

int uref_attr_set_rational(struct uref *uref, struct urational v, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 132.

This function sets the value of a rational attribute, optionally creating it.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_set_rational_va(struct uref *uref, struct urational v, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 132.

This function sets the value of a rational attribute, optionally creating it, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_set_small_int(struct uref *uref, int8_t v, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 128.

This function sets the value of a small_int attribute, optionally creating it.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_set_small_int_va(struct uref *uref, int8_t v, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 128.

This function sets the value of a small_int attribute, optionally creating it, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_set_small_unsigned(struct uref *uref, uint8_t v, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 127.

This function sets the value of a small_unsigned attribute, optionally creating it.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_set_small_unsigned_va(struct uref *uref, uint8_t v, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 127.

This function sets the value of a small_unsigned attribute, optionally creating it, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_set_string(struct uref *uref, const char *v, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 124.

This function sets the value of a string attribute, optionally creating it.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_set_string_va(struct uref *uref, const char *v, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 124.

This function sets the value of a string attribute, optionally creating it, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_set_unsigned(struct uref *uref, uint64_t v, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 129.

This function sets the value of a unsigned attribute, optionally creating it.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_set_unsigned_va(struct uref *uref, uint64_t v, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 129.

This function sets the value of a unsigned attribute, optionally creating it, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

int uref_attr_set_void(struct uref *uref, void *v, enum udict_type type, const char *name)  

This function is declared in upipe/uref_attr.h source file, line 125.

This function sets the value of a void attribute, optionally creating it.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • name: name of the attribute

The return value is an error code

int uref_attr_set_void_va(struct uref *uref, void *v, enum udict_type type, const char *format, ...)  

This function is declared in upipe/uref_attr.h source file, line 125.

This function sets the value of a void attribute, optionally creating it, with printf-style name generation.

Parameters list:

  • uref: pointer to the uref
  • v: value to set
  • type: type of the attribute (potentially a shorthand)
  • format: printf-style format of the attribute, followed by a variable list of arguments

The return value is an error code

Table of contents   Introduction   Installation   Overview   Tutorials   Rules   Reference   Headers list   All declarations
Previous   Next
Upipe reference manual » API documentation » upipe/uref_attr.h header reference

Valid XHTML 1.0 StrictGenerated by cmassiot on Thu Nov 6 12:15:41 2014 using MkDoc