upipe-modules/upipe_file_sink.h header reference
Upipe sink module for files More
Header inclusion
Members
Types
- enum upipe_fsink_command
- enum upipe_fsink_mode
Functions
- int upipe_fsink_get_path(struct upipe *upipe, const char **path_p)
- struct upipe_mgr * upipe_fsink_mgr_alloc(void )
- int upipe_fsink_set_path(struct upipe *upipe, const char *path, enum upipe_fsink_mode mode)
Description
Members detail
This macro is declared in upipe-modules/upipe_file_sink.h source file, line 39.
This macro is declared in upipe-modules/upipe_file_sink.h source file, line 38.
This macro is declared in upipe-modules/upipe_file_sink.h source file, line 31.
This enum is declared in upipe-modules/upipe_file_sink.h source file, line 55.
This enum extends upipe_command with specific commands for file sink.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_FSINK_SENTINEL | 0 | |
| UPIPE_FSINK_GET_PATH | 1 | returns the path of the currently opened file (const char **) |
| UPIPE_FSINK_SET_PATH | 2 | asks to open the given path (const char *, enum upipe_fsink_mode) |
int upipe_fsink_get_path(struct upipe *upipe, const char **path_p)
This function is declared in upipe-modules/upipe_file_sink.h source file, line 78.
This function returns the path of the currently opened file.
Parameters list:
- upipe: description structure of the pipe
- path_p: filled in with the path of the file
The return value is an error code
struct upipe_mgr * upipe_fsink_mgr_alloc(void )
This function is declared in upipe-modules/upipe_file_sink.h source file, line 68.
This function returns the management structure for all file sinks.
The return value is pointer to manager
This enum is declared in upipe-modules/upipe_file_sink.h source file, line 43.
This enum defines file opening modes.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_FSINK_NONE | 0 | do not do anything besides opening the fd |
| UPIPE_FSINK_APPEND | 1 | append to an existing file (O_CREAT + lseek(SEEK_END)) |
| UPIPE_FSINK_OVERWRITE | 2 | overwrite an existing file, or create it (O_CREAT + ftruncate(0)) |
| UPIPE_FSINK_CREATE | 3 | create a file, fail if it already exists (O_CREAT | O_EXCL) |
int upipe_fsink_set_path(struct upipe *upipe, const char *path, enum upipe_fsink_mode mode)
This function is declared in upipe-modules/upipe_file_sink.h source file, line 93.
This function asks to open the given file.
Parameters list:
- upipe: description structure of the pipe
- path: relative or absolute path of the file
- mode: mode of opening the file
The return value is an error code