upipe/uprobe_select_flows.h header reference

probe catching need_update events and creating subpipes More

Header inclusion  

Members  

Type  

Functions  

Description  

The probe catches the need_update events, checks whether it is necessary to output the flow, and allocates a subpipe.

In case of a change of configuration, or if flows are added or deleted, the selections are reconsidered.

Members detail  

#define _UPIPE_UPROBE_SELECT_FLOWS_H_  

This macro is declared in upipe/uprobe_select_flows.h source file, line 37.

struct uprobe * uprobe_selflow_alloc(struct uprobe *next, struct uprobe *subprobe, enum uprobe_selflow_type type, const char *flows)  

This function is declared in upipe/uprobe_select_flows.h source file, line 71.

This function allocates a new uprobe_selflow structure.

Parameter list:

  • next: next probe to test if this one doesn't catch the event
  • subprobe: probe to set on flow subpipes
  • type: type of flows to filter
  • flows: comma-separated list of flows or attribute/value pairs (lang=eng or name=ABC) to select, or "auto" to automatically select the first flow, or "all"

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

struct uprobe * uprobe_selflow_alloc_va(struct uprobe *next, struct uprobe *subprobe, enum uprobe_selflow_type type, const char *format, ...)  

This function is declared in upipe/uprobe_select_flows.h source file, line 86.

This function allocates a new uprobe_selflow structure, with printf-style syntax.

Parameter list:

  • next: next probe to test if this one doesn't catch the event
  • subprobe: probe to set on flow subpipes
  • type: type of flows to filter
  • format: printf-style format for the flows, followed by optional arguments

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

void uprobe_selflow_get(struct uprobe *uprobe, const char **flows_p)  

This function is declared in upipe/uprobe_select_flows.h source file, line 94.

This function returns the flows selected by this probe.

Parameter list:

  • uprobe: pointer to probe
  • flows_p: filled in with a comma-separated list of flows to select, terminated by a comma, or "all", or "auto" if no flow has been found yet

int uprobe_selflow_set(struct uprobe *uprobe, const char *flows)  

This function is declared in upipe/uprobe_select_flows.h source file, line 104.

This function changes the flows selected by this probe.

Parameter list:

  • uprobe: pointer to probe
  • flows: comma-separated list of flows or attribute/value pairs (lang=eng or name=ABC) to select, or "auto" to automatically select the first flow, or "all"

The return value is an error code

int uprobe_selflow_set_va(struct uprobe *uprobe, const char *format, ...)  

This function is declared in upipe/uprobe_select_flows.h source file, line 114.

This function changes the flows selected by this probe, with printf-style syntax.

Parameter list:

  • uprobe: pointer to probe
  • format: format of the syntax, followed by optional arguments

The return value is an error code

enum uprobe_selflow_type  

This enum is declared in upipe/uprobe_select_flows.h source file, line 47.

This enum defines types of flows to select from.

IdentifierValueDescription
UPROBE_SELFLOW_VOID0void flows (programs)
UPROBE_SELFLOW_PIC1picture flows, excepting sub pictures
UPROBE_SELFLOW_SOUND2sound flows
UPROBE_SELFLOW_SUBPIC3sub picture flows

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