[elemental] Elemental Server is a file-based video processing system that provides fast, high-quality video transcoding for multi-screen video applications
PROPERTIES
| Name | Elemental |
| System ID | el |
| Connection String | null |
| Heartbeat Connection String | null |
SUPPORTED NODE
DEFINITIONS
* The message has been deprecated. Please use the replacement message(s) instead.
NODE DEFINITION
DETAILS
Gets the status for a job given its id.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| jobId | NO | Id of the job |
| user | NO | The user used for the authentication. If not provided the one configured in the adaptor will be used. |
| apiKey | NO | key to be used to connect to elemental server if its using authentication. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| status | Status of the job |
| userData | If the job was submitted with any user data, it wll be returned in this variable |
Launchs a Job With Encryption using the encryptionKey to be passed to Elemental. If the encryptionKey is empty it just launches a job without encryption.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| user | NO | The user used for the authentication. If not provided the one configured in the adaptor will be used. |
| apiKey | NO | key to be used to connect to elemental server if its using authentication. |
| encryptionKey | NO | A key used to encrypt the input content. In Elemental, this is called "Resource ID". It must be a String with up to 255 characters. If no encryptionKey value is provided, encryption will not be used. |
| destination | NO | Destination file/stream URI**. Output media files are named by |
| profile | NO | The profile name |
| sources | NO | List of one or more source files to be transcoded. PS: Right now its getting just the first source element. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| jobId | Id of the created job |
Creates a transcoding job in Elemental with a more complete set of parameters
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| source | NO | Source file |
| destination | NO | Destination file/stream URI**. Output media files are named by [destinationuri].[name_modifier].[extension] |
| profile | NO | The profile name |
| user | NO | The user used for the authentication. If not provided the one configured in the adaptor will be used. |
| apiKey | NO | The user api key for the authentication. If not provided the one configured in the adaptor will be used. |
| priority | NO | Priority indicates the order that pending Jobs will be processed. |
| programId | NO | Selects a specific program from within a multi-program transport stream. If the program doesn’t exist, the first program within the transport stream will be selected by default. Use the preview button to populate the list of available programs. |
| avsyncEnable | NO | Enables A/V sync. |
| userData | NO | If the job was submitted with any user data, it wll be returned in this variable |
| copyLocal | NO | Copy all file inputs to the system “copy local” directory before transcoding. Non-streaming network file inputs (see URI types) are always downloaded to this directory regardless of this setting. |
| preProcessScript | NO | Script to run before Job starts. |
| deleteSource | NO | true or false Deletes input source file(s) after the Job is complete. |
| processedFileDestination | NO | Location to move input source file to after Job completes. Note this will not affect preroll or postroll source files. |
| postProcessScript | NO | Script to run after the Job completes |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| jobId | Id of the created job |
Creates a transcoding job in Elemental with the most basic settings
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| profile | NO | If included, only source parameter is needed. |
| user | NO | The user used for the authentication. If not provided the one configured in the adaptor will be used. |
| apiKey | NO | The user api key for the authentication. If not provided the one configured in the adaptor will be used. |
| source | NO | The source file |
| destination | NO | The destination of output media files |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| jobId | Id of the created job |
Superstate to transcode(Launch Job), poll for status(Get Job Status), delay and complete. First launches a job if it's not running already. Then polls for its status. Used to support the retry scenario efficiently in a clustered elemental server. If the work order is re-tried (with CMS re-boot), it'll re-join the transcoding job in progress without re-starting the transcoding job for the same file again.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| jobId | |
| source | |
| destination | |
| profile | |
| status | |
| user | |
| apiKey | |
| userData |
Superstate to transcode(Launch Job), poll for status(Get Job Status), delay and complete.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| source | |
| destination | |
| profile | |
| jobId | |
| status | |
| user | |
| apiKey | |
| userData |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| apiKey | |
| destination | |
| encryptionKey | |
| jobId | |
| profile | |
| sources | |
| user | |
| status | |
| delay | |
| userData |
Superstate to transcode(Launch Job), poll for status(Get Job Status), delay and complete.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| apiKey | |
| user | |
| avsyncEnable | |
| copyLocal | |
| deleteSource | |
| destination | |
| jobId | |
| postProcessScript | |
| preProcessScript | |
| priority | |
| processedFileDestination | |
| profile | |
| programId | |
| source | |
| userData | |
| status |
Superstate to transcode(Launch Job), poll for status(Get Job Status), delay and complete.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| destination | |
| profile | |
| jobId | |
| status | |
| user | |
| apiKey | |
| avsyncEnable | |
| copyLocal | |
| deleteSource | |
| postProcessScript | |
| priority | |
| processedFileDestination | |
| programId | |
| source | |
| userData | |
| preProcessScript |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| apiKey | |
| avsyncEnable | |
| copyLocal | |
| deleteSource | |
| destination | |
| jobId | |
| postProcessScript | |
| preProcessScript | |
| priority | |
| processedFileDestination | |
| profile | |
| programId | |
| source | |
| status | |
| user | |
| userData | |
| delay |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| jobId | |
| apiKey | |
| user | |
| profile | |
| status | |
| userData | |
| source | |
| destination | |
| delay |
Each n seconds query for the Job status on Elemental and waits until the job has been completed.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| jobId | NO | The id of the job that will be queried |
| delay | NO | Delay time for wait for job complete |
| user | NO | The user used for the authentication. If not provided the one configured in the adaptor will be used. |
| apiKey | NO | The user api key for the authentication. If not provided the one configured in the adaptor will be used. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| status | The status of the job |
| userData | If the job was submitted with any user data, it wll be returned in this variable |
| © 2002 - 2012 Ericsson Television Inc. |
| All Rights Reserved. |