MKD 10 00382 01 05 EncodingOnDemand MS UserGuide - v12.0 - RA

Video Processing
Encoding On-demand mS v12.0
User Guide
PN: 10-00382-01-05
Encoding On-demand mS v12.0 ii
User Guide
Contents
Chapter 1 Quick Start.................................................................................................................... 5
Quick start.................................................................................................................................................................. 6
Connect to the Controller....................................................................................................................................7
Create an Encoding On-Demand service.......................................................................................................8
Create a job.............................................................................................................................................................10
Chapter 2 Menus and navigation...............................................................................................12

Menus and navigation........................................................................................................................................ 13
Services and processing types.........................................................................................................................15
Servers....................................................................................................................................................................... 17
Jobs.............................................................................................................................................................................18
Reports...................................................................................................................................................................... 19
Edit the number of rows displayed............................................................................................................... 20
Use the search bar................................................................................................................................................21
Chapter 3 Using Encoding On-demand..................................................................................... 22

Configuring On-Demand services.................................................................................................................. 23
Create and configure an Encoding On-Demand OTT service.................................................. 23
Configuring input stream selection...................................................................................................31
Configuring encoding............................................................................................................................. 36
Configuring output.................................................................................................................................. 40
Configuring post processing................................................................................................................ 41
Configure Closed Captioning...............................................................................................................41
Configure a closed caption subtitle burn-in...................................................................................43
Manage Telecine for video in NTSC...................................................................................................45
Configure HDR signaling conversion (HEVC)................................................................................. 46
Managing jobs....................................................................................................................................................... 48
Display jobs for a specific service.......................................................................................................48
Monitoring jobs......................................................................................................................................... 48
Create a job.................................................................................................................................................49
Delete Jobs..................................................................................................................................................50
Stop jobs...................................................................................................................................................... 51
Cancel all running jobs...........................................................................................................................52
View job details......................................................................................................................................... 53
Create a job from an existing job (duplicate a job)..................................................................... 54
Prioritize jobs..............................................................................................................................................56
Encoding On-demand mS v12.0 iii
User Guide
Create a PCM map for audio................................................................................................................57

Automating encoding with the Watchfolder feature..............................................................................60
Network configurations......................................................................................................................................62
Configure mount points.........................................................................................................................62
Configure credentials for direct remote storage access.............................................................64
Configure NTP............................................................................................................................................ 65
Configure NIC (network)........................................................................................................................ 66
Chapter 4 Managing solutions................................................................................................... 67

View Encoding On-Demand Reports............................................................................................................ 68
Manage services.................................................................................................................................................... 69
Display services..........................................................................................................................................69
Create a service......................................................................................................................................... 69
Assign a server to run the service......................................................................................................70
Assign additional servers to a service...............................................................................................70
Unassign a server from a service........................................................................................................71
Export a service configuration.............................................................................................................71
Import a service.........................................................................................................................................71
Start a service.............................................................................................................................................72
Stop a service............................................................................................................................................. 72
Delete a service......................................................................................................................................... 73
Configure advanced parameters for an existing service............................................................73
Manage servers......................................................................................................................................................74
Display servers........................................................................................................................................... 74
Display server information (system).................................................................................................. 74
System administration........................................................................................................................................ 75
System center.............................................................................................................................................75
Backup and restore.................................................................................................................................. 75
User management.................................................................................................................................... 79
License management.............................................................................................................................. 83
Generating a support package........................................................................................................................88
Chapter 5 Parameters glossary.................................................................................................. 89

License parameters.............................................................................................................................................. 90
Input parameters...................................................................................................................................................91
Video stream input parameters.......................................................................................................... 91
Audio input parameters......................................................................................................................... 92
Subtitles input parameters....................................................................................................................94
Metadata input parameters.................................................................................................................. 95
Encoding parameters.......................................................................................................................................... 96
Video stream encoding parameters.................................................................................................. 96
MPEG-1 Layer II audio encoding parameters.................................................................................98
Dolby Digital audio encoding parameters in stereo channel mode......................................99
Dolby Digital audio encoding parameters in follow input channel mode........................100
Subtitle encoding parameters...........................................................................................................101
Metadata encoding parameters....................................................................................................... 102
Output parameters............................................................................................................................................ 103
Output files............................................................................................................................................... 103
MPEG2-TS output parameters........................................................................................................... 103
MP4 output parameters.......................................................................................................................104
Post Processing....................................................................................................................................................106
Post processing parameters............................................................................................................... 106
Job settings...........................................................................................................................................................107
Job settings parameters...................................................................................................................... 107
Watchfolder settings......................................................................................................................................... 109
Watchfolder settings parameters..................................................................................................... 109
CHAPTER 1
Quick Start
Chapter 1 Encoding On-demand mS v12.0 6
Quick Start - Quick start User Guide
Quick start
Follow step-by-step instructions to configure a newly installed Encoding On-Demand. The Quick Start
includes basic tasks to connect to the Encoder, create a service, and transcode video files.
Get started with these basics tasks

• Create a service
• Assign a service to a server
• Start a service
• Create a job
Quick Start - Connect to the Controller User Guide
Connect to the Controller

1. Open a Web browser.
2. Enter the access URL, then press Enter.
NOTE Your access is either HTTP or HTTPS depending on your security settings.
HTTP example: http://[IP-Address]:8080
HTTPS example: https://[IP-address] or https://[IP-address]:8443
Result: The Login page displays if user authentication is activated and configured.
3. When the Login page displays: Enter your username and password.
NOTE Default admin user log in information:
• Username: admin
• Password: admin
Result: The Home page displays.

Quick Start - Create an Encoding On-Demand service User Guide
Create an Encoding On-Demand service
IMPORTANT Default service settings are ready for use without editing the configuration.
1. Display services.
2. Click Add service.
Example:
Result: A drop down list displays.

3. Select the On-Demand Encoding processing type.
Result: The service configuration options display.
4. Optional: Enter a service Name or leave empty to use automatic name generation.
Example:
REMEMBER Default service settings are ready for immediate use, without editing the
configuration.
5. Optional: Configure input, encoding and output settings.

a. In the Input stream selection tab, click to edit existing video and audio input parameters or
click Add audio.../Add subtitle.../Add metadata ... to complete the input stream.
b. Open the Encoding tab to edit the existing encoding parameters or click Add video .../Add
audio.../Add subtitle.../Add metadata ... to complete the encoding configuration.
c. Open the output tab to Add an Output and configure output streams.
d. Open the Post processing tab to Add post processing settings to the output.
6. Click Save and exit.

Result: The service displays in the list and the status is Stopped.
Quick Start - Create an Encoding On-Demand service User Guide
7. Assign a server.
REMEMBER A server must be assigned to Start the service
8. Start the service.

9. Optional: Add a job.
NOTE Jobs launch automatically when created, or when the service starts.
Quick Start - Create a job User Guide
Create a job
Create one or multiple jobs on a service.
Prerequisites:
A service exists and is started.
1. Display jobs.
2. Click Add job to create a job.
Result: The Job settings options display.
3. Configure the job and click Apply.
IMPORTANT • Input files require specific mount point settings.
• The publishing point requires specific mount point settings.
• You can also use http and https.
Example: Syntax uses file:// for remote NAS (requires mount point):
Example: Syntax uses file:/// for local or absolute path to mounted storage:
Result: If the service is currently running, then the Job launches automatically. The .ts and/or .mp4
files are generated in the defined output folder. Jobs set with the same priority are launched in
order, per job creation date.
TIP • Click to stop a job before completion.
• Click to view details (monitoring).
Quick Start - Create a job User Guide
4. Optional: Configure:
• Custom settings
• Advanced settings
• PCM audio mapping
CHAPTER 2
Menus and navigation

Menus and navigation - Menus and navigation User Guide
Menus and navigation

There are multiple navigation options in the Controller. Some menu options depend on the MediaKind
products that you have installed.
IMPORTANT Features, menus and options vary based on your solution and the MediaKind products
installed.
Home page and dashboard overviews

The Home page displays a dashboard with overviews for services, servers and templates.
TIP • Click an overview to link to the related page.

• The overview display may vary depending on the products you have installed.
Collapse/expand button
The button collapses or expands the Menu panel to either hide or display menu text.
Menu panel
Access information and configuration options.
NOTE Menu options may vary depending on the products you have installed.
Examples: Full / Collapsed
Menus and navigation - Menus and navigation User Guide
Breadcrumbs
Breadcrumbs are navigational links to previous pages. Breadcrumbs display above the viewing screen.
System center menu

The System Center menu drops down after clicking the in the upper right corner of the screen.
Alarms banner
The Alarms banner displays in the upper right corner of the screen, next to the system center menu icon
.
Menus and navigation - Services and processing types User Guide
Services and processing types

A service is a set of parameters required for a given processing type. Services require an assigned server to
run. A service can run on 1 or several servers. Services can be manually started and stopped.
NOTE Access services from the Home page or the left-side menu panel.
Service processing types

Processing type Required Software
Live Encoding MediaKind Encoding Live
On-Demand Encoding MediaKind Encoding On-Demand
Live Packaging MediaKind Packaging
On-Demand Packaging MediaKind Packaging
Catalog MediaKind Packaging
Multiplexing MediaKind Stream Processing
Stream Personalization MediaKind Stream Personalization
Manifest Conditioning MediaKind Prisma
Stream Conditioning MediaKind Prisma
Viewing Policy Manager MediaKind Prisma
Receiver MediaKind - Rx1
Server processing types

Additional processing types are available from the Servers page.

Licensing Dedicated license server running the license manager
NOTE The license manager may also be installed on the
MediaKind Controller server.
Menus and navigation - Services and processing types User Guide

Controller Controller provides a centralized configuration and control
interface, manages failover for Encoding Live, and offers a
flexible licensing management for MediaKind applications.
Menus and navigation - Servers User Guide
Servers
The Servers view displays system information to monitor and manage servers. The statuses indicate
server availability: connected or connection lost.
Server Status
NOTE • If the connection is lost when the server is in a failover group (only for Encoding Live)
then check if failover occurred.
• You can also check alarms or alarm history to investigate possible causes.
• You can also check server information for licenses and IP configurations.
Menus and navigation - Jobs User Guide
Jobs
The jobs menu allows you to access a jobs overview. You can monitor on going, queued, aborted,
completed or uncompleted jobs all from the same jobs overview page.
Related Information
Managing jobs on page 48
Jobs management is centralized per service. You can manage job priorities per service, configurations and
view overall job statistics.
Menus and navigation - Reports User Guide
Reports
The reports menu opens an overview of license token consumption. This table helps to keep track of the
farm usage over time. Select a time range, and generate a report for the selected time range.
IMPORTANT Depth is 90 days.
Related Tasks
View Encoding On-Demand Reports on page 68
The Reports page for Encoding On-Demand offers an overview for a specific period of time. By selecting
a time period you can review the total services, token consumption and total job statistics.
Menus and navigation - Edit the number of rows displayed User Guide
Edit the number of rows displayed

For most menu pages available in the Controller UI, You can display more rows in the table, or less rows,
by selecting the number of rows to display.
1. Use the left-side Menu panel to display a specific page.
2. Scroll to the bottom of the selected page and edit the number of rows to display per page.
Example:
Menus and navigation - Use the search bar User Guide
Use the search bar

The Search bar displays in pages with table displays.
1. Use the left-side Menu panel to display a specific page.
2. Enter one or several keywords in the Search bar to filter the table.
Search requirements:
• Keyword based
• Not case sensitive
• No wildcards
Example:
CHAPTER 3
Using Encoding On-demand

Using Encoding On-demand - Configuring On-Demand services User Guide
Configuring On-Demand services
Create and configure an Encoding On-Demand OTT service

Below is an example procedure that shows you how to create an OTT service by generating multi-
audio and video profiles as well as a manifest file, facilitating downstream packaging.
Prerequisites:
• The Encoding On-Demand software is installed.
• You are connected with the correct access rights.
IMPORTANT The default service is functional but usually requires edition to match encoding needs.
Objective: Create an OTT service with 5 video profiles from UHD to sub-SD resolutions and associate
2 audio stereo channels to support multi-languages for post processing operations by MediaKind
Packaging.
Video profiles
Target Bitrate Frame rate (fps) Resolution Codec Expected Quality

(kbps)
20000 60 3840x2160 HEVC 10 bit Best
8600 60 1920x1080 HEVC 10 bit Best
4000 60 1080x720 HEVC 10 bit Good
2200 30 960x540 HEVC 10 bit Satisfactory
500 15 480x270 HEVC 10 bit Satisfactory
Audio Profiles
Target Bitrate (kbps) Sampling rate (kHz) Codec

48 44.1 HE-AAC
48 44.1 HE-AAC
REMEMBER The following steps are an example of possible customized configurations.

1. Create a new On-Demand Encoding service: Services > Add service > On-Demand Encoding
Example:
Result: By default, the service has 1 audio and 1 video stream.

2. Enter a name for the service.
3. Add an audio stream to the Input Stream Selection.
a. Click Add audio... to add 1 audio stream.
Result: The Audio media processing options display.
b. Configure the audio processing parameters, then click Apply.
Example:
Result: 1 video stream and 2 audio streams display in the Input Stream Selection
4. Configure the video stream Encoding settings.

TIP Use the video profiles table in the beginning of this example to guide your
configuration.
a. Open the Encoding tab to display streams.
b. Click Add video... to add the 4 additional video streams required for this example objective.
c. Click to open the Video encoding options.
Example:
d. Configure the Video encoding settings for each stream, then click Apply.
e. Configure the remaining streams.
Result: The 5 video streams are configured according to this example objective.
5. Configure the Audio stream Encoding settings.

TIP Use the audio profile table at the beginning of this example to guide your
configuration.
a. From the Encoding tab, click Add audio...
Result: The Audio encoding options display.
b. Configure the Audio encoding options, then click Apply.

c. Add and configure the second audio encoding parameters.
Result: The additional audio streams appear in the Input stream Audio selection.
Result: The Video and Audio streams match our example objectives:
• 5 Video streams configured with the provided video profiles.
• 2 audio streams configured with the provided audio profiles.
6. Configure output to generate a manifest with one TS file per video layers.
a. Open the Output tab to configure the stream output settings.
Example:
b. Enter the base publishing point.

c. Click for output_x to edit the output parameters.
Example:
7. Edit the TS file settings of the outputs

a. Click for output_x_x.ts to edit stream configurations.
Example:
Result: The Stream selection options display.
b. Select one video with the audio streams.

c. Configure the PID settings.
Example:
NOTE • The PID is only configurable for selected streams.

• Otherwise, the PID setting is inactive and grayed.
d. Click Apply.
8. Click Add TS file for each of the video layer and configure it accordingly.
9. Click Save and exit to save service configurations and return to the list of services.
Result: The service displays in the list of services.
10. Assign the service to a server.
Example:
11. Click to start the service.

12. To add a job, click the service name from the list of services to display the Jobs page.
NOTE • The page that displays when you click on a service may vary depending on the
processing type.
• Services display as links if there is specific service information do display.
Example:
Result: The Job is automatically launched when added. The .ts files are generated in the defined
output folder. Jobs set with the same priority are launched in order, per job creation date.
Configuring input stream selection

Input stream selection allows to define rules to select input streams from input file. Input streams include
video, audio, subtitles and metadata inputs.
Edit input stream selection parameters

2. Click to edit configurations.
• Video
• Audio
• Subtitle
• Metadata
Example:
3. Configure parameters, then click Apply.

TIP Parameter descriptions:
• Video stream input parameters
• Audio input parameters
• Subtitles input parameters
• Metadata input parameters
4. Optional: You can tick the Mandatory checkbox for each audio, subtitles or metadata input stream.
NOTE A new Service always has a non-removable and mandatory video input stream
preconfigured.
Result: When an encoding job is started, if some of the input streams have the Mandatory option
activated, the job will only be completed if the ingested asset contains streams corresponding to the
selection criteria defined for each input stream.
Examples:
• Let's consider a service with only two input streams: the default video input and an audio input
with no particular selection criteria (Codec: any, Languages: any, PID: any, etc.), where the
audio input stream is declared as Mandatory: if an encoding job is launched for this service, it will
fail if the ingested asset does contain at least one audio stream.
• Let's consider another service where a Subtitle input stream with Arib B24 type is declared as
Mandatory: the job will fail if the ingested asset does not contain at least one subtitle stream with
Arib B24 type.
5. Save configurations.
6. Add and configure additional streams, or click to delete.
Edit video input

New services use a default input stream selection and configurations.
2. Click to edit the video configurations.
Result: The Video selection options display.
3. Expand the menus to configure parameters, then click Apply.

Example: Some processing parameters include:
Add an audio input

2. Click to edit the service.
3. Click Add audio...
Example:
Result: The Audio selection options display.


Example:
Result: The stream displays in the list.

5. Configure this new audio stream in encodings settings.
Edit an audio input

3. In the Input stream selection tab, click to edit the audio configuration.
Result: The Audio selection options display.
Example:
Add a subtitle input

3. Click Add subtitle...
Result: The Subtitle media processing options display.
4. Select the subtitle Type depending on the input file:
• DVB
• ARIB B24
• SCTE-27
• Teletext
• Subtitle file (.srt files)
NOTE Closed caption are managed in the video stream selection settings. Configuration
details are available here:
• Configure Closed Captioning on page 41
• Configure a closed caption subtitle burn-in on page 43
Example:
5. Configure parameters:, then click Apply

6. Configure encodings.
Add a metadata input

3. Click Add metadata ...
Result: The Metadata selection and processing parameters display.

Example:
NOTE Changing Type changes the processing parameters to configure.

5. Configure encodings.
Configuring encoding
Encoding parameters are applied during processing.
Edit encoding
Newly added services use default encoding settings so the service is launch-ready. These encoding settings
requires edition to match encoding needs.
Prerequisites:
Inputs are configured.
2. Click to edit a service.
3. Click Encoding to open the tab and to display encoding settings.

Example:
4. Click to edit an encoding option, or add encodings.

• Add a video encoding
• Add an audio encoding
• Add subtitle encoding
• Add metadata encoding
Add a video encoding

Video encoding is set of video encoding configuration options applied to a video. For example, resolution,
rate control, bit rate, etc.
Prerequisites:
1. Display encodings.
2. Click Add video ...
Result: Video encoding options display.
3. Configure the parameters, then click Apply.

Example:
4. Configure this new video stream in output settings.

Add an audio encoding

An audio encoding is set of audio configuration options applied to an audio component. For example,
channel mode, Codec, etc.
Prerequisites:
2. Click Add audio...
Result: The Audio encoding options display.

Example:
Result: The encoding is listed in the Encoding tab.

4. Configure this new audio stream in output settings.
Add metadata encoding

Prerequisites:
At least one metadata input is configured.
2. Click Add metadata...
Result: The Metadata encoding parameters display.
Example:

4. Configure this new metadata in output settings.
Add a subtitle encoding

Prerequisites:
At least one subtitle Inputs is configured.
NOTE This step does not apply for extracted subtitles (teletext and closed caption).
2. Click Add subtitle...
Result: The Subtitle encoding options display.

Example:

4. Configure this new subtitle in output settings.
Configuring output
Edit and add outputs
An output can contain multiple files. For example, one file per video encoding for different resolutions.
Multiple audio streams may also be associated to the video stream in the same file for multiple languages.
3. Ensure that Input stream selection and Encoding settings are correct.
4. Open the Output tab.
Result: By default, one output is already available.
5. Select the output file format:
• MPEG2-TS file
• MP4 file
6. Configure the output general parameters:

• MPEG2-TS file output general parameters
• MP4 file output general parameters
7. Tune the output by selecting:

a. to change the default video output format.
b. Add TS file...to add another ts file to the output.
c. Generate TTML files to include subtitles defined in the Input stream selection.
d. Generate ESAM files to include metadata defined in the Input stream selection.
TTML and ESAM files generation only applies when the Encoding On-Demand
service is then processed by a MediaKind - Packaging service.
8. Click Add output to create and tune another output.

TIP Click to duplicate the existing output.
Example:
Result: A new blank output is added.

9. Click Add TS file..., Generate TTML files and Generate ESAM files to define the data to include in
the output.
Configuring post processing

The encoder has post processing processes that prepare outputs for other products and components.
Post processing is carried out after encoding processes complete and when outputs are available. # For
example, post-processing can be used to automatically add the output asset in a MediaKind - Packaging
catalog.
Configure Closed Captioning


NOTE You can add a new service to create and edit the video selection settings.
Result: The service settings display the Input stream selection.
3. In the Input stream selection tab click to edit the video selection.
4. Expand the Closed Caption / SCTE-20 section and select the tracks.
NOTE You can select up to 4 Closed Caption tracks.
5. Optional: Enter a language for the track according the ISO 639-2 language standards.
Example:
6. Click Apply.
Result: The tracks are saved and display in the Closed Caption column in the Input stream
selection tab.
7. Optional: Activate the closed captions in the Encoding configuration.

a. Open the Encoding tab.
b. Click to edit the Video encoding.
c. Scroll to the Stream metadata settings, then click to expand and display options.
d. Select Insert closed captions.
Example:
8. Open the Output tab and click Generate TTML files.

Result: The Closed Caption tracks selected in the video input display. The files are sent to the same
location as output files (see Configure Mount Point).
9. Click Apply.
Post Requisite:
• When MediaKind - Packaging is used to package the asset, closed caption needs to be extracted and
converted to TTML.
Configure a closed caption subtitle burn-in

You can burn subtitles into the image stream when a player doesn't support the subtitle format.
1. Create an new service, or edit an existing service to display service parameters.

Example:
2. Open the Input stream selection tab and add a subtitle stream.
Example:
3. For Closed captions burn-in, configure the Closed Caption tracks in the stream.
Example:
4. Click to edit the video stream encoding configuration.

Example:
5. Click the Subtitle burn-in field to display available subtitle streams.

Example:
6. Select the stream to burn-in, then click Apply.

7. Save the configuration and continue or exit the service configuration.
Manage Telecine for video in NTSC

Adaptive inverse telecine is applied to the process of converting assets to 24 frames per second
(23.976fps).

Result: The Input Stream Selection tab displays current stream configurations.
3. Click to edit the video stream.

Result: The Video selection parameters display.
4. Expand the Video adjustment section.
Example:
5. Select the Adaptive inverse telecine to activate.

Result: Video stream frame rate will be converted to 24fps (23.976fps) if stream is telecine.
NOTE Video players must be compatible with assets in 24fps to avoid streaming issues.
6. Click Apply.
Result: The settings are applied and the services edition page displays.
7. Save settings.
Configure HDR signaling conversion (HEVC)

You can configure HDR signaling conversion in the encoding options, or choose to keep the initial input
‘as is’ using the Follow input option.

Result: The Input Stream Selection tab displays current stream configurations.
3. Open the Encoding tab and click to edit the video encoding.
Result: The parameters display.
4. Set the video codec to HEVC main 10 bits.
5. Expand the Codec settings section.
6. Configure the Dynamic range mode.
Example:
Result: The parameters display.

7. Click Apply.
Result: The settings are applied and the services edition page displays.
8. Save settings.
Using Encoding On-demand - Managing jobs User Guide
Managing jobs
Jobs management is centralized per service. You can manage job priorities per service, configurations and
view overall job statistics.
Display jobs for a specific service

You can configure, edit and add jobs for a specific service.
Prerequisites:
2. Click the service name from the list of services to display the Jobs page.
processing type.
• Services display as a hyperlink if there is specific service information do display.
Example:
3. Optional: Select Jobs from the left-side menu panel to display an overview of jobs for all services.
Monitoring jobs
A single Encoding On-Demand service may have multiple jobs. The Jobs menu offers a centralized view
of on-going, queued, completed, and aborted jobs (manually stopped or in error).
REMEMBER The cancelled status is for jobs that were stopped manually.
1. Select Jobs in the left side menu panel.

Result: The Jobs overview page displays.
2. Use the tabs to display the jobs per category.

Example:
3. Optional: Click the link in the ID column to display the details for the specific job.
4. Optional: Click the link in the Server column to display the information for the server running the
job is run.
5. Optional: Click the link in the Service column to display the specific service information related to
the job.
Create a job
Create one or multiple jobs on a service.
Prerequisites:
1. Display jobs.
2. Click Add job to create a job.
Result: The Job settings options display.
3. Configure the job and click Apply.
• You can also use http and https.
Example: Syntax uses file:// for remote NAS (requires mount point):
Example: Syntax uses file:/// for local or absolute path to mounted storage:
Result: If the service is currently running, then the Job launches automatically. The .ts and/or .mp4
files are generated in the defined output folder. Jobs set with the same priority are launched in
order, per job creation date.
TIP • Click to stop a job before completion.
• Click to view details (monitoring).
4. Optional: Configure:
• Custom settings
• Advanced settings
• PCM audio mapping
Delete Jobs
You can delete jobs one by one, or delete all jobs configured for the service.
processing type.
• Services only display as a link if there is specific service information do display.
Example:
3. Click to delete a single job, or Delete all to delete all jobs for the service.
• Delete a single job:
• Delete all jobs for the service:
Example:
Result: You are prompted to confirm.
Stop jobs
You can stop a single job or cancel all to stop all running jobs configured for the service simultaneously.
Prerequisites:
You are connected with the correct access rights.

processing type.
• Services only display as a link if there is specific service information to display.
Example:
3. Click in the Actions column to stop a job.
Example:
Result: The job status changes to cancelled.
Cancel all running jobs

Cancelling running jobs stops job immediately, resulting output will not be complete.
Prerequisites:
processing type.
Example:
3. Click Cancel all to instantly kill all running jobs.

Example:
View job details

processing type.
Example:
3. Click
Result: Job details display for the specific job.
Example:
NOTE Logs provided by Log manager can help viewing Log Manager details for a specific job
can help determine what happened if an error occurs.
Create a job from an existing job (duplicate a job)

Prerequisites:
processing type.
Example:
3. Click in the Actions column.
Result: The Job creation options display.

4. Enter or edit values and click Apply.

Example:

Prioritize jobs
You can prioritize jobs from 1 to 10. Jobs set to 1 have the highest priority. Multiple jobs can have a same
level of priority. Jobs set with the same priority are launched in order, per job creation date.
processing type.
• Services only display as links if there is specific service information to display.
Example:
2. Click Add job to create a new job or to edit an existing job in the list.
Result: The Job settings display.
3. Set the priority and click Apply.

Example:
Result: The job will be processed before jobs with lower priority.
Create a PCM map for audio

Multi-channel PCM audio is sometimes not declared in input files and presented as independant mono-
channel PCM tracks. PCM mapping allows to configure a mapping to re-create a stereo or 5.1 PCM
stream from multiple mono-channel PCM tracks.
Prerequisites:
Your audio is PCM and requires mapping audio files.
1. Click a service to display jobs.

Example:
2. Click Add job...

Result: The Job settings display.
Example:
3. Expand the PCM audio mapping menu, and select Create PCM map.
Result: A drop-down menu displays.
Example:
4. Select the channel context for the audio files: Stereo or 5.1.
Result: A set of audio track displays depending on the selection.
NOTE You can create multiple maps, for both stereo and 5.1 channels.
Example:
5. You can click to delete the map, but only while you are still in the Job settings window.
IMPORTANT Once you click Apply, the job is created and cannot be edited. To delete a map after
the job is created you must delete the job.
Using Encoding On-demand - Automating encoding with the Watchfolder feature User Guide
Automating encoding with the Watchfolder feature

The Watchfolder features allows you to define specific folder(s) for which each new added content will be
automatically encoded and published.
Prerequisites:
• At least one Encoding On-Demand service is created, configured and started.
IMPORTANT The output of the Encoding On-Demand service must be configured with a base
publishing point.
• At least one job for each Encoding On-Demand service is created and configured.
NOTE Jobs can also be added after the Watchfolder service configuration.
1. Create a new Watchfolder service: Services > Add service > Watchfolder
Example:
2. Enter a name for the service.

3. Open the Monitoring tab to display the list of folders to monitor.
NOTE By default, the list is empty.
4. Click Add folder to define the following folder settings:

• The folder path.
• The filter(s) to apply on the files name.
• The starting date from which files are managed.
• The maximum subfolder depth to manage.
Using Encoding On-demand - Automating encoding with the Watchfolder feature User Guide
5. Click Apply to save the folder settings.

Result: The folder to be watched and managed is defined.
6. Click Add folder to add and configure another folder to be watched and managed.
7. Open the Service Association tab.
NOTE By default, the page is empty.
8. Add the service(s) to associate with the Watchfolder service.

The selected service(s) will encode the files added to the watchfolder.
Result: The associated services are displayed.
9. Save the configuration and exit.

10. Start the Watchfolder service.
Result:
For each file within the folder defined previously, jobs configured in the associated services will be
automatically launched.
Using Encoding On-demand - Network configurations User Guide
Network configurations
Configure mount points

Configure mount points to create access to remote content storage locations. Mount points must be
configured on each Encoding On-Demand processing server.
Mount points must comply to the following criteria:
• They are available at boot time
• MediaKind Encoding On-Demand access input files and output directories with user
ericsson:ericsson, this user must have at least rights for read rights for storage and read write execute
rights for output mount points.
• The default group ID is ericsson:ericsson.
For CIFS, authentication is required to access the Remote Server. Use the credentials below:
user=RemoteServerUsername
password=RemoteServerPassword
For NFS shares, the user ericsson should have rights to the share. In some cases, the user ericsson needs to
be added to a specific group to enable access rights on the share.
For example, when MediaKind Encoding On-Demand is driven by the MediaKind CMS, input files and
directories are created by the CMS with the user nobody:nobody. In this case, the user ericsson needs
to be added in the nobody group to grant access to MediaKind Encoding On-Demand. On each server,
execute the following command:
# sudo usermod -aG nobody ericsson

# systemctl restart ericsson-encoding-on-demand-job-daemon
The last command allows user change to take effect for MediaKind Encoding On-Demand.
1. Open an SSH session as a root user.
2. Enter the following command to create the directory where the remote server location is to be
mounted.
# mkdir -p /opt/mfvp/mnt/LocalDirectory/Storage
3. Set the following user rights:
# chown -R ericsson:ericsson /opt/mfvp/mnt/LocalDirectory/Storage
4. Retrieve the [uid_value] and [gid_value] of the Ericsson user with the following commands:
# id ericsson
5. Mount the remote server on the newly created local directory by editing the file /etc/fstab
# vi /etc/fstab
6. Append the line as seen below in the fstab file.

Example context using CIFS mount points: //RemoteServer/Storage /opt/mfvp/mnt/LocalDirectory/Storage
cifs sec=ntlm,
defaults,rw,uid=[uid_value],gid=[gid_value],user=RemoteServerUsername,password=RemoteServerPassword 0 0
TIP We use CIFS in this example. If you are using a different protocol see linux mount
manuals (online resources) for fstab.
To mount a cifs directory located on //RemoteServer/Storage. RemoteServer can either be
the IP address, or the name of the server used for the remote storage.
Example context using NFS mount points: RemoteServer:/Storage /opt/mfvp/mnt/LocalDirectory/Storage

nfs defaults,user,auto,intr 0 0
Codes and commands Description

//RemoteServer/Storage Remote server to mount to a local directory
/opt/mfvp/mnt/LocalDirectory/ Local location where access to the remote server is mounted
Storage
defaults a common option including the auto mount at boot time
rw gives read write access
ro gives read only access
uid specifies that this mount point is owned by ericsson user
gid specifies that this mount point is owned by ericsson group
user specifies the user credential user needed to access the Remote
Server
password specifies the password credentials needed for the user to access
the Remote Server
7. Manually mount the Remote Server to the local directory:

# mount -a
8. Use the command lines (#) below to test the mount point by creating a mount.test file in /opt/mfvp/
mnt/LocalDirectory/Storage.
# cd /opt/mfvp/mnt/LocalDirectory/Storage
# su -c 'touch mount.test' ericsson
# ls /opt/mfvp/mnt/LocalDirectory/Storage
9. Return to the application and create a job using settings for either option 1 or option 2.
Option 1: using remote location (URL beginning with file://)
a. Input: file://RemoteServer/Storage/CustomInputFileName.ts
b. Output: file://RemoteServer/Storage
Option 2: Using local directory (URL beginning with file:///)
a. Input: file:///opt/mfvp/mnt//LocalDirectory/Storage/CustomInputFileName.ts
b. Output: file:///opt/mfvp/mnt/LocalDirectory/Storage
Configure credentials for direct remote storage access

Format
When a job needs to access a distant storage server with access control, it will parse a specific
configuration file to retrieve credentials. This file must be created and deployed by the user on every
Encoding On-Demand server before creating any encoding jobs.
The file is JSON format and contains an array of URLs associated to credentials.
Each entry contains the following elements:
• url: the base URL of a storage
• type: the type of credential to be used for this base URL. It can be:
• user for access with username and password
• s3 for access using AWS S3 object store credentials
User credential
The entry should contain the following elements:
• username
• password
It can be used for FTP or SFTP URL (ftp://... or sftp://…).
Example:
{ "url" : "sftp://myServer/share1",
"type" : "user",
"username" : "test",
"password" : "1234" }
AWS S3 object store credential

This credential corresponds to an AWS access key.
The entry should contain the following elements:
• accessKeyId: The ID of the access key

• secretAccessKey: The secret access key
It can be used for S3 URL (s3://…).
Example:
{ "url" : "s3://myBucket",
"type" : "s3",
"accessKeyId" : "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey" : "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }
Deployment
This configuration file should be created by the user and needs to be deployed on every Encoding On-
Demand server under the following path: /etc/opt/mediakind/credentials/mkeo.json.
IMPORTANT The file should have the read permission for the user ericsson:ericsson.
Example
When a job is created, it will parse this file to find the associated credentials of the file URL it needs to
access.
For example, if the file contains the following credentials:
[{
"type" : "user",
"url" : "sftp://server1",
"username" : "admin",
"password":"1234"
},{
"type" : "user",
"url" : "sftp://server2/share",
"username" : "admin",
"password":"4321"
}]
If a job input file is sftp://server2/share/video.ts, the second credential will be used: the input URL matches
with the base URL of the second credential.
NOTE The selected credentials configuration is logged into the high-level logs of the job.
Configure NTP
The NTP configuration is explained in the corresponding Installation Guide.
Configure NIC (network)

The NIC configuration is explained in the corresponding Installation Guide.
CHAPTER 4
Managing solutions
Managing solutions - View Encoding On-Demand Reports User Guide
View Encoding On-Demand Reports

The Reports page for Encoding On-Demand offers an overview for a specific period of time. By selecting
a time period you can review the total services, token consumption and total job statistics.
IMPORTANT Depth is 3 months.
1. Select the Reports menu from the left-side menu panel.

2. Select a Time Period using a start and end date.
Example:
Result: The table updates.

3. Optional: You can use the Filter bar to keyword based search.
4. Optional: Click Export to download the table in a .csv file.
NOTE The csv file also contains details per day.
Managing solutions - Manage services User Guide
Manage services
Display services
Services are listed in a table and are associated to a specific processing type. Service parameters and
options depend on the processing type.
Prerequisites:
At least one service is configured.
1. Click Services in the left-side menu panel.
TIP The Services page is also available from Home > Services.
Result: The table of services displays.
2. Optional: Edit the number of rows displayed or use the search bar to filter the display.
Create a service
Service configurations vary per processing type. See the specific product user guide for detailed
information about service creation.
2. Click Add Service.
Example:
3. Select a processing type.

Result: The service parameter options display.
4. Configure the service parameters.

IMPORTANT Parameters vary per processing type.
5. Assign a server to the service.

NOTE Multiple servers may be assigned to a same service.
6. Use the buttons in the action column to start or stop the service.
Assign a server to run the service

Services require a server to run. Select a server for each service before starting the service.
2. Click the field in the Mandatory column to display available servers.
3. Enter a server name or select a server from the list, then repeat for each service to run.
4. Optional: Click to display service details and to monitor the service.
5. Optional: Start the service.
Assign additional servers to a service

You can assign additional servers to a service to help with load balancing. Encoding services are launched
on the primary server. When used with multiple servers, job are allocated on servers depending on their
CPU usage.
2. Enter a server name or select a server from the list, then repeat for each service to run.
Example: This configuration below is an example and may not apply to all processing types.
NOTE The service runs processes on the first server in the pool. Then, uses any additional
resources in the pool job depending on their CPU usage.
3. Optional: Click to display service details and to monitor the service.

4. Optional: Start the service if it is not currently running.
Unassign a server from a service

Services require a server to run. Select a server for each service before starting the service.
2. Click X to remove.
Example:
Result: The server is removed and is unassigned from the service.

NOTE Jobs that are running on an unassigned server are cancelled and put back in the queue
to be started again on another server.
Export a service configuration

Exported service configurations are for importing onto a different MediaKind system. This is useful for
product or production support, or testing (parameters and expected function).
IMPORTANT Export is only available for Live Encoding and On-Demand Encoding services.
Exports exclude the service state (started or stopped).
Importing service configurations may require manually starting or stopping other
services.
2. Click to export.
Result: A file downloads to the Web browser default location.
IMPORTANT The download date in the file name is in the following format: YYYY/MM/DD
Import a service
Import a single service to a different server where the service is not currently configured. Import files
must match expected formatting requirements.
Prerequisites:
A .json for the service is available. (see the Export a service configuration on page 71 section)
IMPORTANT • Services on a same server require unique service names.
• Only import the service to a server where the service DOES NOT currently exist.
REMEMBER Files for import are retrieved from a service export from a different server.
2. Click Import service...

3. Click Select file to browse for the .json file previously exported for this service.
Example:
4. Click Import.
Result: The service imports and appears in the list of services.
Start a service
Services can be started and stopped manually from the Services page.
Prerequisites:
At least one service has been created and is available in the list of services.
2. Click the field in the Server column to assign the service to a server.
NOTE Multiple servers may be added for a same service.
3. Click to launch the service.

Result: The Status is started.
NOTE If an alarm is raised:
• Click to display all alarms.
• Alarm colors are based on severity.
Stop a service
IMPORTANT Stopping a service cancels any jobs in progress.
TIP Use the rows per page or the search bar to filter multiple services and to find a specific
service.
2. Click in the Actions column to stop the service.

3. Click Yes, Stop it!
Result: The service stops running and the service status displays stopped.
NOTE Jobs that are running on a stopped service are cancelled.
Delete a service
Deleting a service removes a service from the list of available services.
Prerequisites:
A service exists.
2. Click in the Actions column to delete the service.
3. Click Yes, delete it! to confirm.
Result: The service is now removed from the services table and is no longer available.
Configure advanced parameters for an existing service

3. Click to display advanced parameters.
4. Enter the parameters and click Add advanced setting.
TIP You can add multiple advanced parameters to the service.
5. When finished, click Apply.

6. Required: Click Save and continue before continuing in order to avoid losing the configuration.
Managing solutions - Manage servers User Guide
Manage servers
Display servers
Servers are listed in a table. You can view server settings and usage statistics per server.
1. Click Servers from the left-side Menu panel.
Result: The table of servers displays.
2. Optional: Edit the number of rows displayed or use the search bar to filter the display.
Display server information (system)

Check server functions and performance to manage server and service allocation, or to view license
information. System settings and information displays for each server.
1. Display servers.
2. Click in the Actions column to view server information.
Result: Information based on the server type displays.
3. Click the tabs to display server information.
• General
• System Settings
• Statistics
• Licenses
Example:
Managing solutions - System administration User Guide
System administration
System center
Management and administration features for SNMP settings, users, backup, and restore are available in
the System Settings menu ( ).
Backup and restore

Backup and restore configurations
Backups include services, server definitions, and locally defined users. You can back up your
configurations to restore a previous configuration (for upgrades or rollbacks or after a server crash, etc.)
NOTE • Access to configurations is blocked while a backup or restore is in progress.

• Up to 30 backup files are supported for local backups.
• The oldest backup is deleted once 30 backups are detected.
Backup database configurations

Create a backup of MediaKind configurations to save a version locally or on a remote server.
Display backup MediaKind database options

Back up the MediaKind configuration to a local or remote server. Backups include services, servers, and
users. Backups are time-stamped.
1. Click in the upper-right corner of the screen.
Result: The System Center menu displays.
2. Select Backup.
Result: The Backup Controller Database options display.
Create a local backup

Local backups of MediaKind settings are still accessible even when no remote access is possible. Backups
only include the list of servers, services, and user configurations.
1. Display backup options.
Example:
NOTE • The Host, Port and Path are only required for a remote backup.
• FTPS is also authorized.
Result: Local Backup is selected by default.

2. Click Backup now.
Result: The backup is stored on the local drive.
Create a remote backup

Create remote backups to restore MediaKind settings from a remote server using FTP or FTPS.
1. Display backup options.
2. Select Remote backup.
Result: Required fields are highlighted.
3. Enter the required remote backup settings information.

NOTE FTPS is also authorized.
Example:
IMPORTANT Editing the backup file storage location impacts scheduled backups.
4. Click Backup Now.
Schedule an automatic backup (periodic)

Set a schedule to back up the MediaKind database on a regular basis: weekly, daily or hourly. Backup
guard times may impact backup availability.
1. Enable the scheduled backup.
2. Select the backup schedule time.
NOTE The time stamp is based on the current time on the Controller server.
3. Open the Backup Location tab to set the backup file storage settings, if they are not currently
configured.
4. Save and exit.
Restore configurations
Restore configurations for recovery or troubleshooting. You must have already created a local or remote
backup in order to restore. Backups are selected based on the backup time stamp.
IMPORTANT • The Database is inaccessible until the restore completes.

• Only one restore can be launched at a time.
• Alarms and statistical data are not restored because they are dynamic.
• The alarms banner is not displayed until the restore completes.
Display restore options

You can restore the MediaKind database configuration from existing local or remote backups.
1. Click in the upper-right corner of the screen.
Result: The System Center menu displays.
2. Select Restore.
Result: The Restore Controller Database page displays.
Restore configurations from a remote backup

1. Display restore options.
2. Select Remote Backup.
3. Select a Year > Month > Backup.
NOTE • Available backups are time-stamped.
• Be aware of backup guard time configurations to ensure availability.
Example:
4. Click Restore.
IMPORTANT The Controller is unavailable to all users until the restore completes.
Restore configurations from a local backup

1. Display restore options.
Result: Local Backup is selected by default.
2. Expand the Backup drop-down list to display available backups, then select a backup to restore.
NOTE • Available backups are time-stamped.
• Be aware of backup guard time configurations to ensure availability.
3. Click Restore.
Result: All users are temporarily assigned to the Monitoring user group until the restore completes or
is terminated.
User management
Manage users
Administrators have rights to create users and assign groups. User groups reflect different user roles with
specific permissions. Permissions authorize access to MediaKind applications, menus and features.
IMPORTANT Menu options depend on your processing type and product installation.
User groups
A user group is a set of access rights and permissions. Permissions authorize users to either display or edit
configurations. Users are assigned to at least 1 user group. A user can be assigned to multiple groups.
NOTE New users are automatically assigned to the Monitoring group.
User group permissions

There are 3 default user groups. Permissions are either Read (R), Write (W), or Read and Write (R/W).
Yes means the user group can carry out the action, but may be limited to specific options.
IMPORTANT User group options depend on your processing type and product installation.
Admin Configuration Monitoring API

Services R/W R/W R R/W
Servers R/W R/W R R/W
Templates R/W R/W R R/W
Failover R/W R/W R R/W
Alarms and Stats R R R R
Settings R/W N/A N/A R/W
Restore Yes Yes No N/A
Admin Configuration Monitoring API

Backup Yes Yes Yes N/A
User R+W N/A N/A N/A
Management
Display the list of users

1. Click in the upper right corner of the window.
2. Select User Management.
Result: The User Administration page displays.
3. Select Users.
Result: The list of users displays.
TIP Scroll to the end of the list to display the total number of users.
Create a new user

The MediaKind Controller is a single access point for MediaKind products. Administrators manage
users, groups and permissions from the system center.
1. Display users.
2. Select Add User.
Result: You are prompted to enter User information.
3. Enter the User information.
• Username
• Password
IMPORTANT • An Admin user can edit or create other Admin users and profiles, including
passwords and permissions.
• Password is case sensitive.
4. Select a Save option.

5. Assign a user to a group to manage user access rights and permissions.
Result: By default, new users are assigned to the Monitoring group.
Assign a user to a group

Groups are a set of access rights and permissions. Permissions authorize users to either display or edit
configurations. Give a user access rights by assigning the user to a group.
1. Display users.
2. Click the user in the list to display user information and permissions.
3. Scroll to Permissions and use the arrows to add the group to the list of Chosen groups.
Example:
TIP You can add multiple groups, or click Choose all to assign the user to all available
groups.
Example:
4. Click Save.
Link LDAP or Active Directory

The MediaKind Controller can be linked with an external server (LDAP or ActiveDirectory) to identify
and authenticate users. If activated, the authentication page displays before granting access to the Home
page.
NOTE • The LDAP connection parameters are defined in a dedicated configuration file.
• If using LDAP, then the MediaKind Controller neither stores nor manages user
passwords that are managed by the external LDAP server.
• Users defined on the external server can coexist with locally defined users.
See the Installation manual for LDAP configuration procedures.

Result: When users are first installed from the LDAP or ActiveDirectory server, they are automatically
assigned to the Monitoring group. Administrators can edit user groups to manage permissions and access
rights.
Edit user information

1. Display users.
2. Select a User.
3. Edit the user information:

NOTE An Admin user can edit or create other Admin users and profiles, including passwords
and permissions.
• Username
• Password
• Personal information
• Permissions
4. Select a save option to continue or exit.
Edit a user password

Any user can edit their password, but only users with admin or configuration permissions can edit
passwords for other users.
1. Display the list of users in the System Center.
2. Click the current Admin user from the list to edit.
3. Click the link as shown in the example below to change the password.
Example:
4. Optional: Edit user profile settings, then Save.
Save options for user management

Save Option Result
Save the user is added to the list
Save and continue additional user information displays (groups and
permissions)
Save and add another user is added to the list and the add user page is
refreshed to add another new user
License management
Manage licenses
MediaKind solutions offer flexible licensing models. Each model depends on your solution and
installation options. A service can be configured but can only be processed for a limited period of time
without a license (grace period).
License servers and installation

The license manager is a micro-service application installed on a server, or on 2 servers if in redundancy
mode. By default, the Controller hosts this application that is identified by a Licensing processing type.
The license manager may also run on dedicated servers for very large configurations.
TIP View license details per feature to display:

• license usage per feature
• license codes
• license expiry dates in Universal Time (UTC)
Display license details

There is a license code per feature. Licenses are required for features and options in the MediaKind
solution and have expiry dates.
IMPORTANT • Licenses are managed by a License Manager.

• The License Manager is a micro-service application installed by default on the Controller
server or a dedicated license server.
• There may be more than one license server if your solution is installed in redundancy.
1. Display servers.
Result: The servers display.
2. Click for the server with the Licensing processing type.
NOTE The Licensing processing type may display for the Controller server if the licensing
manager is installed on the same machine as the Controller.
3. Select the Licenses tab.

Example:
Result: The license information displays.

NOTE All time stamps are in Universal Time (UTC).
Request license file

This is your first time connecting to your MediaKind user interface and you want to request a license file.
1. Display license details.
Result: The licensing information displays for the specific server.
2. Copy the locking code, including the asterix (*) and paste into the email or file you plan to send to
MediaKind.
Example:
IMPORTANT In redundant solutions:

• Multiple locking codes display per server.
• Provide both locking codes.
3. Copy and paste the LAC reference number for your Software Handling Community to the same file
or email and send to your MediaKind representative.
NOTE The LAC reference number and the Software Handling Community details are in the
software Delivery Note. See software installation package.
Import license file

New license files are available from the support center.
Prerequisites:
• The new license file needs to be available on the machine.
• Only configuration and admin users can import license files.
1. Display the license details.
Result: The licensing information displays for the specific server.
2. Click Import license > Select file to browse and select the file to import.
Example:
Result: A summary displays.

TIP If an error occurs, keep a copy of the error number and contact support.
Revert to the previous license file

This feature is helpful when solving import errors that restrict license use. Only use if MediaKind
support staff approves a revert.
1. Display the license details.
2. Click Discard last import.
Example:

3. Click OK to confirm.
Result: The last license file import is discarded and the previous file is used.
Display license token usage

Use the Reports menu to review the Encoding On-Demand license usage.
License information details

License information displays in a table. View information on license usage and availability per feature.
Find license codes (FAT codes) for administration and support.
NOTE All time stamps are in Universal Time (UTC).
Encoding On-Demand licensing

Tokens represent processing capabilities that can be acquired and released over time. The license contains
a fixed amount of tokens of different types. The interactions between Encoding On-Demand and the
license system are limited to the worker.
The transcoding worker is using 5 different tokens, all specific to On-Demand processing capabilities:
• video processing (FAT 102 3464/97): for encoding video/audio
• Dolby decoding 2.0 (FAT 102 3464/98): for decoding one audio, =< 2.0 channels
• Dolby encoding 2.0 (FAT 102 3464/99): for encoding one audio, =< 2.0 channels
• Dolby decoding 5.1 (FAT 102 3464/100): for decoding one audio, > 2.0 channels
• Dolby encoding 5.1 (FAT 102 3464/101): for encoding one audio, > 2.0 channels
Video processing tokens

Video processing tokens are requested when the worker starts. The amount of token requested depends
on the CPU capabilities required by the processing. The worker then repeatedly synchronizes with
the license server to know the number of token needed by introspecting its CPU usage and requesting
or releasing extra tokens. As long as a single token has been acquired by the worker at start-up, the
processing is expected to run to completion, even though extra tokens are not available later in the
processing. Given that the license contains at least one token, a worker performing the transcoding
task of job that can not acquire a single token (request at start-up is rejected because all the tokens have
already been acquired by concurrent processes) will stop and the job will be retried.
Whenever the first token cannot be acquired (due to connection problems with the license server or
absence of video processing tokens in the license for example), the job is expected to fail after a timeout.
Some amount of processing can perform during this timeout.
At the end of processing, the worker releases tokens.
Dolby related tokens

A Dolby token is needed for each Dolby stream processing (decoding and encoding).
Dolby tokens are specific to the channel layout of the given stream.
If no 2.0 token (either decoding or encoding) is available on server, a 5.1 token will be taken instead.
Basically 5.1 tokens “include” 2.0 token.
NOTE Contrary to video processing token, the lack of available Dolby-related token will always
generate a job failure (no retry).
Managing solutions - Generating a support package User Guide
Generating a support package

A support package includes files that allows support teams to recreate your system configurations for
testing and troubleshooting.
CAUTION Your computer must be in the Network’s trusted zone to generate a support package. See
the section Network security in the Security Guide or contact an administrator. Generating
a support package from a computer in the untrusted zone may redirect you to an unsecured
HTTP access using port 8080.
To generate a report package, follow these steps:

1. Display servers.
2. In the Actions column, click
Result:
The following page is displayed:
3. Follow the steps in the Support zone (see image above) to generate the package and to contact
support.
CHAPTER 5
Parameters glossary
NOTE • Multiple definitions may exist for some parameter names. For example, parameters
that have the same name but are used in different configuration contexts.
• Parameters may depend on your processing type and product installation.
Parameters glossary - License parameters User Guide
License parameters
Licensing server started: the server is running and available.
status
Licensing version License software version installed on the license server.
Feature Processing options per processing type.
Code The license code used to identify the feature.
Expiry The date when the feature is no longer available unless the license is renewed.
Usage The current use of licenses in relation to the total of available licenses.
Count The total licenses currently used in relation to the total of available licenses.
Related Concepts
Manage licenses on page 83
MediaKind solutions offer flexible licensing models. Each model depends on your solution and
installation options. A service can be configured but can only be processed for a limited period of time
without a license (grace period).
Parameters glossary - Input parameters User Guide
Input parameters
Video stream input parameters

Video selection and media processing parameters are used for video pre-filtering, video adjustment and
video colorimetry.
Video pre-filtering
Deblocking filter Remove the MPEG-2 blocking artifacts. This filter is fully
automated to remove the blocking and ringing effects.
Cross-talk filter Remove noise by processing noise in the source frame by
frame. Also reduces cross-color and cross-luminance artifacts
remaining in the input video.
Spatial denoising filter Remove noise by processing noise in the source frame by
frame.
Diamond filter Remove noise by processing noise in the source frame by
frame. In Adaptive mode, adapts the filtering strength and
uses both edges and noise detection filters to choose areas to
filter.
MCTF Remove noise by processing noise in the source with a
temporal factor. Has a 7 -frame rolling window. In Adaptive
mode a noise detection filter adapts the filter strength.
Video adjustment
Crop overscan Remove the input video overscan area from each edge (left,
top, right and bottom).
Adaptive inverse telecine Select to detect 30/60fps telecine contents and convert them
to 24fps.
Aspect ratio Select the Auto option to pass-through from WSS and AFD
information, or force to a specific ratio.
Noise edge removal Number of lines removed from the top of the video (up to 6
in SD and 14 in HD).
Video colorimetry
Brightness Define the content's relative lightness or darkness..
Possible values: From -100 to 100
Contrast Define the separation between the darkest and brightest

areas..
Saturation Saturation increases the separation between colors, whereas
contrast increases the separation between shadows and
highlights..
Temperature Define a color's perceived warmth or coolness..
Hue Define a color's perceived purity..
Gamma Increase Gamma to make an image look brighter. However,
being non-linear, this only increases brightness of the
shadows and mid-tones in an image, without affecting the
highlights.
Closed Caption
Select Select the Closed Caption tracks to include in the output.
The tracks can be added by generating a TTML file in
output.
Language Specify the language for the Closed Caption track. Entries
must comply with ISO 639_2 language standards. One entry
per track.
Track ID The number assigned to a Closed Caption track used to
identify the track.
Related Tasks
Edit video input on page 32
New services use a default input stream selection and configurations.
Audio input parameters

Selection
Selection The encoder selects the first track that matches the defined
codec and language criteria.
Codec Set your codec selection criteria. You can select multiple
codecs and order them using drag and drop. The first codec
to match the selection in the defined order is used. Use any
to match with any codec.
Language Set your language selection criteria using the ISO639-2

format. You can select multiple languages and order them
using drag and drop. The first language to match the
selection in the defined order is used. Use any to match with
any language.
PID Enter PID(s) and validate using the space bar. The first
PID to match the selection in the defined order is used. Use
"any" to match with any PID. A PID is a number between
16 and 8190
Audio processing
Default language Default language is used when there is no language specified
on the ingested stream. Use ISO639-2 format.
Gain Amplify or attenuate the incoming signal.
Target loudness Maintain the audio level at the level defined by the Target
loudness parameter.
Loudness refers to the perceived strength of a piece of
audio (music, speech, sound effects, etc.). It is defined
by International Telecommunication Union in ITU-R
BS.1770.
The result is a value expressed in either LKFS (Loudness K
weighted Full Scale).
Loudness can be measured on mono, stereo and 5.1
audio signals. In the case of 5.1 audio signals, the five
main channels (left, center, right, left surround and right
surround) are considered. The LFE (low frequency effects)
channel is excluded from the measurement. Loudness
measurement is done in several steps.
Encoding On-Demand algorithm: The loudness level of the
first minute of the asset is measured before actual encoding.
The measured value is used to initiate the algorithm and
correctly adjust loudness at the very beginning of assets or
for short assets. Then the algorithm regularly measures and
adjusts the loudness all along the asset to keep the target
level.
NOTE: For more information, refer to the dedicated
Technical Note, "Target Loudness
Management".
Audio delay Adjust the delay between audio and video. Example: helps
resolve lip sync issues.
Possible valuesFrom -300 to 300
Downmix channels compression Select a mode for Dolby input stream downmixing from 5.1
mode to stereo.
Related Tasks
Add an audio input on page 33
Edit input stream selection parameters on page 31
Subtitles input parameters

Selection
Type Select the subtitle based on its stream type.
Subtitle processing
Table 1. Parameters for the following subtitles types: DVB, ARIB B24, SCTE27 and Teletext
Default language Enter a language according to ISO639-2 language standards.

This language is used to specify the subtitle track language.
The specified language will be defined as default if no
default language have been defined in the input files.
: Click the Force language button to set the
specified language as default over the default
language defined in the input files.
Table 2. Parameters for the following subtitles type: Subtitle file
Default language Enter a language according to ISO639-2 language standards.

This language is used to specify the subtitle track language.
Filename pattern The file pattern is relative to the input file directory.
Following file pattern are supported: {inputFileName}.
Delay Delay from video start time in ms.
Charset Optional, default "auto". Only SRT, it could be used to
force file decoding method to "ansi" or "utf8". In case
of "auto", worker will try to auto-detect file encoding or
otherwise use "ansi".
Related Tasks
Add a subtitle input on page 35
Metadata input parameters

Selection
Type Select the metadata based on its stream type.
Teletext processing
Max bit rate Set the max bit rate of the teletext stream. When under
estimated, some underflow may appear in the output,
resulting in a job failure with an explicit message.
SCTE-35 processing
Source Select the appropriate source for SCTE-35. It can be out-of-
band (provided through job metadata) or in-band (provided
by the asset itself, through an embedded SCTE-35 track).
Related Tasks
Add a metadata input on page 35
Parameters glossary - Encoding parameters User Guide
Encoding parameters
Video stream encoding parameters

Video encoding
Rate control Define how the bitrate is managed for this service, either
constant bit rate (CBR) or constant video quality (CVQ).
Target bit rate Bandwidth used to encode the video stream.
Possible values:From 100 to 40000 (MPEG-2), 50000
(H.264), 120000 (HEVC)
Resolution Define the frame size of the video stream (width x height).
Maximum resolution depends on codec..
Possible values: Depends on codec.
Coding mode Frames will be encoded either in progressive or interlace
mode. Interlace mode is commonly used for set top boxes
and is adapted to SD or 1080i (HDTV) resolutions..
Frame rate Select the possible output frame rates. The actual output
frame rate depends on input frame rate..
Codec Different codecs (MPEG-2, H.264, HEVC) can be used to
encode the content. Select a codec and its profile for each
video stream..
Quality preset Different tradeoffs between video quality and density. CVQ
rate control is optimized for High quality and Fast presets.
Stream conditioning SCTE-35 stream considered to condition the video. IDR
frames are inserted based on SCTE-35 cue points to prepare
the stream for downstream ad-insertion and replacement
scenario
Subtitle burn-in Select a subtitle stream to burn-in if required, otherwise
leave None. A subtitle must be configured in the Input
stream configuration to be available for selection.
Codec settings
Buffer duration Define the size of the video buffer. The video buffer is the
standard MPEG-4 VBV (Video Buffering Verifier). The
instantaneous bitrate smoother (transmission buffer) ensures
that the instantaneous bitrate never exceeds the target
bitrate.
B-frames Modes: Auto: Allows the encoder to choose the number

of B-frames depending on the source. OFF: Disable B-
frames. Select 2 or 3 to set a fixed number of B-frames (not
applicable for MPEG-2).
Entropy coding Entropy coding can be defined as CABAC (Context-based
adaptive variable-length coding) or CAVLC (Context-based
adaptive binary arithmetic coding).
Frame/field coding mode The mode depends on the selected Codec. Options include:
Frame only when each image is considered progressive.
Frame with MBAFF when each image is encoded as
progressive with a interlaced/progressive choice at the
macroblock level. PAFF when each image is encoded as
either progressive or interlaced. PAFF with MBAFF so
the recommended setting automatically detects the best
encoding option for each frame. Field only when each image
is considered interlaced. SAFF when each GOP is either
encoded progressive or interlaced (HEVC only).
Dynamic range mode Follow input leaves input format unchanged. Otherwise, the
color space is converted if necessary: tone mapping (HDR to
SDR) or inverse tone mapping (SDR to HDR).
GOP settings
GOP duration Time between two key frames. Key frames are used to sync
with the stream to start decoding it properly.
Possible values: From 1000 to 10000
GOP policy Values: (1) Open: reference frames can be picked across the
GOPs. (2) Closed: all the reference frames must be in the
same GOP. Impact depends on player capabilities.²
GOP duration mode Fixed: IDR frames are strictly generated every GOP
duration. Adaptive: I/IDR frames are inserted when needed,
depending on the video stream sequence. Maximum time
elapsed between two I/IDR frames is set using the GOP
duration parameter.
I-frame insertion Fixed closed GOP, with interval I-frame insertion mode sets
the maximum interval between IDR and I-Frames inside a
GOP.
Aspect ratio
Insert AFD If present at the input, AFD (Active Format Description)
information will be added in the output stream.
Downscaling Method applied to the video when downscaled from HD

16:9 to SD 4:3. The Anamorphic type dynamically adapts
the pixel aspect ratio (width x height) per frame. Letterbox
inserts black stripes to fit the target ratio.
Top The percentage of the image to crop from the top.
Bottom The percentage of the image to crop from the bottom.
Left The percentage of the image to crop from the left.
Right The percentage of the image to crop from the right.
Output aspect ratio Select an Output aspect ratio.
Zoom Zooming reduces the size of the black stripes that are
inserted when using the Letterbox downscaling method.
Setting Zoom to 100% removes the black stripes but the
image will be cropped.
Stream metadata settings

Insert closed captions If selected then closed captions present in the input will be
added in the output stream..
Insert VUI timing info Insert VUI (video usability information) timing info in the
video. This is usually used by players such as set-to-boxes to
get the video framerate
Insert HRD signaling HRD signaling is used for compliance testing..
Related Tasks
Add a video encoding on page 37
Video encoding is set of video encoding configuration options applied to a video. For example, resolution,
rate control, bit rate, etc.
Edit encoding on page 36
MPEG-1 Layer II audio encoding parameters

Audio Encoding
NOTE Parameters display in relation to the Channel mode and Codec.
Input Define the selected stream to encode..

Codec Different codecs can be used to encode the content. Select a
codec for each audio stream..
Channel mode Number of audio channels in the encoded audio track..

Bit rate Bandwidth used to encode the audio stream..
Sampling rate Number of audio samples per second defined in Hz..
Related Tasks
Add an audio encoding on page 38
Dolby Digital audio encoding parameters in stereo channel mode

Audio Encoding

Basic parameters
Dialog normalization Metadata parameter that controls playback gain..
Dolby Surround mode Decoders can use this flag to automatically switch on Pro
Logic decoding..
Advanced parameters
DRC Line Mode Profile The Dynamic Range Control restricts the signal's absolute
peak level for a decoder using the line mode..
DRC RF Mode Profile The Dynamic Range Control restricts the signal's absolute
peak level for decoder using the RF mode..
DC highpass filter A DC-blocking 3Hz highpass filter applied on the main

Dolby channel. Used to remove DC offsets in the program
audio. Only switch off in exceptional circumstances.
Related Tasks
Dolby Digital audio encoding parameters in follow input channel mode

Audio Encoding

Basic parameters
LFE Lowpass Filter This parameter determines whether a 120 Hz eighth-order
lowpass filter is applied to the LFE channel input of a Dolby
Digital encoder prior to encoding.
Dialog normalization Metadata parameter that controls playback gain..
Dolby Surround EX mode Amplifier or receiver with Dolby Digital Surround
EX decoding that can use this parameter as a flag to
automatically switch the decoding On or Off..
LFE enable The status of the LFE Channel parameter indicates whether
an LFE Channel is present within the bitstream.
Advanced parameters
DRC Line Mode Profile The Dynamic Range Control restricts the signal's absolute
peak level for a decoder using the line mode..
DRC RF Mode Profile The Dynamic Range Control restricts the signal's absolute
peak level for decoder using the RF mode..
90 Degree Phase Shift This parameter causes the Dolby Digital encoder to apply a
90-degree phase shift to the Surround channels.
3 dB Attenuation Attenuates the Surrounds channels by 3 dB before
encoding..
Lo/Ro Center Mix Level Level shift applied to the Center channel when added to the
left and right outputs as a result of downmixing to an Lo/Ro
output..
Lo/Ro Surround Mix Level Level shift applied to the Surround channels when
downmixing to an Lo/Ro output.
Lt/Rt Center Mix Level Level shift applied to the Center channel when added to the
left and right outputs as a result of downmixing to an Lt/Rt
output.
Lt/Rt Surround Mix Level Level shift applied to the Surround channels when
downmixing to an Lt/Rt output.
Stereo Downmix Preference This parameter allows to select the preferred downmix
method for decoders that has stereo outputs..
Related Tasks
Subtitle encoding parameters

NOTE Subtitle encoding parameters may vary in relation to the subtitle Type selected in input
parameters.

Codec Different codecs or formats can be used to produce
subtitling. Select a codec for each subtitle stream.
Adjust display height Enabling this option ensures that the subtitles display
correctly after resizing. DVB Subtitle or SCTE-27 subtitles
are sometimes out of the picture after a resize is performed.
Related Tasks
Add a subtitle encoding on page 39
Metadata encoding parameters

Metadata encoding
Input Define the selected stream to encode.
Related Tasks
Add metadata encoding on page 39
Parameters glossary - Output parameters User Guide
Output parameters
Output files
TS filename TS files are sent to the mount point along with output files.
TS files are then available for packaging.
TTML filename Generate TTML files from subtitles tracks in the input
selection. Files are sent to the mount point along with
output files. TTML files are then available for packaging.
ESAM filename Generate ESAM files to include SCTE-35 conditioning
information. ESAM files are sent to the mount point
along with output files. ESAM files are then available for
packaging.
MPEG2-TS output parameters

General parameters
Manifest file name When used with MediaKind Packaging, enter the name of
the manifest file to create. Otherwise leave blank and no file
will be created.
Example: manifest.mpd
Base publishing point Enter the file path or the URL using FTP or SFTP to be
used as default publishing point for the service. Leave blank
to manage the publishing point at the job level.
Output subfolder Build output subfolder(s) name structure with suggested
keywords to dynamically organize and store published jobs.
Subfolders are created within the base publishing point.
Keywords Select keyword(s) to dynamically customize field values
when a job is launched.
Output parameters
Conditioning for ITV When output targets an internet TV context, the GOPs
needs to be synchronized accross all the stream of the lineup.
The signaling of how the streams are synchronised is defined
by this value. When set to None, mpeg2ts RAP flag is set on
all the video IDR frames.
Conditioning for audio When ALD or EBP signaling is chosen to condition the
output for ITV, audio streams can also be signaled.
Interleave When activated, TS packetization is performed to interleave

audio and video.
Common MPEG-2 TS parameters

Standard MPEG-2 TS information is encapsulated to fit the ATSC or
the DVB standard..
PMT PID Enter the packet identifier of the Program Map Table. This
table defines the structure of the MPEG2-TS stream.
PCR PID Enter the packet identifier of the Program Clock Reference.
This clock is used to synchronize audio and video packets. If
left blank, the PCR PID is set to the output Video PID.
Target PCR period The target time between two PCR information..
Possible values: From 20 to 1000 Milliseconds
Target PSI period The target time between two PSI information.
Possible values: From 20 to 1000 Milliseconds
Program number Associated to a specific program. Commonly used in MPTS
to differentiate programs within the same MPEG-2 TS
stream.
Service name Service name added to the service description table (SDT)..
Service provider Service provider name added to the service description table
(SDT)..
Video frames alignment on PES Each new frame starts with a new PES packet. If a frame
packets finishes before the end of a PES packet then it is filled with
stuffing information. Bandwidth is increased if activated.
LATM encapsulation for AAC Support for both ADTS and LATM encapsulation are
available for AAC audio tracks..
MP4 output parameters

General parameters
Base publishing point Enter the file path or the URL using FTP or SFTP to be
used as default publishing point for the service. Leave blank
to manage the publishing point at the job level.
Output subfolder Build output subfolder(s) name structure with suggested

keywords to dynamically organize and store published jobs.
Subfolders are created within the base publishing point.
Keywords Select keyword(s) to dynamically customize field values
when a job is launched.
Output parameters
Prepare for streaming Insert hint track in mp4 files to prepare for streaming. Note
that this option is Incompatible with HEVC, Dolby digital
and Dolby digital plus codecs.
Progressive download Inserting moov atom at the beginning of the mp4 file to
optimize progressive download.
Parameters glossary - Post Processing User Guide
Post Processing
Post processing parameters
Post Processing
Post processing type Select a post processing type to apply. Post processing occurs
once all other processing is complete.
Catalog id Enter the ID of an existing packaging catalog.
Parameters glossary - Job settings User Guide
Job settings
Job settings parameters

Service The name of the service associated to this job.
Id The id associated to this job. If left blank then an id is
automatically generated and assigned to the job.
Name The name associated to this job. The name displays in the
list of jobs.
Priority The priority associated to this job. Priority determines how
the job is managed and run in relation to available resources
and other jobs.
Input file The input file absolute path, FTP, SFTP, S3 (Amazon
Simple Storage Service) or URL using http or https for the
asset associated to this job.
Example file paths: Use either ftp://, sftp://, http://,
https://, s3://eu-west-1.amazonaws.com/filename.ts or
file://10.86.78.222/Storage/input/filename.ts (syntax using
the remote storage IP address) or file:///mnt/Storage/input/
filename.ts (syntax using a mounted directory).
Publishing point Enter the file path or the URL using FTP or SFTP to create
for this job a publishing point different than the one defined
at the service level. Example file paths: Use either ftp://,
sftp://, http://, https://, s3://eu-west-1.amazonaws.com/
filename.ts or file://10.86.78.222/Storage/input/filename.ts
(syntax using the remote storage IP address) or file:///
mnt/Storage/input/filename.ts (syntax using a mounted
directory).
Advanced settings
Start time You can define a specific start time for the input file (asset).
No start time means that the start takes place at the begining
of the asset.
Example format: hh:mm:ss:sss
End time You can define a specific end time for the input file (asset).
No end time means that the end takes place at the end of the
asset.
Example format: hh:mm:ss:sss
Parameters glossary - Job settings User Guide
DAI metadata Enter the DAI metadata to describe splice points. Either
select a preformatted XML file that will be encoded to
base64 once uploaded, or paste the base64 data directly into
the text field.
Parameters glossary - Watchfolder settings User Guide
Watchfolder settings
Watchfolder settings parameters

Path Base path of the folder to monitor.
Filters List of file filters separated by a comma.
Wildcards are available to replace any character (e.g. "*, *.ts,
*.mp4, input*.mov").
Modified after Last date of file modification.

Maximum depth Max depth starting from the current path. No value means
infinite depth.
Related Tasks
Automating encoding with the Watchfolder feature on page 60
The Watchfolder features allows you to define specific folder(s) for which each new added content will be
automatically encoded and published.

MKD 10 00382 01 05 EncodingOnDemand MS UserGuide - v12.0 - RA

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

MKD 10 00382 01 05 EncodingOnDemand MS UserGuide - v12.0 - RA

Uploaded by

Copyright:

Available Formats

Video Processing

Encoding On-demand mS v12.0

Chapter 2 Menus and navigation...............................................................................................12

Chapter 3 Using Encoding On-demand..................................................................................... 22

Create a PCM map for audio................................................................................................................57

Chapter 4 Managing solutions................................................................................................... 67

Chapter 5 Parameters glossary.................................................................................................. 89

Get started with these basics tasks

Connect to the Controller

Result: The Home page displays.

Create an Encoding On-Demand service

Result: A drop down list displays.

5. Optional: Configure input, encoding and output settings.

6. Click Save and exit.

8. Start the service.

Menus and navigation

Menus and navigation

Home page and dashboard overviews

TIP • Click an overview to link to the related page.

System center menu

Services and processing types

Service processing types

Server processing types

Processing type Required Software

Processing type Required Software

IMPORTANT Depth is 90 days.

Edit the number of rows displayed

Use the search bar

Using Encoding On-demand

Configuring On-Demand services

Create and configure an Encoding On-Demand OTT service

Target Bitrate Frame rate (fps) Resolution Codec Expected Quality

Target Bitrate (kbps) Sampling rate (kHz) Codec

REMEMBER The following steps are an example of possible customized configurations.

Result: By default, the service has 1 audio and 1 video stream.

4. Configure the video stream Encoding settings.

5. Configure the Audio stream Encoding settings.

b. Configure the Audio encoding options, then click Apply.

b. Enter the base publishing point.

7. Edit the TS file settings of the outputs

Result: The Stream selection options display.

b. Select one video with the audio streams.

NOTE • The PID is only configurable for selected streams.

• Otherwise, the PID setting is inactive and grayed.

11. Click to start the service.

Configuring input stream selection

Edit input stream selection parameters

3. Configure parameters, then click Apply.

Edit video input

3. Expand the menus to configure parameters, then click Apply.

Add an audio input

Result: The Audio selection options display.

4. Configure parameters, then click Apply.

Result: The stream displays in the list.

Edit an audio input

Add a subtitle input

5. Configure parameters:, then click Apply

Add a metadata input

4. Configure parameters, then click Apply.

NOTE Changing Type changes the processing parameters to configure.

3. Click Encoding to open the tab and to display encoding settings.

4. Click to edit an encoding option, or add encodings.

Add a video encoding