upipe/uref_flow.h header reference
Upipe flow attributes for uref and control messages More
Header inclusion
Members
Functions
- int uref_flow_cmp_copyright(struct uref *uref1, struct uref *uref2)
- int uref_flow_cmp_def(struct uref *uref1, struct uref *uref2)
- int uref_flow_cmp_error(struct uref *uref1, struct uref *uref2)
- int uref_flow_cmp_hearing_impaired(struct uref *uref1, struct uref *uref2, uint8_t nb)
- int uref_flow_cmp_id(struct uref *uref1, struct uref *uref2)
- int uref_flow_cmp_language(struct uref *uref1, struct uref *uref2, uint8_t nb)
- int uref_flow_cmp_languages(struct uref *uref1, struct uref *uref2)
- int uref_flow_cmp_lowdelay(struct uref *uref1, struct uref *uref2)
- int uref_flow_cmp_name(struct uref *uref1, struct uref *uref2)
- int uref_flow_cmp_original(struct uref *uref1, struct uref *uref2)
- int uref_flow_cmp_random(struct uref *uref1, struct uref *uref2)
- int uref_flow_cmp_raw_def(struct uref *uref1, struct uref *uref2)
- int uref_flow_cmp_visual_impaired(struct uref *uref1, struct uref *uref2, uint8_t nb)
- int uref_flow_delete_copyright(struct uref *uref)
- int uref_flow_delete_def(struct uref *uref)
- void uref_flow_delete_discontinuity(struct uref *uref)
- void uref_flow_delete_end(struct uref *uref)
- int uref_flow_delete_error(struct uref *uref)
- int uref_flow_delete_headers(struct uref *uref)
- int uref_flow_delete_hearing_impaired(struct uref *uref, uint8_t nb)
- int uref_flow_delete_id(struct uref *uref)
- int uref_flow_delete_language(struct uref *uref, uint8_t nb)
- int uref_flow_delete_languages(struct uref *uref)
- int uref_flow_delete_lowdelay(struct uref *uref)
- int uref_flow_delete_name(struct uref *uref)
- int uref_flow_delete_original(struct uref *uref)
- int uref_flow_delete_random(struct uref *uref)
- int uref_flow_delete_raw_def(struct uref *uref)
- int uref_flow_delete_visual_impaired(struct uref *uref, uint8_t nb)
- int uref_flow_get_copyright(struct uref *uref)
- int uref_flow_get_def(struct uref *uref, const char **p)
- int uref_flow_get_discontinuity(struct uref *uref)
- int uref_flow_get_end(struct uref *uref)
- int uref_flow_get_error(struct uref *uref)
- int uref_flow_get_headers(struct uref *uref, const uint8_t **p, size_t *size_p)
- int uref_flow_get_hearing_impaired(struct uref *uref, uint8_t nb)
- int uref_flow_get_id(struct uref *uref, uint64_t *p)
- int uref_flow_get_language(struct uref *uref, const char **p, uint8_t nb)
- int uref_flow_get_languages(struct uref *uref, uint8_t *p)
- int uref_flow_get_lowdelay(struct uref *uref)
- int uref_flow_get_name(struct uref *uref, const char **p)
- int uref_flow_get_original(struct uref *uref)
- int uref_flow_get_random(struct uref *uref)
- int uref_flow_get_raw_def(struct uref *uref, const char **p)
- int uref_flow_get_visual_impaired(struct uref *uref, uint8_t nb)
- int uref_flow_match_def(struct uref *uref, const char *prefix)
- int uref_flow_match_id(struct uref *uref, uint64_t min, uint64_t max)
- int uref_flow_match_language(struct uref *uref, const char *prefix, uint8_t nb)
- int uref_flow_match_languages(struct uref *uref, uint8_t min, uint8_t max)
- int uref_flow_match_name(struct uref *uref, const char *prefix)
- int uref_flow_match_raw_def(struct uref *uref, const char *prefix)
- int uref_flow_set_copyright(struct uref *uref)
- int uref_flow_set_def(struct uref *uref, const char *v)
- int uref_flow_set_def_va(struct uref *uref, const char *format, ...)
- void uref_flow_set_discontinuity(struct uref *uref)
- void uref_flow_set_end(struct uref *uref)
- int uref_flow_set_error(struct uref *uref)
- int uref_flow_set_headers(struct uref *uref, const uint8_t *v, size_t size)
- int uref_flow_set_hearing_impaired(struct uref *uref, uint8_t nb)
- int uref_flow_set_id(struct uref *uref, uint64_t v)
- int uref_flow_set_language(struct uref *uref, const char *v, uint8_t nb)
- int uref_flow_set_languages(struct uref *uref, uint8_t v)
- int uref_flow_set_lowdelay(struct uref *uref)
- int uref_flow_set_name(struct uref *uref, const char *v)
- int uref_flow_set_original(struct uref *uref)
- int uref_flow_set_random(struct uref *uref)
- int uref_flow_set_raw_def(struct uref *uref, const char *v)
- int uref_flow_set_visual_impaired(struct uref *uref, uint8_t nb)
Description
Members detail
This macro is declared in upipe/uref_flow.h source file, line 31.
This function is declared in upipe/uref_flow.h source file, line 70.
This function compares the copyrighted content 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
This function is declared in upipe/uref_flow.h source file, line 51.
This function compares the flow definition 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
This function is declared in upipe/uref_flow.h source file, line 50.
This function compares the error flag that may be present in any uref carrying data 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
This function is declared in upipe/uref_flow.h source file, line 64.
This function compares the flow for hearing impaired 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
This function is declared in upipe/uref_flow.h source file, line 53.
This function compares the flow ID from the last split pipe 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
This function is declared in upipe/uref_flow.h source file, line 60.
This function compares the flow language 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
This function is declared in upipe/uref_flow.h source file, line 56.
This function compares the number of flow languages 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
This function is declared in upipe/uref_flow.h source file, line 69.
This function compares the low delay mode 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
This function is declared in upipe/uref_flow.h source file, line 73.
This function compares the flow name 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
This function is declared in upipe/uref_flow.h source file, line 71.
This function compares the original or copy 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
This function is declared in upipe/uref_flow.h source file, line 48.
This function compares the random access flag that may be present in any uref carrying data 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
This function is declared in upipe/uref_flow.h source file, line 54.
This function compares the raw flow definition 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
This function is declared in upipe/uref_flow.h source file, line 68.
This function compares the flow for visual impaired 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_flow_delete_copyright(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 70.
This function deletes a copyrighted content attribute from a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_def(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 51.
This function deletes the flow definition attribute of a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
void uref_flow_delete_discontinuity(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 46.
This function deletes a discontinuity flag that may be present in any uref carrying data attribute from a uref.
Parameters list:
- uref: pointer to the uref
void uref_flow_delete_end(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 44.
This function deletes a end flag meaning that the writer was disconnected attribute from a uref.
Parameters list:
- uref: pointer to the uref
int uref_flow_delete_error(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 50.
This function deletes a error flag that may be present in any uref carrying data attribute from a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_headers(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 72.
This function deletes the global headers attribute of a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_hearing_impaired(struct uref *uref, uint8_t nb)
This function is declared in upipe/uref_flow.h source file, line 64.
This function deletes a flow for hearing impaired attribute from a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_id(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 53.
This function deletes the flow ID from the last split pipe attribute of a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_language(struct uref *uref, uint8_t nb)
This function is declared in upipe/uref_flow.h source file, line 60.
This function deletes the flow language attribute of a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_languages(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 56.
This function deletes the number of flow languages attribute of a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_lowdelay(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 69.
This function deletes a low delay mode attribute from a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_name(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 73.
This function deletes the flow name attribute of a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_original(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 71.
This function deletes a original or copy attribute from a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_random(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 48.
This function deletes a random access flag that may be present in any uref carrying data attribute from a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_raw_def(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 54.
This function deletes the raw flow definition attribute of a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_delete_visual_impaired(struct uref *uref, uint8_t nb)
This function is declared in upipe/uref_flow.h source file, line 68.
This function deletes a flow for visual impaired attribute from a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_get_copyright(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 70.
This function returns the presence of a copyrighted content attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_get_def(struct uref *uref, const char **p)
This function is declared in upipe/uref_flow.h source file, line 51.
This function returns the flow definition 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_flow_get_discontinuity(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 46.
This function returns the presence of a discontinuity flag that may be present in any uref carrying data attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_get_end(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 44.
This function returns the presence of a end flag meaning that the writer was disconnected attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_get_error(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 50.
This function returns the presence of a error flag that may be present in any uref carrying data attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_get_headers(struct uref *uref, const uint8_t **p, size_t *size_p)
This function is declared in upipe/uref_flow.h source file, line 72.
This function returns the global headers 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_flow_get_hearing_impaired(struct uref *uref, uint8_t nb)
This function is declared in upipe/uref_flow.h source file, line 64.
This function returns the presence of a flow for hearing impaired attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_get_id(struct uref *uref, uint64_t *p)
This function is declared in upipe/uref_flow.h source file, line 53.
This function returns the flow ID from the last split pipe 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_flow_get_language(struct uref *uref, const char **p, uint8_t nb)
This function is declared in upipe/uref_flow.h source file, line 60.
This function returns the flow language 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_flow_get_languages(struct uref *uref, uint8_t *p)
This function is declared in upipe/uref_flow.h source file, line 56.
This function returns the number of flow languages 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_flow_get_lowdelay(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 69.
This function returns the presence of a low delay mode attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_get_name(struct uref *uref, const char **p)
This function is declared in upipe/uref_flow.h source file, line 73.
This function returns the flow name 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_flow_get_original(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 71.
This function returns the presence of a original or copy attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_get_random(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 48.
This function returns the presence of a random access flag that may be present in any uref carrying data attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_get_raw_def(struct uref *uref, const char **p)
This function is declared in upipe/uref_flow.h source file, line 54.
This function returns the raw flow definition 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_flow_get_visual_impaired(struct uref *uref, uint8_t nb)
This function is declared in upipe/uref_flow.h source file, line 68.
This function returns the presence of a flow for visual impaired attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_match_def(struct uref *uref, const char *prefix)
This function is declared in upipe/uref_flow.h source file, line 51.
This function compares the flow definition attribute to a given prefix.
Parameters list:
- uref: pointer to the uref
- prefix: prefix to match
The return value is an error code
int uref_flow_match_id(struct uref *uref, uint64_t min, uint64_t max)
This function is declared in upipe/uref_flow.h source file, line 53.
This function compares the flow ID from the last split pipe 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_flow_match_language(struct uref *uref, const char *prefix, uint8_t nb)
This function is declared in upipe/uref_flow.h source file, line 60.
This function compares the flow language attribute to a given prefix.
Parameters list:
- uref: pointer to the uref
- prefix: prefix to match
The return value is an error code
int uref_flow_match_languages(struct uref *uref, uint8_t min, uint8_t max)
This function is declared in upipe/uref_flow.h source file, line 56.
This function compares the number of flow languages 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_flow_match_name(struct uref *uref, const char *prefix)
This function is declared in upipe/uref_flow.h source file, line 73.
This function compares the flow name attribute to a given prefix.
Parameters list:
- uref: pointer to the uref
- prefix: prefix to match
The return value is an error code
int uref_flow_match_raw_def(struct uref *uref, const char *prefix)
This function is declared in upipe/uref_flow.h source file, line 54.
This function compares the raw flow definition attribute to a given prefix.
Parameters list:
- uref: pointer to the uref
- prefix: prefix to match
The return value is an error code
int uref_flow_set_copyright(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 70.
This function sets a copyrighted content attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_set_def(struct uref *uref, const char *v)
This function is declared in upipe/uref_flow.h source file, line 51.
This function sets the flow definition attribute of a uref.
Parameters list:
- uref: pointer to the uref
- v: value to set
The return value is an error code
int uref_flow_set_def_va(struct uref *uref, const char *format, ...)
This function is declared in upipe/uref_flow.h source file, line 85.
This function sets the flow definition attribute of a uref, with printf-style generation.
Parameters list:
- uref: uref structure
- format: printf-style format of the flow definition, followed by a variable list of arguments
The return value is an error code
void uref_flow_set_discontinuity(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 46.
This function sets a discontinuity flag that may be present in any uref carrying data attribute in a uref.
Parameters list:
- uref: pointer to the uref
void uref_flow_set_end(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 44.
This function sets a end flag meaning that the writer was disconnected attribute in a uref.
Parameters list:
- uref: pointer to the uref
int uref_flow_set_error(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 50.
This function sets a error flag that may be present in any uref carrying data attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_set_headers(struct uref *uref, const uint8_t *v, size_t size)
This function is declared in upipe/uref_flow.h source file, line 72.
This function sets the global headers attribute of a uref.
Parameters list:
- uref: pointer to the uref
- v: value to set
The return value is an error code
int uref_flow_set_hearing_impaired(struct uref *uref, uint8_t nb)
This function is declared in upipe/uref_flow.h source file, line 64.
This function sets a flow for hearing impaired attribute in a uref.
Parameters list:
- uref_p: reference to the pointer to the uref (possibly modified)
The return value is an error code
int uref_flow_set_id(struct uref *uref, uint64_t v)
This function is declared in upipe/uref_flow.h source file, line 53.
This function sets the flow ID from the last split pipe attribute of a uref.
Parameters list:
- uref: pointer to the uref
- v: value to set
The return value is an error code
int uref_flow_set_language(struct uref *uref, const char *v, uint8_t nb)
This function is declared in upipe/uref_flow.h source file, line 60.
This function sets the flow language attribute of a uref.
Parameters list:
- uref: pointer to the uref
- v: value to set
The return value is an error code
int uref_flow_set_languages(struct uref *uref, uint8_t v)
This function is declared in upipe/uref_flow.h source file, line 56.
This function sets the number of flow languages attribute of a uref.
Parameters list:
- uref: pointer to the uref
- v: value to set
The return value is an error code
int uref_flow_set_lowdelay(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 69.
This function sets a low delay mode attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_set_name(struct uref *uref, const char *v)
This function is declared in upipe/uref_flow.h source file, line 73.
This function sets the flow name attribute of a uref.
Parameters list:
- uref: pointer to the uref
- v: value to set
The return value is an error code
int uref_flow_set_original(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 71.
This function sets a original or copy attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_set_random(struct uref *uref)
This function is declared in upipe/uref_flow.h source file, line 48.
This function sets a random access flag that may be present in any uref carrying data attribute in a uref.
Parameters list:
- uref: pointer to the uref
The return value is an error code
int uref_flow_set_raw_def(struct uref *uref, const char *v)
This function is declared in upipe/uref_flow.h source file, line 54.
This function sets the raw flow definition attribute of a uref.
Parameters list:
- uref: pointer to the uref
- v: value to set
The return value is an error code
int uref_flow_set_visual_impaired(struct uref *uref, uint8_t nb)
This function is declared in upipe/uref_flow.h source file, line 68.
This function sets a flow for visual impaired attribute in a uref.
Parameters list:
- uref_p: reference to the pointer to the uref (possibly modified)
The return value is an error code