-
-
Notifications
You must be signed in to change notification settings - Fork 707
/
protocol.json
6713 lines (6713 loc) · 214 KB
/
protocol.json
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
{
"enums": [
{
"enumType": "EventSubscription",
"enumIdentifiers": [
{
"description": "Subcription value used to disable all events.",
"enumIdentifier": "None",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 0
},
{
"description": "Subscription value to receive events in the `General` category.",
"enumIdentifier": "General",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 0)"
},
{
"description": "Subscription value to receive events in the `Config` category.",
"enumIdentifier": "Config",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 1)"
},
{
"description": "Subscription value to receive events in the `Scenes` category.",
"enumIdentifier": "Scenes",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 2)"
},
{
"description": "Subscription value to receive events in the `Inputs` category.",
"enumIdentifier": "Inputs",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 3)"
},
{
"description": "Subscription value to receive events in the `Transitions` category.",
"enumIdentifier": "Transitions",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 4)"
},
{
"description": "Subscription value to receive events in the `Filters` category.",
"enumIdentifier": "Filters",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 5)"
},
{
"description": "Subscription value to receive events in the `Outputs` category.",
"enumIdentifier": "Outputs",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 6)"
},
{
"description": "Subscription value to receive events in the `SceneItems` category.",
"enumIdentifier": "SceneItems",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 7)"
},
{
"description": "Subscription value to receive events in the `MediaInputs` category.",
"enumIdentifier": "MediaInputs",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 8)"
},
{
"description": "Subscription value to receive the `VendorEvent` event.",
"enumIdentifier": "Vendors",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 9)"
},
{
"description": "Subscription value to receive events in the `Ui` category.",
"enumIdentifier": "Ui",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 10)"
},
{
"description": "Helper to receive all non-high-volume events.",
"enumIdentifier": "All",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(General | Config | Scenes | Inputs | Transitions | Filters | Outputs | SceneItems | MediaInputs | Vendors | Ui)"
},
{
"description": "Subscription value to receive the `InputVolumeMeters` high-volume event.",
"enumIdentifier": "InputVolumeMeters",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 16)"
},
{
"description": "Subscription value to receive the `InputActiveStateChanged` high-volume event.",
"enumIdentifier": "InputActiveStateChanged",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 17)"
},
{
"description": "Subscription value to receive the `InputShowStateChanged` high-volume event.",
"enumIdentifier": "InputShowStateChanged",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 18)"
},
{
"description": "Subscription value to receive the `SceneItemTransformChanged` high-volume event.",
"enumIdentifier": "SceneItemTransformChanged",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "(1 << 19)"
}
]
},
{
"enumType": "RequestBatchExecutionType",
"enumIdentifiers": [
{
"description": "Not a request batch.",
"enumIdentifier": "None",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "-1"
},
{
"description": "A request batch which processes all requests serially, as fast as possible.\n\nNote: To introduce artificial delay, use the `Sleep` request and the `sleepMillis` request field.",
"enumIdentifier": "SerialRealtime",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 0
},
{
"description": "A request batch type which processes all requests serially, in sync with the graphics thread. Designed to provide high accuracy for animations.\n\nNote: To introduce artificial delay, use the `Sleep` request and the `sleepFrames` request field.",
"enumIdentifier": "SerialFrame",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 1
},
{
"description": "A request batch type which processes all requests using all available threads in the thread pool.\n\nNote: This is mainly experimental, and only really shows its colors during requests which require lots of\nactive processing, like `GetSourceScreenshot`.",
"enumIdentifier": "Parallel",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 2
}
]
},
{
"enumType": "RequestStatus",
"enumIdentifiers": [
{
"description": "Unknown status, should never be used.",
"enumIdentifier": "Unknown",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 0
},
{
"description": "For internal use to signify a successful field check.",
"enumIdentifier": "NoError",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 10
},
{
"description": "The request has succeeded.",
"enumIdentifier": "Success",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 100
},
{
"description": "The `requestType` field is missing from the request data.",
"enumIdentifier": "MissingRequestType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 203
},
{
"description": "The request type is invalid or does not exist.",
"enumIdentifier": "UnknownRequestType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 204
},
{
"description": "Generic error code.\n\nNote: A comment is required to be provided by obs-websocket.",
"enumIdentifier": "GenericError",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 205
},
{
"description": "The request batch execution type is not supported.",
"enumIdentifier": "UnsupportedRequestBatchExecutionType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 206
},
{
"description": "The server is not ready to handle the request.\n\nNote: This usually occurs during OBS scene collection change or exit. Requests may be tried again after a delay if this code is given.",
"enumIdentifier": "NotReady",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.3.0",
"enumValue": 207
},
{
"description": "A required request field is missing.",
"enumIdentifier": "MissingRequestField",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 300
},
{
"description": "The request does not have a valid requestData object.",
"enumIdentifier": "MissingRequestData",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 301
},
{
"description": "Generic invalid request field message.\n\nNote: A comment is required to be provided by obs-websocket.",
"enumIdentifier": "InvalidRequestField",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 400
},
{
"description": "A request field has the wrong data type.",
"enumIdentifier": "InvalidRequestFieldType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 401
},
{
"description": "A request field (number) is outside of the allowed range.",
"enumIdentifier": "RequestFieldOutOfRange",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 402
},
{
"description": "A request field (string or array) is empty and cannot be.",
"enumIdentifier": "RequestFieldEmpty",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 403
},
{
"description": "There are too many request fields (eg. a request takes two optionals, where only one is allowed at a time).",
"enumIdentifier": "TooManyRequestFields",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 404
},
{
"description": "An output is running and cannot be in order to perform the request.",
"enumIdentifier": "OutputRunning",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 500
},
{
"description": "An output is not running and should be.",
"enumIdentifier": "OutputNotRunning",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 501
},
{
"description": "An output is paused and should not be.",
"enumIdentifier": "OutputPaused",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 502
},
{
"description": "An output is not paused and should be.",
"enumIdentifier": "OutputNotPaused",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 503
},
{
"description": "An output is disabled and should not be.",
"enumIdentifier": "OutputDisabled",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 504
},
{
"description": "Studio mode is active and cannot be.",
"enumIdentifier": "StudioModeActive",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 505
},
{
"description": "Studio mode is not active and should be.",
"enumIdentifier": "StudioModeNotActive",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 506
},
{
"description": "The resource was not found.\n\nNote: Resources are any kind of object in obs-websocket, like inputs, profiles, outputs, etc.",
"enumIdentifier": "ResourceNotFound",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 600
},
{
"description": "The resource already exists.",
"enumIdentifier": "ResourceAlreadyExists",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 601
},
{
"description": "The type of resource found is invalid.",
"enumIdentifier": "InvalidResourceType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 602
},
{
"description": "There are not enough instances of the resource in order to perform the request.",
"enumIdentifier": "NotEnoughResources",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 603
},
{
"description": "The state of the resource is invalid. For example, if the resource is blocked from being accessed.",
"enumIdentifier": "InvalidResourceState",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 604
},
{
"description": "The specified input (obs_source_t-OBS_SOURCE_TYPE_INPUT) had the wrong kind.",
"enumIdentifier": "InvalidInputKind",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 605
},
{
"description": "The resource does not support being configured.\n\nThis is particularly relevant to transitions, where they do not always have changeable settings.",
"enumIdentifier": "ResourceNotConfigurable",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 606
},
{
"description": "The specified filter (obs_source_t-OBS_SOURCE_TYPE_FILTER) had the wrong kind.",
"enumIdentifier": "InvalidFilterKind",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 607
},
{
"description": "Creating the resource failed.",
"enumIdentifier": "ResourceCreationFailed",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 700
},
{
"description": "Performing an action on the resource failed.",
"enumIdentifier": "ResourceActionFailed",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 701
},
{
"description": "Processing the request failed unexpectedly.\n\nNote: A comment is required to be provided by obs-websocket.",
"enumIdentifier": "RequestProcessingFailed",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 702
},
{
"description": "The combination of request fields cannot be used to perform an action.",
"enumIdentifier": "CannotAct",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 703
}
]
},
{
"enumType": "ObsOutputState",
"enumIdentifiers": [
{
"description": "Unknown state.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_UNKNOWN",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_UNKNOWN"
},
{
"description": "The output is starting.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STARTING",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_STARTING"
},
{
"description": "The input has started.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STARTED",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_STARTED"
},
{
"description": "The output is stopping.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STOPPING",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_STOPPING"
},
{
"description": "The output has stopped.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STOPPED",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_STOPPED"
},
{
"description": "The output has disconnected and is reconnecting.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_RECONNECTING",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_RECONNECTING"
},
{
"description": "The output has reconnected successfully.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_RECONNECTED",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.1.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_RECONNECTED"
},
{
"description": "The output is now paused.",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_PAUSED",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.1.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_PAUSED"
},
{
"description": "The output has been resumed (unpaused).",
"enumIdentifier": "OBS_WEBSOCKET_OUTPUT_RESUMED",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_OUTPUT_RESUMED"
}
]
},
{
"enumType": "ObsMediaInputAction",
"enumIdentifiers": [
{
"description": "No action.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NONE",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NONE"
},
{
"description": "Play the media input.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY"
},
{
"description": "Pause the media input.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE"
},
{
"description": "Stop the media input.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP"
},
{
"description": "Restart the media input.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART"
},
{
"description": "Go to the next playlist item.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NEXT",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NEXT"
},
{
"description": "Go to the previous playlist item.",
"enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PREVIOUS",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PREVIOUS"
}
]
},
{
"enumType": "WebSocketCloseCode",
"enumIdentifiers": [
{
"description": "For internal use only to tell the request handler not to perform any close action.",
"enumIdentifier": "DontClose",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 0
},
{
"description": "Unknown reason, should never be used.",
"enumIdentifier": "UnknownReason",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4000
},
{
"description": "The server was unable to decode the incoming websocket message.",
"enumIdentifier": "MessageDecodeError",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4002
},
{
"description": "A data field is required but missing from the payload.",
"enumIdentifier": "MissingDataField",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4003
},
{
"description": "A data field's value type is invalid.",
"enumIdentifier": "InvalidDataFieldType",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4004
},
{
"description": "A data field's value is invalid.",
"enumIdentifier": "InvalidDataFieldValue",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4005
},
{
"description": "The specified `op` was invalid or missing.",
"enumIdentifier": "UnknownOpCode",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4006
},
{
"description": "The client sent a websocket message without first sending `Identify` message.",
"enumIdentifier": "NotIdentified",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4007
},
{
"description": "The client sent an `Identify` message while already identified.\n\nNote: Once a client has identified, only `Reidentify` may be used to change session parameters.",
"enumIdentifier": "AlreadyIdentified",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4008
},
{
"description": "The authentication attempt (via `Identify`) failed.",
"enumIdentifier": "AuthenticationFailed",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4009
},
{
"description": "The server detected the usage of an old version of the obs-websocket RPC protocol.",
"enumIdentifier": "UnsupportedRpcVersion",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4010
},
{
"description": "The websocket session has been invalidated by the obs-websocket server.\n\nNote: This is the code used by the `Kick` button in the UI Session List. If you receive this code, you must not automatically reconnect.",
"enumIdentifier": "SessionInvalidated",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4011
},
{
"description": "A requested feature is not supported due to hardware/software limitations.",
"enumIdentifier": "UnsupportedFeature",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 4012
}
]
},
{
"enumType": "WebSocketOpCode",
"enumIdentifiers": [
{
"description": "The initial message sent by obs-websocket to newly connected clients.",
"enumIdentifier": "Hello",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 0
},
{
"description": "The message sent by a newly connected client to obs-websocket in response to a `Hello`.",
"enumIdentifier": "Identify",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 1
},
{
"description": "The response sent by obs-websocket to a client after it has successfully identified with obs-websocket.",
"enumIdentifier": "Identified",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 2
},
{
"description": "The message sent by an already-identified client to update identification parameters.",
"enumIdentifier": "Reidentify",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 3
},
{
"description": "The message sent by obs-websocket containing an event payload.",
"enumIdentifier": "Event",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 5
},
{
"description": "The message sent by a client to obs-websocket to perform a request.",
"enumIdentifier": "Request",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 6
},
{
"description": "The message sent by obs-websocket in response to a particular request from a client.",
"enumIdentifier": "RequestResponse",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 7
},
{
"description": "The message sent by a client to obs-websocket to perform a batch of requests.",
"enumIdentifier": "RequestBatch",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 8
},
{
"description": "The message sent by obs-websocket in response to a particular batch of requests from a client.",
"enumIdentifier": "RequestBatchResponse",
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"enumValue": 9
}
]
}
],
"requests": [
{
"description": "Gets the value of a \"slot\" from the selected persistent data realm.",
"requestType": "GetPersistentData",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"requestFields": [
{
"valueName": "realm",
"valueType": "String",
"valueDescription": "The data realm to select. `OBS_WEBSOCKET_DATA_REALM_GLOBAL` or `OBS_WEBSOCKET_DATA_REALM_PROFILE`",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
},
{
"valueName": "slotName",
"valueType": "String",
"valueDescription": "The name of the slot to retrieve data from",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": [
{
"valueName": "slotValue",
"valueType": "Any",
"valueDescription": "Value associated with the slot. `null` if not set"
}
]
},
{
"description": "Sets the value of a \"slot\" from the selected persistent data realm.",
"requestType": "SetPersistentData",
"complexity": 2,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"requestFields": [
{
"valueName": "realm",
"valueType": "String",
"valueDescription": "The data realm to select. `OBS_WEBSOCKET_DATA_REALM_GLOBAL` or `OBS_WEBSOCKET_DATA_REALM_PROFILE`",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
},
{
"valueName": "slotName",
"valueType": "String",
"valueDescription": "The name of the slot to retrieve data from",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
},
{
"valueName": "slotValue",
"valueType": "Any",
"valueDescription": "The value to apply to the slot",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Gets an array of all scene collections",
"requestType": "GetSceneCollectionList",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"requestFields": [],
"responseFields": [
{
"valueName": "currentSceneCollectionName",
"valueType": "String",
"valueDescription": "The name of the current scene collection"
},
{
"valueName": "sceneCollections",
"valueType": "Array<String>",
"valueDescription": "Array of all available scene collections"
}
]
},
{
"description": "Switches to a scene collection.\n\nNote: This will block until the collection has finished changing.",
"requestType": "SetCurrentSceneCollection",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"requestFields": [
{
"valueName": "sceneCollectionName",
"valueType": "String",
"valueDescription": "Name of the scene collection to switch to",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Creates a new scene collection, switching to it in the process.\n\nNote: This will block until the collection has finished changing.",
"requestType": "CreateSceneCollection",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"requestFields": [
{
"valueName": "sceneCollectionName",
"valueType": "String",
"valueDescription": "Name for the new scene collection",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Gets an array of all profiles",
"requestType": "GetProfileList",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"requestFields": [],
"responseFields": [
{
"valueName": "currentProfileName",
"valueType": "String",
"valueDescription": "The name of the current profile"
},
{
"valueName": "profiles",
"valueType": "Array<String>",
"valueDescription": "Array of all available profiles"
}
]
},
{
"description": "Switches to a profile.",
"requestType": "SetCurrentProfile",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"requestFields": [
{
"valueName": "profileName",
"valueType": "String",
"valueDescription": "Name of the profile to switch to",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Creates a new profile, switching to it in the process",
"requestType": "CreateProfile",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"requestFields": [
{
"valueName": "profileName",
"valueType": "String",
"valueDescription": "Name for the new profile",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Removes a profile. If the current profile is chosen, it will change to a different profile first.",
"requestType": "RemoveProfile",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "config",
"requestFields": [
{
"valueName": "profileName",
"valueType": "String",
"valueDescription": "Name of the profile to remove",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Gets a parameter from the current profile's configuration.",
"requestType": "GetProfileParameter",