upipe-modules/upipe_multicat_probe.h header reference

Upipe module - multicat probe More

Header inclusion [link]

upipe/upipe.h

Members [link]

Types [link]

enum upipe_multicat_probe_command
enum uprobe_multicat_probe_event

Functions [link]

int upipe_multicat_probe_get_rotate(struct upipe *upipe, uint64_t *interval_p, uint64_t *offset_p)
struct upipe_mgr * upipe_multicat_probe_mgr_alloc(void )
int upipe_multicat_probe_set_rotate(struct upipe *upipe, uint64_t interval, uint64_t offset)

Description [link]

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

Members detail [link]

#define UPIPE_MULTICAT_PROBE_DEF_ROTATE [link]

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

#define UPIPE_MULTICAT_PROBE_DEF_ROTATE_OFFSET [link]

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

#define UPIPE_MULTICAT_PROBE_SIGNATURE [link]

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

#define _UPIPE_MODULES_UPIPE_MULTICAT_PROBE_H_ [link]

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

enum upipe_multicat_probe_command [link]

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.

Identifier	Value	Description
UPIPE_MULTICAT_PROBE_SENTINEL	0x8000
UPIPE_MULTICAT_PROBE_GET_ROTATE	1	get rotate interval (uint64_t , uint64_t )
UPIPE_MULTICAT_PROBE_SET_ROTATE	2	change 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) [link]

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 ) [link]

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) [link]

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).