upipe-modules/upipe_genaux.h header reference

Upipe module - generates auxiliary blocks from k.systime More

Header inclusion  

Members  

Type  

Functions  

Description  

This module outputs an urefblock containing the (network-endian) k.systime value from the input uref. This is typically used as an input for fsink (or any fsink-like pipe) to store multicat auxiliary files.

Members detail  

#define UPIPE_GENAUX_SIGNATURE  

This macro is declared in upipe-modules/upipe_genaux.h source file, line 44.

#define _UPIPE_MODULES_UPIPE_GENAUX_H_  

This macro is declared in upipe-modules/upipe_genaux.h source file, line 35.

enum upipe_genaux_command  

This enum is declared in upipe-modules/upipe_genaux.h source file, line 48.

This enum extends upipe_command with specific commands for genaux pipes.

IdentifierValueDescription
UPIPE_GENAUX_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_GENAUX_SET_GETATTRunknownset getter (int (*)(struct uref*, uint64_t*))
UPIPE_GENAUX_GET_GETATTRunknownget getter (int (*)(struct uref*, uint64_t*))

int upipe_genaux_get_getattr(struct upipe *upipe, int(**get)(struct uref*,uint64_t*))  

This function is declared in upipe-modules/upipe_genaux.h source file, line 79.

This function gets the get callback to fetch the u64 opaque with.

Parameter list:

  • upipe: description structure of the pipe
  • get: callback pointer

The return value is an error code

void upipe_genaux_hton64(uint8_t *buf, uint64_t opaque)  

This function is declared in upipe-modules/upipe_genaux.h source file, line 96.

This function swaps uint64 to net-endian

Parameter list:

  • buf: destination buffer
  • opaque: uint64 opaque to swap

struct upipe_mgr * upipe_genaux_mgr_alloc(void )  

This function is declared in upipe-modules/upipe_genaux.h source file, line 88.

This function returns the management structure for genaux pipes.

The return value is pointer to manager

uint64_t upipe_genaux_ntoh64(const uint8_t *buf)  

This function is declared in upipe-modules/upipe_genaux.h source file, line 113.

This function swaps uint64 from net-endian

Parameter list:

  • buf: source buffer

The return value is uint64 host-endian

int upipe_genaux_set_getattr(struct upipe *upipe, int (*get)(struct ::uref *,uint64_t *) )  

This function is declared in upipe-modules/upipe_genaux.h source file, line 66.

This function sets the get callback to fetch the u64 opaque with.

Parameter list:

  • upipe: description structure of the pipe
  • get: callback

The return value is an error code

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