Difference between revisions of "Settings"
| Line 11: | Line 11: | ||
The sequence type, media file name or location, the sequence duration and whether media tags can be overwritten can be changed from this tab after the sequence has been created. | The sequence type, media file name or location, the sequence duration and whether media tags can be overwritten can be changed from this tab after the sequence has been created. | ||
| + | |||
| + | [[File:InfoMedia.png]] | ||
| Line 18: | Line 20: | ||
xLights/Nutcracker will parse and retrieve the information from the media file. It won't update any information entered on the media/info screen unless the Overwrite Media Tags setting on the Media/Info screen is ticked. | xLights/Nutcracker will parse and retrieve the information from the media file. It won't update any information entered on the media/info screen unless the Overwrite Media Tags setting on the Media/Info screen is ticked. | ||
| + | |||
| + | [[File:MetaData.png]] | ||
====Timings==== | ====Timings==== | ||
The Timings tab enables you to create or import one or more sets of timing marks on timing tracks for the audio of your sequence. | The Timings tab enables you to create or import one or more sets of timing marks on timing tracks for the audio of your sequence. | ||
This screen is part of the flow when creating a new sequence or can be accessed via this tab at any time after creating a sequence to add additional timing tracks. | This screen is part of the flow when creating a new sequence or can be accessed via this tab at any time after creating a sequence to add additional timing tracks. | ||
| − | |||
| + | [[File:Timing_3.png]] | ||
| + | |||
| + | Note: This component uses the VAMP plug-ins to generate the timing marks. | ||
You can create new timings (which use the VAMP plugins) or you can import external (Audacity ) timings files. | You can create new timings (which use the VAMP plugins) or you can import external (Audacity ) timings files. | ||
| + | [[File:Timing_4.png]] | ||
| + | |||
| + | Selecting one of the options then presents a window where you can either select the defaults or change the timing name or any of the plug-in settings. Click Ok and the audio track will be analysed and a timing track will be created. You can then click New again to select another timing track (‘Beats’) to be created | ||
| + | |||
| + | [[File:Timing_5.png]] | ||
| + | |||
| + | Click Ok and the audio track will be analysed and a timing track will be created. You can then click New again to select another timing track (‘Beats’) to be created. | ||
| + | |||
| + | Click Done when complete. | ||
| + | |||
| + | Import | ||
| + | The Import button enables you to import timing marks created externally for example using Audacity or where you have created a timing track manually or wish to import one from another sequencer in a supported format. | ||
| + | You will be presented with a window to navigate to and select a file containing the timing marks. This can be a text file (.txt), a LOR lms file or a LOR LAS file. | ||
| + | |||
| + | |||
| + | Select the required file, click OK to import the timing marks. You can repeat this process to import another file. Click Done when complete. | ||
| + | |||
| + | [[File:Timing_6.png]] | ||
====Data Layers==== | ====Data Layers==== | ||
| Line 36: | Line 60: | ||
You cannot however ‘edit’ any of the imported effects directly. In order to do that see the Import Effects function. The data layer embeds the CONVERT tab into the sequence. The process is used to convert an incoming file from another sequencer into an *.iseq file. Therefore, Vix, Lms, Seq, and Hls data into an ISEQ file. | You cannot however ‘edit’ any of the imported effects directly. In order to do that see the Import Effects function. The data layer embeds the CONVERT tab into the sequence. The process is used to convert an incoming file from another sequencer into an *.iseq file. Therefore, Vix, Lms, Seq, and Hls data into an ISEQ file. | ||
| + | |||
| + | [[File:Import_1.png]] | ||
| + | |||
| + | [[File:Import_2.png]] | ||
| + | |||
| + | [[File:Import_3.png]] | ||
| + | |||
| + | [[File:Import_4.png]] | ||
| + | |||
| + | [[File:Import_5.png]] | ||
===Render On Save=== | ===Render On Save=== | ||
The default setting is to render all the effects of all the models and groups when saving the xml. If this setting is unticked (i.e. to turn off), then it will only save the XML when you click Save / Save As, resulting in a very fast save operation. Then you can render using the Render All button when you really need to create an fseq file or need to make sure what you are previewing is fully up to date. | The default setting is to render all the effects of all the models and groups when saving the xml. If this setting is unticked (i.e. to turn off), then it will only save the XML when you click Save / Save As, resulting in a very fast save operation. Then you can render using the Render All button when you really need to create an fseq file or need to make sure what you are previewing is fully up to date. | ||
| + | |||
| + | [[File:RenderOnSave.png]] | ||
===Tool Icon Size=== | ===Tool Icon Size=== | ||
This function enables you to change the size of the tool icons that are used to represent the effects on the effects ribbon. | This function enables you to change the size of the tool icons that are used to represent the effects on the effects ribbon. | ||
| + | |||
| + | [[File:ToolIcon.png]] | ||
===Grid Spacing=== | ===Grid Spacing=== | ||
This function enables you to change the size (i.e. width of each band) of the sequencer grid. | This function enables you to change the size (i.e. width of each band) of the sequencer grid. | ||
| + | |||
| + | [[File:GridSpacing.png]] | ||
===Grid Icon Backgrounds=== | ===Grid Icon Backgrounds=== | ||
When an effect such as the Morph effect is placed between timing marks (as an example over several seconds long), a representation of the color changes over time for that effect. | When an effect such as the Morph effect is placed between timing marks (as an example over several seconds long), a representation of the color changes over time for that effect. | ||
If you select Off, then the effect on the sequencer grid will only show the generic effect icon and not the colors. Not all effects have this difference. | If you select Off, then the effect on the sequencer grid will only show the generic effect icon and not the colors. Not all effects have this difference. | ||
| + | |||
| + | [[File:GridIconBackground.png]] | ||
===Grid Node Values=== | ===Grid Node Values=== | ||
This function provides the ability to turn off the effect displaying colors at the node level. | This function provides the ability to turn off the effect displaying colors at the node level. | ||
Turing it off improves rendering performance and is recommended where effects are only being dropped at the model level. The value can be turned back on as required. | Turing it off improves rendering performance and is recommended where effects are only being dropped at the model level. The value can be turned back on as required. | ||
| + | |||
| + | [[File:GridNodeValues.png]] | ||
| + | |||
===Render Mode=== | ===Render Mode=== | ||
If the Render Mode is set to Erase (which is the default value), then the fseq file is erased before every render. If set to Canvas Mode, then the data in the fseq is not cleared before a render, rendering is done over the old data. | If the Render Mode is set to Erase (which is the default value), then the fseq file is erased before every render. If set to Canvas Mode, then the data in the fseq is not cleared before a render, rendering is done over the old data. | ||
Note: If set to Canvas mode, deleting an effect will still show when played until it is overridden with a new effect. Imagine a 6 foot painting in which you paint over a 4 foot section. The 2 foot original section is still visible. | Note: If set to Canvas mode, deleting an effect will still show when played until it is overridden with a new effect. Imagine a 6 foot painting in which you paint over a 4 foot section. The 2 foot original section is still visible. | ||
| + | |||
| + | [[File:RenderMode.png]] | ||
| Line 64: | Line 111: | ||
Not all effects support this capability. | Not all effects support this capability. | ||
Always On will display the window in all cases, Always Off won’t display the window and Toggle Mode will display the window if the effect supports it, else won't display the window if the effect does not have this capability. | Always On will display the window in all cases, Always Off won’t display the window and Toggle Mode will display the window if the effect supports it, else won't display the window if the effect does not have this capability. | ||
| + | |||
| + | [[File:EffectAssistWindow.png]] | ||
| + | |||
===Reset Toolbars=== | ===Reset Toolbars=== | ||
The Reset Toolbar option, when selected will reset the Toolbars to the default locations the next time xLights/Nutcracker is started. | The Reset Toolbar option, when selected will reset the Toolbars to the default locations the next time xLights/Nutcracker is started. | ||
| + | |||
| + | [[File:ResetToolbar.png]] | ||
Revision as of 06:28, 4 September 2015
Contents
Settings
Sequence settings
Info/Media
The Info/Media tab displays information about the sequence including the xLights/Nutcracker release that was used to create the sequence, the number of models saved, the Sequence Type (i.e. Media or animated), if media has been specified then the name and location of the media file. The sequence duration, the sequence timing and whether the media tags should be overwritten.
The sequence type, media file name or location, the sequence duration and whether media tags can be overwritten can be changed from this tab after the sequence has been created.
Metadata
The Metadata tab enables the media metadata to be entered or updated. The attributes supported are the author, email, website, song, artist, album, music url and a comment. This information does not drive any functionality in xLights/Nutcracker.
xLights/Nutcracker will parse and retrieve the information from the media file. It won't update any information entered on the media/info screen unless the Overwrite Media Tags setting on the Media/Info screen is ticked.
Timings
The Timings tab enables you to create or import one or more sets of timing marks on timing tracks for the audio of your sequence. This screen is part of the flow when creating a new sequence or can be accessed via this tab at any time after creating a sequence to add additional timing tracks.
Note: This component uses the VAMP plug-ins to generate the timing marks. You can create new timings (which use the VAMP plugins) or you can import external (Audacity ) timings files.
Selecting one of the options then presents a window where you can either select the defaults or change the timing name or any of the plug-in settings. Click Ok and the audio track will be analysed and a timing track will be created. You can then click New again to select another timing track (‘Beats’) to be created
Click Ok and the audio track will be analysed and a timing track will be created. You can then click New again to select another timing track (‘Beats’) to be created.
Click Done when complete.
Import The Import button enables you to import timing marks created externally for example using Audacity or where you have created a timing track manually or wish to import one from another sequencer in a supported format. You will be presented with a window to navigate to and select a file containing the timing marks. This can be a text file (.txt), a LOR lms file or a LOR LAS file.
Select the required file, click OK to import the timing marks. You can repeat this process to import another file. Click Done when complete.
Data Layers
When should you use the data layer to import effects ? Typically if you have sequences from other sequencers such as LSP, LOR, Vixen, HLS that you wish to use within xLights/Nutcracker. The imported sequence is mapped very efficiently as a data image rather than individual effects. After importing the sequencer you can:
- Save it ( an .fseq file is created) and run it within xLights/Nutcracker or via the Falcon Player
- Add xLights/Nutcracker effects to new models via the sequencer
- Selectively override some of the effects from the imported models within xLights/Nutcracker.
You cannot however ‘edit’ any of the imported effects directly. In order to do that see the Import Effects function. The data layer embeds the CONVERT tab into the sequence. The process is used to convert an incoming file from another sequencer into an *.iseq file. Therefore, Vix, Lms, Seq, and Hls data into an ISEQ file.
Render On Save
The default setting is to render all the effects of all the models and groups when saving the xml. If this setting is unticked (i.e. to turn off), then it will only save the XML when you click Save / Save As, resulting in a very fast save operation. Then you can render using the Render All button when you really need to create an fseq file or need to make sure what you are previewing is fully up to date.
Tool Icon Size
This function enables you to change the size of the tool icons that are used to represent the effects on the effects ribbon.
Grid Spacing
This function enables you to change the size (i.e. width of each band) of the sequencer grid.
Grid Icon Backgrounds
When an effect such as the Morph effect is placed between timing marks (as an example over several seconds long), a representation of the color changes over time for that effect. If you select Off, then the effect on the sequencer grid will only show the generic effect icon and not the colors. Not all effects have this difference.
Grid Node Values
This function provides the ability to turn off the effect displaying colors at the node level. Turing it off improves rendering performance and is recommended where effects are only being dropped at the model level. The value can be turned back on as required.
Render Mode
If the Render Mode is set to Erase (which is the default value), then the fseq file is erased before every render. If set to Canvas Mode, then the data in the fseq is not cleared before a render, rendering is done over the old data.
Note: If set to Canvas mode, deleting an effect will still show when played until it is overridden with a new effect. Imagine a 6 foot painting in which you paint over a 4 foot section. The 2 foot original section is still visible.
Effect Assist Window
The effect Assist Window displays a grid which pictorially depicts how an effect is being drawn internally. Not all effects support this capability. Always On will display the window in all cases, Always Off won’t display the window and Toggle Mode will display the window if the effect supports it, else won't display the window if the effect does not have this capability.
Reset Toolbars
The Reset Toolbar option, when selected will reset the Toolbars to the default locations the next time xLights/Nutcracker is started.
