upipe-modules/upipe_file_source.h header reference
Upipe source module for files More
Header inclusion
Members
Type
- enum upipe_fsrc_command
Functions
- int upipe_fsrc_get_position(struct upipe *upipe, uint64_t *position_p)
- int upipe_fsrc_get_size(struct upipe *upipe, uint64_t *size_p)
- struct upipe_mgr * upipe_fsrc_mgr_alloc(void )
- int upipe_fsrc_set_position(struct upipe *upipe, uint64_t position)
Description
Members detail
This macro is declared in upipe-modules/upipe_file_source.h source file, line 38.
This macro is declared in upipe-modules/upipe_file_source.h source file, line 31.
This enum is declared in upipe-modules/upipe_file_source.h source file, line 42.
This enum extends upipe_command with specific commands for file source.
Identifier | Value | Description |
---|---|---|
UPIPE_FSRC_SENTINEL | 0 | |
UPIPE_FSRC_GET_SIZE | 1 | returns the size of the currently opened file, in octets (uint64_t *) |
UPIPE_FSRC_GET_POSITION | 2 | returns the reading position of the currently opened file, in octets (uint64_t *) |
UPIPE_FSRC_SET_POSITION | 3 | asks to read at the given position (uint64_t) |
int upipe_fsrc_get_position(struct upipe *upipe, uint64_t *position_p)
This function is declared in upipe-modules/upipe_file_source.h source file, line 81.
This function returns the reading position of the currently opened file.
Parameters list:
- upipe: description structure of the pipe
- position_p: filled in with the reading position, in octets
The return value is an error code
int upipe_fsrc_get_size(struct upipe *upipe, uint64_t *size_p)
This function is declared in upipe-modules/upipe_file_source.h source file, line 68.
This function returns the size of the currently opened file.
Parameters list:
- upipe: description structure of the pipe
- size_p: filled in with the size of the file, in octets
The return value is an error code
struct upipe_mgr * upipe_fsrc_mgr_alloc(void )
This function is declared in upipe-modules/upipe_file_source.h source file, line 58.
This function returns the management structure for all file sources.
The return value is pointer to manager
int upipe_fsrc_set_position(struct upipe *upipe, uint64_t position)
This function is declared in upipe-modules/upipe_file_source.h source file, line 94.
This function asks to read at the given position.
Parameters list:
- upipe: description structure of the pipe
- position: new reading position, in octets (between 0 and the size)
The return value is an error code