upipe-hls/upipe_hls_playlist.h header reference

Upipe module to play output of a m3u reader pipe More

Header inclusion  

Members  

Types  

Functions  

Description  

Upipe module to play output of a m3u reader pipe

Members detail  

#define UPIPE_HLS_PLAYLIST_SIGNATURE  

This macro is declared in upipe-hls/upipe_hls_playlist.h source file, line 36.

#define _UPIPE_HLS_UPIPE_HLS_PLAYLIST_H_  

This macro is declared in upipe-hls/upipe_hls_playlist.h source file, line 29.

enum upipe_hls_playlist_command  

This enum is declared in upipe-hls/upipe_hls_playlist.h source file, line 40.

This enum extends upipe_command with specific m3u playlist command.

IdentifierValueDescription
UPIPE_HLS_PLAYLIST_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_HLS_PLAYLIST_GET_INDEXunknownget the current index (uint64_t *)
UPIPE_HLS_PLAYLIST_SET_INDEXunknownset the current index (uint64_t)
UPIPE_HLS_PLAYLIST_PLAYunknownplay
UPIPE_HLS_PLAYLIST_NEXTunknowngo to the next index
UPIPE_HLS_PLAYLIST_SEEKunknownseek to this offset (uint64_t)

const char * upipe_hls_playlist_command_str(int cmd)  

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:

The return value is the corresponding string or NULL if not a valid enum upipe_hls_playlist_command

int upipe_hls_playlist_get_index(struct upipe *upipe, uint64_t *index_p)  

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

struct upipe_mgr * upipe_hls_playlist_mgr_alloc(void )  

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

int upipe_hls_playlist_next(struct upipe *upipe)  

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

int upipe_hls_playlist_play(struct upipe *upipe)  

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

int upipe_hls_playlist_seek(struct upipe *upipe, uint64_t at, uint64_t *offset_p)  

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

int upipe_hls_playlist_set_index(struct upipe *upipe, uint64_t index)  

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  

This enum is declared in upipe-hls/upipe_hls_playlist.h source file, line 139.

This enum extends uprobe_event with specific m3u playlist events.

IdentifierValueDescription
UPROBE_HLS_PLAYLIST_SENTINELUPROBE_LOCAL
UPROBE_HLS_PLAYLIST_NEED_RELOADunknownplaylist need to be reloaded
UPROBE_HLS_PLAYLIST_RELOADEDunknownplaylist was reloaded
UPROBE_HLS_PLAYLIST_ITEM_ENDunknownthe item has finished

const char * uprobe_hls_playlist_event_str(int event)  

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: uprobe_event to convert

The return value is a string or NULL if not a valid enum uprobe_hls_playlist_event

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:18 2018 using MkDoc