streamdeck-typescript
Version:
This library will help you build elgato stream deck plugins in typescript
714 lines • 40.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>StreamDeckPropertyInspectorHandler | streamdeck-typescript - v3.2.1</title>
<meta name="description" content="Documentation for streamdeck-typescript - v3.2.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">streamdeck-typescript - v3.2.1</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">streamdeck-typescript - v3.2.1</a>
</li>
<li>
<a href="streamdeckpropertyinspectorhandler.html">StreamDeckPropertyInspectorHandler</a>
</li>
</ul>
<h1>Class StreamDeckPropertyInspectorHandler<Settings, GlobalSettings></h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This will help you create the logic for the property inspector.</p>
</div>
<dl class="tsd-comment-tags">
<dt>author</dt>
<dd><p>XeroxDev <a href="mailto:help@xeroxdev.de">help@xeroxdev.de</a></p>
</dd>
<dt>copyright</dt>
<dd><p>2021</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>Settings = <span class="tsd-signature-type">any</span></h4>
</li>
<li>
<h4>GlobalSettings = <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="streamdeckhandlerbase.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckHandlerBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GlobalSettings</span><span class="tsd-signature-symbol">></span>
<ul class="tsd-hierarchy">
<li>
<span class="target">StreamDeckPropertyInspectorHandler</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-protected"><a href="streamdeckpropertyinspectorhandler.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected"><a href="streamdeckpropertyinspectorhandler.html#actioninfo" class="tsd-kind-icon">action<wbr>Info</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#connectionready" class="tsd-kind-icon">connection<wbr>Ready</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#documentready" class="tsd-kind-icon">document<wbr>Ready</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#globalsettingsready" class="tsd-kind-icon">global<wbr>Settings<wbr>Ready</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#info" class="tsd-kind-icon">info</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#port" class="tsd-kind-icon">port</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#registerevent" class="tsd-kind-icon">register<wbr>Event</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#settingsmanager" class="tsd-kind-icon">settings<wbr>Manager</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#uuid" class="tsd-kind-icon">uuid</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#enabledebug" class="tsd-kind-icon">enable<wbr>Debug</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#logmessage" class="tsd-kind-icon">log<wbr>Message</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#openurl" class="tsd-kind-icon">open<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#requestglobalsettings" class="tsd-kind-icon">request<wbr>Global<wbr>Settings</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="streamdeckpropertyinspectorhandler.html#requestsettings" class="tsd-kind-icon">request<wbr>Settings</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpropertyinspectorhandler.html#send" class="tsd-kind-icon">send</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckpropertyinspectorhandler.html#sendtoplugin" class="tsd-kind-icon">send<wbr>ToPlugin</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="streamdeckpropertyinspectorhandler.html#setsettings" class="tsd-kind-icon">set<wbr>Settings</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-protected">
<a name="constructor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">new <wbr>Stream<wbr>Deck<wbr>Property<wbr>Inspector<wbr>Handler<Settings, GlobalSettings><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="streamdeckpropertyinspectorhandler.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckPropertyInspectorHandler</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Settings</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">GlobalSettings</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L35">abstracts/stream-deck-handler-base.ts:35</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>Settings = <span class="tsd-signature-type">any</span></h4>
</li>
<li>
<h4>GlobalSettings = <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="streamdeckpropertyinspectorhandler.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckPropertyInspectorHandler</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Settings</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">GlobalSettings</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected">
<a name="actioninfo" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> action<wbr>Info</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> actionInfo<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/initeventactioninfo.html" class="tsd-signature-type" data-tsd-kind="Interface">InitEventActionInfo</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-property-inspector-handler.ts#L21">abstracts/stream-deck-property-inspector-handler.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gets the action information</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/initeventactioninfo.html" class="tsd-signature-type" data-tsd-kind="Interface">InitEventActionInfo</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="connectionready" class="tsd-anchor"></a>
<h3>connection<wbr>Ready</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> connectionReady<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L111">abstracts/stream-deck-handler-base.ts:111</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="documentready" class="tsd-anchor"></a>
<h3>document<wbr>Ready</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> documentReady<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L107">abstracts/stream-deck-handler-base.ts:107</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="globalsettingsready" class="tsd-anchor"></a>
<h3>global<wbr>Settings<wbr>Ready</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> globalSettingsReady<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L115">abstracts/stream-deck-handler-base.ts:115</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="info" class="tsd-anchor"></a>
<h3>info</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/initeventinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">InitEventInfo</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L94">abstracts/stream-deck-handler-base.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>All the information send from Elgato</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/initeventinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">InitEventInfo</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="port" class="tsd-anchor"></a>
<h3>port</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> port<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L71">abstracts/stream-deck-handler-base.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The port for the Stream Deck Application</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="registerevent" class="tsd-anchor"></a>
<h3>register<wbr>Event</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> registerEvent<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L86">abstracts/stream-deck-handler-base.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Event sent from Elgato, which is needed for the registration procedure</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="settingsmanager" class="tsd-anchor"></a>
<h3>settings<wbr>Manager</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> settingsManager<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="settingsmanager.html" class="tsd-signature-type" data-tsd-kind="Class">SettingsManager</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L103">abstracts/stream-deck-handler-base.ts:103</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Through this object you can get, set and edit all available settings (global settings and context settings)</p>
</div>
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="settingsmanager.html">SettingsManager</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <a href="settingsmanager.html" class="tsd-signature-type" data-tsd-kind="Class">SettingsManager</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="uuid" class="tsd-anchor"></a>
<h3>uuid</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> uuid<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L78">abstracts/stream-deck-handler-base.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The UUID of the Plugin</p>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="enabledebug" class="tsd-anchor"></a>
<h3>enable<wbr>Debug</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">enable<wbr>Debug<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#enabledebug">enableDebug</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L207">abstracts/stream-deck-handler-base.ts:207</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enables debug mode so you can see incoming and outgoing events.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="logmessage" class="tsd-anchor"></a>
<h3>log<wbr>Message</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">log<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#logmessage">logMessage</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L177">abstracts/stream-deck-handler-base.ts:177</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Logs a message to the elgato log file</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="openurl" class="tsd-anchor"></a>
<h3>open<wbr>Url</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">open<wbr>Url<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#openurl">openUrl</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L167">abstracts/stream-deck-handler-base.ts:167</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Opens a url</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="requestglobalsettings" class="tsd-anchor"></a>
<h3>request<wbr>Global<wbr>Settings</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">request<wbr>Global<wbr>Settings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#requestglobalsettings">requestGlobalSettings</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L157">abstracts/stream-deck-handler-base.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Requests global settings</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="requestsettings" class="tsd-anchor"></a>
<h3>request<wbr>Settings</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">request<wbr>Settings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#requestsettings">requestSettings</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-property-inspector-handler.ts#L41">abstracts/stream-deck-property-inspector-handler.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>inheritdoc</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="send" class="tsd-anchor"></a>
<h3>send</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#send">send</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L188">abstracts/stream-deck-handler-base.ts:188</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sends custom socket events to the stream deck software</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>data: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="sendtoplugin" class="tsd-anchor"></a>
<h3>send<wbr>ToPlugin</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">send<wbr>ToPlugin<span class="tsd-signature-symbol">(</span>payload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, action<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-property-inspector-handler.ts#L30">abstracts/stream-deck-property-inspector-handler.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Send data to the action</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>payload: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Data to send</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> action: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Action context. (Default: current context)</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<a name="setsettings" class="tsd-anchor"></a>
<h3>set<wbr>Settings</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">set<wbr>Settings<Settings><span class="tsd-signature-symbol">(</span>settings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Settings</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides StreamDeckHandlerBase.setSettings</p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-property-inspector-handler.ts#L49">abstracts/stream-deck-property-inspector-handler.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>inheritdoc</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>Settings = <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>settings: <span class="tsd-signature-type">Settings</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-has-type-parameter">
<a href="streamdeckpropertyinspectorhandler.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Property<wbr>Inspector<wbr>Handler</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-protected">
<a href="streamdeckpropertyinspectorhandler.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected">
<a href="streamdeckpropertyinspectorhandler.html#actioninfo" class="tsd-kind-icon">action<wbr>Info</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#connectionready" class="tsd-kind-icon">connection<wbr>Ready</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#documentready" class="tsd-kind-icon">document<wbr>Ready</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#globalsettingsready" class="tsd-kind-icon">global<wbr>Settings<wbr>Ready</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#info" class="tsd-kind-icon">info</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#port" class="tsd-kind-icon">port</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#registerevent" class="tsd-kind-icon">register<wbr>Event</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#settingsmanager" class="tsd-kind-icon">settings<wbr>Manager</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#uuid" class="tsd-kind-icon">uuid</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#enabledebug" class="tsd-kind-icon">enable<wbr>Debug</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#logmessage" class="tsd-kind-icon">log<wbr>Message</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#openurl" class="tsd-kind-icon">open<wbr>Url</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#requestglobalsettings" class="tsd-kind-icon">request<wbr>Global<wbr>Settings</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="streamdeckpropertyinspectorhandler.html#requestsettings" class="tsd-kind-icon">request<wbr>Settings</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="streamdeckpropertyinspectorhandler.html#send" class="tsd-kind-icon">send</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="streamdeckpropertyinspectorhandler.html#sendtoplugin" class="tsd-kind-icon">send<wbr>ToPlugin</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite">
<a href="streamdeckpropertyinspectorhandler.html#setsettings" class="tsd-kind-icon">set<wbr>Settings</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>