upipe-modules/upipe_rate_limit.h header reference
Header inclusion
Members
Type
Functions
- const char * upipe_rate_limit_command_str(int command)
- int upipe_rate_limit_get_duration(struct upipe *upipe, uint64_t *duration_p)
- int upipe_rate_limit_get_limit(struct upipe *upipe, uint64_t *rate_limit_p)
- struct upipe_mgr * upipe_rate_limit_mgr_alloc(void )
- int upipe_rate_limit_set_duration(struct upipe *upipe, uint64_t duration)
- int upipe_rate_limit_set_limit(struct upipe *upipe, uint64_t rate_limit)
Members detail
This macro is declared in upipe-modules/upipe_rate_limit.h source file, line 8.
This macro is declared in upipe-modules/upipe_rate_limit.h source file, line 1.
This enum is declared in upipe-modules/upipe_rate_limit.h source file, line 14.
This enum extends upipe_command with specific commands for rate limit pipe.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_RATE_LIMIT_SENTINEL | UPIPE_CONTROL_LOCAL | |
| UPIPE_RATE_LIMIT_SET_LIMIT | unknown | set the rate limit (uint64_t) in octet per second |
| UPIPE_RATE_LIMIT_GET_LIMIT | unknown | get the rate limit (uint64_t *) in octect per second |
| UPIPE_RATE_LIMIT_SET_DURATION | unknown | set the window (uint64_t) in clock tick |
| UPIPE_RATE_LIMIT_GET_DURATION | unknown | get the window (uint64_t *) in clock tick |
This function is declared in upipe-modules/upipe_rate_limit.h source file, line 33.
This function converts enum upipe_rate_limit_command to a string.
Parameter list:
- command: command to convert
The return value is a string of NULL if invalid
This function is declared in upipe-modules/upipe_rate_limit.h source file, line 91.
This function gets the rate limit window.
Parameter list:
- upipe: description structure of the pipe
- duration_p: pointer filled with the window duration in clock tick
The return value is an error code
This function is declared in upipe-modules/upipe_rate_limit.h source file, line 65.
This function gets the rate limit.
Parameter list:
- upipe: description structure of the pipe
- rate_limit_p: a pointer to the rate limit to get in octect per second
The return value is an error code
This function is declared in upipe-modules/upipe_rate_limit.h source file, line 97.
This function returns the rate limit pipe manager.
This function is declared in upipe-modules/upipe_rate_limit.h source file, line 78.
This function sets the rate limit window.
Parameter list:
- upipe: description structure of the pipe
- duration: window duration in clock tick
The return value is an error code
This function is declared in upipe-modules/upipe_rate_limit.h source file, line 52.
This function sets the rate limit.
Parameter list:
- upipe: description structure of the pipe
- rate_limit: the rate limit in octect per second
The return value is an error code