NiFi Ingest 25.4
NiFi Ingest

# AnalyzeMedia

Runs media analysis on rich media files, without the need for a Media Server. All analysis takes place within NiFi. The processor outputs information with the same schema as a Media Server.

Supported file formats

The processor can handle video files.

The processor can handle the following image formats:

- TIFF
- JPEG
- JPEG 2000
- PNG
- GIF
- BMP (compressed BMP files are not supported) and ICO
- PBM, PGM, and PPM
- WebP

Additionally, if you configure your MediaServiceImpl controller service to use a KeyView Export Service, the processor can handle document formats, including:

- Adobe PDF
- Microsoft Word Document (.DOC and .DOCX)
- Microsoft Excel Sheet (.XLS and .XLSX)
- Microsoft PowerPoint Presentation (.PPT and .PPTX)
- OpenDocument Text (.ODT)
- OpenDocument Spreadsheet (.ODS)
- OpenDocument Presentation (.ODP)
- Rich Text (RTF)

## Properties

Name | Description
--- | ---
IDOL License Service | An IdolLicenseServiceImpl that provides a way to communicate with a Knowledge Discovery License Server.
Media Service | A MediaServiceImpl that manages media analysis resources.
- Config | The session configuration to use for analyzing the media files. This is similar to a Media Server session configuration, with some exceptions. The NiFi processor does not support live streams. To process live streams you must set up a Media Server. The NiFi processor sets a different default value for the `IngestRate` parameter. In NiFi, by default, `IngestRate=0`. The ingest task must use the `NiFiInput` engine. This engine can automatically determine whether a file is an image or video, and process it appropriately. For example:
      [In]
      Type=NiFiInput
- There must be exactly one output task, and it must use the `NiFiOutput` engine. Other types of output are not supported. To insert data into a database, index documents into Content, send information to an HTTP server, and so on, you can use other NiFi processors placed downstream of the AnalyzeMedia processor. The output engine should be configured as in the following example. The `Input` parameter specifies which records to output (the same as in a Media Server session configuration).
      [Out]
      Type=NiFiOutput
      Input=...
- The NiFi processor supports the `EventClip`, `ImageEncoder`, `MPEG`, and `PDF` encoding engines. The other encoding engines are not supported. You have the option to embed encoded images and video in your FlowFiles. You can do this with the `%flowfile%` macro. For example:
      [ImageEncoder]
      Type = ImageEncoder
      OutputPath = %flowfile%/face_%uuid%.png
      ImageInput0 = FaceDetection.ResultWithSource
- The `Enroll` and `NewsSegmentation` engines are not supported. You can use NiFi expression language in the configuration. Expression language is not supported for setting section names, parameter keys, or the values of the parameters `Type`, `Input`, `ImageInput`, `AudioInput`, `OverlayInput`, `EventTrack`, `RegionInput`, `OCRInput`, `NumParallel`, and `MaxFaces`. For example, to use a FlowFile attribute named `LANGUAGE` to set the language pack to use for speech-to-text:
      [SpeechToText]
      Type = SpeechToText
      SpeedBias = 6
      LanguagePack = ${LANGUAGE}
      ModelVersion = micro
To edit your session configuration, and to see example configurations, open the guided setup UI by clicking ADVANCED. For more information about Media Server session configurations, refer to the Media Server Help.
XSL Template | An XSL template to use to extract data from the document metadata and write text to the document content. For example, you can take the output from OCR or speech-to-text and use this to populate the document content. To more easily edit the template, click ADVANCED and click the XSL TEMPLATE tab.
Model File | Some analysis operations (such as face recognition, object classification, and vehicle analysis) require training. You can provide training by setting this property or by configuring an external PostgreSQL or MySQL database in your IDOL Media Service. To use a model file that you exported from Media Server, use this property to specify the file path. The database / classifier / recognizer in the file will be available using the name it was exported with. For example, if you export a face database with the name "sports", you can set `Database=sports` in a face recognition task in your session configuration. For information about how to train rich media analysis and export a database file, refer to the Media Server Help.
Remove document content parts | A Boolean value (default false) that specifies whether to remove `contentfile`, `contentfilename`, and `externalfile` parts that were present in incoming documents. Redaction is an example use-case in which you might want to remove this data. You could configure the processor to add a redacted version of an image and remove the original.

## Relationships

Name | Description
--- | ---
success | Processing was successful.
failure | Processing failed.

Copyright 2018-2025 Open Text
Version 25.4 | Last updated October 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery NiFi Ingest 25.4

Topic Title: AnalyzeMedia