Media Server 23.3

# Process

Starts ingesting and processing the specified media.

Type: asynchronous

Parameter | Description | Required
--- | --- | ---
AdditionalData | Additional files to upload. If your session configuration requires a file, such as a Lua script or XSL transform, that is not available on the Media Server file system, you can upload it with the process action. Files must be uploaded as multipart/form-data. For more information about sending data to Media Server, refer to the Media Server Administration Guide. | No
AdditionalDataLabels | A comma-separated list of labels to identify the files uploaded using the `AdditionalData` parameter. Specify a label for each file that you upload. You can use these labels in your session configuration instead of file paths. | No
Config | A session configuration to use (base64 encoded, unless you upload it as multipart form data). | Set `Config`, `ConfigName`, or `ConfigPath`
ConfigName | The name of a session configuration file to use, when the file is stored in the ConfigDirectory.
ConfigPath | The path of a session configuration file to use.
Persist | Specifies whether the action restarts in the event that processing stops for any reason. | No
Source | The media source to process. | Set either `Source` or `SourceData`
SourceData | The media file to process. | Set either `Source` or `SourceData`
Synchronous | Specifies whether to run the action synchronously. | No
Timeout | The maximum amount of time to spend processing. | No

## Example

The following example starts processing a file using a configuration named `myconfig` that exists in the ConfigDirectory on the Media Server machine.

    /action=Process
                 &ConfigName=myconfig
                 &Source=/videoarchive/broadcast.mpeg

The following example demonstrates how to upload a configuration, source file, and an additional XSL file using the command-line tool cURL.

    curl http://localhost:14000/action=Process
                                -F Config=@ocr.cfg
                                -F SourceData=@document.pdf
                                -F AdditionalData=@transform.xsl
                                -F AdditionalDataLabels=file1

## Response

This action is asynchronous, so Media Server always returns success accompanied by a token. You can use this token with the QueueInfo action to retrieve the status of your request.

The following is an example response from `action=QueueInfo&QueueAction=GetStatus&QueueName=process`:

    <autnresponse>
      <action>QUEUEINFO</action>
      <response>SUCCESS</response>
      <responsedata>
        <actions>
          <action owner="...">
            <status>Queued</status>
            <queued_time>2021-May-24 13:53:25</queued_time>
            <time_in_queue>89</time_in_queue>
            <priority>0</priority>
            <token>...</token>
          </action>
          <action owner="...">
            <status>Processing</status>
            <queued_time>2021-May-24 13:53:24</queued_time>
            <time_in_queue>72</time_in_queue>
            <process_start_time>2021-May-24 13:54:36</process_start_time>
            <time_processing>18</time_processing>
            <configname>object_class_recognition.cfg</configname>
            <configuration>...</configuration>
            <source>video2.mp4</source>
            <token>...</token>
          </action>
          <action>
            <status>Finished</status>
            <queued_time>2021-May-24 13:53:09</queued_time>
            <time_in_queue>1</time_in_queue>
            <process_start_time>2021-May-24 13:53:10</process_start_time>
            <time_processing>86</time_processing>
            <process_end_time>2021-May-24 13:54:36</process_end_time>
            <configname>examples/Face/Face.cfg</configname>
            <configuration>...</configuration>
            <output>
              ...
            </output>
            <source>video1.mp4</source>
            <statistics>
              ...
            </statistics>
            <token>...</token>
          </action>
        </actions>
      </responsedata>
    </autnresponse>

In addition to the standard fields that are returned from the QueueInfo action, the response can include:

- `configname` - identifies the session configuration used to process the media. This element can contain a path, a file name, or the value "Base64 data".
- `configuration` - the contents of the session configuration.
- `source` - the media source.
- `output` - contains any records that were sent to a response output engine.
- `statistics` - statistics generated by the engines used in the processing session. For example, an engine might report the number of records that were processed and the average amount of time required to process each record.

Copyright 2023 Open Text
Version 23.3 | Last updated June 2023

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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Media Server 23.3

Topic Title: Process