Example

====== Legend - Set a chase cue's legend ======

^ by: | Kim Wida, Feb 2018 |
^ published: | http://forum.avolites.com/viewtopic.php?f=20&t=5554 |
^ description: | Change a chase cue's legend to show a specific profile ID |
^ remarks: | In its form it is of almost no practical use, but an example of how to get some information (in that case: the profile ID) displayed. |

{{tag>chase cue legend profile cast}}

==== functions ====
  * [[:macros:function:Playbacks.SetCueLegend]]
  * [[:macros:function:Math.ToString]]
  * [[:macros:function:Profiles.GetHandleProfileId]]

 
===== Code =====
<code xml setLegendToProfileId.xml>
<?xml version="1.0" encoding="utf-8"?>
<avolites.macros xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Avolites.Menus.xsd">
 <macro name="" id="">
    <description></description>
    <sequence>
      <step>Playbacks.SetCueLegend(handle:"chaseHandleUN=10555", 1, Math.ToString
      (Profiles.GetHandleProfileId(handle:"chaseHandleUN=10555")))</step>
     </sequence>
  </macro>
</avolites.macros>
</code>


===== Explanation =====

This explains the functional steps within the sequence. For all the other XML details please refer to [[:macros:formats_and_syntax#xml_format|Formats and syntax]]

As stated above this example is of limited use for operating Titan but helps you get the ID of the profile. This ID is an int number, identifying the assigned key profile on that handle. Usually this is dealt with strictly internally. this macro was written in order to get the profile ID out.
  * ''Profiles.GetHandleProfileId(handle:"chaseHandleUN=10555")'' returns the ID of the assigned key profile
  * ''Math.ToString()'' converts this ID, which is an integer number, to a string which can then be assigned as legend
  * ''Playbacks.SetCueLegend(handle:"chaseHandleUN=10555", 1,...)'' sets this string as legend for cue #1 of a specific chase

===== How to use it =====

  - edit to meet your needs (or set a chaser to userNumber 10555) and [[:macros:deploying|make this macro available]]
  - call this macro to retrieve the profile ID of this specific chase, which will be displayed as legend for its cue #1

~~DISCUSSION~~