streamdeck-typescript

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>StreamDeckActionClass | 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"> <ul class="tsd-breadcrumb"> <li> <a href="../modules.html">streamdeck-typescript - v3.3.4</a> </li> <li> <a href="streamdeckactionclass.html">StreamDeckActionClass</a> </li> </ul> <h1>Class StreamDeckActionClass</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">StreamDeckActionClass</span> </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 "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="streamdeckactionclass.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-accessor tsd-parent-kind-class"><a href="streamdeckactionclass.html#action" class="tsd-kind-icon">action</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="streamdeckactionclass.html#column" class="tsd-kind-icon">column</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="streamdeckactionclass.html#context" class="tsd-kind-icon">context</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="streamdeckactionclass.html#controller" class="tsd-kind-icon">controller</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="streamdeckactionclass.html#device" class="tsd-kind-icon">device</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="streamdeckactionclass.html#isinmultiaction" class="tsd-kind-icon">is<wbr>InMulti<wbr>Action</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="streamdeckactionclass.html#row" class="tsd-kind-icon">row</a></li> <li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="streamdeckactionclass.html#settings" class="tsd-kind-icon">settings</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="streamdeckactionclass.html#state" class="tsd-kind-icon">state</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="streamdeckactionclass.html#userdesiredstate" class="tsd-kind-icon">user<wbr>Desired<wbr>State</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"><a href="streamdeckactionclass.html#disableautodebounce" class="tsd-kind-icon">disable<wbr>Auto<wbr>Debounce</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckactionclass.html#disableautosave" class="tsd-kind-icon">disable<wbr>Auto<wbr>Save</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckactionclass.html#enableautodebounce" class="tsd-kind-icon">enable<wbr>Auto<wbr>Debounce</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckactionclass.html#enableautosave" class="tsd-kind-icon">enable<wbr>Auto<wbr>Save</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckactionclass.html#getaction" class="tsd-kind-icon">get<wbr>Action</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckactionclass.html#getcontext" class="tsd-kind-icon">get<wbr>Context</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckactionclass.html#getdevice" class="tsd-kind-icon">get<wbr>Device</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="streamdeckactionclass.html#getsettings" class="tsd-kind-icon">get<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckactionclass.html#savesettings" class="tsd-kind-icon">save<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="streamdeckactionclass.html#setsettings" class="tsd-kind-icon">set<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckactionclass.html#setsettingsattributes" class="tsd-kind-icon">set<wbr>Settings<wbr>Attributes</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Stream<wbr>Deck<wbr>Action<wbr>Class<span class="tsd-signature-symbol">(</span>_handler<span class="tsd-signature-symbol">: </span><a href="streamdeckpluginhandler.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckPluginHandler</a><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-symbol">: </span><a href="streamdeckactionclass.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckActionClass</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/ca283db/src/classes/stream-deck-action.class.ts#L22">classes/stream-deck-action.class.ts:22</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>_handler: <a href="streamdeckpluginhandler.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckPluginHandler</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="streamdeckactionclass.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckActionClass</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="action" class="tsd-anchor"></a> <h3>action</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> action<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> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> action<span class="tsd-signature-symbol">(</span>value<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/ca283db/src/classes/stream-deck-action.class.ts#L41">classes/stream-deck-action.class.ts:41</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The action's unique identifier. If your plugin supports multiple actions, you should use this value to see which action was triggered.</p> </div> <p>Gets the action</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> <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/classes/stream-deck-action.class.ts#L52">classes/stream-deck-action.class.ts:52</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The action's unique identifier. If your plugin supports multiple actions, you should use this value to see which action was triggered.</p> </div> <p>Sets the action</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <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-accessor tsd-parent-kind-class"> <a name="column" class="tsd-anchor"></a> <h3>column</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> column<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> column<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/ca283db/src/classes/stream-deck-action.class.ts#L104">classes/stream-deck-action.class.ts:104</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The coordinates column of the action triggered.</p> </div> <p>Gets the column</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> <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/classes/stream-deck-action.class.ts#L114">classes/stream-deck-action.class.ts:114</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The coordinates column of the action triggered.</p> </div> <p>Sets the column</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">number</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-accessor tsd-parent-kind-class"> <a name="context" class="tsd-anchor"></a> <h3>context</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> context<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> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> context<span class="tsd-signature-symbol">(</span>value<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/ca283db/src/classes/stream-deck-action.class.ts#L63">classes/stream-deck-action.class.ts:63</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>An opaque value identifying the instance's action. You will need to pass this opaque value to several APIs like the setTitle API.</p> </div> <p>Gets the context</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> <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/classes/stream-deck-action.class.ts#L74">classes/stream-deck-action.class.ts:74</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>An opaque value identifying the instance's action. You will need to pass this opaque value to several APIs like the setTitle API.</p> </div> <p>Sets the context</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <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-accessor tsd-parent-kind-class"> <a name="controller" class="tsd-anchor"></a> <h3>controller</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> controller<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> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> controller<span class="tsd-signature-symbol">(</span>value<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/ca283db/src/classes/stream-deck-action.class.ts#L216">classes/stream-deck-action.class.ts:216</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the controller</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> <p>value</p> </li> <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/classes/stream-deck-action.class.ts#L208">classes/stream-deck-action.class.ts:208</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sets the controller</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> </div> </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-accessor tsd-parent-kind-class"> <a name="device" class="tsd-anchor"></a> <h3>device</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> device<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> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> device<span class="tsd-signature-symbol">(</span>value<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/ca283db/src/classes/stream-deck-action.class.ts#L84">classes/stream-deck-action.class.ts:84</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>An opaque value identifying the device.</p> </div> <p>Gets the device</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> <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/classes/stream-deck-action.class.ts#L94">classes/stream-deck-action.class.ts:94</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>An opaque value identifying the device.</p> </div> <p>Sets the device</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <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-accessor tsd-parent-kind-class"> <a name="isinmultiaction" class="tsd-anchor"></a> <h3>is<wbr>InMulti<wbr>Action</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isInMultiAction<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> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> isInMultiAction<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/ca283db/src/classes/stream-deck-action.class.ts#L144">classes/stream-deck-action.class.ts:144</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Boolean indicating if the action is inside a Multi Action.</p> </div> <p>Gets the is in multi-action state</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> <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/classes/stream-deck-action.class.ts#L154">classes/stream-deck-action.class.ts:154</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Boolean indicating if the action is inside a Multi Action.</p> </div> <p>Sets the is in multi-action state</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">boolean</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-accessor tsd-parent-kind-class"> <a name="row" class="tsd-anchor"></a> <h3>row</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> row<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> row<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/ca283db/src/classes/stream-deck-action.class.ts#L124">classes/stream-deck-action.class.ts:124</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The coordinates row of the action triggered.</p> </div> <p>Gets the row</p> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> <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/classes/stream-deck-action.class.ts#L134">classes/stream-deck-action.class.ts:134</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The coordinates row of the action triggered.</p> </div> <p>Sets the row</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">number</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-set-signature tsd-parent-kind-class"> <a name="settings" class="tsd-anchor"></a> <h3>settings</h3> <ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> settings<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</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/ca283db/src/classes/stream-deck-action.class.ts#L30">classes/stream-deck-action.class.ts:30</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sets the settings</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> </div> </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-accessor tsd-parent-kind-class"> <a name="state" class="tsd-anchor"></a> <h3>state</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> state<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> state<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a><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/ca283db/src/classes/stream-deck-action.class.ts#L165">classes/stream-deck-action.class.ts:165</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This is a parameter that is only set when the action has multiple states defined in its manifest.json. The 0-based value contains the current state of the action.</p> </div> <p>Gets the state</p> </div> <h4 class="tsd-returns-title">Returns <a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a></h4> </li> <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/classes/stream-deck-action.class.ts#L176">classes/stream-deck-action.class.ts:176</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This is a parameter that is only set when the action has multiple states defined in its manifest.json. The 0-based value contains the current state of the action.</p> </div> <p>Sets the state</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a></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-accessor tsd-parent-kind-class"> <a name="userdesiredstate" class="tsd-anchor"></a> <h3>user<wbr>Desired<wbr>State</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> userDesiredState<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> userDesiredState<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a><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/ca283db/src/classes/stream-deck-action.class.ts#L188">classes/stream-deck-action.class.ts:188</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This is a parameter that is only set when the action is triggered with a specific value from a Multi Action. For example if the user sets the Game Capture Record action to be disabled in a Multi Action, you would see the value 1. Only the value 0 and 1 are valid.</p> </div> <p>Gets the user desired state</p> </div> <h4 class="tsd-returns-title">Returns <a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a></h4> </li> <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/classes/stream-deck-action.class.ts#L200">classes/stream-deck-action.class.ts:200</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This is a parameter that is only set when the action is triggered with a specific value from a Multi Action. For example if the user sets the Game Capture Record action to be disabled in a Multi Action, you would see the value 1. Only the value 0 and 1 are valid.</p> </div> <p>Sets the user desired state</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a></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> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="disableautodebounce" class="tsd-anchor"></a> <h3>disable<wbr>Auto<wbr>Debounce</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">disable<wbr>Auto<wbr>Debounce<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"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/classes/stream-deck-action.class.ts#L230">classes/stream-deck-action.class.ts:230</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Disables automatic debounce</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"> <a name="disableautosave" class="tsd-anchor"></a> <h3>disable<wbr>Auto<wbr>Save</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">disable<wbr>Auto<wbr>Save<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"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/classes/stream-deck-action.class.ts#L223">classes/stream-deck-action.class.ts:223</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Disables automatic save</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"> <a name="enableautodebounce" class="tsd-anchor"></a> <h3>enable<wbr>Auto<wbr>Debounce</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">enable<wbr>Auto<wbr>Debounce<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"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/classes/stream-deck-action.class.ts#L244">classes/stream-deck-action.class.ts:244</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Enables automatic debounce</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"> <a name="enableautosave" class="tsd-anchor"></a> <h3>enable<wbr>Auto<wbr>Save</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">enable<wbr>Auto<wbr>Save<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"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/ca283db/src/classes/stream-deck-action.class.ts#L237">classes/stream-deck-action.class.ts:237</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Enables automatic save</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"> <a name="getaction" class="tsd-anchor"></a> <h3>get<wbr>Action</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Action<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/ca283db/src/classes/stream-deck-action.class.ts#L261">classes/stream-deck-action.class.ts:261</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the action</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-method tsd-parent-kind-class"> <a name="getcontext" class="tsd-anchor"></a> <h3>get<wbr>Context</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Context<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/ca283db/src/classes/stream-deck-action.class.ts#L269">classes/stream-deck-action.class.ts:269</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the context</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-method tsd-parent-kind-class"> <a name="getdevice" class="tsd-anchor"></a> <h3>get<wbr>Device</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Device<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/ca283db/src/classes/stream-deck-action.class.ts#L277">classes/stream-deck-action.class.ts:277</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets the device</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-method tsd-parent-kind-class tsd-has-type-parameter"> <a name="getsettings" class="tsd-anchor"></a> <h3>get<wbr>Settings</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">get<wbr>Settings<Settings><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Settings</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/classes/stream-deck-action.class.ts#L253">classes/stream-deck-action.class.ts:253</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets context settings</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>Settings = <span class="tsd-signature-type">object</span></h4> <div class="tsd-comment tsd-typography"> <p>your settings interface for autocomplete</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Settings</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="savesettings" class="tsd-anchor"></a> <h3>save<wbr>Settings</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">save<wbr>Settings<span class="tsd-signature-symbol">(</span>ms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/ca283db/src/classes/stream-deck-action.class.ts#L312">classes/stream-deck-action.class.ts:312</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Save context settings</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>ms: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>for the debounce</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"> <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"> <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">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Settings</span>, ms<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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/ca283db/src/classes/stream-deck-action.class.ts#L287">classes/stream-deck-action.class.ts:287</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set context settings</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>Settings = <span class="tsd-signature-type">object</span></h4> <div class="tsd-comment tsd-typography"> <p>your settings interface for autocomplete</p> </div> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>settings: <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Settings</span></h5> </li> <li> <h5>ms: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5> <div class="tsd-comment tsd-typography"> <p>for the debounce</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"> <a name="setsettingsattributes" class="tsd-anchor"></a> <h3>set<wbr>Settings<wbr>Attributes</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Settings<wbr>Attributes<span class="tsd-signature-symbol">(</span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, ms<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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/ca283db/src/classes/stream-deck-action.class.ts#L301">classes/stream-deck-action.class.ts:301</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set single or multiple attributes for settings</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>attributes: <span class="tsd-signature-type">object</span></h5> </li> <li> <h5>ms: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5> <div class="tsd-comment tsd-typography"> <p>for the debounce</p> </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"> <a href="streamdeckactionclass.html" class="tsd-kind-icon">Stream<wbr>Deck<wbr>Action<wbr>Class</a> <ul> <li