upipe-hls/upipe_hls_playlist.h header reference
Upipe module to play output of a m3u reader pipe More
Header inclusion [link]
Members [link]
Types [link]
Functions [link]
- const char * upipe_hls_playlist_command_str(int cmd)
- int upipe_hls_playlist_get_index(struct upipe *upipe, uint64_t *index_p)
- struct upipe_mgr * upipe_hls_playlist_mgr_alloc(void )
- int upipe_hls_playlist_next(struct upipe *upipe)
- int upipe_hls_playlist_play(struct upipe *upipe)
- int upipe_hls_playlist_seek(struct upipe *upipe, uint64_t at, uint64_t *offset_p)
- int upipe_hls_playlist_set_index(struct upipe *upipe, uint64_t index)
- const char * uprobe_hls_playlist_event_str(int event)
Description [link]
Upipe module to play output of a m3u reader pipe
Members detail [link]
#define UPIPE_HLS_PLAYLIST_SIGNATURE [link]
This macro is declared in upipe-hls/upipe_hls_playlist.h source file, line 36.
#define _UPIPE_HLS_UPIPE_HLS_PLAYLIST_H_ [link]
This macro is declared in upipe-hls/upipe_hls_playlist.h source file, line 29.
enum upipe_hls_playlist_command [link]
This enum is declared in upipe-hls/upipe_hls_playlist.h source file, line 40.
This enum extends enum upipe_command with specific m3u playlist command.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_HLS_PLAYLIST_SENTINEL | 0x8000 | |
| UPIPE_HLS_PLAYLIST_GET_INDEX | 1 | get the current index (uint64_t *) |
| UPIPE_HLS_PLAYLIST_SET_INDEX | 2 | set the current index (uint64_t) |
| UPIPE_HLS_PLAYLIST_PLAY | 3 | play |
| UPIPE_HLS_PLAYLIST_NEXT | 4 | go to the next index |
| UPIPE_HLS_PLAYLIST_SEEK | 5 | seek to this offset (uint64_t) |
const char * upipe_hls_playlist_command_str(int cmd) [link]
This function is declared in upipe-hls/upipe_hls_playlist.h source file, line 62.
This function converts m3u playlist specific command to a string.
Parameter list:
- cmd: enum upipe_hls_playlist_command to convert
The return value is the corresponding string or NULL if not a valid enum upipe_hls_playlist_command
This function is declared in upipe-hls/upipe_hls_playlist.h source file, line 82.
This function gets the current index in the playlist.
Parameter list:
- upipe: description structure of the pipe
- index_p: a pointer to the index
The return value is an error code
This function is declared in upipe-hls/upipe_hls_playlist.h source file, line 170.
This function returns the m3u playlist manager.
The return value is pointer to manager
This function is declared in upipe-hls/upipe_hls_playlist.h source file, line 117.
This function goes to the next element in the playlist.
Parameter list:
- upipe: description structure of the pipe
The return value is an error code
This function is declared in upipe-hls/upipe_hls_playlist.h source file, line 106.
This function plays the next item in the playlist.
Parameter list:
- upipe: description structure of the pipe
The return value is an error code
This function is declared in upipe-hls/upipe_hls_playlist.h source file, line 133.
This function seeks into the playlist the corresponding media sequence for a given offset.
Parameter list:
- upipe: description structure of the pipe
- at: offset to seek
- offset_p: filled with remaining offset to seek in the current item, may be NULL.
The return value is an error code
This function is declared in upipe-hls/upipe_hls_playlist.h source file, line 95.
This function sets the current index in the playlist.
Parameter list:
- upipe: description structure of the pipe
- index: index to set
The return value is an error code
enum uprobe_hls_playlist_event [link]
This enum is declared in upipe-hls/upipe_hls_playlist.h source file, line 139.
This enum extends enum uprobe_event with specific m3u playlist events.
| Identifier | Value | Description |
|---|---|---|
| UPROBE_HLS_PLAYLIST_SENTINEL | 0x8000 | |
| UPROBE_HLS_PLAYLIST_NEED_RELOAD | 1 | playlist need to be reloaded |
| UPROBE_HLS_PLAYLIST_RELOADED | 2 | playlist was reloaded |
| UPROBE_HLS_PLAYLIST_ITEM_END | 3 | the item has finished |
const char * uprobe_hls_playlist_event_str(int event) [link]
This function is declared in upipe-hls/upipe_hls_playlist.h source file, line 156.
This function converts hls playlist specific event to a string.
Parameter list:
- event: enum uprobe_event to convert
The return value is a string or NULL if not a valid enum uprobe_hls_playlist_event