Skip to content

Commit

Permalink
Clarified documentation about device identifiers
Browse files Browse the repository at this point in the history
  • Loading branch information
@kurasu
kurasu committed Sep 7, 2023
1 parent d61ddf2 commit 0fd157d
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 27 deletions.
56 changes: 32 additions & 24 deletions Reference.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5691,9 +5691,10 @@ <h3 id="Device" class="element-title">
deviceID
</td>
<td>
Unique identifier of device/plug-in.
For standards which use UUID as an identifier use the textual representation of the UUID (VST3).
For standards which use an integer as an identifier use the value in decimal form. Base-10 unsigned. (VST2)
Unique identifier of device/plug-in.<br/>
Standards which use UUID as an identifier use the canonical textual representation of the UUID (8-4-4-4-12 with no braces) (VST3)<br/>
Standards which use an integer as an identifier use the value in decimal form. (base-10 unsigned) (VST2)<br/>
Text-based identifiers are used as-is. (CLAP)
</td>
<td style="text-align:center;">
String
Expand Down Expand Up @@ -5956,9 +5957,10 @@ <h3 id="AuPlugin" class="element-title">
deviceID
</td>
<td>
Unique identifier of device/plug-in.
For standards which use UUID as an identifier use the textual representation of the UUID (VST3).
For standards which use an integer as an identifier use the value in decimal form. Base-10 unsigned. (VST2)
Unique identifier of device/plug-in.<br/>
Standards which use UUID as an identifier use the canonical textual representation of the UUID (8-4-4-4-12 with no braces) (VST3)<br/>
Standards which use an integer as an identifier use the value in decimal form. (base-10 unsigned) (VST2)<br/>
Text-based identifiers are used as-is. (CLAP)
</td>
<td style="text-align:center;">
String
Expand Down Expand Up @@ -6225,9 +6227,10 @@ <h3 id="ClapPlugin" class="element-title">
deviceID
</td>
<td>
Unique identifier of device/plug-in.
For standards which use UUID as an identifier use the textual representation of the UUID (VST3).
For standards which use an integer as an identifier use the value in decimal form. Base-10 unsigned. (VST2)
Unique identifier of device/plug-in.<br/>
Standards which use UUID as an identifier use the canonical textual representation of the UUID (8-4-4-4-12 with no braces) (VST3)<br/>
Standards which use an integer as an identifier use the value in decimal form. (base-10 unsigned) (VST2)<br/>
Text-based identifiers are used as-is. (CLAP)
</td>
<td style="text-align:center;">
String
Expand Down Expand Up @@ -6509,9 +6512,10 @@ <h3 id="Plugin" class="element-title">
deviceID
</td>
<td>
Unique identifier of device/plug-in.
For standards which use UUID as an identifier use the textual representation of the UUID (VST3).
For standards which use an integer as an identifier use the value in decimal form. Base-10 unsigned. (VST2)
Unique identifier of device/plug-in.<br/>
Standards which use UUID as an identifier use the canonical textual representation of the UUID (8-4-4-4-12 with no braces) (VST3)<br/>
Standards which use an integer as an identifier use the value in decimal form. (base-10 unsigned) (VST2)<br/>
Text-based identifiers are used as-is. (CLAP)
</td>
<td style="text-align:center;">
String
Expand Down Expand Up @@ -6778,9 +6782,10 @@ <h3 id="Vst2Plugin" class="element-title">
deviceID
</td>
<td>
Unique identifier of device/plug-in.
For standards which use UUID as an identifier use the textual representation of the UUID (VST3).
For standards which use an integer as an identifier use the value in decimal form. Base-10 unsigned. (VST2)
Unique identifier of device/plug-in.<br/>
Standards which use UUID as an identifier use the canonical textual representation of the UUID (8-4-4-4-12 with no braces) (VST3)<br/>
Standards which use an integer as an identifier use the value in decimal form. (base-10 unsigned) (VST2)<br/>
Text-based identifiers are used as-is. (CLAP)
</td>
<td style="text-align:center;">
String
Expand Down Expand Up @@ -7047,9 +7052,10 @@ <h3 id="Vst3Plugin" class="element-title">
deviceID
</td>
<td>
Unique identifier of device/plug-in.
For standards which use UUID as an identifier use the textual representation of the UUID (VST3).
For standards which use an integer as an identifier use the value in decimal form. Base-10 unsigned. (VST2)
Unique identifier of device/plug-in.<br/>
Standards which use UUID as an identifier use the canonical textual representation of the UUID (8-4-4-4-12 with no braces) (VST3)<br/>
Standards which use an integer as an identifier use the value in decimal form. (base-10 unsigned) (VST2)<br/>
Text-based identifiers are used as-is. (CLAP)
</td>
<td style="text-align:center;">
String
Expand Down Expand Up @@ -7310,9 +7316,10 @@ <h3 id="BuiltinDevice" class="element-title">
deviceID
</td>
<td>
Unique identifier of device/plug-in.
For standards which use UUID as an identifier use the textual representation of the UUID (VST3).
For standards which use an integer as an identifier use the value in decimal form. Base-10 unsigned. (VST2)
Unique identifier of device/plug-in.<br/>
Standards which use UUID as an identifier use the canonical textual representation of the UUID (8-4-4-4-12 with no braces) (VST3)<br/>
Standards which use an integer as an identifier use the value in decimal form. (base-10 unsigned) (VST2)<br/>
Text-based identifiers are used as-is. (CLAP)
</td>
<td style="text-align:center;">
String
Expand Down Expand Up @@ -7561,9 +7568,10 @@ <h3 id="Equalizer" class="element-title">
deviceID
</td>
<td>
Unique identifier of device/plug-in.
For standards which use UUID as an identifier use the textual representation of the UUID (VST3).
For standards which use an integer as an identifier use the value in decimal form. Base-10 unsigned. (VST2)
Unique identifier of device/plug-in.<br/>
Standards which use UUID as an identifier use the canonical textual representation of the UUID (8-4-4-4-12 with no braces) (VST3)<br/>
Standards which use an integer as an identifier use the value in decimal form. (base-10 unsigned) (VST2)<br/>
Text-based identifiers are used as-is. (CLAP)
</td>
<td style="text-align:center;">
String
Expand Down
7 changes: 4 additions & 3 deletions src/main/java/com/bitwig/dawproject/device/Device.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ public class Device extends Referenceable
@XmlAttribute(required = true)
public String deviceName;

/** Unique identifier of device/plug-in.
* For standards which use UUID as an identifier use the textual representation of the UUID (VST3).
* For standards which use an integer as an identifier use the value in decimal form. Base-10 unsigned. (VST2) */
/** Unique identifier of device/plug-in.<br/>
* Standards which use UUID as an identifier use the canonical textual representation of the UUID (8-4-4-4-12 with no braces) (VST3)<br/>
* Standards which use an integer as an identifier use the value in decimal form. (base-10 unsigned) (VST2)<br/>
* Text-based identifiers are used as-is. (CLAP) */
@XmlAttribute
public String deviceID;

Expand Down

0 comments on commit 0fd157d

Please sign in to comment.