upipe-modules/upipe_trickplay.h header reference

Upipe module facilitating trick play operations More

Header inclusion [link] 

Members [link] 

Type [link] 

Functions [link] 

Description [link] 

Upipe module facilitating trick play operations

Members detail [link] 

#define UPIPE_TRICKP_SIGNATURE [link] 

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

#define UPIPE_TRICKP_SUB_SIGNATURE [link] 

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

#define _UPIPE_MODULES_UPIPE_TRICKPLAY_H_ [link] 

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

enum upipe_trickp_command [link] 

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

This enum extends upipe_command with specific commands for trickp pipes.

IdentifierValueDescription
UPIPE_TRICKP_SENTINEL0x8000
UPIPE_TRICKP_GET_RATE1returns the current playing rate (struct urational *)
UPIPE_TRICKP_SET_RATE2sets the playing rate (struct urational)

int upipe_trickp_get_rate(struct upipe *upipe, struct urational *rate_p) [link] 

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

This function returns the current playing rate.

Parameter list:

  • upipe: description structure of the pipe
  • rate_p: filled with the current rate

The return value is an error code

struct upipe_mgr * upipe_trickp_mgr_alloc(void ) [link] 

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

This function returns the management structure for all trickp pipes.

The return value is pointer to manager

int upipe_trickp_set_rate(struct upipe *upipe, struct urational rate) [link] 

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

This function sets the playing rate.

Parameter list:

  • upipe: description structure of the pipe
  • rate: new rate (1/1 = normal play, 0 = pause)

The return value is an error code

Valid XHTML 1.0 StrictGenerated by cmassiot on Sun Dec 14 18:31:17 2025 using MkDoc