Table Of Contents
Understanding the Cisco MXE 3000 Client User Interface (CLUI)
Understanding the Cisco MXE 3000 Client User Interface (CLUI)
Revised: October 10, 2008, OL-16995-01This section includes the following topics:
User Interface Components
The Cisco MXE 3000 Client User Interface (CLUI) uses a standard Windows® application interface. This section defines elements commonly used throughout the UI:
•
Tabs
Window Controls
Located in the top right corner of each title bar, the controls described in Table 3-1 allow you to maximize, minimize, and close windows.
Menu Bars
Located below the title bar in each window, the menu bar, shown in Figure 3-1, allows you to access menus relevant to that window. Each menu is described in the Main Menu Reference.
Figure 3-1 Menu Bar
Tabs
Each tab in the main window represents a separate function within one job: the source (File Job), a preprocessor, an encoder, and a type of distribution, as shown in Figure 3-2. Tabs display directly below the menu bar. Click a tab to access the user interface for that particular function. Selected tabs are bold.
Figure 3-2 Tabs
Note
Subtabs
Some tabs are further divided into subtabs. Subtabs are displayed along the left edge of the tab, as shown in Figure 3-3. Click the subtab to bring it to the front. Selected subtabs are bold.
Figure 3-3 Subtabs
User Input Fields
Each window allows you to interact with the application in a variety of ways. Commonly used controls are described, as in the following sections:
Checkboxes
A checkbox turns a setting on or off, as shown in Figure 3-4. Checkboxes may also be used to select one or more values.
Figure 3-4 Checkboxes
Drop-Downs
Many of the fields that are limited to specific values use drop-down menus to allow you to select from the list of valid choices. Drop-downs, shown in Figure 3-5, are identified by the down arrow at the end of the field.
Figure 3-5 Drop-down
Sliders
Settings that allow a range of values may be set using sliders, shown in Figure 3-6. Each slider has an indicator to mark the set value and also shows the value as a number between the label and the slider.
Slider values can be set by dragging the indicator to the desired value.
Figure 3-6 Slider
Four User Interface Windows
The Cisco MXE 3000 provides the following four separate windows that allow you to manage all aspects of job creation, preprocessing, presubmission jobs, and submitted jobs:
•
•
•
•
Main Menu Reference
This section describes the following menus and their options:
Main Menu
The main menu, shown in Figure 3-7, is the primary work area. It is used to create job profiles and submit jobs.
Figure 3-7 Main Menu
File Menu
The File menu is accessed from the main menu bar and offers the options described in Table 3-2.
Edit Menu
The Edit menu is accessed from the main menu or by right-clicking any tab. Menu options that do not apply to the chosen tab are grayed out. The Edit menu offers the options in Table 3-3 that are used to add, remove, or make changes to the profile.
Table 3-3 Edit Menu Options and Descriptions
Remove Tab
Choose this option to delete the selected tab from the Job Profile.
Change Tab Name
Choose this option to assign a name to a tab.
Change Encoder User Data
Choose this option to define what appears in the <user-data> field of the task XML. See also: Changing Encoder User Data.
Reset Tab
Choose this option to reset tab values to the last saved settings. On the File Job tab, this option will reset values to their defaults.
Export Profile Element
Choose this option to save a single tab of a Job Profile. The Export Profile Element option applies only to a Preprocessor tab or an Encoder tab.
View XML
Choose this option to display the XML for the currently selected tab. This option applies to all tabs except File Job.
Disable Tab
Choose this option to temporarily omit a tab without deleting it from the Job Profile.
Audio Only
Choose this option to limit the encoder to creating Audio Only files.
Video Only
Choose this option to limit the encoder to creating Video Only files.
Fast Start
Choose this option to use Fast Start encoding for the selected encoder. Fast Start reduces the total time required to process a job by starting the encoding process as soon as enough of the image has been preprocessed, rather than waiting for the preprocessing to be complete. Customers typically use this feature when submitting large jobs.
Because Fast Start encoding utilizes available computer processing cycles, the Cisco MXE 3000 will use Fast Start encoding only under the following circumstances:
•
•
Immediate
Choose this option to use Immediate (typically faster than Fast Start) encoding for the selected encoder. Immediate encoding removes the intermediate .avi file, forcing the encoder to read directly from the memory-mapped interface (MMI) (similar to a cache).
Archive
Choose this option to bypass the preprocessor settings and only read the input file, passing the video directly through to the encoder. Currently this feature is only enabled on the MPEG encoder.
Rewrap
Choose this option to rewrap RAW data in the new encoder's header. By choosing this option, the Cisco MXE 3000 does not decompress and recompress the video, resulting in faster job processing.
Note
Audio Tracks
Choose this option to map up to eight tracks of audio from the source to the Cisco MXE 3000 output.
Timecode
Choose this option to apply a timecode to the selected encoder's output.
Note
Duplicate Tab
Choose this option to insert, into the Job Profile, a new encoder tab that is the same type and contains the same settings as the encoder tab currently selected.
Changing Encoder User Data
Choose this option to define what appears in the <user-data> field of the task XML:
•
1.
2.
3.
•
1.
2.
•
1.
2.
•
1.
2.
or
Check the FTP box, and enter a Directory.
Figure 3-8 Add User Data to Delivery Location and FTP Directory
Encoder Menu
The Encoder menu is accessed from the main menu and is used to add encoder tabs to Job Profiles.
Encoder tabs are used to set parameters specific to a desired output. For example, a file that is intended for users of Microsoft Windows Media Player who connect to the Internet using cable modems will have one set of requirements, while a file intended for users of RealPlayer who connect to the Internet using a T1 connection will have a different set of requirements. Encoder tabs govern how preprocessor output will be compressed for distribution. See also: Adding Encoders to a Job Profile (CLUI).
The standard functions of each encoder are displayed on its respective tab. The settings included on each encoder tab are specific to the encoder chosen.
Imaging Menu
The Imaging menu, described in Table 3-4, is accessed from the main menu and is used to add imaging tabs to jobs or Job Profiles.
Indexing
This section includes the following topics:
•
•
•
Introduction to the Indexing Tab
Indexing tabs, shown in Figure 9, are added to a job or a job profile from the main menu, by selecting Imaging > Add Indexing. Adding indexing settings to a job or Job Profile is optional.
The Indexing tab is used to define parameters that specify how to perform scene change detection, whether to capture thumbnail images as representative samples of the scene changes, as well as the format, size, and quality of the thumbnail image(s). See also: Introduction to the Thumbnails Tab.
See also: Understanding Indexing Settings for a description of each of the settings.
Figure 9 Indexing Tab
Understanding Indexing Settings
The Indexing tab is made up of the following two sections:
Scene Change Detection
Figure 10 shows the Scene Change Detection section.
Figure 10 Indexing Tab: Scene Change Detection Section
Table 5 describes the settings.
Thumbnail Properties
Figure 11 shows the Thumbnail Properties section.
Figure 11 Indexing Tab: Thumbnail Properties Section
See also: Understanding Thumbnail Settings for a description of each field.
Adding an Indexing Tab to a Profile
Procedure
Step 1
Step 2
Step 3
Step 4
Thumbnails
This section includes the following topics:
•
•
•
Introduction to the Thumbnails Tab
Thumbnail tabs are added to a job or a Job Profile from the main menu, by selecting Distribution > Add Thumbnails. Adding thumbnails to a job or Job Profile is optional.
Use this tab to set up the creation of thumbnail images, specify their format, and specify the conditions for capturing them. Thumbnails are basically images from single frames of the video. Despite the name, you may set the images to any size. The Thumbnails tab also allows you to set up periodic thumbnail captures.
Thumbnails are placed in a subfolder of the Thumbnail Output Directory. All the thumbnails from one encoding job will be held in a subfolder. The subfolder is named according to the Cisco MXE 3000 naming conventions for output files. For example, if the output name is $(basename).$(profile).$(subprofile).$(extension), the thumbnail subfolder will be named $(basename)_$(profile)_$(subprofile)_tmb with the periods converted to "_" and the $(extension) converted to "_tmb".
The subfolder will contain a text file with an .index extension that contains a list of the thumbnail files and times (measured from the beginning of the video clip) where the thumbnails were captured.
The thumbnail files themselves are named 0000.ext, 0001.ext, 0002.ext, ... etc, where "ext" is one of the allowed graphics formats. See also: Image Format in Table 3-7.
You may change the thumbnail naming convention with a Windows environment variable: set OLD_THUMBNAIL_NAMING_CONVENTION=1
The OLD convention uses the Cisco MXE 3000 naming convention to name each thumbnail file. So, the example above produces a thumbnail named: $(basename)_$(profile)_$(subprofile)0000.ext instead of 0000.ext.
There are three checkboxes you may use to specify different methods of determining times to capture thumbnail images. You may check more than one box. The Cisco MXE 3000 uses all checked methods; the times satisfying any of the checked methods generate a thumbnail image. If no boxes are checked, no thumbnails are generated.
See also: Understanding Thumbnail Settings.
Understanding Thumbnail Settings
The Thumbnails tab is used to define parameters that specify when to capture thumbnail images, as well as the format, size, and quality of the thumbnail image(s). The Thumbnails tab is made up of two sections:
Frame Selection
Figure 3-12 shows the Frame Selection area.
Figure 3-12 Frame Selection
Table 3-6 describes the settings.
Thumbnail Properties
Figure 3-13 shows the Thumbnail Properties area.
Figure 3-13 Thumbnail Properties
Table 3-7 describes the settings.
Adding a Thumbnails Tab to a Job Profile
Procedure
Step 1
Step 2
Step 3
Step 4
Distribution Menu
The Distribution menu is accessed from the main menu and is used to add distribution tabs to jobs or Job Profiles.
For more information and instructions, see the reference in the Option column of Table 3-8.
View Menu
The View menu is accessed from the main menu. The View menu is consistent and available across all Cisco MXE 3000 Client User Interface windows and allows users to view any CLUI window. The currently viewed window is grayed out.
By default, when you open the Client User Interface, the Main Window displays.
Choose View > Preview Window, Job Status Window, and/or Job Log Window to also display these windows.
See also: Four User Interface Windows.
Tools Menu
The Tools menu is accessed from the main menu and is used for the options described in Table 3-9.
Table 3-9 Tool Menu Options and Descriptions
V-Chip Mapping
This feature allows you to associate V-chip ratings with watermark graphic files. When enabled, the preprocessor will automatically use the mapping file configured watermark for the submitted V-chip rating value, allowing different mapping files for different versions of the V-chip watermark graphics.
V-Chip Extractor
This feature extracts the V-chip rating from a CableLabs-compliant MPEG clip if it contains a rating.
Preferences
Choose this option to configure various User Interface settings. See also: Setting Preferences.
Preview
Choose this option to open the video clip and profile displayed in the main window in the Preview window. The Preview window allows users to see how preprocessor settings will affect the video and to make other adjustments to the job.
Setting Preferences
The Preferences submenu, shown in Figure 3-14, is accessed from the Tools menu and is used to set various defaults as described in Table 3-10. Setting preferences is optional. Users have the option of overriding any default at the time of job submission.
Figure 3-14 Setting Preferences
Choose any of the preferences from the above list to display the Preferences window.
For more information and instructions, see the reference in the Option column of Table 3-10.
General Preferences
The General tab, shown in Figure 3-15, is accessed from the main menu by selecting Tools > Preferences > General Preferences.
Figure 3-15 General Preferences Tab
Table 3-11 describes the settings.
Table 3-11 General Preferences Settings and Descriptions
Profiles Location
This option allows you to set the default profile storage location. Each Cisco MXE 3000 can save profiles to a unique directory, or the profiles can be saved to a common network location. We recommend that network profile directories follow the default profile location format, which is:
C:\Program Files\Cisco\Media Experience Engine\Profiles
Note
Server List
This option allows you to identify the server(s) where jobs will be directed when submitted from the Job Log. Separate server names with a comma. Typically, the server name is set during the original Cisco MXE 3000 installation. This value can be changed in the Job Status window > Tools > Change Server to connect to a different server.
Default Output Name
This option allows you to define a default pattern for output file names. See also: Variables Used for File and Directory Naming for a complete list of variables used in defining output file names.
Default Video Format
This option allows you to set the default video format to NTSC or PAL.
Keep Output Files Defaults
This option allows you to define which type of output files will be saved locally after submitted jobs have completed. Local files that are not identified in this section will be deleted once the job has completed.
Note
Audio Preferences
The Audio tab, shown in Figure 3-16, is accessed from the main menu by selecting Tools > Preferences > Audio Preferences and is used to set audio mixer preferences (or defaults).
Figure 3-16 Audio Preferences Tab
Table 3-12 describes the settings.
Submission Defaults
The Submission Defaults tab, shown in Figure 3-17, is accessed from the main menu by selecting Tools > Preferences > Submission Preferences.
Entry of data into the fields is optional. The Cisco MXE 3000 uses the data to auto-populate fields in the corresponding File Job Metadata sections. See also: Understanding File Job Settings.
Figure 3-17 Corresponding File Job Metadata Section
The following defaults are set on the Submission Defaults tab and will auto-populate on the File Job tab, shown in Figure 3-18.
Figure 3-18 Submission Defaults Tab
Table 3-13 describes the settings.
E-mail Preferences
The E-mail tab, shown in Figure 3-19, is accessed from the main menu by selecting Tools > Preferences > E-mail Preferences. At this time, the E-mail tab is used to enter information that appears in the job submission metadata only.
Figure 3-19 E-mail Preferences Tab
Thumbnail Preferences
The Thumbnails tab, shown in Figure 3-20, is accessed from the main menu by selecting Tools > Preferences > Thumbnail Preferences and is used to specify defaults for the location, naming, and imaging of encoded video thumbnails.
Figure 3-20 Thumbnail Preferences Tab
Table 3-14 describes the settings.
Help Menu
The Help menu is accessed from the main menu and is used to:
•
•
•
