upipe/uref_event.h header reference

Upipe event attributes for uref and control messages More

Header inclusion  

Members  

Functions  

Description  

Upipe event attributes for uref and control messages

Members detail  

#define _UPIPE_UREF_EVENT_H_  

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

int uref_event_cmp_description(struct uref *uref1, struct uref *uref2, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 55.

This function compares the event description attribute in two urefs.

Parameter 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_event_cmp_duration(struct uref *uref1, struct uref *uref2, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 49.

This function compares the event duration attribute in two urefs.

Parameter 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_event_cmp_events(struct uref *uref1, struct uref *uref2)  

This function is declared in upipe/uref_event.h source file, line 43.

This function compares the event number attribute in two urefs.

Parameter 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_event_cmp_id(struct uref *uref1, struct uref *uref2, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 45.

This function compares the event ID attribute in two urefs.

Parameter 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_event_cmp_language(struct uref *uref1, struct uref *uref2, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 51.

This function compares the event ISO-639 language attribute in two urefs.

Parameter 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_event_cmp_name(struct uref *uref1, struct uref *uref2, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 53.

This function compares the event name attribute in two urefs.

Parameter 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_event_cmp_start(struct uref *uref1, struct uref *uref2, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 47.

This function compares the event start time attribute in two urefs.

Parameter 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_event_copy_description(struct uref *uref, struct uref *uref_src, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 55.

This function copies the event description attribute from an uref to another.

Parameter list:

  • uref: pointer to the uref
  • uref_src: pointer to the source uref

The return value is an error code

int uref_event_copy_duration(struct uref *uref, struct uref *uref_src, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 49.

This function copies the event duration attribute from an uref to another.

Parameter list:

  • uref: pointer to the uref
  • uref_src: pointer to the source uref

The return value is an error code

int uref_event_copy_events(struct uref *uref, struct uref *uref_src)  

This function is declared in upipe/uref_event.h source file, line 43.

This function copies the event number attribute from an uref to another.

Parameter list:

  • uref: pointer to the uref
  • uref_src: pointer to the source uref

The return value is an error code

int uref_event_copy_id(struct uref *uref, struct uref *uref_src, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 45.

This function copies the event ID attribute from an uref to another.

Parameter list:

  • uref: pointer to the uref
  • uref_src: pointer to the source uref

The return value is an error code

int uref_event_copy_language(struct uref *uref, struct uref *uref_src, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 51.

This function copies the event ISO-639 language attribute from an uref to another.

Parameter list:

  • uref: pointer to the uref
  • uref_src: pointer to the source uref

The return value is an error code

int uref_event_copy_name(struct uref *uref, struct uref *uref_src, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 53.

This function copies the event name attribute from an uref to another.

Parameter list:

  • uref: pointer to the uref
  • uref_src: pointer to the source uref

The return value is an error code

int uref_event_copy_start(struct uref *uref, struct uref *uref_src, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 47.

This function copies the event start time attribute from an uref to another.

Parameter list:

  • uref: pointer to the uref
  • uref_src: pointer to the source uref

The return value is an error code

int uref_event_delete_description(struct uref *uref, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 55.

This function deletes the event description attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_event_delete_duration(struct uref *uref, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 49.

This function deletes the event duration attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_event_delete_events(struct uref *uref)  

This function is declared in upipe/uref_event.h source file, line 43.

This function deletes the event number attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_event_delete_id(struct uref *uref, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 45.

This function deletes the event ID attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_event_delete_language(struct uref *uref, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 51.

This function deletes the event ISO-639 language attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_event_delete_name(struct uref *uref, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 53.

This function deletes the event name attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_event_delete_start(struct uref *uref, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 47.

This function deletes the event start time attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_event_get_description(struct uref *uref, const char **p, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 55.

This function returns the event description attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_get_duration(struct uref *uref, uint64_t *p, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 49.

This function returns the event duration attribute of a uref.

Parameter list:

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

The return value is an error code

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

This function is declared in upipe/uref_event.h source file, line 43.

This function returns the event number attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_get_id(struct uref *uref, uint64_t *p, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 45.

This function returns the event ID attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_get_language(struct uref *uref, const char **p, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 51.

This function returns the event ISO-639 language attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_get_name(struct uref *uref, const char **p, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 53.

This function returns the event name attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_get_start(struct uref *uref, uint64_t *p, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 47.

This function returns the event start time attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_match_description(struct uref *uref, const char *prefix, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 55.

This function compares the event description attribute to a given prefix.

Parameter list:

  • uref: pointer to the uref
  • prefix: prefix to match

The return value is an error code

int uref_event_match_duration(struct uref *uref, uint8_t min, uint8_t max, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 49.

This function compares the event duration attribute to given values.

Parameter list:

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

The return value is an error code

int uref_event_match_events(struct uref *uref, uint64_t min, uint64_t max)  

This function is declared in upipe/uref_event.h source file, line 43.

This function compares the event number attribute to given values.

Parameter list:

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

The return value is an error code

int uref_event_match_id(struct uref *uref, uint8_t min, uint8_t max, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 45.

This function compares the event ID attribute to given values.

Parameter list:

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

The return value is an error code

int uref_event_match_language(struct uref *uref, const char *prefix, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 51.

This function compares the event ISO-639 language attribute to a given prefix.

Parameter list:

  • uref: pointer to the uref
  • prefix: prefix to match

The return value is an error code

int uref_event_match_name(struct uref *uref, const char *prefix, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 53.

This function compares the event name attribute to a given prefix.

Parameter list:

  • uref: pointer to the uref
  • prefix: prefix to match

The return value is an error code

int uref_event_match_start(struct uref *uref, uint8_t min, uint8_t max, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 47.

This function compares the event start time attribute to given values.

Parameter list:

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

The return value is an error code

int uref_event_set_description(struct uref *uref, const char *v, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 55.

This function sets the event description attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_set_duration(struct uref *uref, uint64_t v, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 49.

This function sets the event duration attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_set_events(struct uref *uref, uint64_t v)  

This function is declared in upipe/uref_event.h source file, line 43.

This function sets the event number attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_set_id(struct uref *uref, uint64_t v, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 45.

This function sets the event ID attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_set_language(struct uref *uref, const char *v, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 51.

This function sets the event ISO-639 language attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_set_name(struct uref *uref, const char *v, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 53.

This function sets the event name attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_event_set_start(struct uref *uref, uint64_t v, uint64_t event)  

This function is declared in upipe/uref_event.h source file, line 47.

This function sets the event start time attribute of a uref.

Parameter list:

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

The return value is an error code

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:20 2018 using MkDoc