@types/gorilla-engine 1.1.3 → 1.1.5

gorilla-engine/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Gorilla Engine (https://gorilla-engin
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gorilla-engine.
 
 ### Additional Details
- * Last updated: Wed, 20 Sep 2023 17:08:03 GMT
+ * Last updated: Wed, 27 Sep 2023 12:07:12 GMT
  * Dependencies: none
  * Global values: `GorillaEngine`
 

gorilla-engine/components/ComboBox.d.ts

@@ -18,7 +18,7 @@ declare namespace GorillaEngine.UI {
         checkmarkPadding: ComboBoxPadding;
     }
 
-    interface ComboBoxProps extends Common, Bounds, Background, Clickable, Font {
+    interface ComboBoxProps extends Common, Bounds, Background, Clickable, Font, Highlight {
         value: number;
         /**
          * List of options

gorilla-engine/components/Knob.d.ts

@@ -1,10 +1,17 @@
 declare namespace GorillaEngine.UI {
-    interface KnobProps extends Common, Bounds, Clickable, Background, Skinnable {
+    interface KnobProps extends Common, Bounds, Clickable, Background, Skinnable, MIDILearn, Highlight {
         text: string;
         min: number;
         max: number;
         value: number;
         stepSize: number;
+        inverted: boolean;
+        scrollWheelEnabled: boolean;
+        image: string;
+        snapsToMousePosition: boolean;
+        minRotation: number;
+        maxRotation: number;
+        direction: 'horizontal' | 'vertical';
     }
 
     interface Knob extends KnobProps {}

gorilla-engine/components/Label.d.ts

@@ -1,8 +1,10 @@
 declare namespace GorillaEngine.UI {
-    interface LabelProps extends Common, Bounds, Background, Font, Clickable {
+    interface LabelProps extends Common, Bounds, Background, Font, Clickable, Margin, Keyable {
+        value: any;
         text: string | number;
         format: string;
         multiLine: boolean;
+        stretchText: boolean;
     }
 
     /**

gorilla-engine/components/ListBox.d.ts

@@ -1,5 +1,5 @@
 declare namespace GorillaEngine.UI {
-    interface ListBoxProps extends Common, Bounds, Font, Clickable, Background, Scrollable {
+    interface ListBoxProps extends Common, Bounds, Font, Clickable, Background, Scrollable, Highlight, MIDILearn {
         items?: string[];
         horizontalMargin?: number;
         cellColor?: string;

gorilla-engine/components/LottieAnimation.d.ts

@@ -10,6 +10,7 @@ declare namespace GorillaEngine.UI {
         stop(): void;
         pause(): void;
         setFrame(frame: number): void;
+        setTargetFrame(frame: number): void;
         setFrameFromLinearTransform(value: number, min: number, max: number): void;
         setProperties(
             selector: string,

gorilla-engine/components/Pad.d.ts

@@ -1,5 +1,5 @@
 declare namespace GorillaEngine.UI {
-    interface PadProps extends Common, Bounds, Background, KeyboardFocus {
+    interface PadProps extends Common, Bounds, Background, KeyboardFocus, Clickable, Skinnable, Font {
         midiNote: number;
         velocity: number;
         padState: boolean;

gorilla-engine/components/Rubberband.d.ts

@@ -0,0 +1,9 @@
+declare namespace GorillaEngine.UI {
+    interface RubberbandProps extends Common, Bounds {
+    }
+
+    class Rubberband extends Component {
+        constructor(options: Partial<RubberbandProps>);
+    }
+    interface Rubberband extends RubberbandProps {}
+}

gorilla-engine/components/ScrollView.d.ts

@@ -3,6 +3,8 @@ declare namespace GorillaEngine.UI {
         scrollbarThickness: number;
         hideVerticalScrollbar: boolean;
         hideHorizontalScrollbar: boolean;
+        ignoreKeypressEvent: boolean;
+        scrollChildIntoView(childIndex: number): void;  
     }
 
     class ScrollView extends Component {

gorilla-engine/components/SliceEditor.d.ts

@@ -1,6 +1,7 @@
 declare namespace GorillaEngine.UI {
     interface SliceStyle {
         y: number;
+        xOffset: number;
         width: number;
         height: number;
         color: string;
@@ -45,10 +46,14 @@ declare namespace GorillaEngine.UI {
         setValues: (values: any) => void;
     }
     interface GridMeasure {
-        fractionOfBar: number;
-        showLabels?: boolean;
-        tickHeight: number;
-        font?: { size: number };
+      fractionOfBar: number;
+      enabled: boolean;
+      showLabels?: boolean;
+      tickWidth: boolean;
+      tickHeight: number;
+      tickColor: string;
+      tickImage: string;
+      font?: {name: string; size: number; kerning: number; color: string };
     }
 
     interface SliceEditorProps extends Common, Bounds, Background, Clickable {
@@ -56,11 +61,12 @@ declare namespace GorillaEngine.UI {
         audioLengthInSamples: number;
         audioLengthInBeats: number;
         minSliceSpacing: number;
+        minMarkerSpacing: number;
         canChangeSlices: boolean;
         canAddSlices: boolean;
         canRemoveSlices: boolean;
         snapSlicesToGrid: boolean;
-        zoom: { start: number; end: number };
+        zoom: { start: number; end: number; dragToZoomFactor: number; dragToZoomEnabled: boolean };
         addModulation(modulation: Partial<Modulation>): Modulation;
         grid: Partial<{
             position: string;
@@ -80,6 +86,7 @@ declare namespace GorillaEngine.UI {
         }>;
         selectionAreaStyle: Partial<{
             backgroundColor: string;
+            enabled: boolean;
             border: Partial<{
                 width: number;
                 radius: number;

gorilla-engine/components/Slider.d.ts

@@ -1,15 +1,11 @@
 declare namespace GorillaEngine.UI {
-    interface SliderProps extends Common, Bounds, Clickable, Background {
-        text: string;
-        min: number;
-        max: number;
-        value: number;
-        direction: "horizontal" | "vertical";
-        animation: LottieAnimation;
-        filmstrip: {
-            path: string;
-            count: number;
-            direction: string;
+    interface SliderProps extends KnobProps {
+        thumbImage: string;
+        sliderBounds: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
         };
     }
 

gorilla-engine/components/StepEditor.d.ts

@@ -13,7 +13,9 @@ declare namespace GorillaEngine.UI {
             width: number;
             height: number;
             cornerRadius: number;
-            border: number;
+            borderSizeX: number;
+            borderSizeY: number;
+            activeColor: string;
             markDefault: boolean;
             incrementHeight: number;
             backgroundColor: string;

gorilla-engine/components/TagBrowser.d.ts

@@ -0,0 +1,17 @@
+declare namespace GorillaEngine.UI {
+    interface TagBrowserProps extends Common, Bounds, Background, Font  {
+        value: any;
+        tags: Tag[];
+    }
+
+    class TagBrowser extends Component {
+        constructor(options: Partial<TagBrowserProps>);
+    }
+    interface TagBrowser extends TagBrowserProps {}
+}
+
+
+
+
+
+

gorilla-engine/components/TagEditor.d.ts

@@ -0,0 +1,15 @@
+declare namespace GorillaEngine.UI {
+    interface TagEditorProps extends Common, Bounds, Background, Font  {
+        value: any;
+        tags: Tag[];
+        editable: boolean;
+        action: string;
+        removeAction: string;
+    }
+
+    class TagEditor extends Component {
+        constructor(options: Partial<TagEditorProps>);
+    }
+    interface TagEditor extends TagEditorProps {}
+}
+

gorilla-engine/components/TextBox.d.ts

@@ -1,5 +1,5 @@
 declare namespace GorillaEngine.UI {
-    interface TextBoxProps extends Font, Clickable, Bounds, Background {
+    interface TextBoxProps extends Font, Clickable, Bounds, Background, Margin, Keyable {
         text: string;
         palceholder: string;
         unit: string;
@@ -14,6 +14,11 @@ declare namespace GorillaEngine.UI {
         acceptedDataType: "integer" | "int" | "float" | "string";
         minValue: number;
         maxValue: number;
+        highlightStart: number;
+        highlightEnd: number;
+        keyDownAction: string;
+        textChangedAction: string;
+        focusLostUpdate: boolean;
     }
 
     interface TextBox extends TextBoxProps {

gorilla-engine/components/Toggle.d.ts

@@ -1,5 +1,5 @@
 declare namespace GorillaEngine.UI {
-    interface ToggleProps extends Common, Bounds, Font, Clickable, Background {
+    interface ToggleProps extends Common, Bounds, Font, Clickable, Background, Highlight, MIDILearn, Margin {
         text: string;
         onColor: string;
         offColor: string;

gorilla-engine/components/Trigger.d.ts

@@ -1,6 +1,7 @@
 declare namespace GorillaEngine.UI {
-    interface TriggerProps extends Common, Bounds, Font, Clickable, Background, KeyboardFocus {
+    interface TriggerProps extends Common, Bounds, Font, Clickable, Background, KeyboardFocus, Keyable {
         text: string;
+        isDumb: boolean;
         images: {
             normal?: string;
             hover?: string;

gorilla-engine/components/Waveform.d.ts

@@ -34,7 +34,7 @@ declare namespace GorillaEngine.UI {
         canResize: boolean;
     }
 
-    interface WaveformProps extends Common, Bounds, Background, Font, Clickable {
+    interface WaveformProps extends Common, Bounds, Background, Font, Clickable, Margin {
         waveformColor: string;
         gradientCenterColor: string;
         gradientEndColor: string;
@@ -47,6 +47,7 @@ declare namespace GorillaEngine.UI {
         fitHeight: boolean;
         paintCenterLine: boolean;
         value: number;
+        drawUsingLegacy: boolean;
         dragzone: Partial<WaveformDragZone>;
         markers: Partial<WaveformMarker>;
     }

gorilla-engine/components/XYPad.d.ts

@@ -0,0 +1,19 @@
+declare namespace GorillaEngine.UI {
+    interface XYPadProps extends Common, Bounds, Clickable, Background {
+        valueX: number;
+        valueY: number;
+        minX: number;
+        maxX: number;
+        minY: number;
+        maxY: number;
+        stepSizeX: number;
+        stepSizeY: number;
+        snapsToMousePosition: boolean;
+        thumbImage: string;
+    }
+
+    interface XYPad extends XYPadProps {}
+    class XYPad extends Component {
+        constructor(options: Partial<XYPadProps>);
+    }
+}

gorilla-engine/index.d.ts

@@ -17,6 +17,11 @@
 /// <reference path = "interfaces/KeyboardFocus.d.ts" />
 /// <reference path = "interfaces/Scrollable.d.ts" />
 /// <reference path = "interfaces/Skinnable.d.ts" />
+/// <reference path = "interfaces/MIDILearn.d.ts" />
+/// <reference path = "interfaces/Highlight.d.ts" />
+/// <reference path = "interfaces/Keyable.d.ts" />
+/// <reference path = "interfaces/Margin.d.ts" />
+/// <reference path = "interfaces/Tag.d.ts" />
 
 /// <reference path = "components/AmpEnv.d.ts" />
 /// <reference path = "components/BarStepEditor.d.ts" />
@@ -40,6 +45,10 @@
 /// <reference path = "components/Trigger.d.ts" />
 /// <reference path = "components/Waveform.d.ts" />
 /// <reference path = "components/Window.d.ts" />
+/// <reference path = "components/TagBrowser.d.ts" />
+/// <reference path = "components/TagEditor.d.ts" />
+/// <reference path = "components/XYPad.d.ts" />
+/// <reference path = "components/Rubberband.d.ts" />
 
 declare namespace GorillaEngine {
     /**
@@ -302,12 +311,40 @@ declare namespace GorillaEngine {
     function registerUncaughtUIExceptionCallback(handler: (err: Error) => void): void;
     function getResourcePath(): string;
     function getPluginName(): string;
+    function getPluginType(): string;
+    function getPluginPath(): string;
+    function quitApplication(): void;
     function getManufacturerName(): string;
     function loadBlob(blobPath: string): Blob;
+    function getPluginNRTB(enable: boolean): void;
+    /**
+     * Method updates the list of the automatable parameters note it does not work for all DAWS
+     */
+    function updateHostDisplay(): void;
+    /**
+     * Method returns the Host name of the plugin is running in
+     * @returns The name of the host
+     */
+    function getHostDescription(): string;
+    function showNativeMessageBox(options: {
+        title: string;
+        message: string;
+        iconType: 'info' | 'question' | 'warning';
+    }): void;
+    function calculateTextWidth(text: string, font: string, fontSize: number, fontKerning: number): number;
+    function checkLicense(): boolean;
+    function isTrial(): boolean;
+    function trialExpirationTimestamp(): number;
+    function initialiseSpliceRTO(pluginName?: string): any;
     function disposeInstrument(instrument: Instrument): void;
     function setActiveInstrument(instrument: Instrument): void;
     function setSessionSaveCallback(callback: any, instance: any): void;
     function setSessionLoadCallback(callback: any, instance: any): void;
+    function setParametersDirty(dirty: boolean): void;
+    function areParametersDirty(): boolean;
+    function shouldWaitForReadySignal(): void;
+    function signalReady(): void;
+    function setParametersDirtyCallback(callback: any): void;
     function getBuildInformation(): any;
     function openURLinBrowser(path: string): void;
     function getPluginMM(v: boolean): void;
@@ -322,6 +359,19 @@ declare namespace GorillaEngine {
         allowedExtensions?: string;
         defaultLocation?: string;
     }): void;
+    /**
+     * Method to convert mp3 files to wave files
+     * @param mp3Filepath The path of the mp3 file to convert
+     * @param wavFilePath The path where the converted file should be stored
+     * @returns `true` if the convertion was successful
+     */
+    function convertMp3ToWav(mp3Filepath: string, wavFilePath: string): boolean;
+    /**
+     * Method to register opening and closing of the plugin editor
+     * @param openCallback The callback when the plugin editor opens
+     * @param closeCallback The callback when the plugin editor closes
+     */
+    function registerEditorCallbacks(openCallback?: any, closeCallback?: any): void;
     let sessionSaveLoadCallbackTimeoutMs: number;
 
     namespace UI {

gorilla-engine/interfaces/Highlight.d.ts

@@ -0,0 +1,12 @@
+declare namespace GorillaEngine.UI {
+    interface Highlight {
+        highlight: {
+            drawFilledCircle: boolean;
+            lineWidth: number;
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+    }
+}

gorilla-engine/interfaces/Keyable.d.ts

@@ -0,0 +1,6 @@
+declare namespace GorillaEngine.UI {
+    interface Keyable {
+        keyPressAction: string;
+        consumeEvent: boolean;
+    }
+}

gorilla-engine/interfaces/KeyboardFocus.d.ts

@@ -2,6 +2,8 @@ declare namespace GorillaEngine.UI {
     interface KeyboardFocus {
         keyboardFocus: {
             color?: string;
+            lineWidth?: number;
+            cornerRadius?: number;
         };
     }
 }

gorilla-engine/interfaces/MIDILearn.d.ts

@@ -0,0 +1,7 @@
+declare namespace GorillaEngine.UI {
+    interface MIDILearn {
+        midiLearn: {
+            enabled: boolean;
+        };
+    }
+}

gorilla-engine/interfaces/Margin.d.ts

@@ -0,0 +1,11 @@
+declare namespace GorillaEngine.UI {
+    interface Margin {
+        margin: {
+            other: number;
+            left: number;
+            top: number;
+            right: number;
+            bottom: number;
+        };
+    }
+}

gorilla-engine/interfaces/Tag.d.ts

@@ -0,0 +1,10 @@
+declare namespace GorillaEngine.UI {
+    interface Tag {
+        height: number;
+        borderSize: number;
+        cornerRadius: number;
+        textColor: { normal: string; active: string; header: string };
+        backgroundColor: { normal: string; active: string; header: string };
+        cancel: { x: number; width: number };
+    }
+}

gorilla-engine/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/gorilla-engine",
-    "version": "1.1.3",
+    "version": "1.1.5",
     "description": "TypeScript definitions for Gorilla Engine",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gorilla-engine",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "1aa3f4d68bbb00e2253209f521e251eaac38ae9f43879ed886985b3163c75569",
+    "typesPublisherContentHash": "368a209471927d10c9a891bc30a3c154b8b8aaf3612d002d0904aa6f6bdac7b3",
     "typeScriptVersion": "4.5"
 }