upipe-modules/upipe_udp_sink.h header reference
Upipe sink module for udp More
Header inclusion
Members
Types
- enum upipe_udpsink_command
- enum upipe_udpsink_mode
Functions
- int upipe_udpsink_get_uri(struct upipe *upipe, const char **uri_p)
- struct upipe_mgr * upipe_udpsink_mgr_alloc(void )
- int upipe_udpsink_set_uri(struct upipe *upipe, const char *uri, enum upipe_udpsink_mode mode)
Description
Members detail
This macro is declared in upipe-modules/upipe_udp_sink.h source file, line 39.
This macro is declared in upipe-modules/upipe_udp_sink.h source file, line 32.
This enum is declared in upipe-modules/upipe_udp_sink.h source file, line 49.
This enum extends upipe_command with specific commands for udp sink.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_UDPSINK_SENTINEL | 0 | |
| UPIPE_UDPSINK_GET_URI | 1 | returns the uri of the currently opened udp (const char **) |
| UPIPE_UDPSINK_SET_URI | 2 | asks to open the given uri (const char *, enum upipe_udpsink_mode) |
int upipe_udpsink_get_uri(struct upipe *upipe, const char **uri_p)
This function is declared in upipe-modules/upipe_udp_sink.h source file, line 72.
This function returns the uri of the currently opened udp uri.
Parameters list:
- upipe: description structure of the pipe
- uri_p: filled in with the uri of the udp
The return value is false in case of error
struct upipe_mgr * upipe_udpsink_mgr_alloc(void )
This function is declared in upipe-modules/upipe_udp_sink.h source file, line 62.
This function returns the management structure for all udp sinks.
The return value is pointer to manager
This enum is declared in upipe-modules/upipe_udp_sink.h source file, line 43.
This enum defines udp opening modes.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_UDPSINK_NONE | 0 | do not do anything besides opening the fd |
int upipe_udpsink_set_uri(struct upipe *upipe, const char *uri, enum upipe_udpsink_mode mode)
This function is declared in upipe-modules/upipe_udp_sink.h source file, line 87.
This function asks to open the given udp uri.
Parameters list:
- upipe: description structure of the pipe
- uri: relative or absolute uri
- mode: mode of opening the uri
The return value is false in case of error