upipe/upipe_helper_uclock.h header reference

Upipe helper functions for uclock More

Header inclusion  

Members  

Macro  

Description  

Upipe helper functions for uclock

Members detail  

#define UPIPE_HELPER_UCLOCK(STRUCTURE, UCLOCK)  

This macro is declared in upipe/upipe_helper_uclock.h source file, line 81.

This macro declares four functions dealing with the uclock.

You must add one pointer to your private upipe structure, for instance:

struct uclock *uclock;

Supposing the name of your structure is upipe_foo, it declares:

  • void upipe_foo_init_uclock(struct upipe *upipe)

    Typically called in your upipe_foo_alloc() function.

  • int upipe_foo_attach_uclock(struct upipe *upipe)

    Typically called from your upipe_foo_control() handler, such as:

    case UPIPE_ATTACH_UREF_MGR: {
    return upipe_foo_attach_uclock(upipe);
    }
  • int upipe_foo_check_uclock(struct upipe *upipe)

    Checks if the uclock is available, and asks for it otherwise.

  • void upipe_foo_clean_uclock(struct upipe *upipe)

    Typically called from your upipe_foo_free() function.

Parameters list:

  • STRUCTURE: name of your private upipe structure
  • UCLOCK: name of the struct uclock * field of your private upipe structure

#define _UPIPE_UPIPE_HELPER_UCLOCK_H_  

This macro is declared in upipe/upipe_helper_uclock.h source file, line 31.

Valid XHTML 1.0 StrictGenerated by cmassiot on Thu Nov 6 12:15:37 2014 using MkDoc