upipe-modules/upipe_grid.h header reference
Header inclusion [link]
Members [link]
Types [link]
- enum upipe_grid_command
- enum upipe_grid_out_command
Functions [link]
- struct upipe * upipe_grid_alloc_input(struct upipe *upipe, struct uprobe *uprobe)
- struct upipe * upipe_grid_alloc_output(struct upipe *upipe, struct uprobe *uprobe)
- struct upipe_mgr * upipe_grid_mgr_alloc(void )
- int upipe_grid_out_get_input(struct upipe *upipe, struct upipe **input_p)
- int upipe_grid_out_iterate_input(struct upipe *upipe, struct upipe **input_p)
- int upipe_grid_out_set_input(struct upipe *upipe, struct upipe *input)
- int upipe_grid_set_max_retention(struct upipe *upipe, uint64_t max_retention)
Macros [link]
Members detail [link]
#define UPIPE_GRID_IN_SIGNATURE [link]
This macro is declared in upipe-modules/upipe_grid.h source file, line 37.
This macro is the grid input pipe signature.
#define UPIPE_GRID_OUT_SIGNATURE [link]
This macro is declared in upipe-modules/upipe_grid.h source file, line 39.
This macro is the grid output pipe signature.
#define UPIPE_GRID_SIGNATURE [link]
This macro is declared in upipe-modules/upipe_grid.h source file, line 35.
This macro is the grid pipe signature.
#define _UPIPE_MODULES_UPIPE_GRID_H_ [link]
This macro is declared in upipe-modules/upipe_grid.h source file, line 26.
This function is declared in upipe-modules/upipe_grid.h source file, line 76.
This function allocates a new grid input.
Parameter list:
- upipe: description structure of the pipe
- uprobe: structure used to raise events
The return value is an allocated sub pipe.
This function is declared in upipe-modules/upipe_grid.h source file, line 98.
This function allocates a new grid output.
Parameter list:
- upipe: description structure of the pipe
- uprobe: structure used to raise events
The return value is an allocated sub pipe.
enum upipe_grid_command [link]
This enum is declared in upipe-modules/upipe_grid.h source file, line 49.
This enum enumerates the grid control commands.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_GRID_SENTINEL | 0x8000 | sentinel |
| UPIPE_GRID_SET_MAX_RETENTION | 1 | set the max retention time (uint64_t) |
This function is declared in upipe-modules/upipe_grid.h source file, line 46.
This function returns grid pipe manager.
The return value is a pointer to the pipe manager
enum upipe_grid_out_command [link]
This enum is declared in upipe-modules/upipe_grid.h source file, line 79.
This enum enumerates the grid output control commands.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_GRID_OUT_SENTINEL | 0x8000 | sentinel |
| UPIPE_GRID_OUT_GET_INPUT | 1 | get the grid output input pipe (struct upipe **) |
| UPIPE_GRID_OUT_SET_INPUT | 2 | set the grid output input pipe (struct upipe *) |
| UPIPE_GRID_OUT_ITERATE_INPUT | 3 | iterate the grid input of a grid output (struct upipe **) |
#define upipe_grid_out_foreach_input(UPIPE, INPUT) [link]
This macro is declared in upipe-modules/upipe_grid.h source file, line 139.
This macro is an helper for upipe_grid_out_iterate_input.
This function is declared in upipe-modules/upipe_grid.h source file, line 121.
This function gets the current input of a grid output pipe.
Parameter list:
- upipe: description structure of the pipe
- input_p: filled with the input pipe
The return value is an error code
This function is declared in upipe-modules/upipe_grid.h source file, line 134.
This function iterates the inputs of a grid output pipe.
Parameter list:
- upipe: description structure of the output pipe
- input_p: filled with the next input pipe
The return value is an error code
This function is declared in upipe-modules/upipe_grid.h source file, line 108.
This function sets the input of a grid output pipe.
Parameter list:
- upipe: description structure of the pipe
- input: description of the input pipe to set
The return value is an error code
This function is declared in upipe-modules/upipe_grid.h source file, line 64.
This function sets the max retention time for input buffers.
Parameter list:
- upipe: description structure of the pipe
- max_retention: max retention time value in 27MHz ticks
The return value is an error code