Profile Types

A Profile is a "template" used to store configuration details. There are two Profile Types available in Ooyala Flex, discussed below.

Validation Profiles

Used for validating Assets against desired file structural metadata values. A Validation Profile is referenced from within some Validation Actions as well as by Inboxes to validate incoming media files. During a validation operation, Ooyala Flex compares a Validation Profile with the technical metadata values (bitrate, framerate, codec, etc) extracted from an Asset, to identify whether the Validation Profile rules are met.

There are two types of Validation Profiles:

  • Media Validate: Used to Validate Media Asset Types.
  • Image Validate: Used to Validate Image Asset Types.

Complex Types and Pattern Matching

As well as Scripting, Ooyala Flex's Validation Profiles support complex types. This means that instead of entering values into number fields, you can also enter operators to make your matching more powerful. You can also use Scripting in string and text fields.

The operators available are as follows:

Pattern Explanation Example

.. Range from a lower value to a larger value 20..30

> The match is greater than the value given >35.0

< The match is less than the value given 65.3<

| The "or" operator. The match must be with one of the value 65 | 64

! The "!" operator. The match must not be with the value shown !65

* The wildcard means anything will be matched

29834

Transcode Profiles

Used for defining a Transcode Profile to be used when Transcoding an Asset from one file format to another. A Transcode Profile is referenced from within some Transcode Actions, to specify the type of transcode process that must occur when the Transcode Job is delegated to a Transcode Resource.

Notes:

A Profile is in fact a System-generated Metadata Schema that is used for the purposes of storing configuration templates.

Media Transcode Profile

Note: This Template supports Scripting values in the string and text fields only!

Properties:

Table 1.
Field Value Explanation
Icon Plugin icon
Supports Scripting Whether configuration supports Scripting
Scripting Context asset, job

What Ooyala Flex Objects can be referenced from within the Scripting context

Configuration:

Table 2.
Field Field Type Mandatory Multiplicity Description
Transcode Engine transcode-engine 0.1 The specific transcode engine required for this profile
Transcoder Profile Name string 0..1 Transcoder specific preset/profile name
Transcode Profile Template file 0..1 Transcode profile is based on an uploaded template
Configured Profile complex 0..1 Transcode profile is based on configuration
Sources complex 1..* Information about the source Assets
Source Asset Context string   Asset content hierarchy reference to the source asset
In string    
Out string    
Source Transformations complex    
Deinterlace complex 0..1 Deinterlace an interlaced source
Deinterlace Method transcode-deinterlace-method    
Threshold string    
Cropping complex 0..1 Crop a source video
Top (px) integer    
Bottom (px) integer    
Left (px) integer    
Right (px) integer    
Frame Rate Conversion complex 0..1 Convert a Variable to Fixed Framerate
Conversion Frame Rate (fps) transcode-frame-rate    
Pixel Aspect Ratio Conversion complex 0..1 Correct a video's reported aspect ratio
Pixel Aspect Ratio Conversion(e.g. 4:3) string    
Product complex   Information about the product
Format transcode-format    
Format Variant transcode-format-variant    
Output complex   Information about the output
File Options complex 0..1 File Output Options
File Option complex 0..* File Output Option
File Option Name string    
File Option Value string    
Video Streams complex 0..1 Information about the video
Video Stream complex 0..1 General information about stream
Video Codec transcode-video-codec    
Video Bit Rate string    
Video Frame Rate (fps) double    
Video Width (px) integer    
Video Width (px) integer    
Pixel Aspect Ratio (e.g. 4:3 string    
Interlace Format transcode-interlace-format    
Video Options complex 0..1 Video Codec Options
Video Option complex 0..* Video Codec Option
Video Option Name string    
Video Option Value string    
Video Transformations complex    
Video Fade complex 0..1  
Video Fade-In (sec) string    
Video Fade-Out (sec) string    
Overlays complex    
Graphic Overlay complex 0..*  
Image image   Overlay Image for Transcode.
Start Time Code string    
End Time Code string    
Fade-In Duration (sec) integer    
Fade-Out Duration (sec) integer    
X Position (pixels) integer   Horizontal offset, in pixels. "0" denotes the far left and increasing values will offset the image to the right
Y Position (pixels) integer   Vertical offset, in pixels. "0" denotes the top of the image and increasing values will offset the image towards the bottom
X Scale double   Horizontal scale factor. E.g. 1.0 is actual size, 0.5 is half size, and 2.0 is double original size
Y Scale double   Vertical scale factor. E.g. 1.0 is actual size, 0.5 is half size, and 2.0 is double original size
Transparency (0.0-1.0) double   0.0 (fully opaque) and 1.0 (fully transparent)
Text Overlay complex   0..*
Text string    
Start Time Code string    
End Time Code string    
Fade-In Duration (sec) integer    
Fade-Out Duration (sec) integer    
X Position (0.0-1.0) double   0.0 (left of the screen) and 1.0 (right of the screen)
Y Position (0.0-1.0) double   0.0 (top of the screen) and 1.0 (bottom of the screen)
Horizontal Alignments complex 1  
Horizontal Alignment single-option   Horizontal Alignment
Vertical Alignments complex 1  
Vertical Alignment single-option   Vertical Alignment
Transparency (0.0-1.0) double   0.0 (fully opaque) and 1.0 (fully transparent)
Font string    
Size (0.0-1.0) double    
Red Colour Component (0-255) integer    
Blue Colour Component (0-255) integer    
Green Colour Component (0-255) integer    
Shadow (0.0-1.0) double   0.0 (no glow) and 1.0 (strongest glow)
Hard Shadow boolean    
Background Enabled boolean    
Media Expansion complex 0..1  
Add Pre-Roll Frames integer    
Add Post-Roll Frames integer    
Field Order Shift complex 0..1  
Field Order Shift single-option   Field Order Shift
Audio Streams complex 0..1 Information about the audio
Audio Stream complex 0..1 General information about stream
Audio Codec transcode-audio-codec    
Sample Rate (kHz) double    
Audio Bit Rate string    
Bits Per Sample integer    
Channels integer    
Audio Options complex 0..1 Audio Codec Options
Audio Option complex 0..* Audio Codec Option
Audio Option Name string    
Audio Option Value string    
Audio Transformations complex    
Audio Fade complex 0..1  
Audio Fade-In (sec) string    
Audio Fade-Out (sec) string    
Channel Mapping complex 0..1  
Channel Mapping Left string    
Channel Mapping Right string    
Channel Mapping Centre string    
Channel Mapping Rear Left string    
Channel Mapping LFE string    
Audio Gain complex 0..1  
Gain (dB) double   Audio Gain (dB)
Normalise boolean    
Loudness Adjust complex 0..1  
Gain (dB) double   Gain (dB)
ITU BS 1770 complex 0..1  
Target Perceived Loudness (LKFS) double   Target Perceived Loudness (LKFS)
Restrict Peak Level complex 0..1 Peak Level (dBFS)
Peak Level (dBFS) double    
Static Image image 0..1 Static image for Transcode.

The common way of managing the behaviour of a Transcode Job is to configure a Transcode Profile as shown above. There is one option that allows for much lower level manipulation of the Transcode Profile. The Transcode Profile Template option shown above in red allows for the upload of a Transcode template. If you set this then it provides much lower level control of the Transcode Profile and more dynamic control. This is explained in the Low Level Profiles section.

Low Level Profiles

It is possible to upload a lower level Transcode template to your Transcode Profile. This template takes the form of a Velocity Template. The Apache Velocity Engine is a free open-source templating engine. Velocity permits you to use a simple yet powerful template language to reference Objects defined in Java code. It is written in 100% pure Java and can be easily embedded into your own applications.

Note:The use of Velocity templates is beyond the scope of this guide. More information can be found here velocity.apache.org and also in the Scripting section of the API Guide.

By uploading a Velocity template a Super User can create a direct XML request API call to the underlying Transcoder. This template bypasses the higher level Media Transcode Profile and it also bypasses the Transcode Adapter. The benefits of this are:

• You can craft more customised, lower-level API calls to your transcoder

• Templating and Scripting enables you to dynamically create profiles based on variables existing within the Context.

• You can access API calls that are new or not yet available in the Media Transcode Profile

The following Objects are made available in the context of the Velocity template engine:

• An XML document named "document" that exists in the Workflow Context

• An XML document called "contentMetadata" that represents the Metadata Instance belonging to the Asset that is being transcoded.

For more information on creating Velocity Templates, please consult the API Guide. A Full example of a Velocity Template is shown in the Appendix.

Image Transcode Profile

Note: This Template supports Scripting values in the string and text fields only!

Properties:

Table 3.
Field Value Explanation
Icon Plugin icon
Supports Scripting Whether configuration supports Scripting
Scripting Context asset, job What Ooyala Flex Objects can be referenced from within the Scripting context

Configuration:

Table 4.
Field Field Type Mandatory Multiplicity Description
Source complex 1 Information about the source 0.
Asset Context string    
Image Format single-option   The asset image format to transcode.
Width integer   Width of image desired. Ignored if Resize Mode = Fixed Width or Scale.
Height integer   Height of image desired. Ignored if Resize Mode = Fixed Height or Scale
Width Scale double   Scaling factor to be applied to the width of the image if Resize Mode = Scale
Height Scale double   Scaling factor to be applied to the height of the image if Resize Mode = Scale
Resize Mode single-option   Resize Mode

Media Validate Profile

Note: This Template supports Scripting values in the string and text fields only!

Properties:

Table 5.
Field Value Explanation
Icon Plugin icon
Supports Scripting Whether configuration supports Scripting
Scripting Context Asset, Job, Event What Ooyala Flex Objects can be referenced from within the Scripting context

Configuration:

Table 6.
Field Field Type Mandatory Multiplicity Description
File complex   Information about the format
File Bit Rate long    
Duration (uSec) long    
Stream Count integer    
Video Stream Count integer    
Audio Stream Count integer    
Format validation-format    
Video Streams complex 0..1 Video stream information. Adding this implies at least one audio stream should exist.
Video Stream complex 0..1 Information about a particular video stream
General Video Stream Information complex   General information about stream
Video Bit Rate long    
Video Language string    
Video Start Time Code string    
Video External Stream boolean 0..1  
Video Codec validation-video-codec    
MPEG-2 Codec Context complex 0..* General information about stream
GOP Size integer    
GOP Sequence string    
I-Frame Only boolean 0..1  
Bit Rate Type validation-bit-rate-type    
VBV Buffer Size integer    
MPEG-2 Profile validation-mpeg-2-profile    
MPEG-2 Level validation-mpeg-2-level    
Frame Rate (fps) double    
Frame Width (px) integer    
Frame Height (px) integer    
Pixel Aspect Ratio (e.g. 4:3) string    
Interlace Format validation-interlace-format    
Pixel Format validation-pixel-format    
Standard validation-standard    
Telecine Format validation-telecine-format    
Audio Streams complex 0..1 Audio stream information. Adding this implies at least one audio stream should exist.
Audio Stream complex 0..1 Information about a particular video stream
General Audio Stream Information complex   General information about stream
Audio Bit Rate long    
Audio Language string    
Audio Start Time Code string    
Audio External Stream boolean 0..1  
Audio Codec validation-audio-codec    
Sample Rate (kHz) double    
Channels integer    
Bits Per Sample integer    
Internal Text Metadata complex 1 Descriptive metadata contained within the file.
Number Of Fields integer   Number of metadata fields.
Fields complex    
Abstract string    
Author string    
Copyright string    
Description string    

Image Validate Profile

Note: This Template supports Scripting values in the string and text fields only!

Properties:

Table 7.
Field Value Explanation
Icon Plugin icon
Supports Scripting Whether configuration supports Scripting
Scripting Context Asset, Job, Event What Ooyala Flex Objects can be referenced from within the Scripting context

Configuration:

Table 8.
Field Field Type Mandatory Multiplicity Description
Image Format single-option   The file format of the image.
File Size long   The size of the file e.g. 100, 100..200, 100|200, >100, <200
Width integer   The width of the image in pixels e.g. 800, 600..800, 600|800, >600, <800
Height integer   The height of the image in pixels e.g. 800, 600..800, 600|800, >600, <800
Display Aspect Ratio string   he aspect ratio of the image e.g. 16:9

Was this article helpful?