Macros

The Macros extension allows you automate actions for your presentation - such as scene switching or showing/hiding sources through a keypress and even starting your broadcast or recording during a set time.

You'll be able to access it by going to Extensions then selecting Macros.

Creating Macros

1. Click the Add macro button to create a new macro.

2. You can rename your macros by clicking the icon.

3. Select the event that will trigger the macro from the drop-down menu.

4. Additional drop-down menus will appear depending on your selected event.

5. Select an action to perform from the drop-down menu.

6. Additional drop-down menus will appear depending on your selected action.

7. Clicking will add another action to the macro that will run after the previous one.

8. Once you're done, click Enable event listener. This will make the extension continuously check if the event conditions are satisfied then execute the actions sequentially.

   If your Event is set to On key press, we recommend disabling the event listener first before changing the hotkey assigned since it will automatically run the macro while changing it.

• Clicking the Test button will trigger the macro without waiting for the event conditions to be satisfied.

  

• - Copies an Event or Action's script to the Clipboard.
  - Creates a copy of a Macro or Action.
  - Deletes a Macro or Action.
  You can also swap the order of actions by dragging the label on top of another one.

For examples on how you can use macros, visit this blog post:
How to use Macros in XSplit Broadcaster

Events

On key press

Triggers the macro when the key or mouse click combination set is pressed similar to Hotkeys.

Every interval

Triggers the macro at every time interval set in milliseconds.

On scheduled time

Triggers the macro at the set hour.

On scene switch

Triggers the macro when the selected scene becomes active.

When a stream source goes online/offline

Triggers the macro when the selected stream source in a scene goes online or offline. Works with RTMP, RTSP and NDI stream sources.

When a media source stops

Triggers the macro when a specific media source stops.

Custom Script

See Custom Script section below.

Actions

Wait

Waits for a time interval before going to the next action.

Start/stop broadcast

Starts or stops one of your streaming outputs, Local Streaming or Local Recording.

Switch to scene

Switches to a specific scene in your presentation.

Set scene transition

Sets a specific scene's transition. Also supports Stingers.

Set source visibility

Shows, hides or toggles the visibility of a specific source from a chosen scene. Note that source transitions are also triggered when a source is shown or hidden.

Set media source playback state

Plays, pauses or stops a specific media source. Works on both video and audio media sources.

Set source audio state

Mute or unmute a source's audio output.

Run macro

Runs a different macro.

Stop macro

Stops a different macro.

Enable/Disable macro listener

Enable or disable another macro's event listener.

Go to action

Go to another action in the same macro. Currently does not work with all available actions.

Custom Script

See Custom Script section below.

Custom Scripts

The Custom scripts functionality for the Macros extension are still being changed and improved so documentation and guidelines for them are a work in progress. For now, you can experiment on modifying existing events and actions by clicking the to copy their scripts to the clipboard and pasting them to a custom script action.