Documentation

Welcome!

This is the documentation for Beam. This documentation is  aimed to have all information about the current release. For older releases you can find an offline copy in Beam itself.

As this is the first release of Beam, we do not have changelog. Instead we consider all features as new!

Also have a look into our FAQ for questions often asked.

Installation

Each platform require different installation scenarios, please refer to the Downloads-page for specific platforms.

Getting started

After installing Beam you need to set which media player to connect to.  This is done in the preferences.

File->Preferences

Under Basic settings, Media player, select your media player. Now you are good to go!

Screenshot 2015-03-01 13.58.41

Configuring Beam

The main interface

The main window of Beam will display your songs. When using Beam at a milonga, simply open Beam (which you have configured). Move it to the projector or external screen, and set it to full screen.

Screenshot 2015-03-01 13.58.12
Scaling and fullscreen

As a window, Beam is scaled by dragging the boarders of the window. Beam can be set to full screen by double-clicking in the window or F11. Beam can scale to 4:3, 16:9, 16:10 or any dimensions of your projector or screen.

 

Preferences

All settings for Beam is configured from the preferences.

Basic Settings

The basic settings control how to retrieve song information from the media players and some look- and feel-information.

Screenshot 2015-03-01 14.01.25
Layout

In Layout menu you configure what to display in Beam. This is done with a combination of static text and tags. A list of all tags available in Beam can be found here.

Screenshot 2015-03-01 14.01.34

Cortinas and Rules

Under Cortinas and Rules you set up how Beam will find cortinas and parse information the tags. As Beam is intended for tango, we have created an additional tag which is not present in the ID3-tags, %Singer. Intention is to fill this with information such as name of singer or instrumental. See below.

In the Cortinas and rules you can add, remove, edit, toggle rules to be active or inactive.

Screenshot 2015-03-01 14.01.46

There are three types of rules in Beam:

Copy-rule
Copies a value from one field to another. This is very useful for %Singer this information probably is stored in some other tag in your files.

Screenshot 2015-03-01 14.04.35

Parse-rule
This rule is used to handle combined tags. Tags containing for example “Nada – Alberto Podestá”  can with the rule below be separated into %Title and %Singer.

Screenshot 2015-03-01 14.04.51

Cortina-rule
Detecting cortinas are vital to be able to detect the next tanda. Beam is able to show information about the next tanda, only if the cortina is detected in the playlist. This feature is dependent on which media player you are using. See the feature-list for more info about this.

Screenshot 2015-03-01 14.05.26

Screenshot 2015-03-01 14.05.14

Screenshot 2015-03-01 14.09.04

 Moods

For moods settings, see separate section here.

Beam me up scotty!