HLS User Manual and Reference Guide: Difference between revisions

Latest revision as of 00:52, 26 October 2013

This User Manual and Reference Guide is a detailed guide to using all aspects of HLS. It is currently under significant development.

To quickly get up and running with a sequence, you may want to look at the HLS Getting Started Manual.

Due to the rapid development of HLS, the links that follow will contain, in parenthesis, information that can help the user with a quick visual inspection:

##X: The page is up to date as of the listed version.
CN: Content Needed to complete the page and it currently contains very little information.

Getting HLS

Creating a Sequence

An HLS Sequence consists of an audio file (generally) with lighting and other effects synchronized with the music.

HLS Sequence Creation Wizard (16J)

Channel Management

Managing channels in HLS is one of the core tasks to building a sequence. Each of the sub-pages will address various channel configurations and tasks.

Advanced Channel Management (16J)

Configuring Display Groups (16J)

Display Preview

A Display Preview is a method of previewing how a display will look by assigning virtual channels to drawn objects superimposed over a picture.

Creating a Display Preview (16J)

Sequencing Channels and Adding Effects

Sequencing is the main "work" of syncronizing effects with the music. HLS has basic effects which can be combined into more complex compound effects. The sub-pages in this section discuss the various methods of adding effects to sequences.

Creating Basic Effects (16J)

Adding and Using Beat Tracks (16J)

Setting Defaults for Effects (16J)

Creating Chase Effects (16J)

Mirroring Effects (16J)

Fill Effects (16J)

Submaster Lighting Channels (16J)

Sequencing with RGB Channels (16J)

Custom Effects (16J)

Creating a Library of Group Effects (16J)

Creating and Using PixelPlanes

A PixelPlane is a single channel in the sequence editor that represents multiple pixels. This allows macro control of pixels, with the ability to "drop" effects onto a plane, such as with Nutcracker, and manipulate the entire effect as if it were one channel.

Creating a PixelPlane (16J)

The PixelPlane Editor: Creating Effects (16J)

Using Nutcracker with a PixelPlane (16J)

Fill Channels (16J)

PixelPlane Transitions Using Lighting Channels (16J)

Drawing a PixelPlane in the Display Preview (16J)

Facial Animation

Facial Animation (CN)

Sequence Playback

Sequence Playback (16J)

Sequence Output

Preparing Channels for Output (13F)

Hardware Configuration (13F)

Working with Playlists (13F)

Creating and Running a Schedule (13F)

Advanced Features

Trigger Events (CN)

RDS Output (16K)

Servo Motors (CN)

Remote-Controlled Video Player (CN)

Using Audacity Labels (16J)

Importing and Exporting Data and Sequences

Using HLS Sequence Images (16J)

Importing and Exporting CSV (16J)

Importing a Sequence from Vixen (16J)

Importing a Sequence from LOR (16J)

Sharing HLS Sequences (16J)

Sharing Library Effects (16J)

Copying and Pasting Channels from Another Sequence (16J)

Reference Guide

Restoring a Sequence from Backup (16J)

HLS Dimming Curves (16J)

Crosshair Cursor (16J)

The HLS Toolbar (16J)

Master Lighting Channel (16J)

@@ Line 3: / Line 3: @@
 [[File:HLS-Logo.jpg|250px]]<br />
-This User Manual and Reference Guide is a detailed guide to using all aspects of HLS.  It is currently under significant development. To quickly get up and running with a sequence, you may want to look at the '''[[HLS Getting Started Manual]]'''.
+This User Manual and Reference Guide is a detailed guide to using all aspects of HLS.  It is currently under significant development.
+To quickly get up and running with a sequence, you may want to look at the '''[[HLS Getting Started Manual]]'''.
+Due to the rapid development of HLS, the links that follow will contain, in parenthesis, information that can help the user with a quick visual inspection:
+*'''##X:''' The page is up to date as of the listed version.
+*'''CN:''' '''C'''ontent '''N'''eeded to complete the page and it currently contains very little information.
 __TOC__
 ===Getting HLS===
+----
 ====[[Download and Installation]]====
 ====[[Upgrading HLS]]====
-<br /><br />
+====[[Moving HLS Data Directories]]====
+<br />
 ===Creating a Sequence===
+----
 An HLS Sequence consists of an audio file (generally) with lighting and other effects synchronized with the music.
-====[[Starting a new HLS Sequence]]====
+====[[HLS Sequence Creation Wizard]] (16J)====
-====[[Audio File]]====
+====[[Time Resolution]] (16J)====
-====[[Time Resolution]]====
+<br />
-<br /><br />
 ===Channel Management===
+----
 Managing channels in HLS is one of the core tasks to building a sequence.  Each of the sub-pages will address various channel configurations and tasks.
-====[[Setting up HLS Channels]]====
+====[[Setting up HLS Channels]] (16F)====
-====[[Configuring Display Groups]]====
+====[[Advanced Channel Management]] (16J)====
-====[[Adding and Deleting Channels]]====
-====[[RGB Channels]]====
+====[[RGB Channels]] (16J)====
-====[[Pixel Channels]]====
-====[[Converting 3 Channels into a Single RGB Channel]]====
+====[[Configuring Display Groups]] (16J)====
-====[[Using Folders]]====
+====[[Sticky Channels]] (16J)====
-====[[Displaying a Group in the Main Window]]====
+====[[Segment Channels]] (16J)====
-====[[Importing and Exporting]]====
+<br />
-=====[[Comma-Separated Values (CSV)]]=====
-=====[[Importing a Sequence from Vixen]]=====
-=====[[Importing a Sequence from LOR]]=====
-=====[[Moving or Sharing Sequences]]=====
-=====[[Sharing Library Effects]]=====
-<br /><br />
 ===Display Preview===
+----
 A Display Preview is a method of previewing how a display will look by assigning virtual channels to drawn objects superimposed over a picture.
-====[[Creating a Display Preview]]====
+====[[Creating a Display Preview]] (16J)====
-<br /><br />
+<br />
-===Dimming Curves===
-Dimming curves can be used to give the appearance of a more "natural" ramp on and off to LED lights.
-====[[Setting up Dimming Curves]]====
-<br /><br />
 ===Sequencing Channels and Adding Effects===
+----
 Sequencing is the main "work" of syncronizing effects with the music.  HLS has basic effects which can be combined into more complex compound effects.  The sub-pages in this section discuss the various methods of adding effects to sequences.
-====[[Adding and Using Beat Tracks]]====
+====[[Creating Basic Effects]] (16J)====
-====[[Creating Basic Effects]]====
+====[[Adding and Using Beat Tracks]] (16J)====
-====[[Setting Defaults for Level, Ramps, and min/max out]]====
+====[[Setting Defaults for Effects]] (16J)====
-====[[Creating Chase Effects]]====
+====[[Creating Chase Effects]] (16J)====
-====[[Mirroring Effects]]====
+====[[Mirroring Effects]] (16J)====
-====[[Fill Effects]]====
+====[[Fill Effects]] (16J)====
-====[[Over Control Ramp]]====
+====[[Submaster Lighting Channels]] (16J)====
-====[[Custom Effects]]====
+====[[Sequencing with RGB Channels]] (16J)====
-====[[Creating a Library of Group Effects]]====
+====[[Custom Effects]] (16J)====
+====[[Creating a Library of Group Effects]] (16J)====
+<br />
+===Creating and Using PixelPlanes===
+----
+A PixelPlane is a single channel in the sequence editor that represents multiple pixels.  This allows macro control of pixels, with the ability to "drop" effects onto a plane, such as with Nutcracker, and manipulate the entire effect as if it were one channel.
+====[[Creating a PixelPlane]] (16J)====
+====[[The PixelPlane Editor: Creating Effects]] (16J)====
+====[[Using Nutcracker with a PixelPlane]] (16J)====
+====[[Fill Channels]] (16J)====
+====[[PixelPlane Transitions Using Lighting Channels]] (16J)====
+====[[Drawing a PixelPlane in the Display Preview]] (16J)====
+<br />
+===Facial Animation===
+----
+====[[Facial Animation]] (CN)====
+<br />
+===Sequence Playback===
+----
+====[[Sequence Playback]] (16J)====
+<br />
+===Sequence Output===
+----
+====[[Preparing Channels for Output]] (13F)====
+====[[Hardware Configuration]] (13F)====
+====[[Working with Playlists]] (13F)====
+====[[Creating and Running a Schedule]] (13F)====
+<br />
+===Advanced Features===
+----
+====[[Trigger Events]] (CN)====
+====[[RDS Output]] (16K)====
-===[[The PixelPlane]]===
+====[[Servo Motors]] (CN)====
-A PixelPlane is a single channel in the sequence editor that represents multiple pixels.  This allows macro control of pixels, with the ability to "drop" effects onto a plane, such as with Nutcracker, and manipulate the entire effect as if it was one channel.
+====[[Remote-Controlled Video Player]] (CN)====
+====[[Using Audacity Labels]] (16J)====
+<br />
-====[[PixelPlane Editor]====
+===Importing and Exporting Data and Sequences===
-=====[[MegaTree]]=====
+----
-=====[[Using Nutcracker with the PixelPlane]]=====
+====[[Using HLS Sequence Images]] (16J)====
+====[[Importing and Exporting CSV]] (16J)====
+====[[Importing a Sequence from Vixen]] (16J)====
+====[[Importing a Sequence from LOR]] (16J)====
+====[[Sharing HLS Sequences]] (16J)====
+====[[Sharing Library Effects]] (16J)====
+====[[Copying and Pasting Channels from Another Sequence]] (16J)====
+<br />
-===[[Sequence Playback]]===
+===Reference Guide===
-===[[Outputting the Sequence]]===
+----
-====[[Hardware Configuration]]====
+====[[Restoring a Sequence from Backup]] (16J)====
-====[[Selecting the Output Method]]====
+====[[HLS Dimming Curves]] (16J)====
-====[[Working with Playlists]]====
+====[[Crosshair Cursor]] (16J)====
-====[[Creating and Running a Schedule]]====
+====[[The HLS Toolbar]] (16J)====
-===[[Advanced Hardware Configuration]]===
+====[[Master Lighting Channel]] (16J)====
-====[[Trigger Events]]====
+<br />
-====[[RDS Output]]====
-====[[Servo Motors]]====
 [[Category:HLS User Manual]]
 [[Category:HLS]]
+[[Category:DIYC Software]]
 [[Category:DIYC Index]]
+[[Category:Pixel]]