Ingestion Operator Overview

The ingestion pipeline consists of ingestion operators, which this page gives an overview of.

We provide the important information of the operators, such as factory classes and properties.

Enumerators

An ENUMERATOR typed operator is the start of the pipeline, emitting the retrievables.

Operator Properties:

Property	Description
mediaTypes	A list of media types to emit retrievables of. One of IMAGE, VIDEO, AUDIO, MESH

FileSystemEnumerator

Factory Class: FileSystemEnumerator

The FileSystemEnumerator emits retrievables based on the file system, specifically based on a location.

Local Ingestion Context Properties:

Property	Description
path	The path (relative to the working directory) to start the file tree walk from
depth	The depth the tree walk should go, e.g. 1 means one level deeper than current working directory, 2 means two, etc.

Decoders

An DECODER typed operator decodes the media file to Content, ready for further processing.

VideoDecoder

Factory Class: VideoDecoder

A decoder for videos, which emits video and audio.

Local Ingestion Context Properties:

Property	Description
timeWindowMs	The duration of the segmentation

Extractors

An EXTRACTOR typed operator extracts, analysises the content and performs the actual ingestion.

See Analyser Overview for more information of the extractors.

Exporters

An EXTRACTOR typed operator exports derivative artifacts. E.g. a thumbnail exporter produces thumbnails. These are defined on the schema, however the properties can be overridden from the ingestion context.

ThumbanilExporter

Factory Class: ThumbnailExporter (Defined in the schema and referenced by name.)

Produces thumbnails.

Local Ingestion Context Properties:

Property	Description
maxSideResolution	The longer side's size in pixels
mimeType	The mime type to use. One of JPG, PNG

Transformers

A TRANSFORMER typed operator transforms incoming retrievables to outcoming ones, might aggregate or filter them.

TypeFilterTransformer

Factory Class: TypeFilterTransformer

Filters incoming retrievables based on their type.

Local Ingestion Context Properties:

Property	Description
type	The type to allow through. One of SOURCE:IMAGE, SOURCE:VIDEO, SOURCE:AUDIO, SOURCE:MESH (custom filters could be defined)

LastContentAggregator

Factory Class: LastContentAggregator

Aggregates content based on the 'last' strategy.

Local Ingestion Context Properties:

none