upipe-modules/upipe_skip.h header reference

Upipe module - skip More

Header inclusion  

Members  

Type  

Functions  

Description  

Skip arbitrary length of data in blocks.

Members detail  

#define UPIPE_SKIP_SIGNATURE  

This macro is declared in upipe-modules/upipe_skip.h source file, line 40.

#define _UPIPE_MODULES_UPIPE_SKIP_H_  

This macro is declared in upipe-modules/upipe_skip.h source file, line 32.

enum upipe_skip_command  

This enum is declared in upipe-modules/upipe_skip.h source file, line 44.

This enum extends upipe_command with specific commands for upipe_skip.

IdentifierValueDescription
UPIPE_SKIP_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_SKIP_GET_OFFSETunknownreturns the current offset (size_t *)
UPIPE_SKIP_SET_OFFSETunknowndefines offset (size_t)

int upipe_skip_get_offset(struct upipe *upipe, size_t *offset_p)  

This function is declared in upipe-modules/upipe_skip.h source file, line 61.

This function returns the currently opened offset.

Parameter list:

  • upipe: description structure of the pipe
  • offset: current offset

The return value is an error code

struct upipe_mgr * upipe_skip_mgr_alloc(void )  

This function is declared in upipe-modules/upipe_skip.h source file, line 83.

This function returns the management structure for skip pipes.

The return value is pointer to manager

int upipe_skip_set_offset(struct upipe *upipe, size_t offset)  

This function is declared in upipe-modules/upipe_skip.h source file, line 74.

This function asks to open the given offset.

Parameter list:

  • upipe: description structure of the pipe
  • offset: skip offset

The return value is an error code

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