Telestream Wirecast Plugin for Stream Deck User Guide
- June 6, 2024
- Telestream
Table of Contents
Telestream Wirecast Plugin for Stream Deck User Guide
Wirecast Plugin for Stream Deck
Introduction
Elgato Stream Deck is a customizable control pad for producing live broadcasts. Use the Wirecast plugin for Stream Deck to program shortcuts, enabling you to streamline your Wirecast workflows.
Requirements
- A Stream Deck control panel, plugged into your computer via USB.
- Stream Deck software (for Windows or Mac) located at: https://www.elgato.com/en/gaming/downloads.
- Wirecast software
- Minimum OS versions: Windows 10, MacOS 10.12
Installation
- Connect your Stream Deck controller via USB on your computer.
- Download the Stream Deck software at: https://www.elgato.com/en/gaming/downloads.
- Open the Stream Deck software application and click the More Actions button in the lower right corner.
- Locate the Wirecast Stream Deck plugin on the list and click Install.
Using Stream Deck
Note: For the Wirecast Stream Deck plugin to work properly, there should be only one Wirecast document open on your computer.
After installing the Stream Deck plugin, there should be a new category of actions named Wirecast located on the list of actions on the right side of the Stream Deck application window.
The actions listed under Wirecast are: Shot, Multi Shot, Go, Auto Live, Stream and Record. Click and drag any of the Wirecast action icons to the Stream Deck button panel to create a new custom button. The Stream Deck hardware panel will mirror what is displayed on the button panel. You can configure the button using the Property Inspector.
Note: When a “?” is displayed on a button, it
indicates that you do not have an underlying shot that is being referenced in
your Wirecast document.
The colour of the buttons in Stream Deck correspond to layer colours in Wirecast: Blue = 1, Grey = 2, Yellow = 3, Orange = 4, Navy = 5.
Layer colours are turned on and off in Wirecast from the File >Preferences
Shot Display Theme menu. Select Keys or XKeys – Layer Backgrounds to toggle colour displays.
Shot Action
A shot can be configured in the Property Inspector by selecting one of three modes: By Grid Position, By Index and By Name. (Default mode is By Grid Position).
By Grid Position
By Grid mode maps the shot action to the same button location on a Wirecast
layer. For example, placing a shot in the upper left-hand corner of the Stream
Deck button panel, maps this shot to the top-most layer and the shot farthest
to the left in your Wirecast document. This corresponds to the Clear Layer
shot of the first layer in Wirecast.
By Index
By Index mode enables you to select a shot in Wirecast by selecting its master
layer and shot index numbers. When By Index is selected, Master Layer and Shot
Index pull-down menus are displayed. Select a layer and shot number from these
menus. Shots are numbered from left to right, corresponding to their placement
on a layer. The Clear Layer shot is labelled Clear Layer.
By Name
By Name mode allows you to choose the shot in Wirecast that this shot action maps to by selecting the name of your shot from available shots in your active document.
Once a shot action is mapped to a shot in Wirecast by one of the above three
modes, pressing the assigned button on the Stream Deck board performs the same
actions as clicking on the corresponding shot in Wirecast.
The displayed image of a shot on the Stream Deck grid notifies you of whether the Wirecast shot is LIVE, IN PREVIEW, Both, or Neither.
LIVE A red dot is displayed on top of the shot’s regular icon
IN PREVIEW A green dot is displayed
Both A red dot is displayed (same behaviour as in Wirecast)
Neither No dot displayed. When in By Grid or By Index mode, the layer and
index number of your shot will be displayed on the button. When in By Name
mode, the name of the shot in Wirecast is displayed on the button.
Alternatively, in any mode you can enter a Title in the Property
Inspector to override the default name. Click the “T” pull-down menu to
display the font settings.
Multi Shot Action
Multi Shot actions can be configured to map to a single shot in each layer. Pressing a Multi Shot button performs the same action as selecting each of the mapped shots in quick succession, enabling multiple shots to go live with the press of one button. The Multi Shot action can be configured in the Property Inspector by selecting one of the following modes: By Grid , By Index or By Name. (See Shot Action above for mode definitions).
To create a Multi Shot, click and drag the Multi Shot icon to a target button. Select a mode: By Index or By Name from the Mode pull-down menu. Map one shot for each layer by using pull-down menus in the Property Inspector.
Note: There is a status indicator (red or green dot) on a Multi Shot button. However, if a shot contained in a Multi Shot is also mapped to the Stream Deck as an individual shot, it will take the properties of the individual shot when showing as LIVE, IN PREVIEW, both, or neither (as defined in the Name Action above).
Go Action
To create a Wirecast Go button, click and drag the Go icon to a target button on the button panel. The new button resembles the Go button in Wirecast.
Pressing the Go button on the Stream Deck control panel performs the same actions as clicking Go in Wirecast, taking a shot from Preview to Live.
AutoLive Action
To create a Wirecast AutoLive button, click and drag the AutoLive icon to a target button on the button panel. The new button resembles the Go button in Wirecast with a red dot indicator. The display of a red dot indicates that Wirecast is in AutoLive mode. Pressing this button toggles AutoLive on and off.
Stream Action
To create a Wirecast Stream button, click and drag the Stream icon to a target button on the button panel. Pressing the Stream button performs the same actions as clicking Start/Stop Broadcasting button in Wirecast. The image will turn green when Wirecast is broadcasting.
Record Action
To create a Wirecast Record button, click and drag the Record icon to a target button on the button panel. Pressing the Record button performs the same actions as clicking Start/Stop Recording button in Wirecast. The image will turn green when Wirecast is recording.
Note: If you are using a Mac, there is currently no way to check if Wirecast is recording or broadcasting through AppleScript.
Anytime a broadcast or record action is added to the Stream Deck control panel, or if the Stream Deck application is loaded with previously added broadcast/record actions, then Wirecast is assumed to be in a state of NOT BROADCASTING and NOT RECORDING (and the icons are greyed-out).
The broadcast and record images do not synchronize with Wirecast. For example, if you click Start Recording in the Wirecast GUI, the image on the Stream Deck grid will not turn to colour. It still assumes Wirecast is NOT RECORDING.
To sync the record/broadcast actions with Wirecast when they are out of sync, simply press the record/broadcast action that is out of sync. For example, if Wirecast is broadcasting, but the broadcast image on the Stream Deck is greyed-out, press the broadcast action and its image will display colour.