Example

====== Playback - Fire/Release Playbacks from Usernumber ======

^ by: | Peter Budd |
^ published: | October 2017 |
^ description: | Fire/Release some Playbacks.  |
^ remarks: | This is also an example of the use of [[macros:identifier:usernumber|userNumber]]. |

{{tag>playback fire release usernumber}}
==== functions ====
  * [[:macros:function:Playbacks.ReleasePlayback]]
  * [[:macros:function:Playbacks.FirePlaybackAtLevel]]

==== affected properties ====
  * [[:macros:property:Playbacks.MasterReleaseTime]]

 
===== Code =====
<code xml firereleaseplaybacks.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 id="Avolites.Macros.ReleaseLists" name="Release Lists">
    <description>Releases some playbacks.</description>
    <sequence>
      <step>Playbacks.ReleasePlayback(userNumber:83,  Playbacks.MasterReleaseTime, true)</step>
      <step>Playbacks.ReleasePlayback(userNumber:2,  Playbacks.MasterReleaseTime, true)</step>
      <step>Playbacks.ReleasePlayback(userNumber:79,  Playbacks.MasterReleaseTime, true)</step>
      <step>Playbacks.ReleasePlayback(userNumber:3,  Playbacks.MasterReleaseTime, true)</step>
      <step>Playbacks.ReleasePlayback(userNumber:4,  Playbacks.MasterReleaseTime, true)</step>
      <step>Playbacks.ReleasePlayback(userNumber:81,  Playbacks.MasterReleaseTime, true)</step>
      <step>Playbacks.ReleasePlayback(userNumber:50,  Playbacks.MasterReleaseTime, true)</step>
    </sequence>
  </macro>

  <macro id="Avolites.Macros.FirePlayback83" name="Fire Hold">
    <description>Fire Hold State.</description>
    <sequence>
      <step>Playbacks.FirePlaybackAtLevel(userNumber:83, level:1, true)</step>
    </sequence>
  </macro>

  <macro id="Avolites.Macros.ReleasePlayback83" name="Release Hold">
    <description>Releases hold state.</description>
    <sequence>
      <step>Playbacks.ReleasePlayback(userNumber:83,  Playbacks.MasterReleaseTime, true)</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]]

These macros are designed to work with specific usernumbers - either you adjust the usernumbers in the macro or you assign your playbacks the currect usernumbers.

''Playbacks.ReleasePlayback()'' releases a certain playback in a given time - which here is taken from the property ''Playbacks.MasterReleaseTime''.

''Playbacks.FirePlaybackAtLevel'' fires a certain playback at a certain level. 

Here, the playbacks are identifies by their [[macros:identifier:usernumber]]. Also note the syntax of defining the [[macros:type:object:leveladjust|level]].

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

  - [[:macros:deploying|make this macro available]]
  - These macros are designed to work with specific usernumbers - either you adjust the usernumbers in the macro or you assign your playbacks the currect usernumbers.

Another example see http://forum.avolites.com/viewtopic.php?f=20&t=5784:

<code xml>
<sequence>
  <step>Playbacks.ReleasePlayback(userNumber: 1, 0, false)</step>
  <step>Playbacks.ReleasePlayback(userNumber: 2, 0, false)</step>
  <step>Playbacks.ReleasePlayback(userNumber: 3, 0, false)</step>
  <step>Playbacks.ReleasePlayback(userNumber: 4, 0, false)</step>
  <step>Playbacks.FirePlaybackAtLevel(userNumber: 1, 1, true)</step>
</sequence>
</code>

~~DISCUSSION~~