Skip to content

Commit

Permalink
Merge branch 'main' into deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
m-klag committed Aug 1, 2023
2 parents f748b75 + db15f1f commit 927a558
Show file tree
Hide file tree
Showing 14 changed files with 60 additions and 34 deletions.
32 changes: 21 additions & 11 deletions src/HALion-Developer-Resource.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,26 @@
# HALion Instrument & Sound Designers
# HALion Developer Resource

Whether you want to dive into the Macro Page Editor or get in-depth descriptions of the classes and functions provided in HALion Script, HALion Developer Resource is the go-to reference for all relevant information concerned with creating advanced content libraries in HALion.

Please choose from the below to learn how to get started and find short examples and detailed information on the selected topic.

||HALion Developer Resource||
|:-:|:-:|:-:|
|![HALion Script](Scripting.png)|![HALion Macro Page](Macro-Page-Designer.png)|![HALion Tutorials & Guidelines](Library-Creator.png)|
|**[HALion Script](./HALion-Script/pages/HALion-Script.md)**|**[HALion Macro Page](./HALion-Macro-Page/pages/HALion-Macro-Page.md)**|**[HALion Tutorials & Guidelines](./HALion-Tutorials-Guidelines/pages/HALion-Tutorials-Guidelines.md)**|






<div class="image-container">
<div class="image-with-caption">
<a href="./HALion-Script/pages/HALion-Script.html">
<img src="Scripting.png">
<figcaption><a href="./HALion-Script/pages/HALion-Script.html">HALion Script</a></figcaption>
</a>
</div>
<div class="image-with-caption">
<a href="./HALion-Macro-Page/pages/HALion-Macro-Page.html">
<img src="Macro-Page-Designer.png">
<figcaption><a href="./HALion-Macro-Page/pages/HALion-Macro-Page.html">HALion Macro Page</a></figcaption>
</a>
</div>
<div class="image-with-caption">
<a href="./HALion-Tutorials-Guidelines/pages/HALion-Tutorials-Guidelines.html">
<img src="Library-Creator.png">
<figcaption><a href="./HALion-Tutorials-Guidelines/pages/HALion-Tutorials-Guidelines.html">HALion Tutorials & Guidelines</a></figcaption>
</a>
</div>
</div>
2 changes: 1 addition & 1 deletion src/HALion-Macro-Page/pages/Example-Macro-Pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To learn more about macro pages and how to set them up, you can load the presets

## Using Templates from the Example Macro Pages

The macro pages of Anima, Skylab, Eagle, Raven, Studio Strings, and Hot Brass are installed as independent VST Sounds for all HALion family products (HALion, HALion Sonic and HALion Sonic SE), which means that you can use the templates from these instruments for your own macro pages, too.
The macro pages of Anima, Skylab, Eagle, Raven, Studio Strings, and Hot Brass are installed as independent VST Sounds for HALion and for HALion Sonic, which means that you can use the templates from both these instruments for your own macro pages, too.

In the **Resource/Library Browser**, you have access to the templates of these macro pages.

Expand Down
2 changes: 1 addition & 1 deletion src/HALion-Macro-Page/pages/Template-List.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

## Description

A Template List can be used to create a list of child templates from a single referenced template, where each instance of the referenced template can be used to control different parameter scopes, for example. The look of the Template List rows and columns is determined by the referenced template which you can choose in the Template property. Depending on the Layout property, Horizontal, Vertical, or Grid, the templates are arranged in a row, a column or in a grid. The templates are arranged without spacing or graphic separators. If spacing or graphic separators are desired, they must be part of the referenced template.
A Template List can be used to create child templates from a single referenced template, where each instance of the referenced template can be used to control different parameter scopes, for example. The look of the Template List rows and columns is determined by the referenced template which you can choose in the Template property. Depending on the Layout property, the templates are arranged in a row, a column, or in a grid. The templates are arranged without spacing or graphic separators. If spacing or graphic separators are desired, they must be part of the referenced template.

## Properties

Expand Down
14 changes: 7 additions & 7 deletions src/HALion-Script/pages/Event-Types.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Enumerator to identify the different types of events. See [Event Constructor](./

|Index|Name|Description|
|:-|:-|:-|
|1|EventType.noteOn|Note-on events.|
|2|EventType.noteOff|Note-off events.|
|3|EventType.controller|Continuous controller events.|
|4|EventType.noteExpression|Note expression events.|
|5|EventType.programChange|Only used for Standard MIDI files.|
|6|EventType.noteRetrigger|Note-retrigger events.|
|7|EventType.data|System exclusive messages.|
|1|EventType.noteOn|Note-on events|
|2|EventType.noteOff|Note-off events|
|3|EventType.controller|Continuous controller events|
|4|EventType.noteExpression|Note expression events|
|5|EventType.programChange|Only used for Standard MIDI files|
|6|EventType.noteRetrigger|Note-retrigger events|
|7|EventType.data|System exclusive messages|

## Example

Expand Down
2 changes: 1 addition & 1 deletion src/HALion-Script/pages/Event.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The state of an Event object is described by the following fields.
|**.data**|An array with the bytes of a system exclusive message. For the interpretation of these values, please consult the documentation of the MIDI data format of the device sending the system exclusive message.|table|
|**.dataType**|Currently, there is only one data type (0 = sysex).|number|
|**.dataSize**|The number of bytes in the system exclusive message.|number|
|**.ppqPosition**|The position of the event in ppq relative to the song start. The host must be in in playback. This value will be 0.0 if the host is not in playback.|number|
|**.ppqPosition**|The position of the event in ppq relative to the project start. The host must be in playback. This value will be 0.0 if the host is not in playback.|number|

#### Fields per Event Type

Expand Down
2 changes: 1 addition & 1 deletion src/HALion-Script/pages/onData.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This callback is called when the script module receives a system exclusive messa

|Argument|Description|Value Type|
|:-|:-|:-|
|**event**|Event object of the type data.|Event|
|**event**|[Event](./Event.md) object of the type data.|[Event](./Event.md)|

## Fields

Expand Down
4 changes: 2 additions & 2 deletions src/HALion-Script/pages/onNote.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ This callback function is called when the script module receives a note-on event

|Argument|Description|Value Type|
|:-|:-|:-|
|**event**|Event object of the type noteOn.|Event|
|**event**|[Event](./Event.md) object of the type noteOn.|Event|

## Fields

|Field|Description|Value Type|
|:-|:-|:-|
|**.type**|The type of event (1 = noteOn). See Event Types for details.|number|
|**.type**|The type of event (1 = noteOn). See [Event Types](./Event-Types.md) for details.|number|
|**.id**|The note ID of the note-on event.|number|
|**.note**|The note number in the range of 0 to 127.|number|
|**.velocity**|The note-on velocity in the range of 0 to 127.|number|
Expand Down
4 changes: 2 additions & 2 deletions src/HALion-Script/pages/onRetrigger.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ This callback function is called when the script module receives a note-retrigge

|Argument|Description|Value Type|
|:-|:-|:-|
|event|[Event](./Event.md) object of the type noteRetrigger.|[Event](./Event.md)|
|**event**|[Event](./Event.md) object of the type noteRetrigger.|[Event](./Event.md)|

## Fields

Note-off events use the following fields of the [Event](./Event.md) object.
Note-retrigger events use the following fields of the [Event](./Event.md) object.

|Field|Description|Value Type|
|:-|:-|:-|
Expand Down
8 changes: 4 additions & 4 deletions src/HALion-Script/pages/playNote.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@

Function to generate note events.

* If ``duration`` is -1 the generated note plays as long as the key that called playNote is held.
* If ``duration`` is greater 0 the note plays as long as the key is held, but maximum for the time specified in milliseconds.
* If ``duration`` is 0 playNote generates only the note-on event. The release can be managed manually with [onRelease](./onRelease.md) or with [releaseVoice](./releaseVoice.md) and the ID returned by playNote.
* If ``duration`` is -1, the generated note plays for as long as the key that called playNote is held.
* If ``duration`` is greater 0, the note plays for as long as the key is held, with the maximum duration specified in milliseconds.
* If ``duration`` is 0, playNote generates only the note-on event. The release can be managed manually with [onRelease](./onRelease.md) or with [releaseVoice](./releaseVoice.md) and the ID returned by playNote.

**Available in:** Processor.

Expand All @@ -21,7 +21,7 @@ Function to generate note events.
|**note**|The note number of the note in the range of 0 to 127.|number|
|**velocity**|The velocity of the note in the range of 0 to 127.|number|
|**duration**|The length of the note in milliseconds. The default is -1.|number, optional|
|**layerOrZone**|The layer or zone which shall receive the note. Only elements after the script module are addressable. The default is nil (all layers).|[Layer](./Layer.md) or [Zone](./Zone.md), optional|
|**layerOrZone**|The layer or zone to receive the note. Only elements that come after the script module are addressable. The default is nil (all layers).|[Layer](./Layer.md) or [Zone](./Zone.md), optional|
|**volume**|The initial volume in the range of 0 to 1.0. The default is 1.0.|number, optional|
|**pan**|The initial pan position in the range of -1.0 to 1.0. The default is 0.|number, optional|
|**tune**|The initial tuning in the range of -120.0 to 120.0. The default is 0.|number, optional|
Expand Down
2 changes: 1 addition & 1 deletion src/HALion-Script/pages/savePreset.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
|**filename**|The absolute path and name of the VST preset.|string|
|**layer**|Specifies the [Layer](./Layer.md) element which is to be saved.|[Layer](./Layer.md)|
|**plugin**|Determines the plug-in for the VST preset. You can choose ``H7`` (HALion 7) or ``HS`` (HALion Sonic). |string, optional|
|**attr**|Set this to ``program`` to save a program VST preset. A layer VST preset will be saved, if this is not set. Alternatively, you can provide a table with MediaBay attributes and values.|string, optional|
|**attr**|Set this to ``program`` to save a program VST preset. If this is not set, a layer VST preset will be saved. Alternatively, you can provide a table with MediaBay attributes and values.|string, optional|

## MediaBay Attributes

Expand Down
2 changes: 1 addition & 1 deletion src/HALion-Script/pages/setZoneFMXAlgo.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
## Description

Function to set the algorithm of the FM zone. The ``zone`` argument sets the target FM zone by its [Zone](./Zone.md) object. You can use [getZone](./getZone.md) or [findZones](./findZones.md) to determine the Zone object of the target FM zone. The ``algo`` argument is the index that corresponds to the desired FM-X algorithm preset of the FM zone.
Function to set the algorithm of the FM zone. The ``zone`` argument sets the target FM zone by its [Zone](./Zone.md) object. You can use [getZone](./getZone.md) or [findZones](./findZones.md) to determine the [Zone](./Zone.md) object of the target FM zone. The ``algo`` argument is the index that corresponds to the desired FM-X algorithm preset of the FM zone.

**Available in:** Controller.

Expand Down
2 changes: 1 addition & 1 deletion src/HALion-Script/pages/startWriteOutputToFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Function to write the ouput of print functions to a file. Only the print functio
|Argument|Description|Value Type|
|:-|:-|:-|
|**filename**|The absolute path and name of the file.|string|
|**append**|Appends the output in the file if this is set to ``true``.|boolean|
|**append**|Appends the output to the file if this is set to ``true``.|boolean|
|**silent**|Hides the console output if this is set to ``true``.|boolean|

## Example
Expand Down
2 changes: 1 addition & 1 deletion theme/css/chrome.css
Original file line number Diff line number Diff line change
Expand Up @@ -571,6 +571,6 @@ ul#searchresults span.teaser em {
}

.footer a {
color: --links;
color: var(--links);
text-decoration: none;
}
16 changes: 16 additions & 0 deletions theme/css/general.css
Original file line number Diff line number Diff line change
Expand Up @@ -205,3 +205,19 @@ kbd {
.result-no-output {
font-style: italic;
}

.image-container {
max-width: 750px;
display: flex;
justify-content: space-between;
}

.image-container .image-with-caption {
display: flex;
flex-direction: column;
align-items: center;
}

.image-container img {
margin-bottom: 5px;
}

0 comments on commit 927a558

Please sign in to comment.