forked from BarRaider/streamdeck-tools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
streamdeck-tools.xml
1479 lines (1476 loc) · 63.2 KB
/
streamdeck-tools.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>StreamDeckTools</name>
</assembly>
<members>
<member name="T:BarRaider.SdTools.FilenamePropertyAttribute">
<summary>
FilenamePropertyAttribute - Used to indicate the current property holds a file name.
This will allow StreamDeck Tools to strip the mandatory "C:\fakepath\" added by the SDK
</summary>
</member>
<member name="T:BarRaider.SdTools.PluginActionIdAttribute">
<summary>
PluginActionId attribute
Used to indicate the UUID in the manifest file that matches to this class
</summary>
</member>
<member name="P:BarRaider.SdTools.PluginActionIdAttribute.ActionId">
<summary>
UUID of the action
</summary>
</member>
<member name="M:BarRaider.SdTools.PluginActionIdAttribute.#ctor(System.String)">
<summary>
Constructor - This attribute is used to indicate the UUID in the manifest file that matches to this class
</summary>
<param name="ActionId"></param>
</member>
<member name="T:BarRaider.SdTools.SDConnection">
<summary>
Connection object which handles your communication with the Stream Deck app
</summary>
</member>
<member name="E:BarRaider.SdTools.SDConnection.OnSendToPlugin">
<summary>
Event received by the plugin when the Property Inspector uses the sendToPlugin event.
</summary>
</member>
<member name="E:BarRaider.SdTools.SDConnection.OnTitleParametersDidChange">
<summary>
Event received when the user changes the title or title parameters.
</summary>
</member>
<member name="E:BarRaider.SdTools.SDConnection.OnApplicationDidTerminate">
<summary>
Event received when a monitored application is terminated
</summary>
</member>
<member name="E:BarRaider.SdTools.SDConnection.OnApplicationDidLaunch">
<summary>
Event received when a monitored application is launched
</summary>
</member>
<member name="E:BarRaider.SdTools.SDConnection.OnDeviceDidDisconnect">
<summary>
Event received when a device is unplugged from the computer
</summary>
</member>
<member name="E:BarRaider.SdTools.SDConnection.OnDeviceDidConnect">
<summary>
Event received when a device is plugged to the computer.
</summary>
</member>
<member name="E:BarRaider.SdTools.SDConnection.OnPropertyInspectorDidAppear">
<summary>
Event received when the Property Inspector appears in the Stream Deck software user interface, for example when selecting a new instance.
</summary>
</member>
<member name="E:BarRaider.SdTools.SDConnection.OnPropertyInspectorDidDisappear">
<summary>
Event received when the Property Inspector for an instance is removed from the Stream Deck software user interface, for example when selecting a different instance.
</summary>
</member>
<member name="M:BarRaider.SdTools.SDConnection.SendToPropertyInspectorAsync(Newtonsoft.Json.Linq.JObject)">
<summary>
Send settings to the PropertyInspector
</summary>
<param name="settings"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.SetSettingsAsync(Newtonsoft.Json.Linq.JObject)">
<summary>
Persists your plugin settings
</summary>
<param name="settings"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.SetGlobalSettingsAsync(Newtonsoft.Json.Linq.JObject,System.Boolean)">
<summary>
Persists your global plugin settings
</summary>
<param name="settings">Settings to save globally</param>
<param name="triggerDidReceiveGlobalSettings">Boolean whether to also trigger a didReceiveGlobalSettings event. Default is true</param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.GetGlobalSettingsAsync">
<summary>
Persists your global plugin settings
</summary>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.SetImageAsync(System.String,System.Nullable{System.Int32},System.Boolean)">
<summary>
Sets an image on the StreamDeck key.
</summary>
<param name="base64Image">Base64 encoded image</param>
<param name="state">A 0-based integer value representing the state of an action with multiple states. This is an optional parameter. If not specified, the title is set to all states.</param>
<param name="forceSendToStreamdeck">Should image be sent even if it is identical to the one sent previously. Default is false</param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.SetImageAsync(System.Drawing.Image,System.Nullable{System.Int32},System.Boolean)">
<summary>
Sets an image on the StreamDeck key
</summary>
<param name="image">Image object</param>
<param name="state">A 0-based integer value representing the state of an action with multiple states. This is an optional parameter. If not specified, the title is set to all states.</param>
<param name="forceSendToStreamdeck">Should image be sent even if it is identical to the one sent previously. Default is false</param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.SetDefaultImageAsync">
<summary>
Sets the default image for this state, as configured in the manifest
</summary>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.SetTitleAsync(System.String,System.Nullable{System.Int32})">
<summary>
Sets a title on the StreamDeck key
</summary>
<param name="title"></param>
<param name="state">A 0-based integer value representing the state of an action with multiple states. This is an optional parameter. If not specified, the title is set to all states.</param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.SwitchProfileAsync(System.String)">
<summary>
Switches to one of the plugin's built-in profiles
</summary>
<param name="profileName"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.SwitchProfileAsync(System.String,System.String)">
<summary>
Switches to one of the plugin's built-in profiles. Allows to choose which device to switch it on.
</summary>
<param name="profileName"></param>
<param name="deviceId"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.ShowAlert">
<summary>
Shows the Alert (Yellow Triangle) on the StreamDeck key
</summary>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.ShowOk">
<summary>
Shows the Success (Green checkmark) on the StreamDeck key
</summary>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.LogSDMessage(System.String)">
<summary>
Add a message to the Stream Deck log. This is the log located at: %appdata%\Elgato\StreamDeck\logs\StreamDeck0.log
</summary>
<param name="message"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.DeviceInfo">
<summary>
Gets the Stream Deck device's info
</summary>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.GetSettingsAsync">
<summary>
Tells Stream Deck to return the current plugin settings via the ReceivedSettings function
</summary>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.OpenUrlAsync(System.String)">
<summary>
Opens a URI in the user's browser
</summary>
<param name="uri"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.OpenUrlAsync(System.Uri)">
<summary>
Opens a URI in the user's browser
</summary>
<param name="uri"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.SDConnection.SetStateAsync(System.UInt32)">
<summary>
Sets the plugin to a specific state which is pre-configured in the manifest file
</summary>
<param name="state"></param>
<returns></returns>
</member>
<member name="P:BarRaider.SdTools.SDConnection.ContextId">
<summary>
An opaque value identifying the plugin. This value is received during the Registration procedure
</summary>
</member>
<member name="P:BarRaider.SdTools.SDConnection.DeviceId">
<summary>
An opaque value identifying the device the plugin is launched on.
</summary>
</member>
<member name="P:BarRaider.SdTools.SDConnection.StreamDeckConnection">
<summary>
StreamDeckConnection object, initialized based on the args received when launching the program
</summary>
</member>
<member name="M:BarRaider.SdTools.SDConnection.#ctor(streamdeck_client_csharp.StreamDeckConnection,System.String,BarRaider.SdTools.StreamDeckInfo,System.String,System.String,System.String)">
<summary>
Public constructor, a StreamDeckConnection object is required along with the current action and context IDs
These will be used to correctly communicate with the StreamDeck App
</summary>
<param name="connection"></param>
<param name="pluginUUID"></param>
<param name="deviceInfo"></param>
<param name="actionId"></param>
<param name="contextId"></param>
/// <param name="deviceId"></param>
</member>
<member name="M:BarRaider.SdTools.SDConnection.Dispose">
<summary>
Dispose (Destructor) function
</summary>
</member>
<member name="F:BarRaider.SdTools.SDConnection.pluginUUID">
<summary>
An opaque value identifying the plugin. Received as an argument when the executable was launched.
</summary>
</member>
<member name="F:BarRaider.SdTools.SDConnection.deviceInfo">
<summary>
Holds information about the devices connected to the computer
</summary>
</member>
<member name="T:BarRaider.SdTools.SDWrapper">
<summary>
* Easy Configuration Instructions:
* 1. Use NuGet to get the following packages:
* CommandLineParser by gsscoder
* streamdeck-client-csharp by Shane DeSeranno
* Newtonsoft.Json by James Newton-King
* 2. Create a class that implements the IPluginable interface (which is located in BarRaider.SDTools), this will be your main plugin
* 3. Pass the type of the class to the main function
</summary>
</member>
<member name="M:BarRaider.SdTools.SDWrapper.Run(System.String[],BarRaider.SdTools.PluginActionId[])">
/************************************************************************
* Initial configuration from TyrenDe's streamdeck-client-csharp example:
* https://github.com/TyrenDe/streamdeck-client-csharp
* and SaviorXTanren's MixItUp.StreamDeckPlugin:
* https://github.com/SaviorXTanren/mixer-mixitup/
*************************************************************************/
<summary>
Obsolete! Use the new Run(string[]) overload
Library's main initialization point.
Pass the args from your Main function and a list of supported PluginActionIds, the framework will handle the rest.
</summary>
<param name="args"></param>
<param name="supportedActionIds"></param>
</member>
<member name="M:BarRaider.SdTools.SDWrapper.Run(System.String[])">
<summary>
Library's main initialization point.
Pass the args from your Main function. We'll handle the rest
</summary>
<param name="args"></param>
</member>
<member name="T:BarRaider.SdTools.Events.ApplicationDidLaunch">
<summary>
Payload for ApplicationDidLaunch event
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.ApplicationDidLaunch.Payload">
<summary>
Payload
</summary>
</member>
<member name="M:BarRaider.SdTools.Events.ApplicationDidLaunch.#ctor(BarRaider.SdTools.Payloads.ApplicationPayload)">
<summary>
Constructor
</summary>
<param name="payload"></param>
</member>
<member name="T:BarRaider.SdTools.Events.ApplicationDidTerminate">
<summary>
Payload for ApplicationDidTerminate event
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.ApplicationDidTerminate.Payload">
<summary>
Payload
</summary>
</member>
<member name="M:BarRaider.SdTools.Events.ApplicationDidTerminate.#ctor(BarRaider.SdTools.Payloads.ApplicationPayload)">
<summary>
Constructor
</summary>
<param name="payload"></param>
</member>
<member name="T:BarRaider.SdTools.Events.DeviceDidConnect">
<summary>
Payload for DeviceDidConnect event
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.DeviceDidConnect.Device">
<summary>
Device GUID
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.DeviceDidConnect.DeviceInfo">
<summary>
Device Info
</summary>
</member>
<member name="M:BarRaider.SdTools.Events.DeviceDidConnect.#ctor(BarRaider.SdTools.StreamDeckDeviceInfo)">
<summary>
Constructor
</summary>
<param name="deviceInfo"></param>
</member>
<member name="T:BarRaider.SdTools.Events.DeviceDidDisconnect">
<summary>
Payload for DeviceDidDisconnect event
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.DeviceDidDisconnect.Device">
<summary>
Device GUID
</summary>
</member>
<member name="M:BarRaider.SdTools.Events.DeviceDidDisconnect.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="device"></param>
</member>
<member name="T:BarRaider.SdTools.Events.PropertyInspectorDidAppear">
<summary>
Payload for PropertyInspectorDidAppear event
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.PropertyInspectorDidAppear.Action">
<summary>
ActionId
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.PropertyInspectorDidAppear.Context">
<summary>
ContextId
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.PropertyInspectorDidAppear.Device">
<summary>
Device Guid
</summary>
</member>
<member name="M:BarRaider.SdTools.Events.PropertyInspectorDidAppear.#ctor(System.String,System.String,System.String)">
<summary>
Constructor
</summary>
<param name="action"></param>
<param name="context"></param>
<param name="device"></param>
</member>
<member name="T:BarRaider.SdTools.Events.PropertyInspectorDidDisappear">
<summary>
Payload for PropertyInspectorDidDisappear event
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.PropertyInspectorDidDisappear.Action">
<summary>
Action Id
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.PropertyInspectorDidDisappear.Context">
<summary>
ContextId
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.PropertyInspectorDidDisappear.Device">
<summary>
Device Guid
</summary>
</member>
<member name="M:BarRaider.SdTools.Events.PropertyInspectorDidDisappear.#ctor(System.String,System.String,System.String)">
<summary>
Constructor
</summary>
<param name="action"></param>
<param name="context"></param>
<param name="device"></param>
</member>
<member name="T:BarRaider.SdTools.Events.SendToPlugin">
<summary>
Payload for SendToPlugin event
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.SendToPlugin.Action">
<summary>
ActionId
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.SendToPlugin.Context">
<summary>
ContextId
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.SendToPlugin.Payload">
<summary>
Payload
</summary>
</member>
<member name="M:BarRaider.SdTools.Events.SendToPlugin.#ctor(System.String,System.String,Newtonsoft.Json.Linq.JObject)">
<summary>
Constructor
</summary>
<param name="action"></param>
<param name="context"></param>
<param name="payload"></param>
</member>
<member name="T:BarRaider.SdTools.Events.TitleParametersDidChange">
<summary>
Payload for TitleParametersDidChange event
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.TitleParametersDidChange.Action">
<summary>
Action Id
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.TitleParametersDidChange.Context">
<summary>
Context Id
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.TitleParametersDidChange.Device">
<summary>
Device Guid
</summary>
</member>
<member name="P:BarRaider.SdTools.Events.TitleParametersDidChange.Payload">
<summary>
Payload
</summary>
</member>
<member name="M:BarRaider.SdTools.Events.TitleParametersDidChange.#ctor(System.String,System.String,System.String,BarRaider.SdTools.Payloads.TitleParametersPayload)">
<summary>
Constructor
</summary>
<param name="action"></param>
<param name="context"></param>
<param name="device"></param>
<param name="payload"></param>
</member>
<member name="T:BarRaider.SdTools.Payloads.ApplicationPayload">
<summary>
ApplicationPayload
</summary>
</member>
<member name="P:BarRaider.SdTools.Payloads.ApplicationPayload.Application">
<summary>
Application Name
</summary>
</member>
<member name="M:BarRaider.SdTools.Payloads.ApplicationPayload.#ctor(System.String)">
<summary>
Constructor
</summary>
<param name="application"></param>
</member>
<member name="T:BarRaider.SdTools.Payloads.TitleParametersPayload">
<summary>
Payload for TitleParametersDidChange Event
</summary>
</member>
<member name="P:BarRaider.SdTools.Payloads.TitleParametersPayload.Settings">
<summary>
Settings JSON Object
</summary>
</member>
<member name="P:BarRaider.SdTools.Payloads.TitleParametersPayload.Coordinates">
<summary>
Key Coordinates
</summary>
</member>
<member name="P:BarRaider.SdTools.Payloads.TitleParametersPayload.State">
<summary>
Key State
</summary>
</member>
<member name="P:BarRaider.SdTools.Payloads.TitleParametersPayload.Title">
<summary>
Title
</summary>
</member>
<member name="P:BarRaider.SdTools.Payloads.TitleParametersPayload.TitleParameters">
<summary>
Title Parameters
</summary>
</member>
<member name="M:BarRaider.SdTools.Payloads.TitleParametersPayload.#ctor(Newtonsoft.Json.Linq.JObject,BarRaider.SdTools.KeyCoordinates,System.UInt32,System.String,BarRaider.SdTools.Wrappers.TitleParameters)">
<summary>
Constructor
</summary>
<param name="settings"></param>
<param name="coordinates"></param>
<param name="state"></param>
<param name="title"></param>
<param name="titleParameters"></param>
</member>
<member name="T:BarRaider.SdTools.InitialPayload">
<summary>
Payload received during the plugin's constructor
</summary>
</member>
<member name="P:BarRaider.SdTools.InitialPayload.Settings">
<summary>
Plugin instance's settings (set through Property Inspector)
</summary>
</member>
<member name="P:BarRaider.SdTools.InitialPayload.Coordinates">
<summary>
Plugin's physical location on the Stream Deck device
</summary>
</member>
<member name="P:BarRaider.SdTools.InitialPayload.State">
<summary>
Current plugin state
</summary>
</member>
<member name="P:BarRaider.SdTools.InitialPayload.IsInMultiAction">
<summary>
Is it in a Multiaction
</summary>
</member>
<member name="P:BarRaider.SdTools.InitialPayload.DeviceInfo">
<summary>
Information regarding the Stream Deck hardware device
</summary>
</member>
<member name="M:BarRaider.SdTools.InitialPayload.#ctor(BarRaider.SdTools.KeyCoordinates,Newtonsoft.Json.Linq.JObject,System.UInt32,System.Boolean,BarRaider.SdTools.StreamDeckInfo)">
<summary>
Constructor
</summary>
<param name="coordinates"></param>
<param name="settings"></param>
<param name="state"></param>
<param name="isInMultiAction"></param>
<param name="deviceInfo"></param>
</member>
<member name="T:BarRaider.SdTools.KeyPayload">
<summary>
Payload received when a key is pressed or released
</summary>
</member>
<member name="P:BarRaider.SdTools.KeyPayload.Settings">
<summary>
Current plugin settings
</summary>
</member>
<member name="P:BarRaider.SdTools.KeyPayload.Coordinates">
<summary>
Location of plugin on the stream deck
</summary>
</member>
<member name="P:BarRaider.SdTools.KeyPayload.State">
<summary>
Current plugin state
</summary>
</member>
<member name="P:BarRaider.SdTools.KeyPayload.UserDesiredState">
<summary>
Desired state
</summary>
</member>
<member name="P:BarRaider.SdTools.KeyPayload.IsInMultiAction">
<summary>
Is part of a multiAction
</summary>
</member>
<member name="M:BarRaider.SdTools.KeyPayload.#ctor(BarRaider.SdTools.KeyCoordinates,Newtonsoft.Json.Linq.JObject,System.UInt32,System.UInt32,System.Boolean)">
<summary>
Constructor
</summary>
<param name="coordinates"></param>
<param name="settings"></param>
<param name="state"></param>
<param name="userDesiredState"></param>
<param name="isInMultiAction"></param>
</member>
<member name="T:BarRaider.SdTools.ReceivedGlobalSettingsPayload">
<summary>
Payload that holds all the settings in the ReceivedGlobalSettings event
</summary>
</member>
<member name="P:BarRaider.SdTools.ReceivedGlobalSettingsPayload.Settings">
<summary>
Global settings object
</summary>
</member>
<member name="T:BarRaider.SdTools.ReceivedSettingsPayload">
<summary>
Payload that holds all the settings in the ReceivedSettings event
</summary>
</member>
<member name="P:BarRaider.SdTools.ReceivedSettingsPayload.Settings">
<summary>
Action's settings
</summary>
</member>
<member name="P:BarRaider.SdTools.ReceivedSettingsPayload.Coordinates">
<summary>
Coordinates of the key pressed
</summary>
</member>
<member name="P:BarRaider.SdTools.ReceivedSettingsPayload.IsInMultiAction">
<summary>
Is event part of a multiaction
</summary>
</member>
<member name="T:BarRaider.SdTools.StreamDeckOptions">
<summary>
Class holding all the information passed to the plugin when the program was launched
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckOptions.Port">
<summary>
Port to communicate with the StreamDeck app
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckOptions.PluginUUID">
<summary>
UUID of the plugin
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckOptions.RegisterEvent">
<summary>
Name of the event we should pass to the StreamDeck app to register
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckOptions.RawInfo">
<summary>
Raw information in JSON format which we will parse into the DeviceInfo property
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckOptions.DeviceInfo">
<summary>
Information regarding the StreamDeck app and StreamDeck hardware which was parsed from the RawInfo JSON field.
</summary>
</member>
<member name="T:BarRaider.SdTools.StreamDeckApplicationInfo">
<summary>
Holds general information on the StreamDeck App we're communicating with
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckApplicationInfo.Language">
<summary>
Current language of the StreamDeck app
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckApplicationInfo.Platform">
<summary>
OS Platform
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckApplicationInfo.Version">
<summary>
Current version of the StreamDeck app
</summary>
</member>
<member name="M:BarRaider.SdTools.StreamDeckApplicationInfo.ToString">
<summary>
Shows class information as string
</summary>
<returns></returns>
</member>
<member name="T:BarRaider.SdTools.StreamDeckDeviceType">
<summary>
Type of StreamDeck hardware device, currently two are supported (classic and mini)
</summary>
</member>
<member name="F:BarRaider.SdTools.StreamDeckDeviceType.StreamDeckClassic">
<summary>
StreamDeck classic with 15 keys
</summary>
</member>
<member name="F:BarRaider.SdTools.StreamDeckDeviceType.StreamDeckMini">
<summary>
StreamDeck mini with 6 keys
</summary>
</member>
<member name="F:BarRaider.SdTools.StreamDeckDeviceType.StreamDeckXL">
<summary>
StreamDeck XL with 32 keys
</summary>
</member>
<member name="F:BarRaider.SdTools.StreamDeckDeviceType.StreamDeckMobile">
<summary>
StreamDeck Mobile version
</summary>
</member>
<member name="F:BarRaider.SdTools.StreamDeckDeviceType.CorsairGKeys">
<summary>
Corsair G-Keys version
</summary>
</member>
<member name="T:BarRaider.SdTools.StreamDeckDeviceInfo">
<summary>
Class which holds information on the StreamDeck hardware device
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckDeviceInfo.Size">
<summary>
Details on number of keys of the StreamDeck hardware device
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckDeviceInfo.Type">
<summary>
Type of StreamDeck hardware device
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckDeviceInfo.Id">
<summary>
Id of the StreamDeck hardware device
</summary>
</member>
<member name="M:BarRaider.SdTools.StreamDeckDeviceInfo.#ctor(BarRaider.SdTools.StreamDeckDeviceSize,BarRaider.SdTools.StreamDeckDeviceType,System.String)">
<summary>
Constructor
</summary>
<param name="size"></param>
<param name="type"></param>
<param name="deviceId"></param>
</member>
<member name="M:BarRaider.SdTools.StreamDeckDeviceInfo.ToString">
<summary>
Shows class information as string
</summary>
<returns></returns>
</member>
<member name="T:BarRaider.SdTools.StreamDeckDeviceSize">
<summary>
Layout of the keys on the StreamDeck hardware device
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckDeviceSize.Rows">
<summary>
Number of key rows on the StreamDeck hardware device
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckDeviceSize.Cols">
<summary>
Number of key columns on the StreamDeck hardware device
</summary>
</member>
<member name="M:BarRaider.SdTools.StreamDeckDeviceSize.#ctor(System.Int32,System.Int32)">
<summary>
Constructor
</summary>
<param name="rows"></param>
<param name="cols"></param>
</member>
<member name="M:BarRaider.SdTools.StreamDeckDeviceSize.ToString">
<summary>
Shows class information as string
</summary>
<returns></returns>
</member>
<member name="T:BarRaider.SdTools.StreamDeckInfo">
<summary>
Class which holds information on the StreamDeck app and StreamDeck hardware device that the plugin is communicating with
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckInfo.Application">
<summary>
Information on the StreamDeck App which we're communicating with
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckInfo.Devices">
<summary>
Information on the StreamDeck hardware device that the plugin is running on
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckInfo.Plugin">
<summary>
Information on the Plugin we're currently running
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckInfo.DevicePixelRatio">
<summary>
Device pixel ratio
</summary>
</member>
<member name="M:BarRaider.SdTools.StreamDeckInfo.ToString">
<summary>
Shows class information as string
</summary>
<returns></returns>
</member>
<member name="T:BarRaider.SdTools.StreamDeckPluginInfo">
<summary>
Holds general information on the StreamDeck App we're communicating with
</summary>
</member>
<member name="P:BarRaider.SdTools.StreamDeckPluginInfo.Version">
<summary>
Current version of the plugin
</summary>
</member>
<member name="M:BarRaider.SdTools.StreamDeckPluginInfo.ToString">
<summary>
Shows class information as string
</summary>
<returns></returns>
</member>
<member name="T:BarRaider.SdTools.ExtensionMethods">
<summary>
Extension methods for various objects
</summary>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.IsCoordinatesSame(BarRaider.SdTools.KeyCoordinates,BarRaider.SdTools.KeyCoordinates)">
<summary>
Checks if too KeyCoordinates match to the same key
</summary>
<param name="coordinates"></param>
<param name="secondCoordinates"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.ToKeyCoordinates(streamdeck_client_csharp.Events.Coordinates)">
<summary>
Converts to a SDTools.KeyCoordinates
</summary>
<param name="coordinates"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.ToStreamDeckDeviceInfo(streamdeck_client_csharp.Events.DeviceInfo,System.String)">
<summary>
Converts to a SDTools StreamDeckDeviceInfo object
</summary>
<param name="deviceInfo"></param>
<param name="deviceId"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.ToSDTitleParameters(streamdeck_client_csharp.Events.TitleParameters)">
<summary>
Converts to an SDTools TitleParameters
</summary>
<param name="titleParameters"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.ToHex(System.Drawing.Color)">
<summary>
Shows Color In Hex Format
</summary>
<param name="color"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.ToHex(System.Drawing.Brush)">
<summary>
Shows Color in Hex format
</summary>
<param name="brush"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.ToByteArray(System.Drawing.Image)">
<summary>
Converts an Image into a Byte Array
</summary>
<param name="image"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.DrawAndMeasureString(System.Drawing.Graphics,System.String,System.Drawing.Font,System.Drawing.Brush,System.Drawing.PointF)">
<summary>
Draws a string on a Graphics object and returns the ending Y position of the string
</summary>
<param name="graphics"></param>
<param name="text"></param>
<param name="font"></param>
<param name="brush"></param>
<param name="position"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.GetTextCenter(System.Drawing.Graphics,System.String,System.Int32,System.Drawing.Font,System.Boolean@,System.Int32)">
<summary>
Returns the center X position of a string, given the image's max Width and Font information
</summary>
<param name="graphics"></param>
<param name="text"></param>
<param name="imageWidth"></param>
<param name="font"></param>
/// <param name="textFitsImage">True/False - Does text fit image? False if text overflows</param>
<param name="minIndentation"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.GetTextCenter(System.Drawing.Graphics,System.String,System.Int32,System.Drawing.Font,System.Int32)">
<summary>
Returns the center X position of a string, given the image's max Width and Font information
</summary>
<param name="graphics"></param>
<param name="text"></param>
<param name="imageWidth"></param>
<param name="font"></param>
<param name="minIndentation"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.GetFontSizeWhereTextFitsImage(System.Drawing.Graphics,System.String,System.Int32,System.Drawing.Font,System.Int32)">
<summary>
Returns the highest size of the given font in which the text fits the image
</summary>
<param name="graphics"></param>
<param name="text"></param>
<param name="imageWidth"></param>
<param name="font"></param>
/// <param name="minimalFontSize"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.AddTextPath(System.Drawing.Graphics,BarRaider.SdTools.Wrappers.TitleParameters,System.Int32,System.Int32,System.String,System.Int32)">
<summary>
Adds a text path to an existing Graphics object. Uses TitleParameters to emulate the Text settings in the Property Inspector
</summary>
<param name="graphics"></param>
<param name="titleParameters"></param>
<param name="imageHeight"></param>
<param name="imageWidth"></param>
<param name="text"></param>
<param name="pixelsAlignment"></param>
</member>
<member name="M:BarRaider.SdTools.ExtensionMethods.AddTextPath(System.Drawing.Graphics,BarRaider.SdTools.Wrappers.TitleParameters,System.Int32,System.Int32,System.String,System.Drawing.Color,System.Single,System.Int32)">
<summary>
Adds a text path to an existing Graphics object. Uses TitleParameters to emulate the Text settings in the Property Inspector
</summary>
<param name="graphics"></param>
<param name="titleParameters"></param>
<param name="imageHeight"></param>
<param name="imageWidth"></param>
<param name="text"></param>
<param name="strokeColor"></param>
<param name="strokeThickness"></param>
<param name="pixelsAlignment"></param>
</member>
<member name="T:BarRaider.SdTools.GlobalSettingsManager">
<summary>
Helper class which allows fetching the GlobalSettings of a plugin
</summary>
</member>
<member name="P:BarRaider.SdTools.GlobalSettingsManager.Instance">
<summary>
Returns singelton entry of GlobalSettingsManager
</summary>
</member>
<member name="E:BarRaider.SdTools.GlobalSettingsManager.OnReceivedGlobalSettings">
<summary>
Event triggered when Global Settings are received
</summary>
</member>
<member name="M:BarRaider.SdTools.GlobalSettingsManager.RequestGlobalSettings">
<summary>
Command to request the Global Settings. Use the OnDidReceiveGlobalSSettings callback function to receive the Global Settings.
</summary>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.GlobalSettingsManager.SetGlobalSettings(Newtonsoft.Json.Linq.JObject,System.Boolean)">
<summary>
Sets the Global Settings for the plugin
</summary>
<param name="settings"></param>
<param name="triggerDidReceiveGlobalSettings"></param>
<returns></returns>
</member>
<member name="T:BarRaider.SdTools.GraphicsTools">
<summary>
Library of tools used to manipulate graphics
</summary>
</member>
<member name="M:BarRaider.SdTools.GraphicsTools.ColorFromHex(System.String)">
<summary>
Return a Color object based on the hex value
</summary>
<param name="hexColor"></param>
<returns></returns>
</member>
<member name="M:BarRaider.SdTools.GraphicsTools.GenerateColorShades(System.String,System.Int32,System.Int32)">
<summary>
Generates multiple shades based on an initial color, and number of stages/shades you want
</summary>
<param name="initialColor"></param>
<param name="currentShade"></param>
<param name="totalAmountOfShades"></param>
<returns></returns>