Substream Reducer

Table of Contents

• Plugin Information
• Plugin Versions
• Component Information
• Properties
• Input Pins
• Output Pins
• Runner Pins
• Dynamic Pins
• Input Pin Stream Types
• Output Pin Stream Types

Plugin Information

Plugin Filename	adtf_core.adtfplugin
Plugin Description	adtf_core.plugindescription
Plugin Name	ADTF Core Plugin
License	ADTF Subscription
Support Mail	support@digitalwerk.net
Homepage URL	https://adtf.dev

Plugin Versions

Plugin Version	3.99.99
Plugin File Version	1.0
adtf	3.99.99
adtf::ucom	3.1.0

Component Information

Name	Substream Reducer
CID	substream_reducer.streaming.adtf.cid
Description	Use this filter to output only a subset of the incoming substreams from the input sample stream. Please keep in mind that this filter will NOT request any substreams from the connected sources. To make sure that the connected source(s) provides data for the given substreams either connect a 'Substream Requestor' to the output pin of this filter and/or make sure the any filter or sink that should handle these substreams does request them (i.e. by enabling the 'request_substreams' property if a 'Recorder' or 'Qt5 Media Description Display' is connected).
Type	Filter

Properties

Name	Value	Type	Description	Subproperties
filter_behaviour	0	tUInt8	Whether the selected filter should be used to include (allow) or exclude (block) the matching substreams.	Value List: allow = 0 block = 1Value Range: minimum = maximum = Filename Extension Filter:
filter_file		cFilename	If set, each line of the given file will be used to match and select substreams according to 'filter_mode'. Note: Cannot be used in combination with property 'filter_string'. Launching will be declined when setting both properties!	Value Range: minimum = maximum = Filename Extension Filter:
filter_mode	1	tUInt8	Chooses how the substreams are filtered. In 'prefix_trim' mode the prefix will be stripped from the substream name as well.	Value List: prefix = 2 prefix_trim = 1 regex = 4Value Range: minimum = maximum = Filename Extension Filter:
filter_string		cString	If set, substreams matching this string will be present in the output substream subset. Note: Cannot be used in combination with property 'filter_file'. Launching will be declined when setting both properties!	Value Range: minimum = maximum = Filename Extension Filter:
log_channels/default/fatal_action	2	tUInt32	The default action when a fatal error is reported.	Value List: Stop session = 2 Shutdown ADTF = 3 Abort to crash handler = 4Value Range: minimum = maximum = Filename Extension Filter:
log_channels/default/log_level	35	tUInt8	The log level for this channel.	Value List: None = 0 Error = 10 Warning = 20 Info = 30 Detail = 35 Dump = 40 All = 255Value Range: minimum = maximum = Filename Extension Filter:
log_channels/default/recoverable_action	0	tUInt8	The action to perform when a recoverable error is reported.	Value List: Log only = 0 Treat as fatal = 1Value Range: minimum = maximum = Filename Extension Filter:

Input Pins

Name	Stream Type	Description
input	adtf/substreams	Sample stream containing substreams to create a subset of.

Output Pins

Name	Stream Type	Description
output	adtf/substreams	Provides the subset of substreams. Please keep in mind that this filter will forward all samples and only manipulate the stream type. So there may be samples transmitted that do not match any of the substream IDs in the output stream type.

Runner Pins

Name	Activation Type	Data Triggered	Data Input	Thread Triggered	Thread Cyclic	Timer Triggered	Timer Interval	Description
process_input	9	1	input	0	0	0	0	Default runner port for the input pin 'input'

Dynamic Pins

Dynamic Input Pins	false
Dynamic Output Pins	false
Dynamic Input Binding Pins	false
Dynamic Output Binding Pins	false

Input Pin Stream Types

Pin Name	input
Meta Type Name	adtf/substreams
Stream Type Properties	Name Value Type Description Subproperties substreams true tBool Value Range: minimum = maximum = Filename Extension Filter:

Output Pin Stream Types

Pin Name	output
Meta Type Name	adtf/substreams
Stream Type Properties	Name Value Type Description Subproperties substreams true tBool Value Range: minimum = maximum = Filename Extension Filter: