upipe-modules/upipe_play.h header reference

Upipe module synchronizing latencies of flows belonging to a program More

Header inclusion

upipe/upipe.h

Members

Type

enum upipe_play_command

Functions

int upipe_play_get_output_latency(struct upipe *upipe, uint64_t *latency_p)
struct upipe_mgr * upipe_play_mgr_alloc(void )
int upipe_play_set_output_latency(struct upipe *upipe, uint64_t latency)

Description

Upipe module synchronizing latencies of flows belonging to a program

Members detail

#define UPIPE_PLAY_SIGNATURE

This macro is declared in upipe-modules/upipe_play.h source file, line 38.

#define UPIPE_PLAY_SUB_SIGNATURE

This macro is declared in upipe-modules/upipe_play.h source file, line 39.

#define _UPIPE_MODULES_UPIPE_PLAY_H_

This macro is declared in upipe-modules/upipe_play.h source file, line 31.

enum upipe_play_command

This enum is declared in upipe-modules/upipe_play.h source file, line 43.

This enum extends upipe_command with specific commands for play pipes.

Identifier	Value	Description
UPIPE_PLAY_SENTINEL	0
UPIPE_PLAY_GET_OUTPUT_LATENCY	1	returns the current output latency (uint64_t *)
UPIPE_PLAY_SET_OUTPUT_LATENCY	2	sets the output latency (uint64_t)

int upipe_play_get_output_latency(struct upipe upipe, uint64_t latency_p)

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

This function returns the current output latency;

Parameters list:

upipe: description structure of the pipe
latency_p: filled with the output latency

The return value is an error code

struct upipe_mgr * upipe_play_mgr_alloc(void )

This function is declared in upipe-modules/upipe_play.h source file, line 56.

This function returns the management structure for all play pipes.

The return value is pointer to manager

int upipe_play_set_output_latency(struct upipe *upipe, uint64_t latency)

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

This function sets the output latency;