Install DJF Companion Profile on a Mac

 

Companion also runs on Windows and Pi.

This article will focus on a Mac installation.

Running Companion is one of those “easy when you know how” things.

This article will show you how. Easy!

There are 6 Segments we will dive into below:

  1. Companion 2.2.0
  2. Blackmagic Switcher Software 8.6.3
  3. Stream Deck 5.0
  4. VLC 3.0.13
  5. VICREO 3.0.3
  6. H2R 0.4

 

 

1. COMPANION (2.2.0 – beta build)

Download Companion:

    • The DJF Companion Profiles require running Companion 2.2.0 to support the most up-to-date features and modules.
    • You will not be able to operate or install this profile using Companion 2.1.3.
    • DJF Companion Profile was built and tested using 2.2.0 build 3479. Don’t use a build prior to 3479. It is generally recommended to simply use the most recent build available.
    • While 2.2.0 is still pre-release, it’s generally pretty stable. That said, make sure you thoroughly test your setup before implementing in a live production.

 

Open Companion

    • If running for the first time, right-click the Companion app and select “Open”.
    • You’ll receive a notification that the developer is unknown. Cancel this.
    • Right-click “Open” a second time, and now you can open the app.
    • Companion’s Web Server icon will be in the top-right menu bar. Click it to open the tray.
    • Check the server is running locally on 127.0.0.1 (easiest setup).
    • Set the Port to 8000 (or 8888)
    • Launch GUI in a web browser.

 

Install the DJF Companion Profile

    • Navigate tabs to Buttons > Import/Export.
    • If you already have your own custom Companion setup, click “Export” to save a backup of your profile first!

 

  • Replace Current Configuration (recommended)
    • Select Import. Choose the DJF Companion Profile file (ends with “.companionconfig”)
    • Select “Replace current configuration”.
      • **Note that this will wipe all existing Companion pages, so make sure you’ve backed up any essential work first!

  • Individual page import (not recommended)
    • Note that the DJF Companion Profile pages are heavily inter-connected, hence it is recommended to “replace current configuration”. While you can copy and paste buttons quite easily after the initial “replace current configuration”, importing individual pages will require manually updating the Page-jump actions, plus you must be careful to target the correct instance label of a module when importing.
    • If you still wish to import individual pages, note that there are also several “backend” service pages need to be imported to very specific pages to maintain integrity:

 

        • Backend service pages for v3.0:
          • Extreme………..Pages 55, 56, 57, 58
          • Pro………………Pages 83, 84
        • Backend service pages for v2.5:
          • Pro………………Pages 22, 23

 

    • Once those backend pages have been imported to their specific page numbers, you can import individual pages to any other Companion page.
      • If dealing with a dual profile that contains both Extreme and Pro, make sure you target the correct instance (i.e. “ext-atem” and “pro-atem” are completely different implementations of the same ATEM Module).
      • Note that any Menu or Page-jump buttons will need to have their action “Set surface with s/n to…” updated manually.
    • For example, if you wanted to import the Extreme’s VLC page:
      • Import DJF Companion Profile Pages 55, 56, 57, 58 to their respective Pages, 55, 56, 57, 58 in your Companion profile.
      • Import the Extreme VLC (Page 30) to whatever blank page you have available in your configuration.
      • Update the Page-jump button actions (ie VLC’s Button #1) to target your configuration layout.

 

Set ATEM Module’s Target IP Address

    • Under the Connections tab, click “Edit” for the “atem Blackmagic Design” module. Update the Target IP to the IP address for your ATEM Mini/Pro/ISO, and for your ATEM Mini Extreme/ISO if running dual systems.
      • **Note: it is recommended to keep the instance labels the way they are (i.e. “ext-atem” and “pro-atem” etc.) Changing the instance label names will update most – but not all – variable names, and will leave some button text (i.e. the BLK button) unable to find the new name.
      • **Note: you can find the ATEM IP using BlackMagic’s “ATEM Setup Software”. Setting a static IP address is recommended.
    • All other modules (VLC, H2R, VICREO, OSC) are pre-set to local 127.0.0.1 and don’t need to be changed.

Set the Home Page

    • Under the Surfaces tab, click the green “Settings” button for the “Elgato Streamdeck Plugin” (or the actual Stream Deck serial number, if running Companion solo).

 

        • Slide the Page number for your specific profile: 
          • DJF PROFILE v3.0
            • 32-button Extreme…………………..PAGE 1
            • 32-button Pro…………………………PAGE 66
            • Vertical Pro…………………………….PAGE 88
            • Vertical Extreme……………………..PAGE 93 
          • DJF PROFILE v2.5
            • 32-button Pro…………………………PAGE 1
            • 15-button Pro…………………………PAGE 31
            • Vertical Pro…………………………….PAGE 71

Make Changes to Companion’s Settings

    • “Remove the Topbar on all buttons”:
      • Go to Companion > Settings > Navigation Buttons > “Remove the topbar on each button” > SELECT “Enabled”.
      • **Note that the PNGs and text layout on the DJF Companion Profile buttons have been designed for the full 72 x 72px.m The buttons will look squished unless you remove the topbar.
    • “Enable OSC”:
      • Go to Companion > Settings > OSC > SELECT “Enabled”.
      • Set the OSC Listen Port to “12321”.

Troubleshooting:

    • If your Stream Deck is plugged in but the Companion buttons are not showing up, go to Companion’s “Surfaces” tab, and click “Rescan USB”
    • If you’d like to run this without a the actual Stream Deck hardware (i.e. use it on a computer or tablet instead), click on “Emulator” in the top left corner. Locally, the address will be http://127.0.0.1:8000/emulator
    • If there’s a conflict while running Elgato Stream Deck’s native software simultaneously with Companion, quit both applications.
      • Then try opening Elgato’s Stream Deck software first;
      • then starting the Companion server secondly.
        • (Make sure the Companion Plugin within the native Elgato Stream Deck app has been installed – see “Stream Deck” installation instructions below).
    • **Note: The DJF Companion Profiles require running Companion 2.2.0 to support the most up-to-date features and modules. Some functions will be missing if you try to operate the profile using Companion 2.1.3.

 

 


2. BLACKMAGIC ATEM SWITCHERS (8.6.3)

Install ATEM Switcher software

    • Download and install the most recent ATEM Switcher software from Blackmagic Design’s Support page.
      • (Each “update” is a full program installation, so the most recent version will suffice).

 

Set a Static IP Address

    • Connect your computer to the ATEM via USB.
    • When connected via USB (as opposed to ethernet), you will be able to change the IP address of the ATEM within the “ATEM Setup” application.
    • Choosing a static IP address appropriate to your router’s range is recommended.
      • Your settings will likely differ, but for example:
        • Router            192.168.1.1
        • Computer       192.168.1.2
        • ATEM             192.168.1.3
    • Within Companion, make sure the ATEM Module’s Target IP has been updated with the new IP Address that was set for the ATEM hardware (as previously mentioned in the Companion setup).

 

Install DJF Macros in ATEM Software Control

    • Open the “ATEM Software Control” application.
    • Go to File > Restore
    • Choose the “DJF-ATEM-MACROS.xml” that came with your DJF Companion Profile and restore Macros.
      • Basic requirement is to install the Macros only.
        • Deselect all options, then select “Macros” only
      • Selecting all options will restore the Media Pool and other presets – this is not essential, but included as a courtesy to help with understanding presets, Super Source layouts, Chroma Keying and so on.
    • Go to File > Save Startup State to commit the macros to the ATEM hardware.
    • Once you’ve “Saved the Startup State”, the macros will still be present each time you power on the ATEM. The ATEM can now operate without the need for Blackmagic’s ATEM Software Control application.

 

Troubleshooting

    • Companion speaks directly to the ATEM via the Ethernet Network and does not require the ATEM Software Control to be running in order to operate.
    • Note that Companion only speaks to the ATEM via Ethernet, not the USB port. While you can install the ATEM Macros via a USB connection, you will need an Ethernet connection to control the ATEM via Companion.

 

 


3. STREAM DECK (5.0)

 

Elgato Stream Deck software is available here

Add the Companion Plugin to your native Elgato Stream Deck software

    • Open the Stream Deck Store
    • Search for “Companion”.
    • Install the Companion plugin.

 

Back up your own Stream Deck Profiles

    • If you are already using Elgato’s Stream Deck software, make sure you back up your work first!
    • Go to the Stream Deck Icon in the top-right menu bar
    • Select “Preferences” (Command + ,), then “Profiles”.
    • To the right of the “+/-” symbols, select the dropdown menu.
    • Go Backup All > Create Backup…
    • Save the file to a safe folder.

 

Install the bonus Stream Deck Profiles

    • FULL RESTORE
    • Go to the Stream Deck Icon in the top-right menu bar
    • Select “Preferences” (Command + “,”), then “Profiles”.
    • To the right of the “+/-” symbols, select the dropdown menu.
    • Go Backup All > Restore From Backup…
    • Select the file ending in “.streamDeckProfilesBackup” to restore a full backup
    • INDIVIDUAL PAGE RESTORE
    • Alternatively, if you don’t want to overwrite your existing setup, you can import individual pages.
    • Go to the Stream Deck Icon in the top-right menu bar
    • Select “Preferences” (Command + “,”), then “Profiles”.
    • To the right of the “+/-” symbols, select the dropdown menu.
    • Select “Import…”
    • Find the individual profile ending with “.streamDeckProfile”
      • Note that when importing individual Stream Deck Profiles, the “profile jump” buttons will need to be manually re-linked to the appropriate profile (by contrast, these links will remain intact if “restoring a full backup” instead).

 

Creating Companion buttons on your Stream Deck Profile

    • You can also build your own Elgato Stream Deck profile pages in conjunction with Companion.
    • From the right sidebar, again Search “Companion”
    • Drag the “Companion button” to each of the Stream Deck’s keys
    • “Dynamic” vs Static pages/buttons:
      • By default, dragging a Companion button on to Stream Deck will create a Dynamic Button.
      • Not modifying the default Dynamic button is recommended, as it will update the function as you navigate through the Companion Profile, however:
    • “Static” buttons:
      • If you want a dedicated Companion button that does not change when the Companion surface does, choose the specific Page and Button number (as found in your Companion software)

 

Simultaneously running Elgato Stream Deck software and Companion’s server

    • You can now mix native Stream Deck buttons into your Elgato Stream Deck’s Companion profile page
    • Button #9 in the DJF Companion Profile (the 1st button on the 2nd row of every page) has been reserved across all Companion pages. When running Companion solo, this button will jump between profiles within Companion.
    • However, if you are also running native Stream Deck software, Button #9 will now switch between your Stream Deck profiles (yes- all these names get confusing!!). This is to allow you to create a dedicated Stream Deck button to switch to other native Elgato Stream Deck profiles you may have.
      • If using this option, you’ll have to use Button #22 on the Menu page to switch between different Companion Profiles (i.e. to jump between controlling the ATEM Pro vs Extreme).
    • It’s recommended to leave all other buttons on the profile as the default “Dynamic” state, so that Companion will dynamically update them

 

Troubleshooting

    • If there’s a conflict while running Companion and Elgato Stream Deck’s native software simultaneously:
      • Quit both applications.
      • Then try opening Elgato’s Stream Deck software first, then starting the Companion server secondly.
      • Make sure you have installed the Companion Plugin within the native Elgato Stream Deck app.
    • If you are trying to run a 15-button or 32-button Stream Deck XL surface simultaneously but independently to the Vertical Stream Deck Mobile app surface on your phone (ie so your two surfaces don’t change pages in sync):
      • Quit both Companion and Stream Deck software
      • Open Companion first
        • Under the Surfaces tab, click “Rescan USB”
        • The “Elgato Streamdeck XL device” will appear with a specific serial number under the ID field.
          • This locks the USB connection to Companion.
          • Note that this also means only Companion buttons will show on the hardware, not the native Stream Deck software.
      • Next open Elgato’s native Stream Deck software
          • The Companion Plugin within the Stream Deck software is now targeting the “Emulator” surface within Companion.
        • Open the Stream Deck Mobile app on your phone
        • Ensure your phone’s WiFi is connected to the same network as the computer
        • Enjoy!

 

 


4. VICREO LISTENER (3.0.3)

Download VICREO

Install and Open

    • Leave Default Port Number 10001
    • Close the window and the app will still run in the top-right menu bar
    • That’s it! (phew – that one was easy, right?)

 

 


5. VLC (3.0.13)

Download VLC

Connect your Computer to HDMI 4

    • **If you have a Macbook, you may need a USB-C-to-HDMI adapter.
    • Connect the HDMI cable from your computer to the ATEM input HDMI 4.
    • Under Mac’s System Preferences > Displays > Arrangement… Uncheck “Mirror Displays”.
    • Under VLC > Video > Full Screen Video Device… Select the appropriate display that is feeding into ATEM’s HDMI 4.

 

Configure VLC to connect to Companion

    • Preferences > Show All > Interface tab > HTTP Web Interface
      • Enable HTTP web interface
        • Set password to “vlcpassword” (this is the password within the DJF Companion Profile VLC module. If you use a different password in VLC, make sure to update the password within the VLC module in Companion).
    • Preferences > Show All > Interface tab > Show All > interface > main interface
      • Select “Web”
      • Select “Telnet”
    • Preferences > Show All > Interface tab > Show All > interface > main interface > macosx
      • Deselect “use the native fullscreen mode”
      • Deselect “Show fullscreen controller”
    • Preferences > Show All > Interface tab > Show All > interface > main interface > macosx
      • Select “Play and Pause”
    • Preferences > Subtitles/OSD tab > Onscreen display
      • Disable “Enable OSD”

 

 


6. H2R Graphics (0.4)

Download H2R Graphics

Create a Chroma Shortcut Key

    • Open Mac’s System Preferences > Keyboard > Shortcuts > App Shortcuts
      • Press the “+” button
      • Application: H2R Graphics
      • Menu Title: Chroma
      • Keyboard Shortcut: “OPTION+1”

 

Install DJF Bonus Preset

    • Note: this bonus DJF Profile for H2R is just to help you understand some of the Custom CSS available within H2R.
    • Open H2R Graphics
    • Under the Settings tab on the far right > Themes > Load
      • Select the bonus H2R Graphics template that came with the DJF Companion Profile:
      • “DJF_H2R_Graphics.json”