streamdeck-typescript
Version:
This library will help you build elgato stream deck plugins in typescript
535 lines • 36.9 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>streamdeck-typescript - v3.3.4</title>
<meta name="description" content="Documentation for streamdeck-typescript - v3.3.4">
<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.3.4</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">
<h1>streamdeck-typescript - v3.3.4</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<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 ">
<h3>Enumerations</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum"><a href="enums/devicetype.html" class="tsd-kind-icon">Device<wbr>Type</a></li>
<li class="tsd-kind-enum"><a href="enums/eventtype.html" class="tsd-kind-icon">Event<wbr>Type</a></li>
<li class="tsd-kind-enum"><a href="enums/statetype.html" class="tsd-kind-icon">State<wbr>Type</a></li>
<li class="tsd-kind-enum"><a href="enums/targettype.html" class="tsd-kind-icon">Target<wbr>Type</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/actionmanager.html" class="tsd-kind-icon">Action<wbr>Manager</a></li>
<li class="tsd-kind-class"><a href="classes/settingsmanager.html" class="tsd-kind-icon">Settings<wbr>Manager</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/streamdeckaction.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Action</a></li>
<li class="tsd-kind-class"><a href="classes/streamdeckactionclass.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Action<wbr>Class</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/streamdeckhandlerbase.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Handler<wbr>Base</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/streamdeckpluginhandler.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Plugin<wbr>Handler</a></li>
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/streamdeckpropertyinspectorhandler.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Property<wbr>Inspector<wbr>Handler</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Event Data Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/applicationdidlaunchevent.html" class="tsd-kind-icon">Application<wbr>Did<wbr>Launch<wbr>Event</a></li>
<li class="tsd-kind-interface"><a href="interfaces/applicationdidterminateevent.html" class="tsd-kind-icon">Application<wbr>Did<wbr>Terminate<wbr>Event</a></li>
<li class="tsd-kind-interface"><a href="interfaces/devicedidconnectevent.html" class="tsd-kind-icon">Device<wbr>Did<wbr>Connect<wbr>Event</a></li>
<li class="tsd-kind-interface"><a href="interfaces/devicediddisconnectevent.html" class="tsd-kind-icon">Device<wbr>Did<wbr>Disconnect<wbr>Event</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/dialdownevent.html" class="tsd-kind-icon">Dial<wbr>Down<wbr>Event</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/dialrotateevent.html" class="tsd-kind-icon">Dial<wbr>Rotate<wbr>Event</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/dialupevent.html" class="tsd-kind-icon">Dial<wbr>UpEvent</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/didreceiveglobalsettingsevent.html" class="tsd-kind-icon">Did<wbr>Receive<wbr>Global<wbr>Settings<wbr>Event</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/didreceivesettingsevent.html" class="tsd-kind-icon">Did<wbr>Receive<wbr>Settings<wbr>Event</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/keydownevent.html" class="tsd-kind-icon">Key<wbr>Down<wbr>Event</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/keyupevent.html" class="tsd-kind-icon">Key<wbr>UpEvent</a></li>
<li class="tsd-kind-interface"><a href="interfaces/propertyinspectordidappearevent.html" class="tsd-kind-icon">Property<wbr>Inspector<wbr>Did<wbr>Appear<wbr>Event</a></li>
<li class="tsd-kind-interface"><a href="interfaces/propertyinspectordiddisappearevent.html" class="tsd-kind-icon">Property<wbr>Inspector<wbr>Did<wbr>Disappear<wbr>Event</a></li>
<li class="tsd-kind-interface"><a href="interfaces/sendtopievent.html" class="tsd-kind-icon">Send<wbr>ToPi<wbr>Event</a></li>
<li class="tsd-kind-interface"><a href="interfaces/sendtopluginevent.html" class="tsd-kind-icon">Send<wbr>ToPlugin<wbr>Event</a></li>
<li class="tsd-kind-interface"><a href="interfaces/systemdidwakeupevent.html" class="tsd-kind-icon">System<wbr>Did<wbr>Wake<wbr>UpEvent</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/titleparametersdidchangeevent.html" class="tsd-kind-icon">Title<wbr>Parameters<wbr>Did<wbr>Change<wbr>Event</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/willappearevent.html" class="tsd-kind-icon">Will<wbr>Appear<wbr>Event</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/willdisappearevent.html" class="tsd-kind-icon">Will<wbr>Disappear<wbr>Event</a></li>
</ul>
<h3>Internal but public Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/initbase.html" class="tsd-kind-icon">Init<wbr>Base</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/initeventactioninfo.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Action<wbr>Info</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/initeventactioninfopayload.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Action<wbr>Info<wbr>Payload</a></li>
<li class="tsd-kind-interface"><a href="interfaces/initeventactioninfopayloadcoordinates.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Action<wbr>Info<wbr>Payload<wbr>Coordinates</a></li>
<li class="tsd-kind-interface"><a href="interfaces/initeventinfo.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Info</a></li>
<li class="tsd-kind-interface"><a href="interfaces/initeventinfoapplication.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Info<wbr>Application</a></li>
<li class="tsd-kind-interface"><a href="interfaces/initeventinfodevice.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Info<wbr>Device</a></li>
<li class="tsd-kind-interface"><a href="interfaces/initeventinfodevicesize.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Info<wbr>Device<wbr>Size</a></li>
<li class="tsd-kind-interface"><a href="interfaces/initeventinfoplugin.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Info<wbr>Plugin</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/initpi.html" class="tsd-kind-icon">Init<wbr>Pi</a></li>
</ul>
<h3>Other Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/acddata.html" class="tsd-kind-icon">Acd<wbr>Data</a></li>
<li class="tsd-kind-interface"><a href="interfaces/coordinates.html" class="tsd-kind-icon">Coordinates</a></li>
<li class="tsd-kind-interface"><a href="interfaces/titleparameters.html" class="tsd-kind-icon">Title<wbr>Parameters</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias"><a href="modules.html#possibleeventsforactiontoreceive" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>Action<wbr>ToReceive</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#possibleeventsforactiontosend" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>Action<wbr>ToSend</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#possibleeventsforalltoreceive" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>All<wbr>ToReceive</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#possibleeventsforalltosend" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>All<wbr>ToSend</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#possibleeventsforpitoreceive" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>PiTo<wbr>Receive</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#possibleeventsforpitosend" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>PiTo<wbr>Send</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#possibleeventstoreceive" class="tsd-kind-icon">Possible<wbr>Events<wbr>ToReceive</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#possibleeventstosend" class="tsd-kind-icon">Possible<wbr>Events<wbr>ToSend</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Decorator Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function"><a href="modules.html#sdonactionevent" class="tsd-kind-icon">SDOn<wbr>Action<wbr>Event</a></li>
<li class="tsd-kind-function"><a href="modules.html#sdonpievent" class="tsd-kind-icon">SDOn<wbr>PiEvent</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="possibleeventsforactiontoreceive" class="tsd-anchor"></a>
<h3>Possible<wbr>Events<wbr>For<wbr>Action<wbr>ToReceive</h3>
<div class="tsd-signature tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>Action<wbr>ToReceive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"keyDown"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"keyUp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"willAppear"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"willDisappear"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"titleParametersDidChange"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"deviceDidConnect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"deviceDidDisconnect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"applicationDidLaunch"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"applicationDidTerminate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"systemDidWakeUp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"propertyInspectorDidAppear"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"propertyInspectorDidDisappear"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sendToPlugin"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dialUp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dialDown"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dialRotate"</span><span class="tsd-signature-symbol"> | </span><a href="modules.html#possibleeventsforalltoreceive" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForAllToReceive</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/interfaces/types.ts#L33">interfaces/types.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>All available events only for action to receive</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="possibleeventsforactiontosend" class="tsd-anchor"></a>
<h3>Possible<wbr>Events<wbr>For<wbr>Action<wbr>ToSend</h3>
<div class="tsd-signature tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>Action<wbr>ToSend<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"openUrl"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"logMessage"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setTitle"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setImage"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"showAlert"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"showOk"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"switchToProfile"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sendToPropertyInspector"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setFeedback"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setFeedbackLayout"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/interfaces/types.ts#L78">interfaces/types.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>All possible events to send for actions</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="possibleeventsforalltoreceive" class="tsd-anchor"></a>
<h3>Possible<wbr>Events<wbr>For<wbr>All<wbr>ToReceive</h3>
<div class="tsd-signature tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>All<wbr>ToReceive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"didReceiveSettings"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"didReceiveGlobalSettings"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"connectionOpened"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"documentLoaded"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"globalSettingsAvailable"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setupReady"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"connectionClosed"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/interfaces/types.ts#L13">interfaces/types.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>All events available for PI and action to receive</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="possibleeventsforalltosend" class="tsd-anchor"></a>
<h3>Possible<wbr>Events<wbr>For<wbr>All<wbr>ToSend</h3>
<div class="tsd-signature tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>All<wbr>ToSend<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"setSettings"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getSettings"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setGlobalSettings"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getGlobalSettings"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/interfaces/types.ts#L64">interfaces/types.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>All possible events for PI and action to send</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="possibleeventsforpitoreceive" class="tsd-anchor"></a>
<h3>Possible<wbr>Events<wbr>For<wbr>PiTo<wbr>Receive</h3>
<div class="tsd-signature tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>PiTo<wbr>Receive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"sendToPropertyInspector"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"registerPi"</span><span class="tsd-signature-symbol"> | </span><a href="modules.html#possibleeventsforalltoreceive" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForAllToReceive</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/interfaces/types.ts#L25">interfaces/types.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>All available events only for property inspector to receive</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="possibleeventsforpitosend" class="tsd-anchor"></a>
<h3>Possible<wbr>Events<wbr>For<wbr>PiTo<wbr>Send</h3>
<div class="tsd-signature tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>PiTo<wbr>Send<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"sendToPlugin"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/interfaces/types.ts#L73">interfaces/types.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>All possible events to send for PI</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="possibleeventstoreceive" class="tsd-anchor"></a>
<h3>Possible<wbr>Events<wbr>ToReceive</h3>
<div class="tsd-signature tsd-kind-icon">Possible<wbr>Events<wbr>ToReceive<span class="tsd-signature-symbol">:</span> <a href="modules.html#possibleeventsforalltoreceive" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForAllToReceive</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#possibleeventsforpitoreceive" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForPiToReceive</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#possibleeventsforactiontoreceive" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForActionToReceive</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/interfaces/types.ts#L4">interfaces/types.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>All possible events to receive</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="possibleeventstosend" class="tsd-anchor"></a>
<h3>Possible<wbr>Events<wbr>ToSend</h3>
<div class="tsd-signature tsd-kind-icon">Possible<wbr>Events<wbr>ToSend<span class="tsd-signature-symbol">:</span> <a href="modules.html#possibleeventsforpitosend" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForPiToSend</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#possibleeventsforalltosend" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForAllToSend</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#possibleeventsforactiontosend" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForActionToSend</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/interfaces/types.ts#L55">interfaces/types.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>All possible events to send</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Decorator Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="sdonactionevent" class="tsd-anchor"></a>
<h3>SDOn<wbr>Action<wbr>Event</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">SDOn<wbr>Action<wbr>Event<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="modules.html#possibleeventsforactiontoreceive" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForActionToReceive</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/ca283db/src/decorators/on-action-event.decorator.ts#L17">decorators/on-action-event.decorator.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This is the Event decorator for the action context</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <a href="modules.html#possibleeventsforactiontoreceive" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForActionToReceive</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="sdonpievent" class="tsd-anchor"></a>
<h3>SDOn<wbr>PiEvent</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">SDOn<wbr>PiEvent<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="modules.html#possibleeventsforpitoreceive" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForPiToReceive</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/ca283db/src/decorators/on-pi-event.decorator.ts#L17">decorators/on-pi-event.decorator.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This is the Event decorator for the property inspector context</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <a href="modules.html#possibleeventsforpitoreceive" class="tsd-signature-type" data-tsd-kind="Type alias">PossibleEventsForPiToReceive</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</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="current ">
<a href="modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="enums/devicetype.html" class="tsd-kind-icon">Device<wbr>Type</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/eventtype.html" class="tsd-kind-icon">Event<wbr>Type</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/statetype.html" class="tsd-kind-icon">State<wbr>Type</a>
</li>
<li class=" tsd-kind-enum">
<a href="enums/targettype.html" class="tsd-kind-icon">Target<wbr>Type</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/actionmanager.html" class="tsd-kind-icon">Action<wbr>Manager</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/settingsmanager.html" class="tsd-kind-icon">Settings<wbr>Manager</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/streamdeckaction.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Action</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/streamdeckactionclass.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Action<wbr>Class</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/streamdeckhandlerbase.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Handler<wbr>Base</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/streamdeckpluginhandler.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Plugin<wbr>Handler</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/streamdeckpropertyinspectorhandler.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Property<wbr>Inspector<wbr>Handler</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/acddata.html" class="tsd-kind-icon">Acd<wbr>Data</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/applicationdidlaunchevent.html" class="tsd-kind-icon">Application<wbr>Did<wbr>Launch<wbr>Event</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/applicationdidterminateevent.html" class="tsd-kind-icon">Application<wbr>Did<wbr>Terminate<wbr>Event</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/coordinates.html" class="tsd-kind-icon">Coordinates</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/devicedidconnectevent.html" class="tsd-kind-icon">Device<wbr>Did<wbr>Connect<wbr>Event</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/devicediddisconnectevent.html" class="tsd-kind-icon">Device<wbr>Did<wbr>Disconnect<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/dialdownevent.html" class="tsd-kind-icon">Dial<wbr>Down<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/dialrotateevent.html" class="tsd-kind-icon">Dial<wbr>Rotate<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/dialupevent.html" class="tsd-kind-icon">Dial<wbr>UpEvent</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/didreceiveglobalsettingsevent.html" class="tsd-kind-icon">Did<wbr>Receive<wbr>Global<wbr>Settings<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/didreceivesettingsevent.html" class="tsd-kind-icon">Did<wbr>Receive<wbr>Settings<wbr>Event</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/initbase.html" class="tsd-kind-icon">Init<wbr>Base</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/initeventactioninfo.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Action<wbr>Info</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/initeventactioninfopayload.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Action<wbr>Info<wbr>Payload</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/initeventactioninfopayloadcoordinates.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Action<wbr>Info<wbr>Payload<wbr>Coordinates</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/initeventinfo.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/initeventinfoapplication.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Info<wbr>Application</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/initeventinfodevice.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Info<wbr>Device</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/initeventinfodevicesize.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Info<wbr>Device<wbr>Size</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/initeventinfoplugin.html" class="tsd-kind-icon">Init<wbr>Event<wbr>Info<wbr>Plugin</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/initpi.html" class="tsd-kind-icon">Init<wbr>Pi</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/keydownevent.html" class="tsd-kind-icon">Key<wbr>Down<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/keyupevent.html" class="tsd-kind-icon">Key<wbr>UpEvent</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/propertyinspectordidappearevent.html" class="tsd-kind-icon">Property<wbr>Inspector<wbr>Did<wbr>Appear<wbr>Event</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/propertyinspectordiddisappearevent.html" class="tsd-kind-icon">Property<wbr>Inspector<wbr>Did<wbr>Disappear<wbr>Event</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/sendtopievent.html" class="tsd-kind-icon">Send<wbr>ToPi<wbr>Event</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/sendtopluginevent.html" class="tsd-kind-icon">Send<wbr>ToPlugin<wbr>Event</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/systemdidwakeupevent.html" class="tsd-kind-icon">System<wbr>Did<wbr>Wake<wbr>UpEvent</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/titleparameters.html" class="tsd-kind-icon">Title<wbr>Parameters</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/titleparametersdidchangeevent.html" class="tsd-kind-icon">Title<wbr>Parameters<wbr>Did<wbr>Change<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/willappearevent.html" class="tsd-kind-icon">Will<wbr>Appear<wbr>Event</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/willdisappearevent.html" class="tsd-kind-icon">Will<wbr>Disappear<wbr>Event</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#possibleeventsforactiontoreceive" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>Action<wbr>ToReceive</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#possibleeventsforactiontosend" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>Action<wbr>ToSend</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#possibleeventsforalltoreceive" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>All<wbr>ToReceive</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#possibleeventsforalltosend" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>All<wbr>ToSend</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#possibleeventsforpitoreceive" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>PiTo<wbr>Receive</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#possibleeventsforpitosend" class="tsd-kind-icon">Possible<wbr>Events<wbr>For<wbr>PiTo<wbr>Send</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#possibleeventstoreceive" class="tsd-kind-icon">Possible<wbr>Events<wbr>ToReceive</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#possibleeventstosend" class="tsd-kind-icon">Possible<wbr>Events<wbr>ToSend</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#sdonactionevent" class="tsd-kind-icon">SDOn<wbr>Action<wbr>Event</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#sdonpievent" class="tsd-kind-icon">SDOn<wbr>PiEvent</a>
</li>
</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>