upipe-modules/upipe_time_limit.h header reference

Upipe module blocking sources if they are too early More

Header inclusion  

Members  

Type  

Functions  

Description  

Upipe module blocking sources if they are too early

Members detail  

#define UPIPE_TIME_LIMIT_SIGNATURE  

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

#define _UPIPE_MODULES_UPIPE_TIME_LIMIT_H_  

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

enum upipe_time_limit_command  

This enum is declared in upipe-modules/upipe_time_limit.h source file, line 44.

This enum extends upipe_command with specific commands for time limit pipe.

IdentifierValueDescription
UPIPE_TIME_LIMIT_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_TIME_LIMIT_SET_LIMITunknownset the time limit (uint64_t) in UCLOCK_FREQ units
UPIPE_TIME_LIMIT_GET_LIMITunknownget the time limit (uint64_t *) in UCLOCK_FREQ units

const char * upipe_time_limit_command_str(int command)  

This function is declared in upipe-modules/upipe_time_limit.h source file, line 59.

This function converts enum upipe_time_limit_command to a string.

Parameter list:

  • command: command to convert

The return value is a string of NULL if invalid

int upipe_time_limit_get_limit(struct upipe *upipe, uint64_t *time_limit_p)  

This function is declared in upipe-modules/upipe_time_limit.h source file, line 90.

This function gets the time limit.

Parameter list:

  • upipe: description structure of the pipe
  • time_limit_p: a pointer to the time limit to get in UCLOCK_FREQ units

The return value is an error code

struct upipe_mgr * upipe_time_limit_mgr_alloc(void )  

This function is declared in upipe-modules/upipe_time_limit.h source file, line 99.

This function returns the management structure for all time_limit pipes.

The return value is pointer to manager

int upipe_time_limit_set_limit(struct upipe *upipe, uint64_t time_limit)  

This function is declared in upipe-modules/upipe_time_limit.h source file, line 76.

This function sets the time limit.

Parameter list:

  • upipe: description structure of the pipe
  • time_limit: the time limit in UCLOCK_FREQ units

The return value is an error code

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