upipe-filters/upipe_audio_bar.h header reference

Upipe module generating audio meters subpictures More

Header inclusion  

Members  

Type  

Functions  

Description  

Upipe module generating audio meters subpictures

Members detail  

#define UPIPE_AUDIO_BAR_SIGNATURE  

This macro is declared in upipe-filters/upipe_audio_bar.h source file, line 35.

#define _UPIPE_FILTERS_UPIPE_AUDIO_BAR_H_  

This macro is declared in upipe-filters/upipe_audio_bar.h source file, line 28.

enum upipe_audiobar_command  

This enum is declared in upipe-filters/upipe_audio_bar.h source file, line 46.

This enum extends upipe_command with specific commands for upipe_audiobar pipes.

IdentifierValueDescription
UPIPE_AUDIOBAR_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_AUDIOBAR_GET_ALPHAunknowngets the value of the alpha channel (uint8_t *)
UPIPE_AUDIOBAR_SET_ALPHAunknownsets the value of the alpha channel (uint8_t)

int upipe_audiobar_get_alpha(struct upipe *upipe, uint8_t *alpha_p)  

This function is declared in upipe-filters/upipe_audio_bar.h source file, line 63.

This function gets the value of the alpha channel.

Parameter list:

  • upipe: description structure of the pipe
  • alpha_p: filled in with the value of the alpha channel

The return value is an error code

struct upipe_mgr * upipe_audiobar_mgr_alloc(void )  

This function is declared in upipe-filters/upipe_audio_bar.h source file, line 42.

This function returns the management structure for audiobar pipes.

The return value is pointer to manager

int upipe_audiobar_set_alpha(struct upipe *upipe, uint8_t alpha)  

This function is declared in upipe-filters/upipe_audio_bar.h source file, line 76.

This function sets the value of the alpha channel.

Parameter list:

  • upipe: description structure of the pipe
  • alpha: value of the alpha channel

The return value is an error code

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