Transcode
These plugins allow you to perform transcodes
Default Transcode
This Plugin manages the creation of a Media Asset of Creation Context Transcode. This plugin is very similar in functionality to the Default Create Proxy Plugin. The configuration can be used to specify the Transcode Profile to use and the output location for the transcoded file.
This Plugin relies on the underlying Transcode Resource and Transcode Adapter.
Field | Value | Explanation |
Icon |
![]() |
Plugin icon |
Sub-type | Transcode | Sub-type of this Plugin |
Classification | Process | Classification of this Plugin |
Deployment | Internal | Whether the plugin is deployed inside Ooyala Flex or within another product |
Supports Configuration |
![]() |
Whether this Plugin supports configuration |
Supports Scripting |
![]() |
Whether configuration supports Scripting |
Scripting Context | job, asset, event | What Ooyala Flex objects can be referenced from within the scripting context.
Note: The event object is only visible in the context of an action running in an event handler.
|
Undo Action | The action required to undo this action | |
Redo Action | The action required to redo this action | |
Timeout | Whether to select a timeout | |
Auto retry | Whether to select an automatic retry | |
Compatibility | 5.x | What versions of Ooyala Flex this Plugin works for |
Lifecycle | Stable | Maturity of this Plugin (Experimental, Unstable or Stable) |
Configuration:
If the Folder Resource is specified, then the Filesystem path is ignored. If the Folder Resource is not specified, then a Filesystem path must be specified.
This configuration allows you to specify plain text XML as a raw transcode profile or a Transcode Profile.
Field | Field Type | Mandatory | Multiplicity | Description |
Transcode Profile | complex |
![]() |
Profile to be used for the transcode | |
|
Transcode Profile (All) |
![]() |
Select a Ooyala Flex Transcode profile to be use. | |
|
string |
![]() |
Specify the name of the Ooyala Flex Transcode Profile to use. This field supports expression evaluation. | |
|
text |
![]() |
Enter the Ooyala Flex Transcode Profile as XML | |
Destination | complex |
![]() |
The final location of the output file | |
|
Resource (Folder) |
![]() |
The output file will be placed in the specified Folder Resource | |
|
string |
![]() |
The output file will be placed in the specified server filesystem location | |
|
string |
![]() |
The output file will be generated with the specified file name | |
Reference Name | string |
![]() |
The name to associate with the output file to allow referencing in a context hierarchy expression |
VFS Transcode
Properties:
Field | Value | Explanation |
Icon |
![]() |
Plugin icon |
Sub-type | Transcode | Sub-type of this Plugin |
Classification | Process | Classification of this Plugin |
Deployment | Internal | Whether the plugin is deployed inside Ooyala Flex or within another product |
Supports Configuration |
![]() |
Whether this Plugin supports configuration |
Supports Scripting |
![]() |
Whether configuration supports Scripting |
Scripting Context | job, asset, event | What Ooyala Flex objects can be referenced from within the scripting context.
Note: The event object is only visible in the context of an action running in an event handler.
|
Undo Action | The action required to undo this action | |
Redo Action | The action required to redo this action | |
Auto retry | Whether to select an automatic retry | |
Timeout | Whether to select a timeout | |
Compatability | 5.x | What versions of Ooyala Flex this Plugin works for |
Lifecycle | Stable | Maturity of this Plugin (Experimental, Unstable or Stable) |
Configuration:
Field | Field Type | Mandatory | Multiplicity | Description |
Transcode Profile | complex |
![]() |
0..1 | Profile to be used for the transcode |
Transcode Profile |
single option |
![]() |
Select a Ooyala Flex Transcode Profile to use | |
Transcode Profile Name |
string |
![]() |
Specify the name of the Ooyala Flex Transcode Profile to use. This field supports expression evaluation. | |
Transcode Profile as XML |
text |
![]() |
Enter the Ooyala Flex Transcode Profile as XML | |
Transcode Profile as JSON |
text |
![]() |
Enter the Ooyala Flex Transcode Profile as JSON The only properties that are configurable are:
Example JSON: { "transcode-engine":{ "value":"Elemental", "isExpression":false }, "transcoder-profile-name":{ "value":"some-name", "isExpression":false }, "configured-profile":{ "sources":[ { "source-asset-context":{ "value":".", "isExpression":false }, "clipping-configuration":[ { "in-timecode":{ "time":"00:00:00:00, "frame-rate":"25" }, "out-timecode":{ "time":"00:00:00:00", "frame-rate":"25" } } ] } ], "Product":{ "filepath":"/some/file/path", "filename":"something.mp4" } } } // Some comments here public String getFoo() { return foo; } |
|
Destination | complex |
![]() |
The final location of the output file | |
Folder Resource |
single option |
![]() |
The output file will be placed in the specified Folder Resource | |
VFS Location |
complex |
![]() |
The output file will be placed in the specified VFS location | |
Protocol |
single option |
![]() |
Protocol for accessing the location | |
Hostname |
string |
![]() |
Hostname for accessing the location (mandatory except for file, s3, google or dropbox protocols) | |
Port |
string |
![]() |
Port for accessing the location (mandatory except for file, s3, google or dropbox protocols) (#) | |
Path |
string |
![]() |
Path for accessing the location (absolute path starting with / except for ftp, sftp, ftps which are relative to the User's home directory) | |
Username |
string |
![]() |
Username for authentication (not required for file protocol) | |
Password |
password |
![]() |
Password for authentication (not required for file, s3, google or dropbox protocols) | |
Key |
string |
![]() |
Key for authentication (only applicable to s3, google and dropbox protocols) | |
Secret |
string |
![]() |
Secret for authentication (only applicable to s3, google and dropbox protocols) | |
Token |
string |
![]() |
Token for authentication (only applicable to google and dropbox protocols) | |
Bucket |
string |
![]() |
Only applicable to S3 protocol | |
Private Key File |
file |
![]() |
Only applicable for SFTP certificate authentication | |
File Name | string |
![]() |
The output file will be generated with the specified file name | |
Reference Name | string |
![]() |
The name to associate with the output file to allow referencing in a context hierarchy expression |
VFS Image Transcode
This Plugin manages the creation of a Media Asset of Creation Context Transcode.
Properties:
Field | Value | Explanation |
Icon |
![]() |
Plugin icon |
Sub-type | Transcode | Sub-type of this Plugin |
Classification | Process | Classification of this Plugin |
Deployment | Internal | Whether the plugin is deployed inside Ooyala Flex or within another product |
Supports Configuration |
![]() |
Whether this Plugin supports configuration |
Supports Scripting |
![]() |
Whether configuration supports Scripting |
Scripting Context | job, asset, event | What Ooyala Flex objects can be referenced from within the scripting context.
Note: The event object is only visible in the context of an action running in an event handler.
|
Undo Action | The action required to undo this action | |
Redo Action | The action required to redo this action | |
Timeout | Whether to select a timeout | |
Auto retry | Whether to select an automatic retry | |
Compatability | 5.x | What versions of Ooyala Flex this Plugin works for |
Lifecycle | Stable | Maturity of this Plugin (Experimental, Unstable or Stable) |
Configuration:
Field | Field Type | Mandatory | Multiplicity | Description |
Transcode Profile | complex |
![]() |
Profile to be used for the transcode | |
|
Transcode Profile (Image) |
![]() |
Select a Ooyala Flex Transcode profile to be use. | |
|
string |
![]() |
Specify the name of the Ooyala Flex Transcode Profile to use. This field supports expression evaluation. | |
|
text |
![]() |
Enter the Ooyala Flex Transcode Profile as XML | |
|
text |
![]() |
Enter the Ooyala Flex Transcode Profile as JSON The only properties that are configurable are:
Example JSON: { "transcode-engine":{ "value":"Elemental", "isExpression":false }, "transcoder-profile-name":{ "value":"some-name", "isExpression":false }, "configured-profile":{ "sources":[ { "source-asset-context":{ "value":".", "isExpression":false }, "clipping-configuration":[ { "in-timecode":{ "time":"00:00:00:00, "frame-rate":"25" }, "out-timecode":{ "time":"00:00:00:00", "frame-rate":"25" } } ] } ], "Product":{ "filepath":"/some/file/path", "filename":"something.mp4" } } } // Some comments here public String getFoo() { return foo; } |
|
Destination | complex |
![]() |
The final location of the output file | |
Folder Resource | single option |
![]() |
The output file will be placed in the specified Folder Resource | |
VFS Location | complex |
![]() |
0..1 | The output file will be placed in the specified VFS location |
|
single option |
![]() |
Protocol for accessing the location | |
|
string |
![]() |
Hostname for accessing the location (mandatory except for file, s3, google or dropbox protocols) | |
|
string |
![]() |
Port for accessing the location (mandatory except for file, s3, google or dropbox protocols) (#) | |
|
string |
![]() |
Path for accessing the location (absolute path starting with / except for ftp, sftp, ftps which are relative to the User's home directory) | |
|
string |
![]() |
Username for authentication (not required for file protocol) | |
|
password |
![]() |
Password for authentication (not required for file, s3, google or dropbox protocols) | |
|
string |
![]() |
Key for authentication (only applicable to s3, google and dropbox protocols) | |
|
string |
![]() |
Secret for authentication (only applicable to s3, google and dropbox protocols) | |
|
string |
![]() |
Token for authentication (only applicable to google and dropbox protocols) | |
|
string |
![]() |
Only applicable to S3 protocol | |
|
Choose option |
![]() |
Only applicable for SFTP certificate authentication | |
File Name | string |
![]() |
0..1 | The output file will be generated with the specified file name |
Reference Name | string |
![]() |
The name to associate with the output file to allow referencing in a context hierarchy expression |
VFS Multiple Profile Transcode
This Plugin manages the creation of a Media Asset of Creation Context Transcode.
Properties:
Field | Value | Explanation |
Icon |
![]() |
Plugin icon |
Sub-type | Transcode | Sub-type of this Plugin |
Classification | Process | Classification of this Plugin |
Deployment | Internal | Whether the plugin is deployed inside Ooyala Flex or within another product |
Supports Configuration |
![]() |
Whether this Plugin supports configuration |
Supports Scripting |
![]() |
Whether configuration supports Scripting |
Scripting Context | job, asset, event | What Ooyala Flex objects can be referenced from within the scripting context.
Note: The event object is only visible in the context of an action running in an event handler.
|
Undo Action | The action required to undo this action | |
Redo Action | The action required to redo this action | |
Timeout | Whether to select a timeout | |
Auto retry | Whether to select an automatic retry | |
Compatability | 5.x | What versions of Ooyala Flex this Plugin works for |
Lifecycle | Stable | Maturity of this Plugin (Experimental, Unstable or Stable) |
Configuration:
Field | Field Type | Mandatory | Multiplicity | Description |
Output File | complex |
![]() |
0..* | A transcoded output file to be produced |
|
complex |
![]() |
Select a Ooyala Flex Transcode Profile to use | |
|
single option |
![]() |
1 | Select a Ooyala Flex Transcode Profile to use |
|
string |
![]() |
1 | Specify the name of the Ooyala Flex Transcode Profile to use. This field supports expression evaluation. |
|
string |
![]() |
1 |
Enter the Ooyala Flex Transcode Profile as XML |
|
string |
![]() |
1 | Enter the Ooyala Flex Transcode Profile as JSON The only properties that are configurable are:
Example JSON: { "transcode-engine":{ "value":"Elemental", "isExpression":false }, "transcoder-profile-name":{ "value":"some-name", "isExpression":false }, "configured-profile":{ "sources":[ { "source-asset-context":{ "value":".", "isExpression":false }, "clipping-configuration":[ { "in-timecode":{ "time":"00:00:00:00, "frame-rate":"25" }, "out-timecode":{ "time":"00:00:00:00", "frame-rate":"25" } } ] } ], "Product":{ "filepath":"/some/file/path", "filename":"something.mp4" } } } // Some comments here public String getFoo() { return foo; } |
|
string |
![]() |
The XML profile will be used directly | |
|
string |
![]() |
The name to associate with the output file to allow referencing in a context hierarchy expression | |
Destination | complex |
![]() |
The final location of the output file | |
|
single option |
![]() |
The output file will be placed in the specified Folder Resource | |
|
complex |
![]() |
0..1 | The output file will be placed in the specified VFS location |
Protocol |
single option |
![]() |
Protocol for accessing the location | |
Hostname |
string |
![]() |
Hostname for accessing the location (mandatory except for file, s3, google or dropbox protocols) | |
Port |
string |
![]() |
Port for accessing the location (mandatory except for file, s3, google or dropbox protocols) (#) | |
Path |
string |
![]() |
Path for accessing the location (absolute path starting with / except for ftp, sftp, ftps which are relative to the User's home directory) | |
Username |
string |
![]() |
Username for authentication (not required for file protocol) | |
Password |
string |
![]() |
Password for authentication (not required for file, s3, google or dropbox protocols) | |
Key |
string |
![]() |
Key for authentication (only applicable to s3, google and dropbox protocols) | |
Secret |
string |
![]() |
Secret for authentication (only applicable to s3, google and dropbox protocols) | |
Token |
string |
![]() |
Token for authentication (only applicable to google and dropbox protocols) | |
Bucket |
string |
![]() |
Only applicable to S3 protocol | |
Private Key File |
file |
![]() |
Only applicable for SFTP certificate authentication |
Image Transcode
This Plugin manages the creation of an Image Asset of Creation Context Transcode. The configuration can be used to specify the profile to use and the output location for the transcoded file.
This Plugin relies on the underlying Transcode Resource and Transcode Adapter.
Properties:
Field | Value | Explanation |
Icon |
![]() |
Plugin icon |
Sub-type | Transcode | Sub-type of this Plugin |
Classification | Process | Classification of this Plugin |
Deployment | Internal | Whether the plugin is deployed inside Ooyala Flex or within another product |
Supports Configuration |
![]() |
Whether this Plugin supports configuration |
Supports Scripting |
![]() |
Whether configuration supports Scripting |
Scripting Context | job, asset, event | What Ooyala Flex objects can be referenced from within the scripting context.
Note: The event object is only visible in the context of an action running in an event handler.
|
Undo Action | The action required to undo this action | |
Redo Action | The action required to redo this action | |
Timeout | Whether to select a timeout | |
Auto retry | Whether to select an automatic retry | |
Compatability | 5.x | What versions of Ooyala Flex this Plugin works for |
Lifecycle | Stable | Maturity of this Plugin (Experimental, Unstable or Stable) |
Configuration:
If the Folder Resource is specified, then the Filesystem path is ignored. If the Folder Resource is not specified, then a Filesystem path must be specified.
This configuration allows you to specify plain text XML as a raw transcode profile or a Transcode Profile.
Field | Field Type | Mandatory | Multiplicity | Description |
Transcode Profile | complex |
![]() |
Profile to be used for the transcode | |
|
Transcode Profile (Image) |
![]() |
Select a Ooyala Flex Transcode profile to be use. | |
|
string |
![]() |
Specify the name of the Ooyala Flex Transcode Profile to use. This field supports expression evaluation. | |
|
text |
![]() |
Enter the Ooyala Flex Transcode Profile as XML | |
Destination | complex |
![]() |
The final location of the output file | |
|
Resource (Folder) |
![]() |
The output file will be placed in the specified Folder Resource | |
|
string |
![]() |
The output file will be placed in the specified server filesystem location | |
|
string |
![]() |
The output file will be generated with the specified file name | |
Reference Name | string |
![]() |
The name to associate with the output file to allow referencing in a context hierarchy expression |
Multi Transcode
This Plugin manages the creation of one or more Media Assets of Creation Context Transcode. This plugin is very similar in functionality to the Multi Create Proxy Plugin.
This Plugin can be configured to specify more than one Transcode Profile to use in order to create a number of child Assets with different output formats.
This Plugin relies on the underlying Transcode Resource and Transcode Adapter.
Properties:
Field | Value | Explanation |
Icon |
![]() |
Plugin icon |
Sub-type | Transcode | Sub-type of this Plugin |
Classification | Process | Classification of this Plugin |
Deployment | Internal | Whether the plugin is deployed inside Ooyala Flex or within another product |
Supports Configuration |
![]() |
Whether this Plugin supports configuration |
Supports Scripting |
![]() |
Whether configuration supports Scripting |
Scripting Context | job, asset, event | What Ooyala Flex objects can be referenced from within the scripting context.
Note: The event object is only visible in the context of an action running in an event handler.
|
Undo Action | The action required to undo this action | |
Redo Action | The action required to redo this action | |
Timeout | Whether to select a timeout | |
Auto retry | Whether to select an automatic retry | |
Compatability | 5.x | What versions of Ooyala Flex this Plugin works for |
Lifecycle | Stable | Maturity of this Plugin (Experimental, Unstable or Stable) |
Configuration:
If the Folder Resource is specified, then the Filesystem path is ignored. If the Folder Resource is not specified, then a Filesystem path must be specified.
This configuration allows you to specify plain text XML as a raw transcode profile or a Transcode Profile.
Field | Field Type | Mandatory | Multiplicity | Description |
Output File | complex |
![]() |
1..* | A transcoded output file to be produced |
|
complex |
![]() |
Profile to be used for the transcode | |
Transcode System Metadata |
Transcode Profile (All) |
![]() |
The profile will be generated from the specified System Metadata | |
Transcode Request XML |
text |
![]() |
The XML profile will be used directly | |
|
string |
![]() |
The name to associate with the output file to allow referencing in a context heirarchy expression | |
Destination | complex |
![]() |
The final location of the output file | |
Folder Resource |
Resource (Folder) |
![]() |
The output file will be placed in the specified Folder Resource | |
Filesystem Path |
string |
![]() |
The output file will be placed in the specified server filesystem location |