upipe-modules/upipe_delay.h header reference

Upipe module adding a delay to all dates More

Header inclusion  

Members  

Type  

Functions  

Description  

Upipe module adding a delay to all dates

Members detail  

#define UPIPE_DELAY_SIGNATURE  

This macro is declared in upipe-modules/upipe_delay.h source file, line 39.

#define _UPIPE_MODULES_UPIPE_DELAY_H_  

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

enum upipe_delay_command  

This enum is declared in upipe-modules/upipe_delay.h source file, line 43.

This enum extends upipe_command with specific commands for delay pipes.

IdentifierValueDescription
UPIPE_DELAY_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_DELAY_GET_DELAYunknownreturns the current delay being set into urefs (int64_t **)
UPIPE_DELAY_SET_DELAYunknownsets the delay to set into urefs (int64_t *)

int upipe_delay_get_delay(struct upipe *upipe, int64_t *delay_p)  

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

This function returns the current delay being set into urefs.

Parameter list:

  • upipe: description structure of the pipe
  • delay_p: filled with the current delay

The return value is an error code

struct upipe_mgr * upipe_delay_mgr_alloc(void )  

This function is declared in upipe-modules/upipe_delay.h source file, line 56.

This function returns the management structure for all delay pipes.

The return value is pointer to manager

int upipe_delay_set_delay(struct upipe *upipe, int64_t delay)  

This function is declared in upipe-modules/upipe_delay.h source file, line 77.

This function sets the delay to set into urefs.

Parameter list:

  • upipe: description structure of the pipe
  • delay: delay 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