Macros are used to retrieve metadata from programs and playlist items in Cinegy Air PRO to be substituted for the Cinegy Titler text objects values.

This can be very useful for scenarios like "Coming next" or "Now playing".

Syntax

General Macro Syntax

The general macro code syntax is as follows:

${<source>.<data>}

where:

<source> – specifies the container/item type to retrieve the specified metadata from. Playlist items and programs are currently supported.

<data> – specifies the metadata field to retrieve the data from. The following fields are supported: name, description, comment (for items), and start time.

For example:

${program.name}

The item or program start time macro is available in several variants:

${source.time} – show hours and minutes (the same macro as .time.hm)

${source.time.h} – show hours only

${source.time.hm} – show hours and minutes

${source.time.hms} – show hours, minutes, and seconds

The "time" macro can have the optional postfix for 5-minute rounding:

${source.time.round} – the minutes value is rounded upward or downward (whatever value is closer).

${source.time.ceil} – the minutes value is rounded upward.

${source.time.floor} – the minutes value is rounded downward.

The same postfixes will work for 5-second rounding, e.g. .time.hms.round, .time.hms.ceil, .time.hms.floor.

It is possible to specify the relative number of the container/item, from which the data should be retrieved, in the following format:

<source+n>

where n is any positive number for programs. For items, this value can only equal 1.

Specifying the <source> parameter is not obligatory. When it is not specified, the data will be retrieved from the item.

For example:

${description}

In this case, the macro will return the item description.

Custom Metadata in Macros

Custom metadata fields are also supported. For example, to retrieve the value of the "Notes" custom field for the specified item, the syntax should be as follows:

${item.Notes}
Important
Refer to the Custom Metadata paragraph in the Cinegy Air Manual for more details on working with custom metadata fields.

Countdown Macros

The countdown macro links the start time of a countdown timer to a specific playlist item.

For example, to show the countdown to the next program in the playlist, the macro syntax is as follows:

${program+1.countdown}

The step-by-step description of how to apply the countdown macros is given below.

Applying General Macros

Macro code is entered in the text value of the text object in the Cinegy Titler template.

To add a macro, follow the steps:

  1. Add a text object and in the "Text" field enter the macro code according to the general macro syntax described above.

    Macros_text_value
  2. Link this text to a new variable:

    Macros_text_linking
  3. Edit the Titler scene according to your needs and save it.

  4. Select the desired item in the Cinegy Air PRO playlist, and use the secondary events panel context menu to assign a Cinegy Titler scene display on the specified layer:

    Macros_add_CG_template
  5. In the "CG Browser" dialog box that appears, select your Titler scene in the "Repository" field. The macro code in the "Template parameters" table will be changed to the corresponding field data value:

    Macros_in_template_browser

Applying Countdown Macros

Follow the steps to create the Cinegy Titler template with the countdown to the specified playlist item and enable its display in the Cinegy Air PRO playlist:

  1. Add a clock object to the Titler scene:

    titler_countdown_clock
  2. On the "Variables" tab create the new string variable and enter the macro code according to the countdown macro syntax described above:

    titler_countdown_variable
  3. On the "Clock" object parameters tab, choose the "Countdown" clock type:

    titler_countdown_clock_type
  4. Link the "Start Value" parameter with the previously created string variable:

    titler_countdown_clock_link
  5. Edit the Titler scene according to your needs and save it.

  6. Select the desired item in the Cinegy Air PRO playlist, and use the secondary events panel context menu to assign a Cinegy Titler template display on the specified layer.

  7. In the "CG Browser" dialog box that appears, select your Titler scene in the "Repository" field. You can play the Cinegy Titler template in the "Preview" screen and see how the countdown works.