upipe/uref_program_flow.h header reference

Upipe program flow definition attributes for uref More

Header inclusion  

Members  

Functions  

Description  

Upipe program flow definition attributes for uref

Members detail  

#define _UPIPE_UREF_PROGRAM_FLOW_H_  

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

struct uref * uref_program_flow_alloc_def(struct uref_mgr *mgr)  

This function is declared in upipe/uref_program_flow.h source file, line 56.

This function allocates a control packet to define a new program flow.

Parameter list:

  • mgr: uref management structure

The return value is pointer to uref control packet, or NULL in case of error

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

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

This function compares the name of the program 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_program_flow_copy_name(struct uref *uref, struct uref *uref_src)  

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

This function copies the name of the program 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_program_flow_delete_name(struct uref *uref)  

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

This function deletes the name of the program attribute of a uref.

Parameter list:

  • uref: pointer to the uref

The return value is an error code

int uref_program_flow_get_name(struct uref *uref, const char **p)  

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

This function returns the name of the program 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_program_flow_match_name(struct uref *uref, const char *prefix)  

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

This function compares the name of the program 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_program_flow_set_name(struct uref *uref, const char *v)  

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

This function sets the name of the program attribute of a uref.

Parameter list:

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

The return value is an error code

#define UREF_PROGRAM_FLOW_DEF  

This macro is for internal use only.

This macro is declared in upipe/uref_program_flow.h source file, line 45.

flow definition prefix for programs

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