upipe-modules/upipe_multicat_probe.h header reference

Upipe module - multicat probe More

Header inclusion  

Members  

Types  

Functions  

Description  

This linear module sends probe depending on the uref k.systime attribute.

Members detail  

#define UPIPE_MULTICAT_PROBE_DEF_ROTATE  

This macro is declared in upipe-modules/upipe_multicat_probe.h source file, line 41.

#define UPIPE_MULTICAT_PROBE_DEF_ROTATE_OFFSET  

This macro is declared in upipe-modules/upipe_multicat_probe.h source file, line 42.

#define UPIPE_MULTICAT_PROBE_SIGNATURE  

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

#define _UPIPE_MODULES_UPIPE_MULTICAT_PROBE_H_  

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

enum upipe_multicat_probe_command  

This enum is declared in upipe-modules/upipe_multicat_probe.h source file, line 46.

This enum extends upipe_command with specific commands for multicat sink.

IdentifierValueDescription
UPIPE_MULTICAT_PROBE_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_MULTICAT_PROBE_GET_ROTATEunknownget rotate interval (uint64_t *, uint64_t *)
UPIPE_MULTICAT_PROBE_SET_ROTATEunknownchange rotate interval (uint64_t, uint64_t) (default: UPIPE_MULTICAT_PROBE_DEF_ROTATE)

int upipe_multicat_probe_get_rotate(struct upipe *upipe, uint64_t *interval_p, uint64_t *offset_p)  

This function is declared in upipe-modules/upipe_multicat_probe.h source file, line 80.

This function returns the rotate interval (in 27MHz unit).

Parameter list:

  • upipe: description structure of the pipe
  • interval_p: filled in with the rotate interval in 27MHz
  • offset_p: filled in with the rotate offset in 27MHz

The return value is an error code

struct upipe_mgr * upipe_multicat_probe_mgr_alloc(void )  

This function is declared in upipe-modules/upipe_multicat_probe.h source file, line 68.

This function returns the management structure for multicat_probe pipes.

The return value is pointer to manager

int upipe_multicat_probe_set_rotate(struct upipe *upipe, uint64_t interval, uint64_t offset)  

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

This function changes the rotate interval (in 27MHz unit) (default: UPIPE_MULTICAT_PROBE_DEF_ROTATE).

Parameter list:

  • upipe: description structure of the pipe
  • interval: rotate interval in 27MHz
  • offset: rotate offset in 27MHz

The return value is an error code

enum uprobe_multicat_probe_event  

This enum is declared in upipe-modules/upipe_multicat_probe.h source file, line 56.

This enum extends uprobe_event with specific events for multicat probe.

IdentifierValueDescription
UPROBE_MULTICAT_PROBE_SENTINELUPROBE_LOCAL
UPROBE_MULTICAT_PROBE_ROTATEunknownrotate event (struct uref *uref, uint64_t index)

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