Create Proxy

These plugins enable you to create proxies.

Create Proxy

This plugin manages the creation of a media asset of creation context proxy. This plugin is very similar in functionality to the transcode plugin.

Properties:

Field Value Explanation
Icon plugin icon
Sub-type Create Proxy 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

This configuration allows you to specify plain text XML as a raw transcode profile or a transcode profile.

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.

Field Field Type Mandatory Multiplicity Description
Transcode Profile complex Profile to be used for the transcode
  • Transcode Profile
 single option 1 Select a Ooyala Flex rranscode profile to use

  • Transcode Profile Name

 string 1 Specify the name of the Ooyala Flex transcode profile to use. This field supports expression evaluation.

  • Transcode Profile as XML

 string 1 Enter the Ooyala Flex transcode profile as XML
  • Transcode Profile as JSON
string 1 Enter the Ooyala Flex transcode profile as JSON
Destination complex 1 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
  • 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
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

Multiple Profile Create Proxy

This plugin manages the creation of one or more media assets of creation context proxy. This plugin is very similar in functionality to the multi transcode 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.

Properties:

Field Value Explanation

Icon

 Plugin icon
Sub-type Create Proxy 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:

Field Field Type Mandatory Multiplicity Description
Output File complex 1..* A create proxy output file to be produced

Transcode Profile

 complex   Profile to be used for the transcode

Transcode Request XML

 text   The XML profile will be used directly
Reference Name 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

Folder Resource

 Resource (Folder)   The output file will be placed in the specified folder resource

Segment Proxy

The Segment Proxy plugin is typically used in conjunction with the Demux plugin which can be found in the Transcode section. Though in some cases it can be used with other MP4 video and audio files that have already been imported into Ooyala Flex.

This plugin takes the audio / video files created by the Demux plugin and packages them as a segmented asset. Once the Segmented Proxy action has completed, a file is created with a segmented proxy. This segmented proxy enables you to make use of the audio switching functionality in MAM.

In the diagram below, you can see how the Segmented Proxy is created:

Note: There are two methods for creating a proxy in Ooyala Flex. We recommend that you use the "Create Proxy" action for standard proxies, and the "Segment Proxy" action for segmented proxies.

The names of the tracks and the order in which they appear in MAM are predetermined by the information provided in the .m3u8 files. Currently you cannot edit HLS files in MAM. The Demux

The Demux action specifies the variable name as videoAssetId1, videoAssetId2, audioAssetId1, audioAssetId2 and so on, based on video and audio streams. You must pass video and audio IDs in the segmented proxy action in the following way: 
  $
{variables.videoAssetId1}
, $
{variables.audioAssetId1}
Please consult the Audio Switching section of the MAM guide for information on how to perform audio switching.

Properties:

Field Value Explanation
Icon Plugin icon
Sub-type Create Proxy 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 or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 6.2.0 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
Select video asset typeahead 0..* Include video asset in segmented proxy.
Note: You must specify the asset ID of each one.
Select audio asset typeahead 0..* Include audio asset in segmented proxy.
Note: You must specify the asset ID of each one.
Audio Stream Names string 0..1 Specify a comma separated list of audio names or languages.

For example: eng, fre, spa, ger
Output Folder Resource single option   Folder Resource with location to write resulting segmented proxy m3u8 file.
Output VFS Location complex   VFS Location to write resulting segmented proxy m3u8 file.
Protocol single option   Protocol for accessing the location
Host Name string   Hostname for accessing the location (mandatory except for FILE, S3 and AZBS protocols)
Account Name string   Account name for accessing the azure blob storage (only applicable for AZBS protocol)
Port string   Port for accessing the location (mandatory except for FILE, S3 and AZBS protocols) (#)
Path string   Path for accessing the location (absolute path starting with / except for FTP, SFTP 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 and AZBS protocols)
Key string   Key for authentication (only applicable to S3 and AZBS protocols)
Secret string   Secret for authentication (only applicable to S3 protocol)
Token string   Token for authentication
Bucket string   Only applicable to S3 and AZBS(Container) protocols
Private Key File string   Only applicable for SFTP certificate authentication
Transcode Configuration complex   Transcoder details
Engine string   Transcode engine name, for instance: 'flex-streamprocessor-service'
Folder Mappings complex 0..* Defines location mappers between the target and the base location
  • Base Location
complex   Asset location prefix to be replaced
    • Protocol
single option   Protocol for accessing the location
    • Host Name
string   Hostname for accessing the location (mandatory except for FILE, S3 and AZBS protocols)
    • Account Name
string   Account name for accessing the azure blob storage (only applicable for AZBS protocol)
    • Port
string   Port for accessing the location (mandatory except for FILE, S3 and AZBS protocols) (#)
    • Path
string   Path for accessing the location (absolute path starting with / except for FTP, SFTP 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 and AZBS protocols)
    • Key
string   Key for authentication (only applicable to S3 and AZBS protocols)
    • Secret
string   Secret for authentication (only applicable to S3 protocol)
    • Token
string   Token for authentication
    • Bucket
string   Only applicable to S3 and AZBS(Container) protocols
    • Private Key File
file   Only applicable for SFTP certificate authentication
  • Target Location
complex   Location to replace the asset location prefix
    • Protocol
single option   Protocol for accessing the location
    • Host Name
string   Hostname for accessing the location (mandatory except for FILE, S3 and AZBS protocols)
    • Account Name
string   Account name for accessing the azure blob storage (only applicable for AZBS protocol)
    • Port
string   Port for accessing the location (mandatory except for FILE, S3 and AZBS protocols) (#)
    • Path
string   Path for accessing the location (absolute path starting with / except for FTP, SFTP 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 and AZBS protocols)
    • Key
string   Key for authentication (only applicable to S3 and AZBS protocols)
    • Secret
string   Secret for authentication (only applicable to S3 protocol)
    • Token
string   Token for authentication
    • Bucket
string   Only applicable to S3 and AZBS(Container) protocols
    • Private Key File
file   Only applicable for SFTP certificate authentication
Parent topic: Action Plugins
https://help.ooyala.com/sites/all/libraries/dita/en/media-logistics/flex/dev/60/action_plugins_60_create_proxy.html