upipe-blackmagic/ubuf_sound_blackmagic.h header reference

Upipe ubuf manager for sound formats with blackmagic storage More

Header inclusion  

Members  

Functions  

Macro  

Description  

Upipe ubuf manager for sound formats with blackmagic storage

Members detail  

#define UBUF_BMD_ALLOC_SOUND  

This macro is declared in upipe-blackmagic/ubuf_sound_blackmagic.h source file, line 45.

This macro is a simple signature to make sure the ubuf_alloc internal API is used properly.

#define _UPIPE_BLACKMAGIC_UBUF_SOUND_BLACKMAGIC_H_  

This macro is declared in upipe-blackmagic/ubuf_sound_blackmagic.h source file, line 31.

struct ubuf * ubuf_sound_bmd_alloc(struct ubuf_mgr *mgr, void *AudioFrame)  

This function is declared in upipe-blackmagic/ubuf_sound_blackmagic.h source file, line 56.

This function returns a new ubuf from a blackmagic sound allocator.

Parameter list:

  • mgr: management structure for this ubuf type
  • AudioFrame: pointer to IDeckLinkAudioInputPacket

The return value is pointer to ubuf or NULL in case of failure

struct ubuf_mgr * ubuf_sound_bmd_mgr_alloc(uint16_t ubuf_pool_depth, uint32_t SampleType, uint8_t nb_channels, const char *channel)  

This function is declared in upipe-blackmagic/ubuf_sound_blackmagic.h source file, line 72.

This function allocates a new instance of the ubuf manager for sound formats using blackmagic.

Parameter list:

  • ubuf_pool_depth: maximum number of ubuf structures in the pool
  • SampleType: blackmagic sample type
  • nb_channels: number of channels
  • channel: channel type (see channel reference)

The return value is pointer to manager, or NULL in case of error

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:18 2018 using MkDoc