Export

These Plugins enable you to export Objects from Ooyala Flex.

Default Export

This Plugin supports the export of an Asset from inside Ooyala Flex onto an external file system directory. The configuration allows for the specification of what aspects of the Asset should be supported (metadata, keyframes, etc) and also some basic specifications for keyframe resizing and file naming.

Properties:

Table 1.
Field Value Explanation
Icon Plugin icon
Sub-type Export Sub-type of this Plugin
Classification I/O 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 or not to select an automatic retry
Timeout   Whether or not to select a timeout
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

 

Configuration:

Table 2.

Field

Field Type Mandatory Multiplicity Description
Target Location string   VFS URL export location
Export Metadata boolean   Export metadata
Content In Title Folder boolean   Create a parent folder using asset title
File Asset Options complex 0..1 Specify File Asset Options for Export
  • Export Keyframes
boolean   Export keyframes
  • Export Master Keyframes
boolean   Export master keyframes only
  • Export Keyframe Version
complex 0..1 Specify the published keyframe sizes

Width

integer   Width of published image (set to zero to use scaling)

Height

integer   Height of published image (set to zero to use scaling)

Scale

integer   Height of published image (must be non-zero)
  • Export Proxies
boolean   Export proxy video files
  • Export Media
boolean   Export video file
  • Destination Media File Name
string   Destination media file name
  • Append File Extension to Media File Name?
boolean   If a destination media file name is specified - append the asset's file extension to this name.

 

VFS Package Export

This Plugin supports the export of an Asset from inside Ooyala Flex onto an external file system directory. The configuration allows for the specification of what aspects of the Asset should be supported (metadata, keyframes, etc) and also some basic specifications for keyframe resizing and file naming.

Properties:

Table 3.
Field Value Explanation
Icon Plugin icon
Sub-type Export Sub-type of this Plugin
Classification I/O 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 or not to select an automatic retry
Timeout   Whether or not to select a timeout
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

 

Configuration:

Table 4.
Field Field Type Mandatory Multiplicity Description
Package Include complex 1..* Specification of content to include in the package
  • Asset Context Hierarchy
string   The asset context hierarchy relative to the asset selected for package export
  • Create Include Sub-Folder
string 0..1 Place the included content in a named sub-folder (If empty, the included asset title will be used)
  • Add Attachments
complex 0..1 Add the associated attachments for the included asset

Create Attachments Sub-Folder

string 0..1 Place the attachments in a named sub-folder

Attachment Filename(s)

string 0..1 Attachment filename(s) - use %d% for an incremented counter
  • Add Media
complex 0..1 Add the associated media for the included asset

Create Media Sub-Folder

string 0..1 Place the media in a named sub-folder

Media Filename

string 0..1 Media filename

OpenPGP Public Key File

file 0..1 OpenPGP public key file to be used for asset file encryption

Include media MD5 file

boolean   Add an MD5 file for the media file
  • Add Proxies
complex 0..1 Add the associated proxies for the included asset

Create Proxies Sub-Folder

string 0..1 Place the proxies in a named sub-folder

Proxy Filename(s)

string 0..1 Proxy filename(s) - use %d% for an incremented counter

Add Keyframes

complex 0..1 Add the keyframes for the included asset

Create Keyframes Sub-Folder

string 0..1 Place the keyframes in a named sub-folder

Master Keyframe Only

boolean   Set to true to only include master keyframe

Include keyframe MD5 files

boolean   Add an MD5 file for each keyframe file
Resize complex 0..1 Optional resize operation to perform on image
Target Height (px) integer   Height of image desired - ignored if Resize Mode = Fixed Width or Scale
Target Width (px) integer   Width of image desired - ignored if Resize Mode = Fixed Height or Scale
Height Scale (> 0.0) double   Scale to be applied to image if Resize Mode = Scale
Width Scale (> 0.0) double   Resize Mode
Overlay complex 0..1 Optional overlay operation to perform on image
Image to overlay image   The image to be overlayed on the target image
X Position integer   The X offset of the top-left of the overlaid image from the top-left of the target image. Target image will be expanded with black to accommodate overlaid image if required.
Y Position integer   The Y offset of the top-left of the overlaid image from the top-left of the target image. Target image will be expanded with black to accommodate overlaid image if required.
Image Format single-option   The image format to convert keyframes to
Image Filename(s) string 0..1 Image Filename(s) - use %d% for an incremented counter, %w% for width and %h% for height
Add Images complex 0..1 Add the images contained in the content metadata for the included asset
Image Variable Names string 1 Specify the content metadata variable names (Comma separated if multiple)
Create Images Sub-Folder string 0..1 Place the images in a named sub-folder
Include image MD5 files boolean   Add an MD5 file for each image file
Image Output complex 1..* Output format specification for included images
Resize complex 0..1 Optional resize operation to perform on image
Target Height (px) integer   Height of image desired - ignored if Resize Mode = Fixed Width or Scale
Target Width (px) integer   Width of image desired - ignored if Resize Mode = Fixed Height or Scale
Height Scale (> 0.0) double   Scale to be applied to image if Resize Mode = Scale
Width Scale (> 0.0) double   Scale to be applied to image if Resize Mode = Scale
Resize Mode single-option   Resize Mode
Overlay complex 0..1 Optional overlay operation to perform on image
Image to overlay image   The image to be overlayed on the target image
X Position integer   The X offset of the top-left of the overlaid image from the top-left of the target image. Target image will be expanded with black to accommodate overlaid image if required.
Y Position integer   The Y offset of the top-left of the overlaid image from the top-left of the target image. Target image will be expanded with black to accommodate overlaid image if required.
Image Format single-option   The image format to convert images to
Image Filename(s) string 0..1 Image filename(s) - use %d% for an incremented counter, %w% for width and %h% for height
Add Metadata complex 0..1 Add the associated metadata for the included asset. If both XSLT and Velocity are selected, XSLT is applied before Velocity
Velocity Template file 0..1 Velocity template to apply to included Metadata XML before output
XSLT file 0..1 Stylesheet to apply to included Metadata XML
Metadata File complex 0..1 Metadata XML will be written to the file specified
Metadata Filename string   Name for resulting metadata file
Include metadata MD5 file boolean   Add an MD5 file for the metadata file
Add Static File complex 0..* Add the configured static file at the configured location
Source Static File file   The file to be placed in export include folder
Create Static File Sub-Folder string 0..1 Place the static file in a named sub-folder
Target Static Filename string   The target filename for the static file
Package Processing complex 0..1 Package Processing.
XSLT Processing complex 0..1 Optional XSLT processing of specified source XML file
XML Source File string   XML source path and filename to apply template to - relative to export location
Package XSLT File file   Package XSLT file
XML Target File string 0..1 XML source file destination - relative to export location. If not set, source is overwritten
Velocity Template Processing complex 0..1 Optional Velocity template processing of specified source XML file
XML Source File string   XML source path and filename to apply template to - relative to export location
Package Velocity Template File file   Package Velocity template file
XML Target File string 0..1 XML source file destination - relative to export location. If not set, source is overwritten
POST XML complex 0..1 Specified XML file will be posted with the details specified
XML Source File string   XML source file to post
Host URL string    
Relative Path string    
Post Parameter string    
extra-parameters complex 0..* Name value pairs of additional POST parameters
name string   Name of the parameter
value string   Value of the parameters
Distribution complex 1..* Delivery locations for package

VFS Location

Complex   The output file(s) will be placed in the specified virtual filesystem location

Protocol

Resource   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
  • Create Folder
String 0..1 Create new folder at destination to place package in - if empty, asset title will be used
  • Distribution Format
Complex 0..1 Choice of final format for package delivered to this destination - default is to leave package as is

File Format

Single Option   The format used for package delivery to this distribution location

Package Filename

String   Name for resulting package file - if not specified, exported asset title will be used with appropriate format extension

OpenPGP Public Key File

File   OpenPGP public key file

Deliver MD5

Boolean   Deliver an MD5 file for the final destination package format
  • Distribute Last
String 0..1 Comma separated extensions to specify files which should be delivered after all other files

 

DDP Metadata Export

This Plugin extends the functionality of the Metadata Export Plugin to generate Ooyala Flex DPP compliant metadata.

Properties:

Table 5.
Field Value Explanation
Icon Plugin icon
Sub-type Export Sub-type of this Plugin
Classification I/O 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 or not to select an automatic retry
Timeout   Whether or not to select a timeout
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

 

Configuration:

Table 6.
Field Field Type Mandatory Multiplicity Description
Distribution complex 0..1 Delivery location for the metadata xml
  • Export Location
string   Can be local server location (/tmp) or virtual file system location (ftp:// etc)
  • Save location as Variable
complex 0..1 Save the exported location as a variable

Variable Name

string   The variable name to use in the workflow context
Save as workflow variable boolean   Save the metadata xml as the document variable

 

iTunes Export

This Plugin is used to Export Ooyala Flex Assets to iTunes. It uses the iTMSTransporter tool via Ooyala Flex's Command Line functionality.

Properties:

Table 7.
Field Value Explanation
Icon Plugin icon
Sub-type Export Sub-type of this Plugin
Classification I/O 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 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 8.
Field Field Type Mandatory Multiplicity Description
Command Timeout integer   This will be used to kill the command line process if time is exceeded (Time in seconds).
Metadata File file   This will be placed in the tmp delivery folder and referenced on the command line.
Asset ID long 0..* This will be used to copy the referred file asset into the temp delivery folder and to calculate the MD5 to be placed in the metadata.xml file.
Extra Arguments string   This will be concatenated directly to the command line. In the scenario above this will be: -m upload -WONoPause true.

 

Object Export

Exports the Ooyala Flex Asset Hierarchy as XML.

Properties:

Table 9.
Field Value Explanation
Icon Plugin icon
Sub-type Export Sub-type of this Plugin
Classification I/O 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 undo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not 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:

Table 10.
Field Field Type Mandatory Multiplicity Description
XSLT Transform file 0..1 XSLT transform to apply to the metadata before export
Distribution complex 0..1 Delivery location for the metadata xml
  • Export Location
string   Can be local server location (/tmp) or virtual file system location (ftp:// etc)
  • Save location as Variable
complex 0..1 Save the exported location as a variable

Variable Name

string   The variable name to use in the workflow context
Save as workflow variable boolean   Save the exported xml as the document variable

 

Omneom Export

Exports Asset in a format supported by an Omneon server.

Properties:

Table 11.
Field Value Explanation
Icon Plugin icon
Sub-type Export Sub-type of this Plugin
Classification I/O 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
Computability 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

 

Configuration:

Table 12.
Field Field Type Mandatory Multiplicity Description
Export Location string   Export Location in VFS format

 

Matrox Export

Exports Asset in a format supported by a Matrox system.

Properties:

Table 13.
Field Value Explanation
Icon Plugin icon
Sub-type Export Sub-type of this Plugin
Classification I/O 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 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 14.
Field string Mandatory Multiplicity Description
Export Location string   Export Location in VFS format

Matrox Export

Exports Asset in a format supported by a Matrox system.

Properties:

Table 15.
Field Value Explanation
Icon Plugin icon
Sub-type Export Sub-type of this Plugin
Classification I/O 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
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Timeout   Whether or not to select a timeout

 

Configuration:

Table 16.
Field Field Type Mandatory Multiplicity Description
Export Location string   Export Location in VFS format

 

Metadata Export

This Plugin supports the exportation of Metadata.

Properties:

Table 17.
Field Value Explanation
Icon Plugin icon
Sub-type Export Sub-type of this Plugin
Classification I/O 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 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

 

Configuration:

Table 18.
Field Field Mandatory Multiplicity Description
XSLT Transform file 0..1 XSLT transform to apply to the metadata before export
Distribution complex 0..1 Delivery location for the metadata xml
  • Export Location
string   Can be local server location (/tmp) or virtual file system location (ftp:// etc)
  • Save location as Variable
complex 0..1 Save the exported location as a variable

Variable Name

string   The variable name to use in the workflow context
Save as workflow variable boolean   Save the metadata xml as the document variable

 

Package Export

This Plugin is an advanced exporting and packaging tool that allows for the creation of custom packages. It has three main sections:

Package Include: A specification of content to include in the package (attachments, media, metadata, keyframes, etc).

Package Processing: An optional set of processing rules to apply to the package (XML transformation using templates).

Distribution: One or more locations where the package must be delivered (including package structuring).

 

Combined with Scripting, this Plugin is extremely extensible.

Package Include

The Include options are further sub-divided into the following sections:

Asset Context Heirachy: context rule to specify which Assets must be packaged based on referencing the Asset in the Job Context. For example TRANSCODE[Web1,Web2,Web3,Mobile Transcode].

Include Sub-folder: Specifies a sub-folder to place the included content into.

 

Add Attachments: Whether to also package Asset attachments in a specified directory with a specified name.

 

Add Media: How to package media including specified directory with a specified name. MD5 and PGP encryption rules.

 

Add Proxies: How to package media including specified directory with a specified name. MD5 rules.

 

Add Keyframes: How to publish Keyframes, including specified directory with a specified name. Includes options for resizing and re-formatting the images. Also supports overlaying of an image on the keyframe. MD5 rules.

 

Add Images: How to package images that are contained with the Asset's Metadata, including options for resizing and re-formatting the images. Also supports overlaying of an image on the image.

 

Add metadata: How to package the Asset Metadata including specified directory with a specified name. MD5 rules. Including option of processing the XML through a stylesheet or Velocity template before packaging.

 

Add Static File: How to package additional file to be included in the package, including specified directory with a specified name.

 

You can specify more than one include option per package Job.

For all folder location options, Ooyala Flex will automatically create the folder location if it does not exist.

Package Processing

The package processing options allow for pre-processing of content through various processors before building the output package file:

Delete Export Folder: Allows for the specification of one or more folders to delete (clean-up).

XSLT Processing: Optional XSLT processing of specified source XML file.

Velocity Template Processing: Optional Velocity template processing of specified source XML file.

Post XML File: An XML output file can be posted to a different location.

 

Distribution

The distribution options allow for the specification of where the created package must be delivered to:

Distribution Location: Where the file should be delivered to in VFS format.

 

Create Folder: Whether to create folder at the remote destination.

 

Distribution Format: Details about packaging format (tar, zip, etc) as well as PGP and MD5 rules.

 

Distribute Last: A list of files to deliver after the others.

 

You can specify more than one distribution option which will allow for delivering the same package to more than one end point.

Properties:

Table 19.
Field Value Explanation
Icon Plugin icon
Sub-type Export Sub-type of this Plugin
Classification I/O 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 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

 

Configuration:

Table 20.
Field Field Type Mandatory Multiplicity Description
Package Include complex 1..* Specification of content to include in the package
  • Asset Context Hierarchy
string   The asset context hierarchy relative to the asset selected for package export
  • Create Include Sub-Folder
string 0..1 Place the included content in a named sub-folder (If empty, the included asset title will be used)
  • Add Attachments
complex 0..1 Add the associated attachments for the included asset

Create Attachments Sub-Folder

string 0..1 Place the attachments in a named sub-folder

Attachment Filename(s)

string 0..1 Attachment filename(s) - use %d% for an incremented counter
  • Add Media
complex 0..1 Add the associated media for the included asset

Create Media Sub-Folder

string 0..1 Place the media in a named sub-folder

Media Filename

string 0..1 Media filename

OpenPGP Public Key File

file 0..1 OpenPGP public key file to be used for asset file encryption

Include media MD5 file

boolean   Add an MD5 file for the media file
  • Add Proxies
complex 0..1 Add the associated proxies for the included asset

Create Proxies Sub-Folder

string 0..1 Place the proxies in a named sub-folder

Proxy Filename(s)

string 0..1 Proxy filename(s) - use %d% for an incremented counter

Add Keyframes

complex 0..1 Add the keyframes for the included asset

Create Keyframes Sub-Folder

string 0..1 Place the keyframes in a named sub-folder

Master Keyframe Only

boolean   Set to true to only include master keyframe

Include keyframe MD5 files

boolean   Add an MD5 file for each keyframe file
Resize complex 0..1 Optional resize operation to perform on image
Target Height (px) integer   Height of image desired - ignored if Resize Mode = Fixed Width or Scale
Target Width (px) integer   Width of image desired - ignored if Resize Mode = Fixed Height or Scale
Height Scale (> 0.0) double   Scale to be applied to image if Resize Mode = Scale
Width Scale (> 0.0) double   Resize Mode
Overlay complex 0..1 Optional overlay operation to perform on image
Image to overlay image   The image to be overlayed on the target image
X Position integer   The X offset of the top-left of the overlaid image from the top-left of the target image. Target image will be expanded with black to accommodate overlaid image if required.
Y Position integer   The Y offset of the top-left of the overlaid image from the top-left of the target image. Target image will be expanded with black to accommodate overlaid image if required.
Image Format single-option   The image format to convert keyframes to
Image Filename(s) string 0..1 Image Filename(s) - use %d% for an incremented counter, %w% for width and %h% for height
Add Images complex 0..1 Add the images contained in the content metadata for the included asset
Image Variable Names string 1 Specify the content metadata variable names (Comma separated if multiple)
Create Images Sub-Folder string 0..1 Place the images in a named sub-folder
Include image MD5 files boolean   Add an MD5 file for each image file
Image Output complex 1..* Output format specification for included images
Resize complex 0..1 Optional resize operation to perform on image
Target Height (px) integer   Height of image desired - ignored if Resize Mode = Fixed Width or Scale
Target Width (px) integer   Width of image desired - ignored if Resize Mode = Fixed Height or Scale
Height Scale (> 0.0) double   Scale to be applied to image if Resize Mode = Scale
Width Scale (> 0.0) double   Scale to be applied to image if Resize Mode = Scale
Resize Mode single-option   Resize Mode
Overlay complex 0..1 Optional overlay operation to perform on image
Image to overlay image   The image to be overlayed on the target image
X Position integer   The X offset of the top-left of the overlaid image from the top-left of the target image. Target image will be expanded with black to accommodate overlaid image if required.
Y Position integer   The Y offset of the top-left of the overlaid image from the top-left of the target image. Target image will be expanded with black to accommodate overlaid image if required.
Image Format single-option   The image format to convert images to
Image Filename(s) string 0..1 Image filename(s) - use %d% for an incremented counter, %w% for width and %h% for height
Add Metadata complex 0..1 Add the associated metadata for the included asset. If both XSLT and Velocity are selected, XSLT is applied before Velocity
Velocity Template file 0..1 Velocity template to apply to included Metadata XML before output
XSLT file 0..1 Stylesheet to apply to included Metadata XML
Metadata File complex 0..1 Metadata XML will be written to the file specified
Metadata Filename string   Name for resulting metadata file
Include metadata MD5 file boolean   Add an MD5 file for the metadata file
Add Static File complex 0..* Add the configured static file at the configured location
Source Static File file   The file to be placed in export include folder
Create Static File Sub-Folder string 0..1 Place the static file in a named sub-folder
Target Static Filename string   The target filename for the static file
Package Processing complex 0..1 Package Processing.
XSLT Processing complex 0..1 Optional XSLT processing of specified source XML file
XML Source File string   XML source path and filename to apply template to - relative to export location
Package XSLT File file   Package XSLT file
XML Target File string 0..1 XML source file destination - relative to export location. If not set, source is overwritten
Velocity Template Processing complex 0..1 Optional Velocity template processing of specified source XML file
XML Source File string   XML source path and filename to apply template to - relative to export location
Package Velocity Template File file   Package Velocity template file
XML Target File string 0..1 XML source file destination - relative to export location. If not set, source is overwritten
POST XML complex 0..1 Specified XML file will be posted with the details specified
XML Source File string   XML source file to post
Host URL string    
Relative Path string    
Post Parameter string    
extra-parameters complex 0..* Name value pairs of additional POST parameters
name string   Name of the parameter
value string   Value of the parameters
Distribution complex 1..* Delivery locations for package
Destination Location string   Can be local server location (/tmp) or virtual file system location (ftp:// etc)
Create Folder string 0..1 Create new folder at destination to place package in - if empty, asset title will be used
File Format single-option   The format used for package delivery to this distribution location
Package Filename string   Name for resulting package file - if not specified, exported asset title will be used with appropriate format extension
OpenPGP Public Key File file 0..1 OpenPGP public key file
Deliver MD5 boolean   Deliver an MD5 file for the final destination package format
Distribute Last string 0..1 Comma separated extensions to specify files which should be delivered after all other files

Default Extract

This Plugin supports the extrAction of technical information and keyframes from a media file.

If the Plugin is configured to support keyframe extrAction, then more advanced keyframe related options are available such as:

Setting state: Specifying whether keyframes are automatically approved, the chosen master, etc.

 

Tiling: The generation of a single tiled image that comprises all keyframes and rules for sizing each keyframe. This is useful for supporting scrubbing previews in Ooyala Flex Players. An example tiled image is as follows:

ExtrAction Rules: Rules to define which keyframes are selected (count offsets, time intervals, etc).

Properties:

Table 21.
Field Value Explanation
Icon   Plugin icon
Sub-type   Sub-type of this Plugin
Classification   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 User, Asset What Ooyala Flex Objects can be referenced from within the Scripting context
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 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 22.
Field Field Type Mandatory Multiplicity Description
Extract Metadata boolean   Whether or not to extract metadata.
Extract Frames complex 0..1 Whether or not to extract frames if the asset has a video stream.
  • Approve Frames
boolean   Set all extracted frames as approved automatically.
  • Set Master Frame
integer 0..1 Approve and set the n-th extracted frame as master. If n is greater than the number of frames, the last frame will be used.
  • Set Frames On Parent Asset
boolean   Set the extracted frames to the parent asset if it exists, otherwise set on the current asset.
  • Create Tiled Image
complex 0..1 Create single tiled image from the extracted frames. Individual extracted frames will be discarded.

Title

string 0..1 Optional title for tiled image. Use %d for an auto-incremented title.

Tiled Image Output

complex   Specify output of tiled keyframe image, this may lead to produce multiple tiled keyframes.

Frames Per Row

integer   The number of keyframe images want to keep in a row of tiled image.

Number of Rows

integer   Number of row want to produce in a tiled image.

Image Format

single-option   The format for the resulting tiled image.
  • Keyframe Output
complex   Output format specification for each tiled frame.

Target Width (px)

integer   Width of each frame tile desired. Ignored if Resize Mode = Fixed Height or Scale.

Target Height (px)

integer   Height of each frame tile desired. Ignored if Resize Mode = Fixed Width or Scale.

Width Scale (> 0.0)

double   Scale to be applied to each frame tile if Resize Mode = Scale

Height Scale (> 0.0)

double   Scale to be applied to each frame tile if Resize Mode = Scale.

Resize Mode

single-option   Resize Mode
  • Fixed Number
integer 0..1 Number of frames to extract at equally spaced intervals.
  • Fixed Time
complex 0..1 Fixed time in seconds to extract a frame (if Fixed Number not set).

Time

integer  

The time to extract from in seconds.

Time Range

integer 0..1 Time range in seconds around specified time from which each and every frame should be extracted.
  • Fixed Interval
integer 0..1 Time interval in seconds starting from zero at which to extract frames (if Fixed Number and Fixed Time not set).

Was this article helpful?