Elemental

[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
Message UID Node Definition Name
01el01 Get Job Status
01el04 Launch Job With Encrytpion
01el02 Launch Job With Settings
01el00 Launch Job
SuperState Transcode (cluster)
SuperState Transcode (single node)
SuperState Transcode With Encryption
SuperState Transcode With Settings (cluster)
SuperState Transcode With Settings (single node)
SuperState Transcode With Settings
SuperState Transcode
01el03 Wait for Job Completion

* The message has been deprecated. Please use the replacement message(s) instead.

NODE DEFINITION DETAILS
Get Job Status (01el01)

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
apiKey NO
RESPONSE MESSAGE:
Parameter Name Description / Value
status Status of the job
userData
Launch Job With Encrytpion (01el04)

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
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
Launch Job With Settings (01el02)

Creates a transcoding job in Elemental with a more complete set of parameters

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
source NO
destination NO
profile NO
user NO
apiKey NO
priority NO
programId NO
avsyncEnable NO
userData NO
copyLocal NO
preProcessScript NO
deleteSource NO
processedFileDestination NO
postProcessScript NO
RESPONSE MESSAGE:
Parameter Name Description / Value
jobId
Launch Job (01el00)

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
destination NO
RESPONSE MESSAGE:
Parameter Name Description / Value
jobId Id of the created job
Transcode (cluster) (SuperState)

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
Transcode (single node) (SuperState)

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
Transcode With Encryption (SuperState)

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
Transcode With Settings (cluster) (SuperState)

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
Transcode With Settings (single node) (SuperState)

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
Transcode With Settings (SuperState)

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
Transcode (SuperState)

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
jobId
apiKey
user
profile
status
userData
source
destination
delay
Wait for Job Completion (01el03)

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
user NO
apiKey NO
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.