Differences

This shows you the differences between two versions of the page.

--- macros:example:playbackgroupcreateadd [2021/06/12 18:40] – ''Playbacks.FilterByPlaybackHandle()'' icke_siegen
+++ macros:example:playbackgroupcreateadd [2021/06/13 14:53] (current) – icke_siegen
@@ Line 11: / Line 11: @@
 Playback Groups were introduced with Titan v13, January 2020. This functionality is not available in earlier versions.
+Gregory Haynes' email which this these examples are based on is attached as {{ :macros:email_07062021.pdf |}} for further details.
 This example is meant to show how Playback Groups are created, how playbacks are added, how the various parameters are conveyed, and which caveats need to be taken care of. Particular attention should be paid to setting IEnureables.
@@ Line 19: / Line 21: @@
   * [[:macros:function:PlaybackGroups.CreatePlaybackGroupWithPlaybacks]]
   * [[:macros:function:Playbacks.FilterByPlaybackHandle]]
+  * [[:macros:function:PlaybackGroups.AddPlaybacksToGroup]]
   * [[:macros:function:PlaybackGroups.SetCurrentPlaybackGroupFromUserNumber]]
@@ Line 121: / Line 124: @@
   * ''PlaybackGroups.AddPlaybacksToGroup()'' adds playbacks to a playback group
     * ''PlaybackGroups.CurrentPlaybackGroup'' is the system property which denotes the currently selected playback group, e.g. still current after previously been created
-    * ''"{cueHandleUN=3,cueListHandleUN=1}"'' list of playback user numbers in string notation to make clear these are playbacks of some type
+    * ''"{cueHandleUN=3,cueListHandleUN=1}"'' is a list of playback user numbers in string notation to make clear these are playbacks of some type.
 ==== Macro 3 ====
@@ Line 130: / Line 133: @@
     * ''Playbacks.FilterByPlaybackHandle()'' makes sure the passed list is looked up in the playbacks namespace
     * ''userNumber:2'' is the standard notation of a user number when denotin a handle
+==== Macro 4 ====
+A playback identified by its user number (see [[#Macro 3]]) is added to a specific playback group. This is denoted by its user number which requires additional casting.
+  * ''PlaybackGroups.AddPlaybacksToGroup()'' adds playbacks to a playback group
+    * ''handle:"playbackGroupHandleUN=1"'' takes the playback group's user number in string notation and cast this into the required handle
+    * ''"cueHandleUN=3"'' is the playback's user number in string notation. Unlike in [[#Macro 2]] we don't need braces here as it is only one playback.
+==== Macro 5 ====
+A playback identified by its user number (see [[#Macro 3]]) is added to a specific playback group. This is denoted by pointing PlaybackGroups.CurrentPlaybackGroup to the user number of the playback group - no additional casting required, and the property PlaybackGroups.CurrentPlaybackGroup is set for future operations as well.
+  * ''PlaybackGroups.SetCurrentPlaybackGroupFromUserNumber(2)'' points the property PlaybackGroups.CurrentPlaybackGroup to the playback group with user number 2.
+  * ''PlaybackGroups.AddPlaybacksToGroup()'' adds playbacks to a playback group.
+    * ''PlaybackGroups.CurrentPlaybackGroup'' holds the previously set reference to playback group 2.
+    * ''"cueHandleUN=3"'' is the playback's user number in string notation, see above. Unlike in [[#Macro 2]] we don't need braces here as it is only one playback.
+==== Macro 6 ====
+**This macro has not been tested.**
+Similar to [[#Macro 2]]. Two playbacks, identified by their TitanIDs, are added to the current playback group. Note that this relies on the current playback group being set previously (creating it in the macro above makes it current). As the TitanID is an internal thing and cannot be set manually nor predicted reliably is of limited use here.
+  * ''PlaybackGroups.AddPlaybacksToGroup()'' adds playbacks to a playback group
+    * ''PlaybackGroups.CurrentPlaybackGroup'' is the system property which denotes the currently selected playback group, e.g. still current after previously been created, or set like in [[#Macro 5]]
+    * ''"{ 1812; 1999 }"'' is a list of playback TitanIDs.
 ===== How to use it =====
   - [[:macros:deploying|make this macro available]]
+  - macros 1~5 have successfully been tested - simply create some playbacks with the relevant user number and fire the macros to see how they work. However these macros might be useful only in special cases, e.g. in setup macros which prepare the console for you following a fixed scheme.
+  - macro 6 has not been tested as using TitanIDs in macros is only of limited use - it's not easy to determine or predict the TitanID of a particular item.
-tbd
 ~~DISCUSSION~~