upipe-modules/upipe_setrap.h header reference

Upipe module setting arbitrary attributes to urefs More

Header inclusion  

Members  

Type  

Functions  

Description  

Upipe module setting arbitrary attributes to urefs

Members detail  

#define UPIPE_SETRAP_SIGNATURE  

This macro is declared in upipe-modules/upipe_setrap.h source file, line 38.

#define _UPIPE_MODULES_UPIPE_SETRAP_H_  

This macro is declared in upipe-modules/upipe_setrap.h source file, line 31.

enum upipe_setrap_command  

This enum is declared in upipe-modules/upipe_setrap.h source file, line 42.

This enum extends upipe_command with specific commands for setrap pipes.

IdentifierValueDescription
UPIPE_SETRAP_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_SETRAP_GET_RAPunknownreturns the current rap being set into urefs (struct uref **)
UPIPE_SETRAP_SET_RAPunknownsets the rap to set into urefs (struct uref *)

int upipe_setrap_get_rap(struct upipe *upipe, uint64_t *rap_sys_p)  

This function is declared in upipe-modules/upipe_setrap.h source file, line 65.

This function returns the current rap_sys being set into urefs.

Parameter list:

  • upipe: description structure of the pipe
  • rap_sys_p: filled with the current rap_sys

The return value is an error code

struct upipe_mgr * upipe_setrap_mgr_alloc(void )  

This function is declared in upipe-modules/upipe_setrap.h source file, line 55.

This function returns the management structure for all setrap pipes.

The return value is pointer to manager

int upipe_setrap_set_rap(struct upipe *upipe, uint64_t rap_sys)  

This function is declared in upipe-modules/upipe_setrap.h source file, line 78.

This function sets the rap_sys to set into urefs.

Parameter list:

  • upipe: description structure of the pipe
  • rap_sys: rap_sys to set

The return value is an error code

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