About Screencast Website Registration

Register your product with the Screencast website after you integrate the API into your product.

Screencast website registration is a manual process requiring communication between your development team and the Autodesk Screencast product support team. Provide the following information:

After you register your product with the required information, recording playback can display icons and descriptions about the commands in the timeline.

Command Lookup Table

The command lookup table is used as an index for all the commands that may be reported as waypoints by your product. The index table should have an entry for every such command ID that the product may report. The table format should be as shown in the following sample from Infraworks:

Product Name Large Image Small Image Description Command Name Command ID Display Name
Infraworks icon_pointer_32px.png icon_pointer_16px.png Select Select action_Tools_Select_Picking Select
Infraworks icon_data_sources_32px.png icon_data_sources_16px.png Import and configure data Data Sources action_Window_DataSources Data Sources
Infraworks icon_base_layers_and_config_32px.png icon_base_layers_and_config_16px.png Manage the order and visibility of surface data Surface Layers action_View_BaseLayerManagerDialog Surface Layers
Infraworks icon_model_explorer_32px.png icon_model_explorer_16px.png Control visibility, display, and selectability of features Model Explorer action_Window_ModelExplorer Model Explorer
Infraworks icon_inspector_32px.png icon_inspector_16px.png View and edit properties for selected features Properties action_Window_PropertyInspector Properties
Infraworks icon_style_palette_32px.png icon_style_palette_16px.png Manage style catalogs and apply styles Style Palette action_Window_StylePalettes Style Palette

Table Field Descriptions

Product Name
The public name associated with your product. Do not include versioning unless you are supporting distinct versions with different command sets for Screencast.
Large Image
This icon appears in several places and should be 32x32 pixels. The icon should be consistent with the icon used for that tool in your application.
Small Image
This icon appears in several places and should be 16x16 pixels. The icon should be consistent with the icon used for that tool in your application.
Description
A user facing short description (1–2 sentences at most) of the command. The description should be consistent with the tooltip information from the actual product. This information is displayed in the command marker tooltip on the Screencast timeline.
Command Name
The name that should appear when sorting a list of all the product's commands. The command name should be the same as the Display Name or the Command ID for all commands. The command name determines the display name in the Command Filter Dialog. For most products, the command name is the Display Name, but for some products it may be helpful to use the Command ID.
Command ID
The exact ID that is reported in the waypoint by the Screencast API to the Screencast recorder. Each ID must be unique.
Display Name
The user-facing name of the command. The display name is usually the name of the icon, button, or menu item that is displayed when a tooltip for that command appears. The Screencast timeline tooltip displays the display name.

Settings and Dialog Lookup Tables

Create the Settings and Dialog lookup tables in the same format as the Command lookup table.

Dialogs waypoints can contain an image, typically a screenshot of the dialog window. Use the API to pass through the screenshot as a parameter. The lookup tables do not define the screenshots. They only define the icons to be used.

Duplicate Values

Sometimes, your application might have commands with multiple access points. If your product reports these as different IDs then you have multiple associated command IDs for a single command. In this case, all fields, except for the ID, should be the same. Duplicate values allow the Screencast website to properly merge them in the Command Filter dialog.

Note: It is not necessary for your product to report the different access points as different IDs. They can also be reported with the same ID, requiring only a single row in the lookup table.