NOTE. To use Macros, the Duet or PC on which you are running Lyric must have Microsoft Internet Explorer 6.0 or later installed.

Transcription

1 Page 1 of 14 Macros Overview View Menu > Macros NOTE To use Macros, the Duet or PC on which you are running Lyric must have Microsoft Internet Explorer 6.0 or later installed. Refer to LEIF Help for additional information about the LEIF API. the LEIF.hlp file in the directory in which Lyric was installed. If clicking this link does not open LEIF Help, open Macros are VB Script programs that are can simplify and automate repetitive tasks for easy recall in on-air or production situations. Such tasks include reading messages, keystrokes, menu selections, etc. They can be triggered as needed, and/or a macro can be set to automatically execute at the time when the macro file is read. This section covers the use of macro scripts as triggered from within Lyric. Individual macro commands, however, can be sent to Lyric via Intelligent Interface. Refer to Intelligent Interface: E Command - Send Macro Commands for detailed information. Note that not all keystrokes or mouse actions are supported in Lyric macros. Refer to Specifying Characters Using SendKeys Commands for additional information. Supported Lyric functions are listed at the end of this section. Macros - Related Topics About VB (Visual Basic) Script Lyric macros are founded on the VB Script language, allowing sophisticated, high-level programs to be created and assigned to macros. These include custom user interfaces for data acquisition and display. The use of VB Script also enables the macro user to control custom CAL (Chyron Abstraction Layer) applications. The Macros Dialog Box For the purpose of the following example, make sure that the Lyric Canvas is empty, and does not contain a fullscreen 2D Text Window. The first step in creating a macro is to access the Macros dialog box. To do so: From the View menu, select Macros. The Macros dialog box is displayed. Macros Dialog Box

2 Page 2 of 14 The Macros dialog box is split into two panes. The left pane displays the following information for each macro: The name of the macro. The hotkey, if specified, that executes the macro. The file path of the macro once it has been saved. The right pane displays three tabs: Description: Displays a short description of each macro. This tab is displayed on opening the Macros dialog box. Script: Displays the VB Script, i.e. the program, for the selected macro. Macro scripts can be input in a variety of manners: Typing a script directly into the Script tab; opening an existing macro file; and recording keyboard/mouse activity. Globals: Displays a list of Global Variables available for use by any of the macros and by macros which are subsequently read into the Macros dialog box. There are also a set of icons at the bottom left of the dialog box, which execute a variety of functions. The left and right panes can be resized by clicking-and-dragging, as can the Macro, Hotkey and File columns: Creating and Playing Back a Macro Resized Macros Dialog Box The following script that you will create will open a 2D Text Window, change its position twice, and display the word "Hello!" 1. Click the Add icon to initiate a new macro file. The default new file name appears in the Description tab. along with the time and date. Additional descriptive text can be typed in at any time. Text editing functions are available by right-clicking in the Description pane. See Right-Pane Context Menu later in this section for additional information on this menu. Adding a New Macro Right-Pane Context Menu 2. Click the Record icon. The right pane switches to displaying the Script tab. From this point on, almost any action performed on the Canvas is recorded as part of the macro. Additionally, while the macro is recording, the Macro symbol next to the default filename blinks, and the letter M in the Status Bar turns red. 3. Click on the Canvas to make it the active window. 4. Open a 2D Text Window. Note that the creation of the 2D Text Window has been recorded.

3 Page 3 of 14 Macros Script Recording the Addition of a 2D Text Window 5. Click-and-drag the 2D Text Window to a new position, and then click-and-drag it to still a different position. Each change in position is recorded as a pair of commands: one addressing the X position, and one addressing the Y position. Macros Script Recording 2D Text Window Movement Most actions involved in creating a Lyric composition can be recorded as part of a macro. Actions not directly related to the creation of the Lyric composition, for example clicking on a window to make it active, are generally ignored. Refer to the end of this section for a complete list of the actions that can be recorded in a macro. 6. In the 2D Text Window, type the word "Hello!" Each character that is typed is recorded in the macro. Macros Script Recording Text Typing

4 Page 4 of Click the Stop icon. The Macro symbol does not stop flashing until the current macro is saved or abandoned. Saving macros is covered later in this section. 8. Press Ctrl + Q to erase the Canvas. Now that recording has stopped, the Erase command is not added to the macros script. 9. Click the Play icon or double-click the macro name. The window containing the typed "Hello!" appears on the Canvas. Because no timing commands were included in this macros script, the repositioning of the 2D Text Window and the typing of the characters may be imperceptible on playback. A macro can also be executed by pressing a Hot Key combination, which is a keyboard shortcut. Setting Hot Keys is covered later in this section. Add additional macros and experiment with other Lyric composition tools to see how they are translated into VB Script commands. Right-Pane Context Menu The right-pane context menu accesses text editing functions in the Description, Script and Globals tabs. To display this menu: Right-click the right pane (displaying the Description, Script and Globals tab) of the Macros dialog box. Right-Pane Context Menu Standard Windows text editing functions such as Cut, Copy, Paste, Delete and Select All are available from this menu. If certain language packages are installed, three additional items are displayed: Right-to-Left Reading Order: Right-justifies the text, and specifies that the text should be read from rightto-left. To toggle on/off, click Right-to-Left Reading Order. When active, a check is displayed next to the menu item. Show Unicode Control Characters: Currently not implemented. Insert Unicode Control Character: Currently not implemented. Left-Pane Context Menu The left-pane context menu accesses functions that allow one to edit, delete, save, set a hotkey or rename a macro. To display this menu: Right-click a macro name in the left pane of the Macros dialog box. The left-pane context menu is displayed. Note that the Script Code item is grayed out. This item only becomes active if the selected macro has been previously saved.

5 Page 5 of 14 Macros Left-Pane Context Menu The context menu items are covered in following order: Save Macro; Script Code; Hot Key; Rename; Delete. Saving Macros Macros that are listed in the Macros dialog box can be saved individually or together when a Save is executed. Macros can be saved in two different formats. *.lmx: The *.lmx format is a file consisting solely of ASCII text, allowing the file to be opened in any text editor for editing. Files of this format can also be used in programs outside of Lyric. *.lyr: The *.lyr format is executable only from Lyric. The advantage to this format is that it allows one individual macro to automatically execute upon reading the macro file. The *.lyr format also allows the file to be read as a Lyric message by entering the Message Number, then pressing Read. It should not, however, be edited outside of Lyric. A macro script or macro name can also be embedded in a Lyric message, and is executed immediately when the message is read. Refer to Selective Recording - Embedded Macro for details. To save a macro or group of macros as an *.lmx file: 1. Select Save Macro from the left-pane context menu to save the selected macro, or click the Save All Macros to File icon or press Ctrl + S to save all macros displayed in the Macros dialog box. The Save As dialog opens. Save Macros As *.lmx 2. In the Save In field, navigate to the directory in which the macro file is to be saved. 3. In the Save as Type drop-down list box, select Lyric Macro Files (*.lmx). Note that the Auto Execute

6 Page 6 of 14 drop-down is grayed out. 4. Enter a File Name. 5. Optional: To save Global Variables, select (check) the Save Globals check box. Global Variables are covered later in this section. 6. Click Save. Note that the when a group of macros is saved as an *.lmx file, the code for each macro is displayed in order of its Macros dialog box listing when the.lmx file is opened in a text editor. To save a macro or group of macros as a *.lyr message: 1. Select Save Macro from the left-pane context menu to save the selected macro, or click the Save All Macros to File icon or press Ctrl + S to save all macros displayed in the Macros dialog box. The Save As dialog opens. It is shown with the file information already entered. Save Macros As *.lyr 2. In the Save In field, navigate to the directory in which the macro message is to be saved. 3. In the Save as Type drop-down list box, select Lyric Macro Files (*.lmx). 4. Enter a File Name. 5. Optional: In the Auto Execute drop-down list box, select the individual macro that should automatically execute when the macro message is read. This step is necessary for auto-execution even if the macro message contains only one macro. Leave the Auto Execute field blank if automatic macro execution should not take place. 6. Optional: To save Global Variables, select (check) the Save Globals check box. Global Variables are covered later in this section. 7. Click Save. If a macro was specified in the Auto-Execute field, the macro will execute when the Lyric macro message is read.

7 Page 7 of 14 Quickly Saving a Macro File (*.lyr) for Easy Recall The following procedures save the macro file in the.lyr format to the current Message Number in the Default Message Directory. Using this recording method also makes allows for easy recall of the macro message, as described in Opening/Reading a Macro later in this section. A quick method for recording a Macro file in the *.lyr format is as follows: 1. Press Ctrl + Record. The Record Only: dialog box opens. 2. Select Macros 3. Click Record. A shortcut key combination can also be used to record the macro: Press Ctrl + Record M Enter. The above methods cannot be used to save Macro files in the.lmx format. Opening/Reading a Macro Macro files in both the *.lmx and *.lyr formats can be opened in Lyric from File > Open, then by navigating to and selecting the file. Macro files in the *.lyr format, that also are identified by numeric names of eight digits or less, and that are stored in the Lyric Default Message Directory, can be read in the same manner as other Lyric messages. Enter the Message Number, then press Read. Note that opening a macro that has the same Macro Name (not file name) as a macro already listed in the window results in the newer macro overwriting the older macro in the Macros dialog box. This does not affect the original macro files that have been previously saved. It simply affects which macro is currently loaded. When a macro in the Macros dialog box has not yet been saved, the overwrite would erase it. A macro can be embedded in a Lyric message so that it automatically executes when the message is read. Refer to Selective Recording - Embedded Macro for details. Script Code Window and Editing Script After an individual macro or group of macros is saved, the VB Script code for the entire file can be displayed and edited. The changes can then be saved. To view and edit the macro file within Lyric: 1. Select Script Code from the left-pane context menu. The Script Code window is displayed.

8 Page 8 of 14 Script Code Window As shown in the previous figure, each individual macro, whether saved individually or as a group, is identified as a subroutine in the VB Script. Script from any of the subroutines can be edited. 2. Make edits to the script. To access available editing functions, right-click in the Script Code window. Script Code Edit Functions 3. When editing is complete, click the Windows Close icon. The following is displayed. Save Changes to Macro? 4. Click Yes to save changes, No to exit the Script Code window without saving changes, or Cancel to

9 Page 9 of 14 cancel the operation and continue to edit. An individual macro can also be edited from within the Script tab of the Macros dialog box. 1. Select (highlight) the macro name in the Macros dialog box. 2. Click the Script tab. The script for the selected macro is displayed. Editing a Macro from the Script Tab 3. Make edits to the script. To access available editing functions, right-click in the Script Code window, as shown in the preceding figure. 4. When editing is complete, the script can be played back. Note that when editing in this manner, the script is not saved until one of the Save functions is executed. Deleting a Macro/All Macros Macros can be deleted either individually or as a group from the Macros dialog box. Note that Global Variables are not deleted by either operation. An individual macro can be deleted from the Macros dialog box. 1. Right-click the macro name in the Macros dialog box. 2. Select Delete from the context menu or press the Delete key. The Confirm Delete prompt is displayed. Confirm Delete Prompt

10 Page 10 of Click OK to delete, or Cancel to cancel the deletion. To erase all macros from the Macros dialog box: 1. Click the Clear All Macros icon. The Confirm Deletion prompt is displayed. Confirm Deletion Prompt 2. Click OK to delete all macros, or Cancel to cancel the deletion. Setting Hot Keys and Macro Symbol Colors A Hot Key, or keyboard shortcut, can be assigned to each individual macro, eliminating the need to use the mouse to execute the macro. A color can also be assigned to the Macro symbol for easy recognition. To set a Hot Key and a macro color: 1. Right-click the macro name in the Macros dialog box. 2. Select Hot Key from the context menu. The Macro Short Cuts dialog box opens. Macro Short Cuts Dialog Box 3. As shown in the preceding figure, enter a key combination in the Hot Key field, then select a color in the Icon color list. For no color, select <none>. 4. Click Apply. The macro can now be executed by pressing the Hot Key combination. The following figure shows Hot Keys and Macro symbol colors applied to all three macros. Hot Keys and Macro Symbol Colors Applied

11 Page 11 of 14 Renaming a Macro A individual macro can be renamed. 1. Right-click the macro name in the Macros dialog box. 2. Select Rename from the context menu. The macro name become available for editing. Type the new name of the macro. Names must be composed of alphanumeric characters and must not contain spaces or punctuation characters. 3. Press Enter. The macro displays the new name. Renaming a Macro Global Variables Renamed Macro A Global Variable is a value that is available to all macros. A Global Variable can be an absolute value, or it can be determined by input from another source, i.e., a macro. For example, a Global Variable such as a price, could be input via one macro. Another macro could then display the Global Variable in a 2D Text Template on the Lyric Canvas. Global Variables can be defined in the Globals tab of the Macros dialog box. Each Global Variable must be preceded by the word public, which indicates that it is available to all macros. Global Variables remain active until deleted or reset (See Resetting the Macro Engine and Global Variables following this subsection). To demonstrate a simple example, the following procedure will define a Global Variable. Two macros will also be created: one to take input of a number, and another to display it. To define a Global Variable "a", which will be set and accessed by macros: 1. Click on the Globals tab in the Macros dialog box. 2. Type the following: public a Defining a Global Variable

12 Page 12 of 14 Create the input macro that displays a Windows input box. This value becomes the Global Variable "a" that can be accessed by other macros. 1. Click the Add icon. This initiates the creation of a new macro. Rename the macro as Input. 2. Click on the Script tab. Type the following: a = InputBox ("Enter Number") To create the macro that displays the Global Variable "a" in a Windows message box. 1. Click the Add icon. This initiates the creation of a new macro. Rename the macro as Output. 2. Click on the Script tab. Type the following: MsgBox (a) The macros can now be executed. 1. Select the macro named Input, then double-click it or click the Play icon. The following is displayed: Input Box Requesting a Value 2. Type a number into the field. For this example, we will use 456. Click OK. 3. Select the macro named Input, then double-click it or click the Play icon. The following is displayed: Outputting the Global Variable Resetting the Macro Engine and Global Variables The macro engine can be reset, clearing out the macros and bringing the VB Script processor back to its initial state. This is recommended when work with one set of macros is complete, and a new set is to be opened. In addition, if macros that normally execute properly exhibit unexpected behavior, or newly created macros are retaining and executing previously created scripts, resetting the macro engine can restore proper function. Note that executing a reset also clears macros that have been created and sent via Intelligent Interface. These macros do not appear in the Macros dialog box. After a reset, it is necessary to resend the macros to Lyric if they are to be used. The Reset Macro Engine and Global Variables can reset only the macros or the macros and Global Variables. Generally, it is desirable not to reset the Global Variables, in order to leave them available for the next set of macros. To execute a reset: 1. Specify whether the macros only, or the macros and the Global Variables are to be reset. To Reset Macros Only: In the right pane of the Macros dialog box, click either the Description

13 Page 13 of 14 tab or the Script tab. To Reset Macros and Global Variables: In the right pane of the Macros dialog box, click Globals tab. 2. Click the Reset Macro Engine and Globals icon. The following is displayed. Confirm Macro Engine and Global Variable Reset Prompt 3. Click OK to reset or Cancel to cancel the operation.. Supported Functions For Macros The following Lyric operations can be performed using macro commands. Refer to LEIF Help for coding and syntax information. If clicking this link does not open LEIF Help, open the LEIF.hlp file in the directory in which Lyric was installed. Object Maintenance Add 2D window (including Roll, Crawl, Type-On, Clock, Timer) Add 3D object (characters, Wavefront, 3DS model) Add 2D image Selection of object by name Delete selected object(s) Toggle visibility (checkbox on scene graph) 2D Text Operations Typing 2D characters Cursor movement via arrow keys, home, end Delete, backspace, next line Insert 2D Text Template Tab to previous/next template Make Window Full Screen Select All 2D Text Insert/Delete Row Delete to end of row Pickup color/font Apply color/font, using shortcut keys Renumber templates

14 Page 14 of 14 Shift/Super-Shift row and page Ctrl+Tab (inserts white space tab) Escape (to exit an active template) Font and Color Hot Keys Animation Operations Set keyframes through Canvas actions or changing values on the XYZ Properties page Go to Next or Previous keyframe Fast Forward Fast Reverse Frame Forward Frame Reverse Go to end of animation Keyframe all objects/selected objects Play or Reverse Play animation Copy Animation State Paste Animation State Duet Operations Toggle Duet Live Button Transfer Channel selection/toggle Swap Transfer to next channel Scene Operations Setting message number Read Record Alt + Record Open (specified filename) Erase Wait (pause between macro commands for a given timeout) Macros - Related Topics