upipe-ts/uref_ts_event.h header reference

Upipe event attributes for TS More

Header inclusion  

Members  

Functions  

Description  

Upipe event attributes for TS

Members detail  

#define _UPIPE_TS_UREF_TS_EVENT_H_  

This macro is declared in upipe-ts/uref_ts_event.h source file, line 31.

int uref_ts_event_add_descriptor(struct uref *uref, const uint8_t *desc, size_t desc_len, uint64_t sub)  

This function is declared in UREF_TS_ATTR_SUBDESCRIPTOR function like macro expansion, line 64 in upipe-ts/uref_ts_event.h source file, line 52.

This function registers a new sub descriptor in the TS flow definition packet.

Parameter list:

  • uref: pointer to the uref
  • desc: descriptor
  • desc_len: size of descriptor
  • sub: number of the sub

The return value is an error code

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

This function is declared in upipe-ts/uref_ts_event.h source file, line 50.

This function compares the number of event descriptors 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_ts_event_cmp_running_status(struct uref *uref1, struct uref *uref2, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 46.

This function compares the event running status 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_ts_event_cmp_scrambled(struct uref *uref1, struct uref *uref2, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 48.

This function compares the scrambled event 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_ts_event_compare_descriptors(struct uref *uref1, struct uref *uref2, uint64_t sub)  

This function is declared in UREF_TS_ATTR_SUBDESCRIPTOR function like macro expansion, line 136 in upipe-ts/uref_ts_event.h source file, line 52.

This function compares all descriptors in two urefs.

Parameter list:

  • uref1: pointer to the first uref
  • uref2: pointer to the second uref
  • sub: number of the sub

The return value is 0 if both are absent or identical

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

This function is declared in upipe-ts/uref_ts_event.h source file, line 50.

This function copies the number of event descriptors 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_ts_event_copy_running_status(struct uref *uref, struct uref *uref_src, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 46.

This function copies the event running status 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_ts_event_copy_scrambled(struct uref *uref, struct uref *uref_src, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 48.

This function copies the scrambled event 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_ts_event_delete_descriptor(struct uref *uref, uint64_t sub, uint64_t nb)  

This function is declared in UREF_TS_ATTR_SUBDESCRIPTOR function like macro expansion, line 50 in upipe-ts/uref_ts_event.h source file, line 52.

This function deletes the sub descriptor attribute of a uref.

Parameter list:

  • uref: pointer to the uref
  • sub: number of the sub
  • nb: number of the descriptor

The return value is an error code

int uref_ts_event_delete_descriptors(struct uref *uref, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 50.

This function deletes the number of event descriptors attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_ts_event_delete_running_status(struct uref *uref, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 46.

This function deletes the event running status attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_ts_event_delete_scrambled(struct uref *uref, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 48.

This function deletes a scrambled event attribute from a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

void uref_ts_event_extract_descriptors(struct uref *uref, uint8_t *descs_p, uint64_t sub)  

This function is declared in UREF_TS_ATTR_SUBDESCRIPTOR function like macro expansion, line 113 in upipe-ts/uref_ts_event.h source file, line 52.

This function extracts all descriptors.

Parameter list:

int uref_ts_event_get_descriptor(struct uref *uref, const uint8_t **p, size_t *size_p, uint64_t sub, uint64_t nb)  

This function is declared in UREF_TS_ATTR_SUBDESCRIPTOR function like macro expansion, line 12 in upipe-ts/uref_ts_event.h source file, line 52.

This function returns the sub descriptor attribute of a uref.

Parameter list:

  • uref: pointer to the uref
  • p: pointer to the retrieved value (modified during execution)
  • sub: number of the substructure
  • nb: number of the descriptor

The return value is an error code

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

This function is declared in upipe-ts/uref_ts_event.h source file, line 50.

This function returns the number of event descriptors 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_ts_event_get_running_status(struct uref *uref, uint8_t *p, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 46.

This function returns the event running status 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_ts_event_get_scrambled(struct uref *uref, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 48.

This function returns the presence of a scrambled event attribute in a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

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

This function is declared in upipe-ts/uref_ts_event.h source file, line 50.

This function compares the number of event descriptors 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_ts_event_match_running_status(struct uref *uref, uint8_t min, uint8_t max, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 46.

This function compares the event running status 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_ts_event_set_descriptor(struct uref *uref, const uint8_t *v, size_t size, uint64_t sub, uint64_t nb)  

This function is declared in UREF_TS_ATTR_SUBDESCRIPTOR function like macro expansion, line 33 in upipe-ts/uref_ts_event.h source file, line 52.

This function sets the sub descriptor attribute of a uref.

Parameter list:

  • uref: pointer to the uref
  • v: value to set
  • sub: number of the sub
  • nb: number of the descriptor

The return value is an error code

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

This function is declared in upipe-ts/uref_ts_event.h source file, line 50.

This function sets the number of event descriptors attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_ts_event_set_running_status(struct uref *uref, uint8_t v, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 46.

This function sets the event running status attribute of a uref.

Parameter list:

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

The return value is an error code

int uref_ts_event_set_scrambled(struct uref *uref, uint64_t event)  

This function is declared in upipe-ts/uref_ts_event.h source file, line 48.

This function sets a scrambled event attribute in a uref.

Parameter list:

  • uref_p: reference to the pointer to the uref (possibly modified)

The return value is an error code

size_t uref_ts_event_size_descriptors(struct uref *uref, uint64_t sub)  

This function is declared in UREF_TS_ATTR_SUBDESCRIPTOR function like macro expansion, line 91 in upipe-ts/uref_ts_event.h source file, line 52.

This function gets the total size of descriptors.

Parameter list:

  • uref: pointer to the uref
  • sub: number of the sub

The return value is the size of descriptors

int uref_ts_event_import(struct uref *uref1, struct uref *uref2, uint64_t *event_p)  

This function is for internal use only.

This function is declared in upipe-ts/uref_ts_event.h source file, line 62.

This function imports events into a flow def.

Parameter list:

  • uref1: output flow definition
  • uref2: uref containing events to import
  • event_p: event number to start with

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