-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
16 lines (16 loc) · 22.5 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-introduction">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.4.0">
<title data-rh="true">Introduction | MIDI REMOTE API</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://steinbergmedia.github.io/midiremote_api_doc/"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Introduction | MIDI REMOTE API"><meta data-rh="true" name="description" content="Welcome to the Steinberg MIDI Remote API."><meta data-rh="true" property="og:description" content="Welcome to the Steinberg MIDI Remote API."><link data-rh="true" rel="icon" href="/midiremote_api_doc/img/favicon.png"><link data-rh="true" rel="canonical" href="https://steinbergmedia.github.io/midiremote_api_doc/"><link data-rh="true" rel="alternate" href="https://steinbergmedia.github.io/midiremote_api_doc/" hreflang="en"><link data-rh="true" rel="alternate" href="https://steinbergmedia.github.io/midiremote_api_doc/" hreflang="x-default"><script data-rh="true">function maybeInsertBanner(){window.__DOCUSAURUS_INSERT_BASEURL_BANNER&&insertBanner()}function insertBanner(){var n=document.getElementById("docusaurus-base-url-issue-banner-container");if(n){n.innerHTML='\n<div id="docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/midiremote_api_doc/</span> </p>\n <p>We suggest trying baseUrl = <span id="docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n';var e=document.getElementById("docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,r="/"===s.substr(-1)?s:s+"/";e.innerHTML=r}}window.__DOCUSAURUS_INSERT_BASEURL_BANNER=!0,document.addEventListener("DOMContentLoaded",maybeInsertBanner)</script><link rel="stylesheet" href="/midiremote_api_doc/assets/css/styles.d852724d.css">
<link rel="preload" href="/midiremote_api_doc/assets/js/runtime~main.9596c922.js" as="script">
<link rel="preload" href="/midiremote_api_doc/assets/js/main.5d4285fc.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
<div id="docusaurus-base-url-issue-banner-container"></div><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><a class="navbar__brand" href="/midiremote_api_doc/"><div class="navbar__logo"><img src="/midiremote_api_doc/img/steinberg_logo.svg" alt="(>) steinberg" class="themedImage_ToTc themedImage--light_HNdA"><img src="/midiremote_api_doc/img/steinberg_logo.svg" alt="(>) steinberg" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">MIDI Remote API</b></a></div><div class="navbar__items navbar__items--right"><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/midiremote_api_doc/">Introduction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/midiremote_api_doc/getting-started">Getting Started</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/midiremote_api_doc/code-examples">Code Examples</a><button aria-label="Toggle the collapsible sidebar category 'Code Examples'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/midiremote_api_doc/versions">API Versions + Compatibility</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/midiremote_api_doc/new_in_v1.1">New in v1.1</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/midiremote_api_doc/advanced-topics">Advanced Topics</a><button aria-label="Toggle the collapsible sidebar category 'Advanced Topics'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/midiremote_api_doc/codedoc_api_reference">API Reference</a></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/midiremote_api_doc/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Introduction</span><meta itemprop="position" content="1"></li></ul></nav><div class="theme-doc-markdown markdown"><h1><div class="main_banner"><img loading="lazy" src="img/steinberg_logo.svg" class="img_ev3q"><div class="main_banner_title">MIDI Remote API <a href="/midiremote_api_doc/new_in_v1.1">v1.1</a></div><div class="main_banner_subtitle">Programmer's Guide</div></div></h1><p>Welcome to the Steinberg <strong>MIDI Remote API</strong>.</p><p>The primary purpose of the <strong>MIDI Remote API</strong> is to give developers the ability to create software solutions that bridge the gap between MIDI controller hardware and the <strong>Cubase / Nuendo</strong> environment.</p><p>This document will guide you through the steps of writing a <strong>MIDI Remote API Script</strong> for a specific MIDI controller hardware.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="basic-concept">BASIC CONCEPT<a href="#basic-concept" class="hash-link" aria-label="Direct link to BASIC CONCEPT" title="Direct link to BASIC CONCEPT"></a></h2><p>The MIDI Remote API Script acts as a mediator between a Hardware Controller and <strong>Cubase / Nuendo</strong>.</p><p><img loading="lazy" src="data:image/svg+xml;base64,<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" viewBox="-0.5 -0.5 801 314">
    <defs/>
    <g>
        <rect x="0" y="33" width="800" height="280" rx="42" ry="42" fill="none" stroke="#9eb4c7" pointer-events="all"/>
        <g transform="translate(-0.5 -0.5)">
            <switch>
                <foreignObject style="overflow:visible;text-align:left" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility">
                    <div xmlns="http://www.w3.org/1999/xhtml" style="display:flex;align-items:unsafe flex-end;justify-content:unsafe center;width:798px;height:1px;padding-top:30px;margin-left:1px">
                        <div style="box-sizing:border-box;font-size:0;text-align:center">
                            <div style="display:inline-block;font-size:25px;font-family:Helvetica;color:#9eb4c7;line-height:1.2;pointer-events:all;white-space:normal;word-wrap:normal">
                                <b>
                                    Cubase / Nuendo
                                </b>
                            </div>
                        </div>
                    </div>
                </foreignObject>
                <text x="400" y="30" fill="#9eb4c7" font-family="Helvetica" font-size="25px" text-anchor="middle">
                    Host
                </text>
            </switch>
        </g>
        <rect x="40" y="73" width="160" height="200" rx="24" ry="24" fill="none" stroke="#9eb4c7" pointer-events="all"/>
        <g transform="translate(-0.5 -0.5)">
            <switch>
                <foreignObject style="overflow:visible;text-align:left" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility">
                    <div xmlns="http://www.w3.org/1999/xhtml" style="display:flex;align-items:unsafe center;justify-content:unsafe center;width:158px;height:1px;padding-top:173px;margin-left:41px">
                        <div style="box-sizing:border-box;font-size:0;text-align:center">
                            <div style="display:inline-block;font-size:12px;font-family:Helvetica;color:#9eb4c7;line-height:1.2;pointer-events:all;white-space:normal;word-wrap:normal">
                                
                                <span style="font-size:14px;font-weight:100">
                                    Windows / macOS
                                </span>
                                <br/>
                                <font style="font-size:16px;font-weight:900">
                                    MIDI I/O
                                </font>
                                
                            </div>
                        </div>
                    </div>
                </foreignObject>
                <text x="120" y="177" fill="#9eb4c7" font-family="Helvetica" font-size="12px" text-anchor="middle">
                    Windows / macOS
                    MIDI I/O
                </text>
            </switch>
        </g>
        <rect x="240" y="73" width="320" height="200" rx="30" ry="30" fill="none" stroke="#00f5ed" pointer-events="all"/>
        <g transform="translate(-0.5 -0.5)">
            <switch>
                <foreignObject style="overflow:visible;text-align:left" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility">
                    <div xmlns="http://www.w3.org/1999/xhtml" style="display:flex;align-items:unsafe center;justify-content:unsafe center;width:318px;height:1px;padding-top:173px;margin-left:241px">
                        <div style="box-sizing:border-box;font-size:0;text-align:center">
                            <div style="display:inline-block;font-size:25px;font-family:Helvetica;color:#9eb4c7;line-height:1.2;pointer-events:all;white-space:normal;word-wrap:normal">
                                <font>
                                    <font color="#00f5ed">
                                        <span style="font-size:26px;font-weight:900">
                                            MIDI Remote API Script
                                        </span>
                                        <br/>
                                        <font style="font-size:14px;font-weight:100">
                                            Written in Javascript (ES5)
                                        </font>
                                    </font>
                                    <br/>
                                </font>
                            </div>
                        </div>
                    </div>
                </foreignObject>
                <text x="400" y="181" fill="#9eb4c7" font-family="Helvetica" font-size="25px" text-anchor="middle">
                    MIDI Remote Script...
                </text>
            </switch>
        </g>
        <rect x="600" y="73" width="160" height="200" rx="24" ry="24" fill="none" stroke="#9eb4c7" pointer-events="all"/>
        <g transform="translate(-0.5 -0.5)">
            <switch>
                <foreignObject style="overflow:visible;text-align:left" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility">
                    <div xmlns="http://www.w3.org/1999/xhtml" style="display:flex;align-items:unsafe center;justify-content:unsafe center;width:158px;height:1px;padding-top:173px;margin-left:601px">
                        <div style="box-sizing:border-box;font-size:0;text-align:center">
                            <div style="display:inline-block;font-size:12px;font-family:Helvetica;color:#9eb4c7;line-height:1.2;pointer-events:all;white-space:normal;word-wrap:normal">
                                <font>
                                    <font>
                                        <font>
                                            <span style="font-size:16px;font-weight:900">
                                                Cubase / Nuendo<br/>Functions
                                            </span>
                                            <br/><br/>
                                            <font style="font-size:12px;font-weight:100">
                                                Quick Controls,<br/>
                                                Selected Track,<br/>
                                                MixConsole,<br/>
                                                Key Commands,<br/>
                                                ...
                                            </font>
                                            <br/>
                                        </font>
                                    </font>
                                </font>
                            </div>
                        </div>
                    </div>
                </foreignObject>
                <text x="680" y="177" fill="#9eb4c7" font-family="Helvetica" font-size="12px" text-anchor="middle">
                    Host Functions...
                </text>
            </switch>
        </g>
        <path d="M 206.37 173 L 233.63 173" fill="none" stroke="#9eb4c7" stroke-miterlimit="10" pointer-events="stroke"/>
        <path d="M 201.12 173 L 208.12 169.5 L 206.37 173 L 208.12 176.5 Z" fill="#9eb4c7" stroke="#9eb4c7" stroke-miterlimit="10" pointer-events="all"/>
        <path d="M 238.88 173 L 231.88 176.5 L 233.63 173 L 231.88 169.5 Z" fill="#9eb4c7" stroke="#9eb4c7" stroke-miterlimit="10" pointer-events="all"/>
        <path d="M 566.37 173 L 593.63 173" fill="none" stroke="#9eb4c7" stroke-miterlimit="10" pointer-events="stroke"/>
        <path d="M 561.12 173 L 568.12 169.5 L 566.37 173 L 568.12 176.5 Z" fill="#9eb4c7" stroke="#9eb4c7" stroke-miterlimit="10" pointer-events="all"/>
        <path d="M 598.88 173 L 591.88 176.5 L 593.63 173 L 591.88 169.5 Z" fill="#9eb4c7" stroke="#9eb4c7" stroke-miterlimit="10" pointer-events="all"/>
    </g>
    <switch>
        <g requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"/>
        <a transform="translate(0,-5)" xlink:href="https://desk.draw.io/support/solutions/articles/16000042487" target="_blank">
            <text text-anchor="middle" font-size="10px" x="50%" y="100%">
                Viewer does not support full SVG 1.1
            </text>
        </a>
    </switch>
</svg>
" width="801" height="314" class="img_ev3q"></p><div class="admonition alert alert--info"><div class="admonition-content"><strong>MIDI Remote API Scripts</strong> are written in the <a href="https://www.w3schools.com/js/js_es5.asp" target="_blank" rel="noopener noreferrer"><strong>ES5</strong></a> version of JavaScript.</div></div><p>A <strong>MIDI Remote API Script</strong> emulates the hardware surface and This improves usability and recognizability.</p><p><img loading="lazy" src="/midiremote_api_doc/assets/images/remote_window_real_world_device-6a3d665df17173f9cb5017cfcecfdc62.png" width="2116" height="852" class="img_ev3q"></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="script-structure">SCRIPT STRUCTURE<a href="#script-structure" class="hash-link" aria-label="Direct link to SCRIPT STRUCTURE" title="Direct link to SCRIPT STRUCTURE"></a></h2><p>The <b>MIDI Remote API Script</b> consists of three building blocks.</p><ol><li><p><strong>Driver Setup</strong></p><ul><li>create driver object</li><li>define driver ports to be associated with existing hardware midi ports</li><li>specify all possible port namings for automatic device detection</li></ul></li><li><p><strong>Surface Layout</strong></p><ul><li>visualize the hardware's surface elements (e.g. knobs, faders, buttons)</li><li>bind surface elements to midi messages</li></ul></li><li><p><strong>Host Mapping</strong></p><ul><li>create mapping pages for each user workflow (e.g. mixing, playing instruments, track navigation)</li></ul></li></ol><div class="admonition alert alert--secondary"><div class="admonition-content">The following image illustrates the three building block and how they are related:</div></div><p><img loading="lazy" src="/midiremote_api_doc/assets/images/script_structure-6513c4ed4a28385473362d3eeba3955a.svg" width="702" height="376" class="img_ev3q"></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--next" href="/midiremote_api_doc/getting-started"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Getting Started</div></a></nav></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 Steinberg Media Technologies GmbH.</div></div></div></footer></div>
<script src="/midiremote_api_doc/assets/js/runtime~main.9596c922.js"></script>
<script src="/midiremote_api_doc/assets/js/main.5d4285fc.js"></script>
</body>
</html>