upipe/upipe_helper_sync.h header reference
Upipe helper functions for sync_lost/sync_acquired probe events More
Header inclusion [link]
Members [link]
Macro [link]
Description [link]
Upipe helper functions for sync_lost/sync_acquired probe events
Members detail [link]
#define UPIPE_HELPER_SYNC(STRUCTURE, ACQUIRED) [link]
This macro is declared in upipe/upipe_helper_sync.h source file, line 76.
This macro declares four functions throwing the UPROBE_SYNC_ACQUIRED and UPROBE_SYNC_LOST events in a consistent manner.
You must add a boolean to your private pipe structure, for instance:
bool acquired;You must also declare UPIPE_HELPER_UPIPE prior to using this macro.
Supposing the name of your structure is upipe_foo, it declares:
void upipe_foo_init_sync(struct upipe_foo *s)Initializes the acquired field.
int upipe_foo_sync_lost(struct upipe_foo *s)Throws the UPROBE_SYNC_LOST event, if it hasn't been thrown before.
int upipe_foo_sync_acquired(struct upipe_foo *s)Throws the UPROBE_SYNC_ACQUIRED event, if it hasn't been thrown before.
void upipe_foo_clean_sync(struct upipe_foo *s)Currently does nothing.
Parameter list:
- STRUCTURE: name of your private upipe structure
- ACQUIRED: name of the bool field of your private upipe structure
#define _UPIPE_UPIPE_HELPER_SYNC_H_ [link]
This macro is declared in upipe/upipe_helper_sync.h source file, line 31.