upipe-modules/upipe_graph.h header reference
Upipe module to graph More
Header inclusion [link]
Members [link]
Types [link]
- enum upipe_graph_control
- enum upipe_graph_sub_control
Functions [link]
- struct upipe_mgr * upipe_graph_mgr_alloc(void )
- int upipe_graph_set_color(struct upipe *upipe, const char *color)
- int upipe_graph_set_history(struct upipe *upipe, uint64_t size)
- int upipe_graph_set_maximum(struct upipe *upipe, int64_t max)
- int upipe_graph_set_minimum(struct upipe *upipe, int64_t min)
- int upipe_graph_sub_set_color(struct upipe *upipe, const char *color)
- int upipe_graph_sub_set_value(struct upipe *upipe, int64_t value)
Description [link]
Upipe module to graph
Members detail [link]
#define UPIPE_GRAPH_SIGNATURE [link]
This macro is declared in upipe-modules/upipe_graph.h source file, line 40.
#define UPIPE_GRAPH_SUB_SIGNATURE [link]
This macro is declared in upipe-modules/upipe_graph.h source file, line 41.
#define _UPIPE_MODULES_UPIPE_GRAPH_H_ [link]
This macro is declared in upipe-modules/upipe_graph.h source file, line 30.
enum upipe_graph_control [link]
This enum is declared in upipe-modules/upipe_graph.h source file, line 45.
This enum enumerates the graph control commands.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_GRAPH_SENTINEL | 0x8000 | |
| UPIPE_GRAPH_SET_MINIMUM | 1 | set the minimum of the graph (int64_t) |
| UPIPE_GRAPH_SET_MAXIMUM | 2 | set the maximum of the graph (int64_t) |
| UPIPE_GRAPH_SET_HISTORY | 3 | set the history size (uint64_t) |
| UPIPE_GRAPH_SET_COLOR | 4 | set the background color (const char *) |
This function is declared in upipe-modules/upipe_graph.h source file, line 150.
This function returns the graph pipe manager.
The return value is a pointer to the graph pipe manager.
This function is declared in upipe-modules/upipe_graph.h source file, line 101.
This function sets the background color of the graph.
Parameter list:
- upipe: description structure of the pipe
- color: string representing rgb color (rgb(R, G, B))
The return value is an error code
This function is declared in upipe-modules/upipe_graph.h source file, line 89.
This function sets the history size of the graph pipe.
Parameter list:
- upipe: description structure of the pipe
- size: history size in number of elements
The return value is an error code
This function is declared in upipe-modules/upipe_graph.h source file, line 77.
This function sets the graph maximum value.
Parameter list:
- upipe: description structure of the pipe
- max: maximum value shown on the graph
The return value is an error code
This function is declared in upipe-modules/upipe_graph.h source file, line 65.
This function sets the graph minimum value.
Parameter list:
- upipe: description structure of the pipe
- min: minimum value shown on the graph
The return value is an error code
enum upipe_graph_sub_control [link]
This enum is declared in upipe-modules/upipe_graph.h source file, line 107.
This enum enumerates the graph input control commands.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_GRAPH_SUB_SENTINEL | 0x8000 | |
| UPIPE_GRAPH_SUB_SET_COLOR | 1 | set the input graph color (const char *) |
| UPIPE_GRAPH_SUB_SET_VALUE | 2 | update the current value (int64_t) |
This function is declared in upipe-modules/upipe_graph.h source file, line 128.
This function sets the input graph color. The format for RGB is "rgb(R, G, B)" with R,G and B respectively the green, red and blue value. The format for RGBA is "rgba(R, G, B, A)" with R, G, B and A respectively the green, red, blue and alpha value.
Parameter list:
- upipe: description structure of the pipe
- color: color string
The return value is an error code
This function is declared in upipe-modules/upipe_graph.h source file, line 141.
This function updates the graph input value.
Parameter list:
- upipe: description structure of the pipe
- value: the new value
The return value is an error code