obs-websocket 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -1
- data/README.md +1 -1
- data/examples/websocket-driver/main.rb +1 -4
- data/lib/obs/websocket/protocol.rb +669 -449
- data/lib/obs/websocket/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5d8e9f455d8bfe88d29b78409c18421f14d1c566e0f3932750e646d0eaa31c71
|
4
|
+
data.tar.gz: e6f02f83b055fd32b817bf61ae26bce2a1d5ce0a3d06b349f9362e10a32e1709
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c1efad878e90f14fb1cad0963d74be7122389a91a2530e04a2574a056049fd6772c32023164c8688b6d28d365d173fc706f97339748bfcbc979b8e93265a82d2
|
7
|
+
data.tar.gz: 4d365401c87c28faa742e9e992d06492388c937b9b58d8c1668cd43654e4df6302714dd200d2cfad59840538d53a952b7af202907a88aada75167bb2e453ee3f
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# OBS::WebSocket
|
2
2
|
|
3
|
-
OBS::WebSocket is a [Ruby](https://www.ruby-lang.org) library to remotely
|
3
|
+
OBS::WebSocket is a [Ruby](https://www.ruby-lang.org) library to remotely control [OBS Studio](https://obsproject.com/) using [obs-websocket](https://github.com/Palakis/obs-websocket) API.
|
4
4
|
|
5
5
|
## Usage
|
6
6
|
|
@@ -1,9 +1,6 @@
|
|
1
1
|
#!/usr/bin/env ruby
|
2
2
|
# SPDX-License-Identifier: MIT
|
3
3
|
|
4
|
-
ENV['BUNDLE_GEMFILE'] = File.join(__dir__, 'Gemfile')
|
5
|
-
require 'bundler/setup'
|
6
|
-
|
7
4
|
require 'obs/websocket'
|
8
5
|
require 'socket'
|
9
6
|
require 'uri'
|
@@ -30,7 +27,7 @@ class Main
|
|
30
27
|
).wait!
|
31
28
|
rescue => e
|
32
29
|
$stderr.puts e.message
|
33
|
-
|
30
|
+
exit! 1
|
34
31
|
end
|
35
32
|
|
36
33
|
# Listen for events using `on_*` methods. The event payload is yielded to the block.
|
@@ -1,7 +1,7 @@
|
|
1
|
-
# Generated from <https://raw.githubusercontent.com/Palakis/obs-websocket/4.9.
|
2
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1
|
+
# Generated from <https://raw.githubusercontent.com/Palakis/obs-websocket/4.9.1/docs/generated/comments.json>
|
2
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md
|
3
3
|
module OBS::WebSocket::Protocol
|
4
|
-
VERSION = "4.9.
|
4
|
+
VERSION = "4.9.1"
|
5
5
|
module Types
|
6
6
|
SceneItem = Type.new(name: "SceneItem") do
|
7
7
|
def as_ruby(o)
|
@@ -21,7 +21,7 @@ module Types
|
|
21
21
|
SceneItemTransform__BASE.as_json(o)
|
22
22
|
end
|
23
23
|
end
|
24
|
-
SceneItemTransform__BASE = Types::Object[{"position"=>{:type=>Types::Object[{:x=>{:type=>Types::Float, :json_name=>"x"}, :y=>{:type=>Types::Float, :json_name=>"y"}, :alignment=>{:type=>Types::Integer, :json_name=>"alignment"}}], :json_name=>"position"}, "rotation"=>{:type=>Types::Float, :json_name=>"rotation"}, "scale"=>{:type=>Types::Object[{:x=>{:type=>Types::Float, :json_name=>"x"}, :y=>{:type=>Types::Float, :json_name=>"y"}}], :json_name=>"scale"}, "crop"=>{:type=>Types::Object[{:top=>{:type=>Types::Integer, :json_name=>"top"}, :right=>{:type=>Types::Integer, :json_name=>"right"}, :bottom=>{:type=>Types::Integer, :json_name=>"bottom"}, :left=>{:type=>Types::Integer, :json_name=>"left"}}], :json_name=>"crop"}, "visible"=>{:type=>Types::Boolean, :json_name=>"visible"}, "locked"=>{:type=>Types::Boolean, :json_name=>"locked"}, "bounds"=>{:type=>Types::Object[{:type=>{:type=>Types::String, :json_name=>"type"}, :alignment=>{:type=>Types::Integer, :json_name=>"alignment"}, :x=>{:type=>Types::Float, :json_name=>"x"}, :y=>{:type=>Types::Float, :json_name=>"y"}}], :json_name=>"bounds"}, "source_width"=>{:type=>Types::Integer, :json_name=>"sourceWidth"}, "source_height"=>{:type=>Types::Integer, :json_name=>"sourceHeight"}, "width"=>{:type=>Types::Float, :json_name=>"width"}, "height"=>{:type=>Types::Float, :json_name=>"height"}, "parent_group_name"=>{:type=>Types::Optional[Types::String], :json_name=>"parentGroupName"}, "group_children"=>{:type=>Types::Optional[Types::Array[Types::SceneItemTransform]], :json_name=>"groupChildren"}}]
|
24
|
+
SceneItemTransform__BASE = Types::Object[{"position"=>{:type=>Types::Object[{:x=>{:type=>Types::Float, :json_name=>"x"}, :y=>{:type=>Types::Float, :json_name=>"y"}, :alignment=>{:type=>Types::Integer, :json_name=>"alignment"}}], :json_name=>"position"}, "rotation"=>{:type=>Types::Float, :json_name=>"rotation"}, "scale"=>{:type=>Types::Object[{:x=>{:type=>Types::Float, :json_name=>"x"}, :y=>{:type=>Types::Float, :json_name=>"y"}, :filter=>{:type=>Types::String, :json_name=>"filter"}}], :json_name=>"scale"}, "crop"=>{:type=>Types::Object[{:top=>{:type=>Types::Integer, :json_name=>"top"}, :right=>{:type=>Types::Integer, :json_name=>"right"}, :bottom=>{:type=>Types::Integer, :json_name=>"bottom"}, :left=>{:type=>Types::Integer, :json_name=>"left"}}], :json_name=>"crop"}, "visible"=>{:type=>Types::Boolean, :json_name=>"visible"}, "locked"=>{:type=>Types::Boolean, :json_name=>"locked"}, "bounds"=>{:type=>Types::Object[{:type=>{:type=>Types::String, :json_name=>"type"}, :alignment=>{:type=>Types::Integer, :json_name=>"alignment"}, :x=>{:type=>Types::Float, :json_name=>"x"}, :y=>{:type=>Types::Float, :json_name=>"y"}}], :json_name=>"bounds"}, "source_width"=>{:type=>Types::Integer, :json_name=>"sourceWidth"}, "source_height"=>{:type=>Types::Integer, :json_name=>"sourceHeight"}, "width"=>{:type=>Types::Float, :json_name=>"width"}, "height"=>{:type=>Types::Float, :json_name=>"height"}, "parent_group_name"=>{:type=>Types::Optional[Types::String], :json_name=>"parentGroupName"}, "group_children"=>{:type=>Types::Optional[Types::Array[Types::SceneItemTransform]], :json_name=>"groupChildren"}}]
|
25
25
|
private_constant :SceneItemTransform__BASE
|
26
26
|
OBSStats = Type.new(name: "OBSStats") do
|
27
27
|
def as_ruby(o)
|
@@ -122,8 +122,8 @@ module Events
|
|
122
122
|
# @return [Integer] <tt>duration</tt> field
|
123
123
|
def duration; get_field("duration", Types::Integer); end
|
124
124
|
# @!attribute [r] from_scene
|
125
|
-
# @return [String] <tt>from-scene</tt> field
|
126
|
-
def from_scene; get_field("from-scene", Types::String); end
|
125
|
+
# @return [String, nil] <tt>from-scene</tt> field
|
126
|
+
def from_scene; get_field("from-scene", Types::Optional[Types::String]); end
|
127
127
|
# @!attribute [r] to_scene
|
128
128
|
# @return [String] <tt>to-scene</tt> field
|
129
129
|
def to_scene; get_field("to-scene", Types::String); end
|
@@ -155,8 +155,8 @@ module Events
|
|
155
155
|
# @return [Integer] <tt>duration</tt> field
|
156
156
|
def duration; get_field("duration", Types::Integer); end
|
157
157
|
# @!attribute [r] from_scene
|
158
|
-
# @return [String] <tt>from-scene</tt> field
|
159
|
-
def from_scene; get_field("from-scene", Types::String); end
|
158
|
+
# @return [String, nil] <tt>from-scene</tt> field
|
159
|
+
def from_scene; get_field("from-scene", Types::Optional[Types::String]); end
|
160
160
|
# @!attribute [r] to_scene
|
161
161
|
# @return [String] <tt>to-scene</tt> field
|
162
162
|
def to_scene; get_field("to-scene", Types::String); end
|
@@ -278,6 +278,12 @@ module Events
|
|
278
278
|
class RecordingResumed < Event
|
279
279
|
json_name "RecordingResumed"
|
280
280
|
end
|
281
|
+
class VirtualCamStarted < Event
|
282
|
+
json_name "VirtualCamStarted"
|
283
|
+
end
|
284
|
+
class VirtualCamStopped < Event
|
285
|
+
json_name "VirtualCamStopped"
|
286
|
+
end
|
281
287
|
class ReplayStarting < Event
|
282
288
|
json_name "ReplayStarting"
|
283
289
|
end
|
@@ -376,6 +382,9 @@ module Events
|
|
376
382
|
# @!attribute [r] volume
|
377
383
|
# @return [Float] <tt>volume</tt> field
|
378
384
|
def volume; get_field("volume", Types::Float); end
|
385
|
+
# @!attribute [r] volume_db
|
386
|
+
# @return [Float] <tt>volumeDb</tt> field
|
387
|
+
def volume_db; get_field("volumeDb", Types::Float); end
|
379
388
|
end
|
380
389
|
class SourceMuteStateChanged < Event
|
381
390
|
json_name "SourceMuteStateChanged"
|
@@ -673,427 +682,441 @@ module Event::Mixin
|
|
673
682
|
# Adds an event handler for <tt>SwitchScenes</tt> event.
|
674
683
|
# @yieldparam event [Events::SwitchScenes] the event object
|
675
684
|
# @return [void]
|
676
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
685
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#switchscenes
|
677
686
|
def on_switch_scenes(&listener)
|
678
687
|
on("SwitchScenes", &listener)
|
679
688
|
end
|
680
689
|
# Adds an event handler for <tt>ScenesChanged</tt> event.
|
681
690
|
# @yieldparam event [Events::ScenesChanged] the event object
|
682
691
|
# @return [void]
|
683
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
692
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneschanged
|
684
693
|
def on_scenes_changed(&listener)
|
685
694
|
on("ScenesChanged", &listener)
|
686
695
|
end
|
687
696
|
# Adds an event handler for <tt>SceneCollectionChanged</tt> event.
|
688
697
|
# @yieldparam event [Events::SceneCollectionChanged] the event object
|
689
698
|
# @return [void]
|
690
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
699
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#scenecollectionchanged
|
691
700
|
def on_scene_collection_changed(&listener)
|
692
701
|
on("SceneCollectionChanged", &listener)
|
693
702
|
end
|
694
703
|
# Adds an event handler for <tt>SceneCollectionListChanged</tt> event.
|
695
704
|
# @yieldparam event [Events::SceneCollectionListChanged] the event object
|
696
705
|
# @return [void]
|
697
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
706
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#scenecollectionlistchanged
|
698
707
|
def on_scene_collection_list_changed(&listener)
|
699
708
|
on("SceneCollectionListChanged", &listener)
|
700
709
|
end
|
701
710
|
# Adds an event handler for <tt>SwitchTransition</tt> event.
|
702
711
|
# @yieldparam event [Events::SwitchTransition] the event object
|
703
712
|
# @return [void]
|
704
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
713
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#switchtransition
|
705
714
|
def on_switch_transition(&listener)
|
706
715
|
on("SwitchTransition", &listener)
|
707
716
|
end
|
708
717
|
# Adds an event handler for <tt>TransitionListChanged</tt> event.
|
709
718
|
# @yieldparam event [Events::TransitionListChanged] the event object
|
710
719
|
# @return [void]
|
711
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
720
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitionlistchanged
|
712
721
|
def on_transition_list_changed(&listener)
|
713
722
|
on("TransitionListChanged", &listener)
|
714
723
|
end
|
715
724
|
# Adds an event handler for <tt>TransitionDurationChanged</tt> event.
|
716
725
|
# @yieldparam event [Events::TransitionDurationChanged] the event object
|
717
726
|
# @return [void]
|
718
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
727
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitiondurationchanged
|
719
728
|
def on_transition_duration_changed(&listener)
|
720
729
|
on("TransitionDurationChanged", &listener)
|
721
730
|
end
|
722
731
|
# Adds an event handler for <tt>TransitionBegin</tt> event.
|
723
732
|
# @yieldparam event [Events::TransitionBegin] the event object
|
724
733
|
# @return [void]
|
725
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
734
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitionbegin
|
726
735
|
def on_transition_begin(&listener)
|
727
736
|
on("TransitionBegin", &listener)
|
728
737
|
end
|
729
738
|
# Adds an event handler for <tt>TransitionEnd</tt> event.
|
730
739
|
# @yieldparam event [Events::TransitionEnd] the event object
|
731
740
|
# @return [void]
|
732
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
741
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitionend
|
733
742
|
def on_transition_end(&listener)
|
734
743
|
on("TransitionEnd", &listener)
|
735
744
|
end
|
736
745
|
# Adds an event handler for <tt>TransitionVideoEnd</tt> event.
|
737
746
|
# @yieldparam event [Events::TransitionVideoEnd] the event object
|
738
747
|
# @return [void]
|
739
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
748
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitionvideoend
|
740
749
|
def on_transition_video_end(&listener)
|
741
750
|
on("TransitionVideoEnd", &listener)
|
742
751
|
end
|
743
752
|
# Adds an event handler for <tt>ProfileChanged</tt> event.
|
744
753
|
# @yieldparam event [Events::ProfileChanged] the event object
|
745
754
|
# @return [void]
|
746
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
755
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#profilechanged
|
747
756
|
def on_profile_changed(&listener)
|
748
757
|
on("ProfileChanged", &listener)
|
749
758
|
end
|
750
759
|
# Adds an event handler for <tt>ProfileListChanged</tt> event.
|
751
760
|
# @yieldparam event [Events::ProfileListChanged] the event object
|
752
761
|
# @return [void]
|
753
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
762
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#profilelistchanged
|
754
763
|
def on_profile_list_changed(&listener)
|
755
764
|
on("ProfileListChanged", &listener)
|
756
765
|
end
|
757
766
|
# Adds an event handler for <tt>StreamStarting</tt> event.
|
758
767
|
# @yieldparam event [Events::StreamStarting] the event object
|
759
768
|
# @return [void]
|
760
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
769
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#streamstarting
|
761
770
|
def on_stream_starting(&listener)
|
762
771
|
on("StreamStarting", &listener)
|
763
772
|
end
|
764
773
|
# Adds an event handler for <tt>StreamStarted</tt> event.
|
765
774
|
# @yieldparam event [Events::StreamStarted] the event object
|
766
775
|
# @return [void]
|
767
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
776
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#streamstarted
|
768
777
|
def on_stream_started(&listener)
|
769
778
|
on("StreamStarted", &listener)
|
770
779
|
end
|
771
780
|
# Adds an event handler for <tt>StreamStopping</tt> event.
|
772
781
|
# @yieldparam event [Events::StreamStopping] the event object
|
773
782
|
# @return [void]
|
774
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
783
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#streamstopping
|
775
784
|
def on_stream_stopping(&listener)
|
776
785
|
on("StreamStopping", &listener)
|
777
786
|
end
|
778
787
|
# Adds an event handler for <tt>StreamStopped</tt> event.
|
779
788
|
# @yieldparam event [Events::StreamStopped] the event object
|
780
789
|
# @return [void]
|
781
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
790
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#streamstopped
|
782
791
|
def on_stream_stopped(&listener)
|
783
792
|
on("StreamStopped", &listener)
|
784
793
|
end
|
785
794
|
# Adds an event handler for <tt>StreamStatus</tt> event.
|
786
795
|
# @yieldparam event [Events::StreamStatus] the event object
|
787
796
|
# @return [void]
|
788
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
797
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#streamstatus
|
789
798
|
def on_stream_status(&listener)
|
790
799
|
on("StreamStatus", &listener)
|
791
800
|
end
|
792
801
|
# Adds an event handler for <tt>RecordingStarting</tt> event.
|
793
802
|
# @yieldparam event [Events::RecordingStarting] the event object
|
794
803
|
# @return [void]
|
795
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
804
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingstarting
|
796
805
|
def on_recording_starting(&listener)
|
797
806
|
on("RecordingStarting", &listener)
|
798
807
|
end
|
799
808
|
# Adds an event handler for <tt>RecordingStarted</tt> event.
|
800
809
|
# @yieldparam event [Events::RecordingStarted] the event object
|
801
810
|
# @return [void]
|
802
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
811
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingstarted
|
803
812
|
def on_recording_started(&listener)
|
804
813
|
on("RecordingStarted", &listener)
|
805
814
|
end
|
806
815
|
# Adds an event handler for <tt>RecordingStopping</tt> event.
|
807
816
|
# @yieldparam event [Events::RecordingStopping] the event object
|
808
817
|
# @return [void]
|
809
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
818
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingstopping
|
810
819
|
def on_recording_stopping(&listener)
|
811
820
|
on("RecordingStopping", &listener)
|
812
821
|
end
|
813
822
|
# Adds an event handler for <tt>RecordingStopped</tt> event.
|
814
823
|
# @yieldparam event [Events::RecordingStopped] the event object
|
815
824
|
# @return [void]
|
816
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
825
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingstopped
|
817
826
|
def on_recording_stopped(&listener)
|
818
827
|
on("RecordingStopped", &listener)
|
819
828
|
end
|
820
829
|
# Adds an event handler for <tt>RecordingPaused</tt> event.
|
821
830
|
# @yieldparam event [Events::RecordingPaused] the event object
|
822
831
|
# @return [void]
|
823
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
832
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingpaused
|
824
833
|
def on_recording_paused(&listener)
|
825
834
|
on("RecordingPaused", &listener)
|
826
835
|
end
|
827
836
|
# Adds an event handler for <tt>RecordingResumed</tt> event.
|
828
837
|
# @yieldparam event [Events::RecordingResumed] the event object
|
829
838
|
# @return [void]
|
830
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
839
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingresumed
|
831
840
|
def on_recording_resumed(&listener)
|
832
841
|
on("RecordingResumed", &listener)
|
833
842
|
end
|
843
|
+
# Adds an event handler for <tt>VirtualCamStarted</tt> event.
|
844
|
+
# @yieldparam event [Events::VirtualCamStarted] the event object
|
845
|
+
# @return [void]
|
846
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#virtualcamstarted
|
847
|
+
def on_virtual_cam_started(&listener)
|
848
|
+
on("VirtualCamStarted", &listener)
|
849
|
+
end
|
850
|
+
# Adds an event handler for <tt>VirtualCamStopped</tt> event.
|
851
|
+
# @yieldparam event [Events::VirtualCamStopped] the event object
|
852
|
+
# @return [void]
|
853
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#virtualcamstopped
|
854
|
+
def on_virtual_cam_stopped(&listener)
|
855
|
+
on("VirtualCamStopped", &listener)
|
856
|
+
end
|
834
857
|
# Adds an event handler for <tt>ReplayStarting</tt> event.
|
835
858
|
# @yieldparam event [Events::ReplayStarting] the event object
|
836
859
|
# @return [void]
|
837
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
860
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#replaystarting
|
838
861
|
def on_replay_starting(&listener)
|
839
862
|
on("ReplayStarting", &listener)
|
840
863
|
end
|
841
864
|
# Adds an event handler for <tt>ReplayStarted</tt> event.
|
842
865
|
# @yieldparam event [Events::ReplayStarted] the event object
|
843
866
|
# @return [void]
|
844
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
867
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#replaystarted
|
845
868
|
def on_replay_started(&listener)
|
846
869
|
on("ReplayStarted", &listener)
|
847
870
|
end
|
848
871
|
# Adds an event handler for <tt>ReplayStopping</tt> event.
|
849
872
|
# @yieldparam event [Events::ReplayStopping] the event object
|
850
873
|
# @return [void]
|
851
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
874
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#replaystopping
|
852
875
|
def on_replay_stopping(&listener)
|
853
876
|
on("ReplayStopping", &listener)
|
854
877
|
end
|
855
878
|
# Adds an event handler for <tt>ReplayStopped</tt> event.
|
856
879
|
# @yieldparam event [Events::ReplayStopped] the event object
|
857
880
|
# @return [void]
|
858
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
881
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#replaystopped
|
859
882
|
def on_replay_stopped(&listener)
|
860
883
|
on("ReplayStopped", &listener)
|
861
884
|
end
|
862
885
|
# Adds an event handler for <tt>Exiting</tt> event.
|
863
886
|
# @yieldparam event [Events::Exiting] the event object
|
864
887
|
# @return [void]
|
865
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
888
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#exiting
|
866
889
|
def on_exiting(&listener)
|
867
890
|
on("Exiting", &listener)
|
868
891
|
end
|
869
892
|
# Adds an event handler for <tt>Heartbeat</tt> event.
|
870
893
|
# @yieldparam event [Events::Heartbeat] the event object
|
871
894
|
# @return [void]
|
872
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
895
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#heartbeat
|
873
896
|
def on_heartbeat(&listener)
|
874
897
|
on("Heartbeat", &listener)
|
875
898
|
end
|
876
899
|
# Adds an event handler for <tt>BroadcastCustomMessage</tt> event.
|
877
900
|
# @yieldparam event [Events::BroadcastCustomMessage] the event object
|
878
901
|
# @return [void]
|
879
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
902
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#broadcastcustommessage
|
880
903
|
def on_broadcast_custom_message(&listener)
|
881
904
|
on("BroadcastCustomMessage", &listener)
|
882
905
|
end
|
883
906
|
# Adds an event handler for <tt>SourceCreated</tt> event.
|
884
907
|
# @yieldparam event [Events::SourceCreated] the event object
|
885
908
|
# @return [void]
|
886
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
909
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcecreated
|
887
910
|
def on_source_created(&listener)
|
888
911
|
on("SourceCreated", &listener)
|
889
912
|
end
|
890
913
|
# Adds an event handler for <tt>SourceDestroyed</tt> event.
|
891
914
|
# @yieldparam event [Events::SourceDestroyed] the event object
|
892
915
|
# @return [void]
|
893
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
916
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcedestroyed
|
894
917
|
def on_source_destroyed(&listener)
|
895
918
|
on("SourceDestroyed", &listener)
|
896
919
|
end
|
897
920
|
# Adds an event handler for <tt>SourceVolumeChanged</tt> event.
|
898
921
|
# @yieldparam event [Events::SourceVolumeChanged] the event object
|
899
922
|
# @return [void]
|
900
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
923
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcevolumechanged
|
901
924
|
def on_source_volume_changed(&listener)
|
902
925
|
on("SourceVolumeChanged", &listener)
|
903
926
|
end
|
904
927
|
# Adds an event handler for <tt>SourceMuteStateChanged</tt> event.
|
905
928
|
# @yieldparam event [Events::SourceMuteStateChanged] the event object
|
906
929
|
# @return [void]
|
907
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
930
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcemutestatechanged
|
908
931
|
def on_source_mute_state_changed(&listener)
|
909
932
|
on("SourceMuteStateChanged", &listener)
|
910
933
|
end
|
911
934
|
# Adds an event handler for <tt>SourceAudioDeactivated</tt> event.
|
912
935
|
# @yieldparam event [Events::SourceAudioDeactivated] the event object
|
913
936
|
# @return [void]
|
914
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
937
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourceaudiodeactivated
|
915
938
|
def on_source_audio_deactivated(&listener)
|
916
939
|
on("SourceAudioDeactivated", &listener)
|
917
940
|
end
|
918
941
|
# Adds an event handler for <tt>SourceAudioActivated</tt> event.
|
919
942
|
# @yieldparam event [Events::SourceAudioActivated] the event object
|
920
943
|
# @return [void]
|
921
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
944
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourceaudioactivated
|
922
945
|
def on_source_audio_activated(&listener)
|
923
946
|
on("SourceAudioActivated", &listener)
|
924
947
|
end
|
925
948
|
# Adds an event handler for <tt>SourceAudioSyncOffsetChanged</tt> event.
|
926
949
|
# @yieldparam event [Events::SourceAudioSyncOffsetChanged] the event object
|
927
950
|
# @return [void]
|
928
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
951
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourceaudiosyncoffsetchanged
|
929
952
|
def on_source_audio_sync_offset_changed(&listener)
|
930
953
|
on("SourceAudioSyncOffsetChanged", &listener)
|
931
954
|
end
|
932
955
|
# Adds an event handler for <tt>SourceAudioMixersChanged</tt> event.
|
933
956
|
# @yieldparam event [Events::SourceAudioMixersChanged] the event object
|
934
957
|
# @return [void]
|
935
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
958
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourceaudiomixerschanged
|
936
959
|
def on_source_audio_mixers_changed(&listener)
|
937
960
|
on("SourceAudioMixersChanged", &listener)
|
938
961
|
end
|
939
962
|
# Adds an event handler for <tt>SourceRenamed</tt> event.
|
940
963
|
# @yieldparam event [Events::SourceRenamed] the event object
|
941
964
|
# @return [void]
|
942
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
965
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcerenamed
|
943
966
|
def on_source_renamed(&listener)
|
944
967
|
on("SourceRenamed", &listener)
|
945
968
|
end
|
946
969
|
# Adds an event handler for <tt>SourceFilterAdded</tt> event.
|
947
970
|
# @yieldparam event [Events::SourceFilterAdded] the event object
|
948
971
|
# @return [void]
|
949
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
972
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcefilteradded
|
950
973
|
def on_source_filter_added(&listener)
|
951
974
|
on("SourceFilterAdded", &listener)
|
952
975
|
end
|
953
976
|
# Adds an event handler for <tt>SourceFilterRemoved</tt> event.
|
954
977
|
# @yieldparam event [Events::SourceFilterRemoved] the event object
|
955
978
|
# @return [void]
|
956
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
979
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcefilterremoved
|
957
980
|
def on_source_filter_removed(&listener)
|
958
981
|
on("SourceFilterRemoved", &listener)
|
959
982
|
end
|
960
983
|
# Adds an event handler for <tt>SourceFilterVisibilityChanged</tt> event.
|
961
984
|
# @yieldparam event [Events::SourceFilterVisibilityChanged] the event object
|
962
985
|
# @return [void]
|
963
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
986
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcefiltervisibilitychanged
|
964
987
|
def on_source_filter_visibility_changed(&listener)
|
965
988
|
on("SourceFilterVisibilityChanged", &listener)
|
966
989
|
end
|
967
990
|
# Adds an event handler for <tt>SourceFiltersReordered</tt> event.
|
968
991
|
# @yieldparam event [Events::SourceFiltersReordered] the event object
|
969
992
|
# @return [void]
|
970
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
993
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcefiltersreordered
|
971
994
|
def on_source_filters_reordered(&listener)
|
972
995
|
on("SourceFiltersReordered", &listener)
|
973
996
|
end
|
974
997
|
# Adds an event handler for <tt>MediaPlaying</tt> event.
|
975
998
|
# @yieldparam event [Events::MediaPlaying] the event object
|
976
999
|
# @return [void]
|
977
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1000
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediaplaying
|
978
1001
|
def on_media_playing(&listener)
|
979
1002
|
on("MediaPlaying", &listener)
|
980
1003
|
end
|
981
1004
|
# Adds an event handler for <tt>MediaPaused</tt> event.
|
982
1005
|
# @yieldparam event [Events::MediaPaused] the event object
|
983
1006
|
# @return [void]
|
984
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1007
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediapaused
|
985
1008
|
def on_media_paused(&listener)
|
986
1009
|
on("MediaPaused", &listener)
|
987
1010
|
end
|
988
1011
|
# Adds an event handler for <tt>MediaRestarted</tt> event.
|
989
1012
|
# @yieldparam event [Events::MediaRestarted] the event object
|
990
1013
|
# @return [void]
|
991
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1014
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediarestarted
|
992
1015
|
def on_media_restarted(&listener)
|
993
1016
|
on("MediaRestarted", &listener)
|
994
1017
|
end
|
995
1018
|
# Adds an event handler for <tt>MediaStopped</tt> event.
|
996
1019
|
# @yieldparam event [Events::MediaStopped] the event object
|
997
1020
|
# @return [void]
|
998
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1021
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediastopped
|
999
1022
|
def on_media_stopped(&listener)
|
1000
1023
|
on("MediaStopped", &listener)
|
1001
1024
|
end
|
1002
1025
|
# Adds an event handler for <tt>MediaNext</tt> event.
|
1003
1026
|
# @yieldparam event [Events::MediaNext] the event object
|
1004
1027
|
# @return [void]
|
1005
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1028
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#medianext
|
1006
1029
|
def on_media_next(&listener)
|
1007
1030
|
on("MediaNext", &listener)
|
1008
1031
|
end
|
1009
1032
|
# Adds an event handler for <tt>MediaPrevious</tt> event.
|
1010
1033
|
# @yieldparam event [Events::MediaPrevious] the event object
|
1011
1034
|
# @return [void]
|
1012
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1035
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediaprevious
|
1013
1036
|
def on_media_previous(&listener)
|
1014
1037
|
on("MediaPrevious", &listener)
|
1015
1038
|
end
|
1016
1039
|
# Adds an event handler for <tt>MediaStarted</tt> event.
|
1017
1040
|
# @yieldparam event [Events::MediaStarted] the event object
|
1018
1041
|
# @return [void]
|
1019
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1042
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediastarted
|
1020
1043
|
def on_media_started(&listener)
|
1021
1044
|
on("MediaStarted", &listener)
|
1022
1045
|
end
|
1023
1046
|
# Adds an event handler for <tt>MediaEnded</tt> event.
|
1024
1047
|
# @yieldparam event [Events::MediaEnded] the event object
|
1025
1048
|
# @return [void]
|
1026
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1049
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediaended
|
1027
1050
|
def on_media_ended(&listener)
|
1028
1051
|
on("MediaEnded", &listener)
|
1029
1052
|
end
|
1030
1053
|
# Adds an event handler for <tt>SourceOrderChanged</tt> event.
|
1031
1054
|
# @yieldparam event [Events::SourceOrderChanged] the event object
|
1032
1055
|
# @return [void]
|
1033
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1056
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourceorderchanged
|
1034
1057
|
def on_source_order_changed(&listener)
|
1035
1058
|
on("SourceOrderChanged", &listener)
|
1036
1059
|
end
|
1037
1060
|
# Adds an event handler for <tt>SceneItemAdded</tt> event.
|
1038
1061
|
# @yieldparam event [Events::SceneItemAdded] the event object
|
1039
1062
|
# @return [void]
|
1040
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1063
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemadded
|
1041
1064
|
def on_scene_item_added(&listener)
|
1042
1065
|
on("SceneItemAdded", &listener)
|
1043
1066
|
end
|
1044
1067
|
# Adds an event handler for <tt>SceneItemRemoved</tt> event.
|
1045
1068
|
# @yieldparam event [Events::SceneItemRemoved] the event object
|
1046
1069
|
# @return [void]
|
1047
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1070
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemremoved
|
1048
1071
|
def on_scene_item_removed(&listener)
|
1049
1072
|
on("SceneItemRemoved", &listener)
|
1050
1073
|
end
|
1051
1074
|
# Adds an event handler for <tt>SceneItemVisibilityChanged</tt> event.
|
1052
1075
|
# @yieldparam event [Events::SceneItemVisibilityChanged] the event object
|
1053
1076
|
# @return [void]
|
1054
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1077
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemvisibilitychanged
|
1055
1078
|
def on_scene_item_visibility_changed(&listener)
|
1056
1079
|
on("SceneItemVisibilityChanged", &listener)
|
1057
1080
|
end
|
1058
1081
|
# Adds an event handler for <tt>SceneItemLockChanged</tt> event.
|
1059
1082
|
# @yieldparam event [Events::SceneItemLockChanged] the event object
|
1060
1083
|
# @return [void]
|
1061
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1084
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemlockchanged
|
1062
1085
|
def on_scene_item_lock_changed(&listener)
|
1063
1086
|
on("SceneItemLockChanged", &listener)
|
1064
1087
|
end
|
1065
1088
|
# Adds an event handler for <tt>SceneItemTransformChanged</tt> event.
|
1066
1089
|
# @yieldparam event [Events::SceneItemTransformChanged] the event object
|
1067
1090
|
# @return [void]
|
1068
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1091
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemtransformchanged
|
1069
1092
|
def on_scene_item_transform_changed(&listener)
|
1070
1093
|
on("SceneItemTransformChanged", &listener)
|
1071
1094
|
end
|
1072
1095
|
# Adds an event handler for <tt>SceneItemSelected</tt> event.
|
1073
1096
|
# @yieldparam event [Events::SceneItemSelected] the event object
|
1074
1097
|
# @return [void]
|
1075
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1098
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemselected
|
1076
1099
|
def on_scene_item_selected(&listener)
|
1077
1100
|
on("SceneItemSelected", &listener)
|
1078
1101
|
end
|
1079
1102
|
# Adds an event handler for <tt>SceneItemDeselected</tt> event.
|
1080
1103
|
# @yieldparam event [Events::SceneItemDeselected] the event object
|
1081
1104
|
# @return [void]
|
1082
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1105
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemdeselected
|
1083
1106
|
def on_scene_item_deselected(&listener)
|
1084
1107
|
on("SceneItemDeselected", &listener)
|
1085
1108
|
end
|
1086
1109
|
# Adds an event handler for <tt>PreviewSceneChanged</tt> event.
|
1087
1110
|
# @yieldparam event [Events::PreviewSceneChanged] the event object
|
1088
1111
|
# @return [void]
|
1089
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1112
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#previewscenechanged
|
1090
1113
|
def on_preview_scene_changed(&listener)
|
1091
1114
|
on("PreviewSceneChanged", &listener)
|
1092
1115
|
end
|
1093
1116
|
# Adds an event handler for <tt>StudioModeSwitched</tt> event.
|
1094
1117
|
# @yieldparam event [Events::StudioModeSwitched] the event object
|
1095
1118
|
# @return [void]
|
1096
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1119
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#studiomodeswitched
|
1097
1120
|
def on_studio_mode_switched(&listener)
|
1098
1121
|
on("StudioModeSwitched", &listener)
|
1099
1122
|
end
|
@@ -1101,7 +1124,7 @@ end # module Event::Mixin
|
|
1101
1124
|
module Requests
|
1102
1125
|
# @see Request::Mixin#get_version
|
1103
1126
|
# @see Responses::GetVersion
|
1104
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1127
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getversion
|
1105
1128
|
class GetVersion < Request
|
1106
1129
|
json_name "GetVersion"
|
1107
1130
|
params(
|
@@ -1109,7 +1132,7 @@ module Requests
|
|
1109
1132
|
end
|
1110
1133
|
# @see Request::Mixin#get_auth_required
|
1111
1134
|
# @see Responses::GetAuthRequired
|
1112
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1135
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getauthrequired
|
1113
1136
|
class GetAuthRequired < Request
|
1114
1137
|
json_name "GetAuthRequired"
|
1115
1138
|
params(
|
@@ -1117,7 +1140,7 @@ module Requests
|
|
1117
1140
|
end
|
1118
1141
|
# @see Request::Mixin#authenticate
|
1119
1142
|
# @see Responses::Authenticate
|
1120
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1143
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#authenticate
|
1121
1144
|
class Authenticate < Request
|
1122
1145
|
json_name "Authenticate"
|
1123
1146
|
params(
|
@@ -1126,7 +1149,7 @@ module Requests
|
|
1126
1149
|
end
|
1127
1150
|
# @see Request::Mixin#set_heartbeat
|
1128
1151
|
# @see Responses::SetHeartbeat
|
1129
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1152
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setheartbeat
|
1130
1153
|
class SetHeartbeat < Request
|
1131
1154
|
json_name "SetHeartbeat"
|
1132
1155
|
params(
|
@@ -1135,7 +1158,7 @@ module Requests
|
|
1135
1158
|
end
|
1136
1159
|
# @see Request::Mixin#set_filename_formatting
|
1137
1160
|
# @see Responses::SetFilenameFormatting
|
1138
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1161
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setfilenameformatting
|
1139
1162
|
class SetFilenameFormatting < Request
|
1140
1163
|
json_name "SetFilenameFormatting"
|
1141
1164
|
params(
|
@@ -1144,7 +1167,7 @@ module Requests
|
|
1144
1167
|
end
|
1145
1168
|
# @see Request::Mixin#get_filename_formatting
|
1146
1169
|
# @see Responses::GetFilenameFormatting
|
1147
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1170
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getfilenameformatting
|
1148
1171
|
class GetFilenameFormatting < Request
|
1149
1172
|
json_name "GetFilenameFormatting"
|
1150
1173
|
params(
|
@@ -1152,7 +1175,7 @@ module Requests
|
|
1152
1175
|
end
|
1153
1176
|
# @see Request::Mixin#get_stats
|
1154
1177
|
# @see Responses::GetStats
|
1155
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1178
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstats
|
1156
1179
|
class GetStats < Request
|
1157
1180
|
json_name "GetStats"
|
1158
1181
|
params(
|
@@ -1160,7 +1183,7 @@ module Requests
|
|
1160
1183
|
end
|
1161
1184
|
# @see Request::Mixin#broadcast_custom_message
|
1162
1185
|
# @see Responses::BroadcastCustomMessage
|
1163
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1186
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#broadcastcustommessage
|
1164
1187
|
class BroadcastCustomMessage < Request
|
1165
1188
|
json_name "BroadcastCustomMessage"
|
1166
1189
|
params(
|
@@ -1170,7 +1193,7 @@ module Requests
|
|
1170
1193
|
end
|
1171
1194
|
# @see Request::Mixin#get_video_info
|
1172
1195
|
# @see Responses::GetVideoInfo
|
1173
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1196
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvideoinfo
|
1174
1197
|
class GetVideoInfo < Request
|
1175
1198
|
json_name "GetVideoInfo"
|
1176
1199
|
params(
|
@@ -1178,7 +1201,7 @@ module Requests
|
|
1178
1201
|
end
|
1179
1202
|
# @see Request::Mixin#open_projector
|
1180
1203
|
# @see Responses::OpenProjector
|
1181
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1204
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#openprojector
|
1182
1205
|
class OpenProjector < Request
|
1183
1206
|
json_name "OpenProjector"
|
1184
1207
|
params(
|
@@ -1190,7 +1213,7 @@ module Requests
|
|
1190
1213
|
end
|
1191
1214
|
# @see Request::Mixin#trigger_hotkey_by_name
|
1192
1215
|
# @see Responses::TriggerHotkeyByName
|
1193
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1216
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#triggerhotkeybyname
|
1194
1217
|
class TriggerHotkeyByName < Request
|
1195
1218
|
json_name "TriggerHotkeyByName"
|
1196
1219
|
params(
|
@@ -1199,7 +1222,7 @@ module Requests
|
|
1199
1222
|
end
|
1200
1223
|
# @see Request::Mixin#trigger_hotkey_by_sequence
|
1201
1224
|
# @see Responses::TriggerHotkeyBySequence
|
1202
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1225
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#triggerhotkeybysequence
|
1203
1226
|
class TriggerHotkeyBySequence < Request
|
1204
1227
|
json_name "TriggerHotkeyBySequence"
|
1205
1228
|
params(
|
@@ -1209,7 +1232,7 @@ module Requests
|
|
1209
1232
|
end
|
1210
1233
|
# @see Request::Mixin#execute_batch
|
1211
1234
|
# @see Responses::ExecuteBatch
|
1212
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1235
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#executebatch
|
1213
1236
|
class ExecuteBatch < Request
|
1214
1237
|
json_name "ExecuteBatch"
|
1215
1238
|
params(
|
@@ -1217,9 +1240,18 @@ module Requests
|
|
1217
1240
|
"abort_on_fail": {json_name: "abortOnFail", type: Types::Optional[Types::Boolean]},
|
1218
1241
|
)
|
1219
1242
|
end
|
1243
|
+
# @see Request::Mixin#sleep
|
1244
|
+
# @see Responses::Sleep
|
1245
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sleep
|
1246
|
+
class Sleep < Request
|
1247
|
+
json_name "Sleep"
|
1248
|
+
params(
|
1249
|
+
"sleep_millis": {json_name: "sleepMillis", type: Types::Integer},
|
1250
|
+
)
|
1251
|
+
end
|
1220
1252
|
# @see Request::Mixin#play_pause_media
|
1221
1253
|
# @see Responses::PlayPauseMedia
|
1222
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1254
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#playpausemedia
|
1223
1255
|
class PlayPauseMedia < Request
|
1224
1256
|
json_name "PlayPauseMedia"
|
1225
1257
|
params(
|
@@ -1229,7 +1261,7 @@ module Requests
|
|
1229
1261
|
end
|
1230
1262
|
# @see Request::Mixin#restart_media
|
1231
1263
|
# @see Responses::RestartMedia
|
1232
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1264
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#restartmedia
|
1233
1265
|
class RestartMedia < Request
|
1234
1266
|
json_name "RestartMedia"
|
1235
1267
|
params(
|
@@ -1238,7 +1270,7 @@ module Requests
|
|
1238
1270
|
end
|
1239
1271
|
# @see Request::Mixin#stop_media
|
1240
1272
|
# @see Responses::StopMedia
|
1241
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1273
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopmedia
|
1242
1274
|
class StopMedia < Request
|
1243
1275
|
json_name "StopMedia"
|
1244
1276
|
params(
|
@@ -1247,7 +1279,7 @@ module Requests
|
|
1247
1279
|
end
|
1248
1280
|
# @see Request::Mixin#next_media
|
1249
1281
|
# @see Responses::NextMedia
|
1250
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1282
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#nextmedia
|
1251
1283
|
class NextMedia < Request
|
1252
1284
|
json_name "NextMedia"
|
1253
1285
|
params(
|
@@ -1256,7 +1288,7 @@ module Requests
|
|
1256
1288
|
end
|
1257
1289
|
# @see Request::Mixin#previous_media
|
1258
1290
|
# @see Responses::PreviousMedia
|
1259
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1291
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#previousmedia
|
1260
1292
|
class PreviousMedia < Request
|
1261
1293
|
json_name "PreviousMedia"
|
1262
1294
|
params(
|
@@ -1265,7 +1297,7 @@ module Requests
|
|
1265
1297
|
end
|
1266
1298
|
# @see Request::Mixin#get_media_duration
|
1267
1299
|
# @see Responses::GetMediaDuration
|
1268
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1300
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediaduration
|
1269
1301
|
class GetMediaDuration < Request
|
1270
1302
|
json_name "GetMediaDuration"
|
1271
1303
|
params(
|
@@ -1274,7 +1306,7 @@ module Requests
|
|
1274
1306
|
end
|
1275
1307
|
# @see Request::Mixin#get_media_time
|
1276
1308
|
# @see Responses::GetMediaTime
|
1277
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1309
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediatime
|
1278
1310
|
class GetMediaTime < Request
|
1279
1311
|
json_name "GetMediaTime"
|
1280
1312
|
params(
|
@@ -1283,7 +1315,7 @@ module Requests
|
|
1283
1315
|
end
|
1284
1316
|
# @see Request::Mixin#set_media_time
|
1285
1317
|
# @see Responses::SetMediaTime
|
1286
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1318
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setmediatime
|
1287
1319
|
class SetMediaTime < Request
|
1288
1320
|
json_name "SetMediaTime"
|
1289
1321
|
params(
|
@@ -1293,7 +1325,7 @@ module Requests
|
|
1293
1325
|
end
|
1294
1326
|
# @see Request::Mixin#scrub_media
|
1295
1327
|
# @see Responses::ScrubMedia
|
1296
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1328
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#scrubmedia
|
1297
1329
|
class ScrubMedia < Request
|
1298
1330
|
json_name "ScrubMedia"
|
1299
1331
|
params(
|
@@ -1303,7 +1335,7 @@ module Requests
|
|
1303
1335
|
end
|
1304
1336
|
# @see Request::Mixin#get_media_state
|
1305
1337
|
# @see Responses::GetMediaState
|
1306
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1338
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediastate
|
1307
1339
|
class GetMediaState < Request
|
1308
1340
|
json_name "GetMediaState"
|
1309
1341
|
params(
|
@@ -1312,7 +1344,7 @@ module Requests
|
|
1312
1344
|
end
|
1313
1345
|
# @see Request::Mixin#get_media_sources_list
|
1314
1346
|
# @see Responses::GetMediaSourcesList
|
1315
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1347
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediasourceslist
|
1316
1348
|
class GetMediaSourcesList < Request
|
1317
1349
|
json_name "GetMediaSourcesList"
|
1318
1350
|
params(
|
@@ -1320,7 +1352,7 @@ module Requests
|
|
1320
1352
|
end
|
1321
1353
|
# @see Request::Mixin#create_source
|
1322
1354
|
# @see Responses::CreateSource
|
1323
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1355
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#createsource
|
1324
1356
|
class CreateSource < Request
|
1325
1357
|
json_name "CreateSource"
|
1326
1358
|
params(
|
@@ -1333,7 +1365,7 @@ module Requests
|
|
1333
1365
|
end
|
1334
1366
|
# @see Request::Mixin#get_sources_list
|
1335
1367
|
# @see Responses::GetSourcesList
|
1336
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1368
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourceslist
|
1337
1369
|
class GetSourcesList < Request
|
1338
1370
|
json_name "GetSourcesList"
|
1339
1371
|
params(
|
@@ -1341,7 +1373,7 @@ module Requests
|
|
1341
1373
|
end
|
1342
1374
|
# @see Request::Mixin#get_source_types_list
|
1343
1375
|
# @see Responses::GetSourceTypesList
|
1344
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1376
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcetypeslist
|
1345
1377
|
class GetSourceTypesList < Request
|
1346
1378
|
json_name "GetSourceTypesList"
|
1347
1379
|
params(
|
@@ -1349,7 +1381,7 @@ module Requests
|
|
1349
1381
|
end
|
1350
1382
|
# @see Request::Mixin#get_volume
|
1351
1383
|
# @see Responses::GetVolume
|
1352
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1384
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvolume
|
1353
1385
|
class GetVolume < Request
|
1354
1386
|
json_name "GetVolume"
|
1355
1387
|
params(
|
@@ -1359,7 +1391,7 @@ module Requests
|
|
1359
1391
|
end
|
1360
1392
|
# @see Request::Mixin#set_volume
|
1361
1393
|
# @see Responses::SetVolume
|
1362
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1394
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setvolume
|
1363
1395
|
class SetVolume < Request
|
1364
1396
|
json_name "SetVolume"
|
1365
1397
|
params(
|
@@ -1368,9 +1400,29 @@ module Requests
|
|
1368
1400
|
"use_decibel": {json_name: "useDecibel", type: Types::Optional[Types::Boolean]},
|
1369
1401
|
)
|
1370
1402
|
end
|
1403
|
+
# @see Request::Mixin#set_tracks
|
1404
|
+
# @see Responses::SetTracks
|
1405
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settracks
|
1406
|
+
class SetTracks < Request
|
1407
|
+
json_name "SetTracks"
|
1408
|
+
params(
|
1409
|
+
"source_name": {json_name: "sourceName", type: Types::String},
|
1410
|
+
"track": {json_name: "track", type: Types::Integer},
|
1411
|
+
"active": {json_name: "active", type: Types::Boolean},
|
1412
|
+
)
|
1413
|
+
end
|
1414
|
+
# @see Request::Mixin#get_tracks
|
1415
|
+
# @see Responses::GetTracks
|
1416
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettracks
|
1417
|
+
class GetTracks < Request
|
1418
|
+
json_name "GetTracks"
|
1419
|
+
params(
|
1420
|
+
"source_name": {json_name: "sourceName", type: Types::String},
|
1421
|
+
)
|
1422
|
+
end
|
1371
1423
|
# @see Request::Mixin#get_mute
|
1372
1424
|
# @see Responses::GetMute
|
1373
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1425
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmute
|
1374
1426
|
class GetMute < Request
|
1375
1427
|
json_name "GetMute"
|
1376
1428
|
params(
|
@@ -1379,7 +1431,7 @@ module Requests
|
|
1379
1431
|
end
|
1380
1432
|
# @see Request::Mixin#set_mute
|
1381
1433
|
# @see Responses::SetMute
|
1382
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1434
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setmute
|
1383
1435
|
class SetMute < Request
|
1384
1436
|
json_name "SetMute"
|
1385
1437
|
params(
|
@@ -1389,16 +1441,25 @@ module Requests
|
|
1389
1441
|
end
|
1390
1442
|
# @see Request::Mixin#toggle_mute
|
1391
1443
|
# @see Responses::ToggleMute
|
1392
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1444
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#togglemute
|
1393
1445
|
class ToggleMute < Request
|
1394
1446
|
json_name "ToggleMute"
|
1395
1447
|
params(
|
1396
1448
|
"source": {json_name: "source", type: Types::String},
|
1397
1449
|
)
|
1398
1450
|
end
|
1451
|
+
# @see Request::Mixin#get_source_active
|
1452
|
+
# @see Responses::GetSourceActive
|
1453
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourceactive
|
1454
|
+
class GetSourceActive < Request
|
1455
|
+
json_name "GetSourceActive"
|
1456
|
+
params(
|
1457
|
+
"source_name": {json_name: "sourceName", type: Types::String},
|
1458
|
+
)
|
1459
|
+
end
|
1399
1460
|
# @see Request::Mixin#get_audio_active
|
1400
1461
|
# @see Responses::GetAudioActive
|
1401
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1462
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getaudioactive
|
1402
1463
|
class GetAudioActive < Request
|
1403
1464
|
json_name "GetAudioActive"
|
1404
1465
|
params(
|
@@ -1407,7 +1468,7 @@ module Requests
|
|
1407
1468
|
end
|
1408
1469
|
# @see Request::Mixin#set_source_name
|
1409
1470
|
# @see Responses::SetSourceName
|
1410
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1471
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcename
|
1411
1472
|
class SetSourceName < Request
|
1412
1473
|
json_name "SetSourceName"
|
1413
1474
|
params(
|
@@ -1417,7 +1478,7 @@ module Requests
|
|
1417
1478
|
end
|
1418
1479
|
# @see Request::Mixin#set_sync_offset
|
1419
1480
|
# @see Responses::SetSyncOffset
|
1420
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1481
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsyncoffset
|
1421
1482
|
class SetSyncOffset < Request
|
1422
1483
|
json_name "SetSyncOffset"
|
1423
1484
|
params(
|
@@ -1427,7 +1488,7 @@ module Requests
|
|
1427
1488
|
end
|
1428
1489
|
# @see Request::Mixin#get_sync_offset
|
1429
1490
|
# @see Responses::GetSyncOffset
|
1430
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1491
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsyncoffset
|
1431
1492
|
class GetSyncOffset < Request
|
1432
1493
|
json_name "GetSyncOffset"
|
1433
1494
|
params(
|
@@ -1436,7 +1497,7 @@ module Requests
|
|
1436
1497
|
end
|
1437
1498
|
# @see Request::Mixin#get_source_settings
|
1438
1499
|
# @see Responses::GetSourceSettings
|
1439
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1500
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcesettings
|
1440
1501
|
class GetSourceSettings < Request
|
1441
1502
|
json_name "GetSourceSettings"
|
1442
1503
|
params(
|
@@ -1446,7 +1507,7 @@ module Requests
|
|
1446
1507
|
end
|
1447
1508
|
# @see Request::Mixin#set_source_settings
|
1448
1509
|
# @see Responses::SetSourceSettings
|
1449
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1510
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcesettings
|
1450
1511
|
class SetSourceSettings < Request
|
1451
1512
|
json_name "SetSourceSettings"
|
1452
1513
|
params(
|
@@ -1457,7 +1518,7 @@ module Requests
|
|
1457
1518
|
end
|
1458
1519
|
# @see Request::Mixin#get_text_gdi_plus_properties
|
1459
1520
|
# @see Responses::GetTextGDIPlusProperties
|
1460
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1521
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettextgdiplusproperties
|
1461
1522
|
class GetTextGDIPlusProperties < Request
|
1462
1523
|
json_name "GetTextGDIPlusProperties"
|
1463
1524
|
params(
|
@@ -1466,7 +1527,7 @@ module Requests
|
|
1466
1527
|
end
|
1467
1528
|
# @see Request::Mixin#set_text_gdi_plus_properties
|
1468
1529
|
# @see Responses::SetTextGDIPlusProperties
|
1469
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1530
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settextgdiplusproperties
|
1470
1531
|
class SetTextGDIPlusProperties < Request
|
1471
1532
|
json_name "SetTextGDIPlusProperties"
|
1472
1533
|
params(
|
@@ -1499,7 +1560,7 @@ module Requests
|
|
1499
1560
|
end
|
1500
1561
|
# @see Request::Mixin#get_text_freetype2_properties
|
1501
1562
|
# @see Responses::GetTextFreetype2Properties
|
1502
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1563
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettextfreetype2properties
|
1503
1564
|
class GetTextFreetype2Properties < Request
|
1504
1565
|
json_name "GetTextFreetype2Properties"
|
1505
1566
|
params(
|
@@ -1508,7 +1569,7 @@ module Requests
|
|
1508
1569
|
end
|
1509
1570
|
# @see Request::Mixin#set_text_freetype2_properties
|
1510
1571
|
# @see Responses::SetTextFreetype2Properties
|
1511
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1572
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settextfreetype2properties
|
1512
1573
|
class SetTextFreetype2Properties < Request
|
1513
1574
|
json_name "SetTextFreetype2Properties"
|
1514
1575
|
params(
|
@@ -1528,7 +1589,7 @@ module Requests
|
|
1528
1589
|
end
|
1529
1590
|
# @see Request::Mixin#get_browser_source_properties
|
1530
1591
|
# @see Responses::GetBrowserSourceProperties
|
1531
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1592
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getbrowsersourceproperties
|
1532
1593
|
class GetBrowserSourceProperties < Request
|
1533
1594
|
json_name "GetBrowserSourceProperties"
|
1534
1595
|
params(
|
@@ -1537,7 +1598,7 @@ module Requests
|
|
1537
1598
|
end
|
1538
1599
|
# @see Request::Mixin#set_browser_source_properties
|
1539
1600
|
# @see Responses::SetBrowserSourceProperties
|
1540
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1601
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setbrowsersourceproperties
|
1541
1602
|
class SetBrowserSourceProperties < Request
|
1542
1603
|
json_name "SetBrowserSourceProperties"
|
1543
1604
|
params(
|
@@ -1555,7 +1616,7 @@ module Requests
|
|
1555
1616
|
end
|
1556
1617
|
# @see Request::Mixin#get_special_sources
|
1557
1618
|
# @see Responses::GetSpecialSources
|
1558
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1619
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getspecialsources
|
1559
1620
|
class GetSpecialSources < Request
|
1560
1621
|
json_name "GetSpecialSources"
|
1561
1622
|
params(
|
@@ -1563,7 +1624,7 @@ module Requests
|
|
1563
1624
|
end
|
1564
1625
|
# @see Request::Mixin#get_source_filters
|
1565
1626
|
# @see Responses::GetSourceFilters
|
1566
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1627
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcefilters
|
1567
1628
|
class GetSourceFilters < Request
|
1568
1629
|
json_name "GetSourceFilters"
|
1569
1630
|
params(
|
@@ -1572,7 +1633,7 @@ module Requests
|
|
1572
1633
|
end
|
1573
1634
|
# @see Request::Mixin#get_source_filter_info
|
1574
1635
|
# @see Responses::GetSourceFilterInfo
|
1575
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1636
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcefilterinfo
|
1576
1637
|
class GetSourceFilterInfo < Request
|
1577
1638
|
json_name "GetSourceFilterInfo"
|
1578
1639
|
params(
|
@@ -1582,7 +1643,7 @@ module Requests
|
|
1582
1643
|
end
|
1583
1644
|
# @see Request::Mixin#add_filter_to_source
|
1584
1645
|
# @see Responses::AddFilterToSource
|
1585
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1646
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#addfiltertosource
|
1586
1647
|
class AddFilterToSource < Request
|
1587
1648
|
json_name "AddFilterToSource"
|
1588
1649
|
params(
|
@@ -1594,7 +1655,7 @@ module Requests
|
|
1594
1655
|
end
|
1595
1656
|
# @see Request::Mixin#remove_filter_from_source
|
1596
1657
|
# @see Responses::RemoveFilterFromSource
|
1597
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1658
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#removefilterfromsource
|
1598
1659
|
class RemoveFilterFromSource < Request
|
1599
1660
|
json_name "RemoveFilterFromSource"
|
1600
1661
|
params(
|
@@ -1604,7 +1665,7 @@ module Requests
|
|
1604
1665
|
end
|
1605
1666
|
# @see Request::Mixin#reorder_source_filter
|
1606
1667
|
# @see Responses::ReorderSourceFilter
|
1607
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1668
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#reordersourcefilter
|
1608
1669
|
class ReorderSourceFilter < Request
|
1609
1670
|
json_name "ReorderSourceFilter"
|
1610
1671
|
params(
|
@@ -1615,7 +1676,7 @@ module Requests
|
|
1615
1676
|
end
|
1616
1677
|
# @see Request::Mixin#move_source_filter
|
1617
1678
|
# @see Responses::MoveSourceFilter
|
1618
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1679
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#movesourcefilter
|
1619
1680
|
class MoveSourceFilter < Request
|
1620
1681
|
json_name "MoveSourceFilter"
|
1621
1682
|
params(
|
@@ -1626,7 +1687,7 @@ module Requests
|
|
1626
1687
|
end
|
1627
1688
|
# @see Request::Mixin#set_source_filter_settings
|
1628
1689
|
# @see Responses::SetSourceFilterSettings
|
1629
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1690
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcefiltersettings
|
1630
1691
|
class SetSourceFilterSettings < Request
|
1631
1692
|
json_name "SetSourceFilterSettings"
|
1632
1693
|
params(
|
@@ -1637,7 +1698,7 @@ module Requests
|
|
1637
1698
|
end
|
1638
1699
|
# @see Request::Mixin#set_source_filter_visibility
|
1639
1700
|
# @see Responses::SetSourceFilterVisibility
|
1640
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1701
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcefiltervisibility
|
1641
1702
|
class SetSourceFilterVisibility < Request
|
1642
1703
|
json_name "SetSourceFilterVisibility"
|
1643
1704
|
params(
|
@@ -1648,7 +1709,7 @@ module Requests
|
|
1648
1709
|
end
|
1649
1710
|
# @see Request::Mixin#get_audio_monitor_type
|
1650
1711
|
# @see Responses::GetAudioMonitorType
|
1651
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1712
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getaudiomonitortype
|
1652
1713
|
class GetAudioMonitorType < Request
|
1653
1714
|
json_name "GetAudioMonitorType"
|
1654
1715
|
params(
|
@@ -1657,7 +1718,7 @@ module Requests
|
|
1657
1718
|
end
|
1658
1719
|
# @see Request::Mixin#set_audio_monitor_type
|
1659
1720
|
# @see Responses::SetAudioMonitorType
|
1660
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1721
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setaudiomonitortype
|
1661
1722
|
class SetAudioMonitorType < Request
|
1662
1723
|
json_name "SetAudioMonitorType"
|
1663
1724
|
params(
|
@@ -1667,7 +1728,7 @@ module Requests
|
|
1667
1728
|
end
|
1668
1729
|
# @see Request::Mixin#get_source_default_settings
|
1669
1730
|
# @see Responses::GetSourceDefaultSettings
|
1670
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1731
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcedefaultsettings
|
1671
1732
|
class GetSourceDefaultSettings < Request
|
1672
1733
|
json_name "GetSourceDefaultSettings"
|
1673
1734
|
params(
|
@@ -1676,7 +1737,7 @@ module Requests
|
|
1676
1737
|
end
|
1677
1738
|
# @see Request::Mixin#take_source_screenshot
|
1678
1739
|
# @see Responses::TakeSourceScreenshot
|
1679
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1740
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#takesourcescreenshot
|
1680
1741
|
class TakeSourceScreenshot < Request
|
1681
1742
|
json_name "TakeSourceScreenshot"
|
1682
1743
|
params(
|
@@ -1691,7 +1752,7 @@ module Requests
|
|
1691
1752
|
end
|
1692
1753
|
# @see Request::Mixin#refresh_browser_source
|
1693
1754
|
# @see Responses::RefreshBrowserSource
|
1694
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1755
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#refreshbrowsersource
|
1695
1756
|
class RefreshBrowserSource < Request
|
1696
1757
|
json_name "RefreshBrowserSource"
|
1697
1758
|
params(
|
@@ -1700,7 +1761,7 @@ module Requests
|
|
1700
1761
|
end
|
1701
1762
|
# @see Request::Mixin#list_outputs
|
1702
1763
|
# @see Responses::ListOutputs
|
1703
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1764
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listoutputs
|
1704
1765
|
class ListOutputs < Request
|
1705
1766
|
json_name "ListOutputs"
|
1706
1767
|
params(
|
@@ -1708,7 +1769,7 @@ module Requests
|
|
1708
1769
|
end
|
1709
1770
|
# @see Request::Mixin#get_output_info
|
1710
1771
|
# @see Responses::GetOutputInfo
|
1711
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1772
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getoutputinfo
|
1712
1773
|
class GetOutputInfo < Request
|
1713
1774
|
json_name "GetOutputInfo"
|
1714
1775
|
params(
|
@@ -1717,7 +1778,7 @@ module Requests
|
|
1717
1778
|
end
|
1718
1779
|
# @see Request::Mixin#start_output
|
1719
1780
|
# @see Responses::StartOutput
|
1720
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1781
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startoutput
|
1721
1782
|
class StartOutput < Request
|
1722
1783
|
json_name "StartOutput"
|
1723
1784
|
params(
|
@@ -1726,7 +1787,7 @@ module Requests
|
|
1726
1787
|
end
|
1727
1788
|
# @see Request::Mixin#stop_output
|
1728
1789
|
# @see Responses::StopOutput
|
1729
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1790
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopoutput
|
1730
1791
|
class StopOutput < Request
|
1731
1792
|
json_name "StopOutput"
|
1732
1793
|
params(
|
@@ -1736,7 +1797,7 @@ module Requests
|
|
1736
1797
|
end
|
1737
1798
|
# @see Request::Mixin#set_current_profile
|
1738
1799
|
# @see Responses::SetCurrentProfile
|
1739
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1800
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentprofile
|
1740
1801
|
class SetCurrentProfile < Request
|
1741
1802
|
json_name "SetCurrentProfile"
|
1742
1803
|
params(
|
@@ -1745,7 +1806,7 @@ module Requests
|
|
1745
1806
|
end
|
1746
1807
|
# @see Request::Mixin#get_current_profile
|
1747
1808
|
# @see Responses::GetCurrentProfile
|
1748
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1809
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentprofile
|
1749
1810
|
class GetCurrentProfile < Request
|
1750
1811
|
json_name "GetCurrentProfile"
|
1751
1812
|
params(
|
@@ -1753,7 +1814,7 @@ module Requests
|
|
1753
1814
|
end
|
1754
1815
|
# @see Request::Mixin#list_profiles
|
1755
1816
|
# @see Responses::ListProfiles
|
1756
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1817
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listprofiles
|
1757
1818
|
class ListProfiles < Request
|
1758
1819
|
json_name "ListProfiles"
|
1759
1820
|
params(
|
@@ -1761,7 +1822,7 @@ module Requests
|
|
1761
1822
|
end
|
1762
1823
|
# @see Request::Mixin#get_recording_status
|
1763
1824
|
# @see Responses::GetRecordingStatus
|
1764
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1825
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getrecordingstatus
|
1765
1826
|
class GetRecordingStatus < Request
|
1766
1827
|
json_name "GetRecordingStatus"
|
1767
1828
|
params(
|
@@ -1769,7 +1830,7 @@ module Requests
|
|
1769
1830
|
end
|
1770
1831
|
# @see Request::Mixin#start_stop_recording
|
1771
1832
|
# @see Responses::StartStopRecording
|
1772
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1833
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstoprecording
|
1773
1834
|
class StartStopRecording < Request
|
1774
1835
|
json_name "StartStopRecording"
|
1775
1836
|
params(
|
@@ -1777,7 +1838,7 @@ module Requests
|
|
1777
1838
|
end
|
1778
1839
|
# @see Request::Mixin#start_recording
|
1779
1840
|
# @see Responses::StartRecording
|
1780
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1841
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startrecording
|
1781
1842
|
class StartRecording < Request
|
1782
1843
|
json_name "StartRecording"
|
1783
1844
|
params(
|
@@ -1785,7 +1846,7 @@ module Requests
|
|
1785
1846
|
end
|
1786
1847
|
# @see Request::Mixin#stop_recording
|
1787
1848
|
# @see Responses::StopRecording
|
1788
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1849
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stoprecording
|
1789
1850
|
class StopRecording < Request
|
1790
1851
|
json_name "StopRecording"
|
1791
1852
|
params(
|
@@ -1793,7 +1854,7 @@ module Requests
|
|
1793
1854
|
end
|
1794
1855
|
# @see Request::Mixin#pause_recording
|
1795
1856
|
# @see Responses::PauseRecording
|
1796
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1857
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#pauserecording
|
1797
1858
|
class PauseRecording < Request
|
1798
1859
|
json_name "PauseRecording"
|
1799
1860
|
params(
|
@@ -1801,7 +1862,7 @@ module Requests
|
|
1801
1862
|
end
|
1802
1863
|
# @see Request::Mixin#resume_recording
|
1803
1864
|
# @see Responses::ResumeRecording
|
1804
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1865
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#resumerecording
|
1805
1866
|
class ResumeRecording < Request
|
1806
1867
|
json_name "ResumeRecording"
|
1807
1868
|
params(
|
@@ -1809,7 +1870,7 @@ module Requests
|
|
1809
1870
|
end
|
1810
1871
|
# @see Request::Mixin#set_recording_folder
|
1811
1872
|
# @see Responses::SetRecordingFolder
|
1812
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1873
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setrecordingfolder
|
1813
1874
|
class SetRecordingFolder < Request
|
1814
1875
|
json_name "SetRecordingFolder"
|
1815
1876
|
params(
|
@@ -1818,7 +1879,7 @@ module Requests
|
|
1818
1879
|
end
|
1819
1880
|
# @see Request::Mixin#get_recording_folder
|
1820
1881
|
# @see Responses::GetRecordingFolder
|
1821
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1882
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getrecordingfolder
|
1822
1883
|
class GetRecordingFolder < Request
|
1823
1884
|
json_name "GetRecordingFolder"
|
1824
1885
|
params(
|
@@ -1826,7 +1887,7 @@ module Requests
|
|
1826
1887
|
end
|
1827
1888
|
# @see Request::Mixin#get_replay_buffer_status
|
1828
1889
|
# @see Responses::GetReplayBufferStatus
|
1829
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1890
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getreplaybufferstatus
|
1830
1891
|
class GetReplayBufferStatus < Request
|
1831
1892
|
json_name "GetReplayBufferStatus"
|
1832
1893
|
params(
|
@@ -1834,7 +1895,7 @@ module Requests
|
|
1834
1895
|
end
|
1835
1896
|
# @see Request::Mixin#start_stop_replay_buffer
|
1836
1897
|
# @see Responses::StartStopReplayBuffer
|
1837
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1898
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopreplaybuffer
|
1838
1899
|
class StartStopReplayBuffer < Request
|
1839
1900
|
json_name "StartStopReplayBuffer"
|
1840
1901
|
params(
|
@@ -1842,7 +1903,7 @@ module Requests
|
|
1842
1903
|
end
|
1843
1904
|
# @see Request::Mixin#start_replay_buffer
|
1844
1905
|
# @see Responses::StartReplayBuffer
|
1845
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1906
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startreplaybuffer
|
1846
1907
|
class StartReplayBuffer < Request
|
1847
1908
|
json_name "StartReplayBuffer"
|
1848
1909
|
params(
|
@@ -1850,7 +1911,7 @@ module Requests
|
|
1850
1911
|
end
|
1851
1912
|
# @see Request::Mixin#stop_replay_buffer
|
1852
1913
|
# @see Responses::StopReplayBuffer
|
1853
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1914
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopreplaybuffer
|
1854
1915
|
class StopReplayBuffer < Request
|
1855
1916
|
json_name "StopReplayBuffer"
|
1856
1917
|
params(
|
@@ -1858,7 +1919,7 @@ module Requests
|
|
1858
1919
|
end
|
1859
1920
|
# @see Request::Mixin#save_replay_buffer
|
1860
1921
|
# @see Responses::SaveReplayBuffer
|
1861
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1922
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#savereplaybuffer
|
1862
1923
|
class SaveReplayBuffer < Request
|
1863
1924
|
json_name "SaveReplayBuffer"
|
1864
1925
|
params(
|
@@ -1866,7 +1927,7 @@ module Requests
|
|
1866
1927
|
end
|
1867
1928
|
# @see Request::Mixin#set_current_scene_collection
|
1868
1929
|
# @see Responses::SetCurrentSceneCollection
|
1869
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1930
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentscenecollection
|
1870
1931
|
class SetCurrentSceneCollection < Request
|
1871
1932
|
json_name "SetCurrentSceneCollection"
|
1872
1933
|
params(
|
@@ -1875,7 +1936,7 @@ module Requests
|
|
1875
1936
|
end
|
1876
1937
|
# @see Request::Mixin#get_current_scene_collection
|
1877
1938
|
# @see Responses::GetCurrentSceneCollection
|
1878
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1939
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentscenecollection
|
1879
1940
|
class GetCurrentSceneCollection < Request
|
1880
1941
|
json_name "GetCurrentSceneCollection"
|
1881
1942
|
params(
|
@@ -1883,7 +1944,7 @@ module Requests
|
|
1883
1944
|
end
|
1884
1945
|
# @see Request::Mixin#list_scene_collections
|
1885
1946
|
# @see Responses::ListSceneCollections
|
1886
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1947
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listscenecollections
|
1887
1948
|
class ListSceneCollections < Request
|
1888
1949
|
json_name "ListSceneCollections"
|
1889
1950
|
params(
|
@@ -1891,7 +1952,7 @@ module Requests
|
|
1891
1952
|
end
|
1892
1953
|
# @see Request::Mixin#get_scene_item_list
|
1893
1954
|
# @see Responses::GetSceneItemList
|
1894
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1955
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsceneitemlist
|
1895
1956
|
class GetSceneItemList < Request
|
1896
1957
|
json_name "GetSceneItemList"
|
1897
1958
|
params(
|
@@ -1900,7 +1961,7 @@ module Requests
|
|
1900
1961
|
end
|
1901
1962
|
# @see Request::Mixin#get_scene_item_properties
|
1902
1963
|
# @see Responses::GetSceneItemProperties
|
1903
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1964
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsceneitemproperties
|
1904
1965
|
class GetSceneItemProperties < Request
|
1905
1966
|
json_name "GetSceneItemProperties"
|
1906
1967
|
params(
|
@@ -1910,7 +1971,7 @@ module Requests
|
|
1910
1971
|
end
|
1911
1972
|
# @see Request::Mixin#set_scene_item_properties
|
1912
1973
|
# @see Responses::SetSceneItemProperties
|
1913
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1974
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemproperties
|
1914
1975
|
class SetSceneItemProperties < Request
|
1915
1976
|
json_name "SetSceneItemProperties"
|
1916
1977
|
params(
|
@@ -1918,7 +1979,7 @@ module Requests
|
|
1918
1979
|
"item": {json_name: "item", type: Types::StringOrObject[{:name=>{:type=>Types::Optional[Types::String], :json_name=>"name"}, :id=>{:type=>Types::Optional[Types::Integer], :json_name=>"id"}}]},
|
1919
1980
|
"position": {json_name: "position", type: Types::Object[{:x=>{:type=>Types::Optional[Types::Float], :json_name=>"x"}, :y=>{:type=>Types::Optional[Types::Float], :json_name=>"y"}, :alignment=>{:type=>Types::Optional[Types::Integer], :json_name=>"alignment"}}]},
|
1920
1981
|
"rotation": {json_name: "rotation", type: Types::Optional[Types::Float]},
|
1921
|
-
"scale": {json_name: "scale", type: Types::Object[{:x=>{:type=>Types::Optional[Types::Float], :json_name=>"x"}, :y=>{:type=>Types::Optional[Types::Float], :json_name=>"y"}}]},
|
1982
|
+
"scale": {json_name: "scale", type: Types::Object[{:x=>{:type=>Types::Optional[Types::Float], :json_name=>"x"}, :y=>{:type=>Types::Optional[Types::Float], :json_name=>"y"}, :filter=>{:type=>Types::Optional[Types::String], :json_name=>"filter"}}]},
|
1922
1983
|
"crop": {json_name: "crop", type: Types::Object[{:top=>{:type=>Types::Optional[Types::Integer], :json_name=>"top"}, :bottom=>{:type=>Types::Optional[Types::Integer], :json_name=>"bottom"}, :left=>{:type=>Types::Optional[Types::Integer], :json_name=>"left"}, :right=>{:type=>Types::Optional[Types::Integer], :json_name=>"right"}}]},
|
1923
1984
|
"visible": {json_name: "visible", type: Types::Optional[Types::Boolean]},
|
1924
1985
|
"locked": {json_name: "locked", type: Types::Optional[Types::Boolean]},
|
@@ -1927,7 +1988,7 @@ module Requests
|
|
1927
1988
|
end
|
1928
1989
|
# @see Request::Mixin#reset_scene_item
|
1929
1990
|
# @see Responses::ResetSceneItem
|
1930
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
1991
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#resetsceneitem
|
1931
1992
|
class ResetSceneItem < Request
|
1932
1993
|
json_name "ResetSceneItem"
|
1933
1994
|
params(
|
@@ -1937,7 +1998,7 @@ module Requests
|
|
1937
1998
|
end
|
1938
1999
|
# @see Request::Mixin#set_scene_item_render
|
1939
2000
|
# @see Responses::SetSceneItemRender
|
1940
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2001
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemrender
|
1941
2002
|
class SetSceneItemRender < Request
|
1942
2003
|
json_name "SetSceneItemRender"
|
1943
2004
|
params(
|
@@ -1949,7 +2010,7 @@ module Requests
|
|
1949
2010
|
end
|
1950
2011
|
# @see Request::Mixin#set_scene_item_position
|
1951
2012
|
# @see Responses::SetSceneItemPosition
|
1952
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2013
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemposition
|
1953
2014
|
class SetSceneItemPosition < Request
|
1954
2015
|
json_name "SetSceneItemPosition"
|
1955
2016
|
params(
|
@@ -1961,7 +2022,7 @@ module Requests
|
|
1961
2022
|
end
|
1962
2023
|
# @see Request::Mixin#set_scene_item_transform
|
1963
2024
|
# @see Responses::SetSceneItemTransform
|
1964
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2025
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemtransform
|
1965
2026
|
class SetSceneItemTransform < Request
|
1966
2027
|
json_name "SetSceneItemTransform"
|
1967
2028
|
params(
|
@@ -1974,7 +2035,7 @@ module Requests
|
|
1974
2035
|
end
|
1975
2036
|
# @see Request::Mixin#set_scene_item_crop
|
1976
2037
|
# @see Responses::SetSceneItemCrop
|
1977
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2038
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemcrop
|
1978
2039
|
class SetSceneItemCrop < Request
|
1979
2040
|
json_name "SetSceneItemCrop"
|
1980
2041
|
params(
|
@@ -1988,7 +2049,7 @@ module Requests
|
|
1988
2049
|
end
|
1989
2050
|
# @see Request::Mixin#delete_scene_item
|
1990
2051
|
# @see Responses::DeleteSceneItem
|
1991
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2052
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#deletesceneitem
|
1992
2053
|
class DeleteSceneItem < Request
|
1993
2054
|
json_name "DeleteSceneItem"
|
1994
2055
|
params(
|
@@ -1998,18 +2059,18 @@ module Requests
|
|
1998
2059
|
end
|
1999
2060
|
# @see Request::Mixin#add_scene_item
|
2000
2061
|
# @see Responses::AddSceneItem
|
2001
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2062
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#addsceneitem
|
2002
2063
|
class AddSceneItem < Request
|
2003
2064
|
json_name "AddSceneItem"
|
2004
2065
|
params(
|
2005
2066
|
"scene_name": {json_name: "sceneName", type: Types::String},
|
2006
2067
|
"source_name": {json_name: "sourceName", type: Types::String},
|
2007
|
-
"set_visible": {json_name: "setVisible", type: Types::Boolean},
|
2068
|
+
"set_visible": {json_name: "setVisible", type: Types::Optional[Types::Boolean]},
|
2008
2069
|
)
|
2009
2070
|
end
|
2010
2071
|
# @see Request::Mixin#duplicate_scene_item
|
2011
2072
|
# @see Responses::DuplicateSceneItem
|
2012
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2073
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#duplicatesceneitem
|
2013
2074
|
class DuplicateSceneItem < Request
|
2014
2075
|
json_name "DuplicateSceneItem"
|
2015
2076
|
params(
|
@@ -2020,7 +2081,7 @@ module Requests
|
|
2020
2081
|
end
|
2021
2082
|
# @see Request::Mixin#set_current_scene
|
2022
2083
|
# @see Responses::SetCurrentScene
|
2023
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2084
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentscene
|
2024
2085
|
class SetCurrentScene < Request
|
2025
2086
|
json_name "SetCurrentScene"
|
2026
2087
|
params(
|
@@ -2029,7 +2090,7 @@ module Requests
|
|
2029
2090
|
end
|
2030
2091
|
# @see Request::Mixin#get_current_scene
|
2031
2092
|
# @see Responses::GetCurrentScene
|
2032
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2093
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentscene
|
2033
2094
|
class GetCurrentScene < Request
|
2034
2095
|
json_name "GetCurrentScene"
|
2035
2096
|
params(
|
@@ -2037,7 +2098,7 @@ module Requests
|
|
2037
2098
|
end
|
2038
2099
|
# @see Request::Mixin#get_scene_list
|
2039
2100
|
# @see Responses::GetSceneList
|
2040
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2101
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getscenelist
|
2041
2102
|
class GetSceneList < Request
|
2042
2103
|
json_name "GetSceneList"
|
2043
2104
|
params(
|
@@ -2045,7 +2106,7 @@ module Requests
|
|
2045
2106
|
end
|
2046
2107
|
# @see Request::Mixin#create_scene
|
2047
2108
|
# @see Responses::CreateScene
|
2048
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2109
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#createscene
|
2049
2110
|
class CreateScene < Request
|
2050
2111
|
json_name "CreateScene"
|
2051
2112
|
params(
|
@@ -2054,7 +2115,7 @@ module Requests
|
|
2054
2115
|
end
|
2055
2116
|
# @see Request::Mixin#reorder_scene_items
|
2056
2117
|
# @see Responses::ReorderSceneItems
|
2057
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2118
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#reordersceneitems
|
2058
2119
|
class ReorderSceneItems < Request
|
2059
2120
|
json_name "ReorderSceneItems"
|
2060
2121
|
params(
|
@@ -2064,7 +2125,7 @@ module Requests
|
|
2064
2125
|
end
|
2065
2126
|
# @see Request::Mixin#set_scene_transition_override
|
2066
2127
|
# @see Responses::SetSceneTransitionOverride
|
2067
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2128
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setscenetransitionoverride
|
2068
2129
|
class SetSceneTransitionOverride < Request
|
2069
2130
|
json_name "SetSceneTransitionOverride"
|
2070
2131
|
params(
|
@@ -2075,7 +2136,7 @@ module Requests
|
|
2075
2136
|
end
|
2076
2137
|
# @see Request::Mixin#remove_scene_transition_override
|
2077
2138
|
# @see Responses::RemoveSceneTransitionOverride
|
2078
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2139
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#removescenetransitionoverride
|
2079
2140
|
class RemoveSceneTransitionOverride < Request
|
2080
2141
|
json_name "RemoveSceneTransitionOverride"
|
2081
2142
|
params(
|
@@ -2084,7 +2145,7 @@ module Requests
|
|
2084
2145
|
end
|
2085
2146
|
# @see Request::Mixin#get_scene_transition_override
|
2086
2147
|
# @see Responses::GetSceneTransitionOverride
|
2087
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2148
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getscenetransitionoverride
|
2088
2149
|
class GetSceneTransitionOverride < Request
|
2089
2150
|
json_name "GetSceneTransitionOverride"
|
2090
2151
|
params(
|
@@ -2093,7 +2154,7 @@ module Requests
|
|
2093
2154
|
end
|
2094
2155
|
# @see Request::Mixin#get_streaming_status
|
2095
2156
|
# @see Responses::GetStreamingStatus
|
2096
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2157
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstreamingstatus
|
2097
2158
|
class GetStreamingStatus < Request
|
2098
2159
|
json_name "GetStreamingStatus"
|
2099
2160
|
params(
|
@@ -2101,7 +2162,7 @@ module Requests
|
|
2101
2162
|
end
|
2102
2163
|
# @see Request::Mixin#start_stop_streaming
|
2103
2164
|
# @see Responses::StartStopStreaming
|
2104
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2165
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopstreaming
|
2105
2166
|
class StartStopStreaming < Request
|
2106
2167
|
json_name "StartStopStreaming"
|
2107
2168
|
params(
|
@@ -2109,7 +2170,7 @@ module Requests
|
|
2109
2170
|
end
|
2110
2171
|
# @see Request::Mixin#start_streaming
|
2111
2172
|
# @see Responses::StartStreaming
|
2112
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2173
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstreaming
|
2113
2174
|
class StartStreaming < Request
|
2114
2175
|
json_name "StartStreaming"
|
2115
2176
|
params(
|
@@ -2118,7 +2179,7 @@ module Requests
|
|
2118
2179
|
end
|
2119
2180
|
# @see Request::Mixin#stop_streaming
|
2120
2181
|
# @see Responses::StopStreaming
|
2121
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2182
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopstreaming
|
2122
2183
|
class StopStreaming < Request
|
2123
2184
|
json_name "StopStreaming"
|
2124
2185
|
params(
|
@@ -2126,7 +2187,7 @@ module Requests
|
|
2126
2187
|
end
|
2127
2188
|
# @see Request::Mixin#set_stream_settings
|
2128
2189
|
# @see Responses::SetStreamSettings
|
2129
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2190
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setstreamsettings
|
2130
2191
|
class SetStreamSettings < Request
|
2131
2192
|
json_name "SetStreamSettings"
|
2132
2193
|
params(
|
@@ -2137,7 +2198,7 @@ module Requests
|
|
2137
2198
|
end
|
2138
2199
|
# @see Request::Mixin#get_stream_settings
|
2139
2200
|
# @see Responses::GetStreamSettings
|
2140
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2201
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstreamsettings
|
2141
2202
|
class GetStreamSettings < Request
|
2142
2203
|
json_name "GetStreamSettings"
|
2143
2204
|
params(
|
@@ -2145,7 +2206,7 @@ module Requests
|
|
2145
2206
|
end
|
2146
2207
|
# @see Request::Mixin#save_stream_settings
|
2147
2208
|
# @see Responses::SaveStreamSettings
|
2148
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2209
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#savestreamsettings
|
2149
2210
|
class SaveStreamSettings < Request
|
2150
2211
|
json_name "SaveStreamSettings"
|
2151
2212
|
params(
|
@@ -2153,7 +2214,7 @@ module Requests
|
|
2153
2214
|
end
|
2154
2215
|
# @see Request::Mixin#send_captions
|
2155
2216
|
# @see Responses::SendCaptions
|
2156
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2217
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sendcaptions
|
2157
2218
|
class SendCaptions < Request
|
2158
2219
|
json_name "SendCaptions"
|
2159
2220
|
params(
|
@@ -2162,7 +2223,7 @@ module Requests
|
|
2162
2223
|
end
|
2163
2224
|
# @see Request::Mixin#get_studio_mode_status
|
2164
2225
|
# @see Responses::GetStudioModeStatus
|
2165
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2226
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstudiomodestatus
|
2166
2227
|
class GetStudioModeStatus < Request
|
2167
2228
|
json_name "GetStudioModeStatus"
|
2168
2229
|
params(
|
@@ -2170,7 +2231,7 @@ module Requests
|
|
2170
2231
|
end
|
2171
2232
|
# @see Request::Mixin#get_preview_scene
|
2172
2233
|
# @see Responses::GetPreviewScene
|
2173
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2234
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getpreviewscene
|
2174
2235
|
class GetPreviewScene < Request
|
2175
2236
|
json_name "GetPreviewScene"
|
2176
2237
|
params(
|
@@ -2178,7 +2239,7 @@ module Requests
|
|
2178
2239
|
end
|
2179
2240
|
# @see Request::Mixin#set_preview_scene
|
2180
2241
|
# @see Responses::SetPreviewScene
|
2181
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2242
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setpreviewscene
|
2182
2243
|
class SetPreviewScene < Request
|
2183
2244
|
json_name "SetPreviewScene"
|
2184
2245
|
params(
|
@@ -2187,7 +2248,7 @@ module Requests
|
|
2187
2248
|
end
|
2188
2249
|
# @see Request::Mixin#transition_to_program
|
2189
2250
|
# @see Responses::TransitionToProgram
|
2190
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2251
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitiontoprogram
|
2191
2252
|
class TransitionToProgram < Request
|
2192
2253
|
json_name "TransitionToProgram"
|
2193
2254
|
params(
|
@@ -2196,7 +2257,7 @@ module Requests
|
|
2196
2257
|
end
|
2197
2258
|
# @see Request::Mixin#enable_studio_mode
|
2198
2259
|
# @see Responses::EnableStudioMode
|
2199
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2260
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#enablestudiomode
|
2200
2261
|
class EnableStudioMode < Request
|
2201
2262
|
json_name "EnableStudioMode"
|
2202
2263
|
params(
|
@@ -2204,7 +2265,7 @@ module Requests
|
|
2204
2265
|
end
|
2205
2266
|
# @see Request::Mixin#disable_studio_mode
|
2206
2267
|
# @see Responses::DisableStudioMode
|
2207
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2268
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#disablestudiomode
|
2208
2269
|
class DisableStudioMode < Request
|
2209
2270
|
json_name "DisableStudioMode"
|
2210
2271
|
params(
|
@@ -2212,7 +2273,7 @@ module Requests
|
|
2212
2273
|
end
|
2213
2274
|
# @see Request::Mixin#toggle_studio_mode
|
2214
2275
|
# @see Responses::ToggleStudioMode
|
2215
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2276
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#togglestudiomode
|
2216
2277
|
class ToggleStudioMode < Request
|
2217
2278
|
json_name "ToggleStudioMode"
|
2218
2279
|
params(
|
@@ -2220,7 +2281,7 @@ module Requests
|
|
2220
2281
|
end
|
2221
2282
|
# @see Request::Mixin#get_transition_list
|
2222
2283
|
# @see Responses::GetTransitionList
|
2223
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2284
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionlist
|
2224
2285
|
class GetTransitionList < Request
|
2225
2286
|
json_name "GetTransitionList"
|
2226
2287
|
params(
|
@@ -2228,7 +2289,7 @@ module Requests
|
|
2228
2289
|
end
|
2229
2290
|
# @see Request::Mixin#get_current_transition
|
2230
2291
|
# @see Responses::GetCurrentTransition
|
2231
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2292
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrenttransition
|
2232
2293
|
class GetCurrentTransition < Request
|
2233
2294
|
json_name "GetCurrentTransition"
|
2234
2295
|
params(
|
@@ -2236,7 +2297,7 @@ module Requests
|
|
2236
2297
|
end
|
2237
2298
|
# @see Request::Mixin#set_current_transition
|
2238
2299
|
# @see Responses::SetCurrentTransition
|
2239
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2300
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrenttransition
|
2240
2301
|
class SetCurrentTransition < Request
|
2241
2302
|
json_name "SetCurrentTransition"
|
2242
2303
|
params(
|
@@ -2245,7 +2306,7 @@ module Requests
|
|
2245
2306
|
end
|
2246
2307
|
# @see Request::Mixin#set_transition_duration
|
2247
2308
|
# @see Responses::SetTransitionDuration
|
2248
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2309
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settransitionduration
|
2249
2310
|
class SetTransitionDuration < Request
|
2250
2311
|
json_name "SetTransitionDuration"
|
2251
2312
|
params(
|
@@ -2254,7 +2315,7 @@ module Requests
|
|
2254
2315
|
end
|
2255
2316
|
# @see Request::Mixin#get_transition_duration
|
2256
2317
|
# @see Responses::GetTransitionDuration
|
2257
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2318
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionduration
|
2258
2319
|
class GetTransitionDuration < Request
|
2259
2320
|
json_name "GetTransitionDuration"
|
2260
2321
|
params(
|
@@ -2262,7 +2323,7 @@ module Requests
|
|
2262
2323
|
end
|
2263
2324
|
# @see Request::Mixin#get_transition_position
|
2264
2325
|
# @see Responses::GetTransitionPosition
|
2265
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2326
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionposition
|
2266
2327
|
class GetTransitionPosition < Request
|
2267
2328
|
json_name "GetTransitionPosition"
|
2268
2329
|
params(
|
@@ -2270,7 +2331,7 @@ module Requests
|
|
2270
2331
|
end
|
2271
2332
|
# @see Request::Mixin#get_transition_settings
|
2272
2333
|
# @see Responses::GetTransitionSettings
|
2273
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2334
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionsettings
|
2274
2335
|
class GetTransitionSettings < Request
|
2275
2336
|
json_name "GetTransitionSettings"
|
2276
2337
|
params(
|
@@ -2279,7 +2340,7 @@ module Requests
|
|
2279
2340
|
end
|
2280
2341
|
# @see Request::Mixin#set_transition_settings
|
2281
2342
|
# @see Responses::SetTransitionSettings
|
2282
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2343
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settransitionsettings
|
2283
2344
|
class SetTransitionSettings < Request
|
2284
2345
|
json_name "SetTransitionSettings"
|
2285
2346
|
params(
|
@@ -2289,7 +2350,7 @@ module Requests
|
|
2289
2350
|
end
|
2290
2351
|
# @see Request::Mixin#release_t_bar
|
2291
2352
|
# @see Responses::ReleaseTBar
|
2292
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2353
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#releasetbar
|
2293
2354
|
class ReleaseTBar < Request
|
2294
2355
|
json_name "ReleaseTBar"
|
2295
2356
|
params(
|
@@ -2297,7 +2358,7 @@ module Requests
|
|
2297
2358
|
end
|
2298
2359
|
# @see Request::Mixin#set_t_bar_position
|
2299
2360
|
# @see Responses::SetTBarPosition
|
2300
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2361
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settbarposition
|
2301
2362
|
class SetTBarPosition < Request
|
2302
2363
|
json_name "SetTBarPosition"
|
2303
2364
|
params(
|
@@ -2305,28 +2366,60 @@ module Requests
|
|
2305
2366
|
"release": {json_name: "release", type: Types::Optional[Types::Boolean]},
|
2306
2367
|
)
|
2307
2368
|
end
|
2369
|
+
# @see Request::Mixin#get_virtual_cam_status
|
2370
|
+
# @see Responses::GetVirtualCamStatus
|
2371
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvirtualcamstatus
|
2372
|
+
class GetVirtualCamStatus < Request
|
2373
|
+
json_name "GetVirtualCamStatus"
|
2374
|
+
params(
|
2375
|
+
)
|
2376
|
+
end
|
2377
|
+
# @see Request::Mixin#start_stop_virtual_cam
|
2378
|
+
# @see Responses::StartStopVirtualCam
|
2379
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopvirtualcam
|
2380
|
+
class StartStopVirtualCam < Request
|
2381
|
+
json_name "StartStopVirtualCam"
|
2382
|
+
params(
|
2383
|
+
)
|
2384
|
+
end
|
2385
|
+
# @see Request::Mixin#start_virtual_cam
|
2386
|
+
# @see Responses::StartVirtualCam
|
2387
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startvirtualcam
|
2388
|
+
class StartVirtualCam < Request
|
2389
|
+
json_name "StartVirtualCam"
|
2390
|
+
params(
|
2391
|
+
)
|
2392
|
+
end
|
2393
|
+
# @see Request::Mixin#stop_virtual_cam
|
2394
|
+
# @see Responses::StopVirtualCam
|
2395
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopvirtualcam
|
2396
|
+
class StopVirtualCam < Request
|
2397
|
+
json_name "StopVirtualCam"
|
2398
|
+
params(
|
2399
|
+
)
|
2400
|
+
end
|
2308
2401
|
module Request::Mixin
|
2309
2402
|
# Sends <tt>GetVersion</tt> request.
|
2310
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2403
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getversion
|
2311
2404
|
# @return [Future<Responses::GetVersion>]
|
2312
2405
|
def get_version()
|
2313
2406
|
send_request(Requests::GetVersion.new({}))
|
2314
2407
|
end
|
2315
2408
|
# Sends <tt>GetAuthRequired</tt> request.
|
2316
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2409
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getauthrequired
|
2317
2410
|
# @return [Future<Responses::GetAuthRequired>]
|
2318
2411
|
def get_auth_required()
|
2319
2412
|
send_request(Requests::GetAuthRequired.new({}))
|
2320
2413
|
end
|
2321
2414
|
# Sends <tt>Authenticate</tt> request.
|
2322
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2415
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#authenticate
|
2323
2416
|
# @param auth [String] <tt>auth</tt> field
|
2324
2417
|
# @return [Future<Responses::Authenticate>]
|
2325
2418
|
def authenticate(auth:)
|
2326
2419
|
send_request(Requests::Authenticate.new({auth: auth}))
|
2327
2420
|
end
|
2328
2421
|
# Sends <tt>SetHeartbeat</tt> request.
|
2329
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2422
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setheartbeat
|
2330
2423
|
# @param enable [Boolean] <tt>enable</tt> field
|
2331
2424
|
# @deprecated This type of request is deprecated.
|
2332
2425
|
# @return [Future<Responses::SetHeartbeat>]
|
@@ -2334,26 +2427,26 @@ module Request::Mixin
|
|
2334
2427
|
send_request(Requests::SetHeartbeat.new({enable: enable}))
|
2335
2428
|
end
|
2336
2429
|
# Sends <tt>SetFilenameFormatting</tt> request.
|
2337
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2430
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setfilenameformatting
|
2338
2431
|
# @param filename_formatting [String] <tt>filename-formatting</tt> field
|
2339
2432
|
# @return [Future<Responses::SetFilenameFormatting>]
|
2340
2433
|
def set_filename_formatting(filename_formatting:)
|
2341
2434
|
send_request(Requests::SetFilenameFormatting.new({filename_formatting: filename_formatting}))
|
2342
2435
|
end
|
2343
2436
|
# Sends <tt>GetFilenameFormatting</tt> request.
|
2344
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2437
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getfilenameformatting
|
2345
2438
|
# @return [Future<Responses::GetFilenameFormatting>]
|
2346
2439
|
def get_filename_formatting()
|
2347
2440
|
send_request(Requests::GetFilenameFormatting.new({}))
|
2348
2441
|
end
|
2349
2442
|
# Sends <tt>GetStats</tt> request.
|
2350
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2443
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstats
|
2351
2444
|
# @return [Future<Responses::GetStats>]
|
2352
2445
|
def get_stats()
|
2353
2446
|
send_request(Requests::GetStats.new({}))
|
2354
2447
|
end
|
2355
2448
|
# Sends <tt>BroadcastCustomMessage</tt> request.
|
2356
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2449
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#broadcastcustommessage
|
2357
2450
|
# @param realm [String] <tt>realm</tt> field
|
2358
2451
|
# @param data [Hash] <tt>data</tt> field
|
2359
2452
|
# @return [Future<Responses::BroadcastCustomMessage>]
|
@@ -2361,13 +2454,13 @@ module Request::Mixin
|
|
2361
2454
|
send_request(Requests::BroadcastCustomMessage.new({realm: realm, data: data}))
|
2362
2455
|
end
|
2363
2456
|
# Sends <tt>GetVideoInfo</tt> request.
|
2364
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2457
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvideoinfo
|
2365
2458
|
# @return [Future<Responses::GetVideoInfo>]
|
2366
2459
|
def get_video_info()
|
2367
2460
|
send_request(Requests::GetVideoInfo.new({}))
|
2368
2461
|
end
|
2369
2462
|
# Sends <tt>OpenProjector</tt> request.
|
2370
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2463
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#openprojector
|
2371
2464
|
# @param type [String, nil] <tt>type</tt> field
|
2372
2465
|
# @param monitor [Integer, nil] <tt>monitor</tt> field
|
2373
2466
|
# @param geometry [String, nil] <tt>geometry</tt> field
|
@@ -2377,14 +2470,14 @@ module Request::Mixin
|
|
2377
2470
|
send_request(Requests::OpenProjector.new({type: type, monitor: monitor, geometry: geometry, name: name}))
|
2378
2471
|
end
|
2379
2472
|
# Sends <tt>TriggerHotkeyByName</tt> request.
|
2380
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2473
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#triggerhotkeybyname
|
2381
2474
|
# @param hotkey_name [String] <tt>hotkeyName</tt> field
|
2382
2475
|
# @return [Future<Responses::TriggerHotkeyByName>]
|
2383
2476
|
def trigger_hotkey_by_name(hotkey_name:)
|
2384
2477
|
send_request(Requests::TriggerHotkeyByName.new({hotkey_name: hotkey_name}))
|
2385
2478
|
end
|
2386
2479
|
# Sends <tt>TriggerHotkeyBySequence</tt> request.
|
2387
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2480
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#triggerhotkeybysequence
|
2388
2481
|
# @param key_id [String] <tt>keyId</tt> field
|
2389
2482
|
# @param key_modifiers [Hash, nil] <tt>keyModifiers</tt> field
|
2390
2483
|
# @return [Future<Responses::TriggerHotkeyBySequence>]
|
@@ -2392,15 +2485,22 @@ module Request::Mixin
|
|
2392
2485
|
send_request(Requests::TriggerHotkeyBySequence.new({key_id: key_id, key_modifiers: key_modifiers}))
|
2393
2486
|
end
|
2394
2487
|
# Sends <tt>ExecuteBatch</tt> request.
|
2395
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2488
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#executebatch
|
2396
2489
|
# @param requests [Array<Hash>] <tt>requests</tt> field
|
2397
2490
|
# @param abort_on_fail [Boolean, nil] <tt>abortOnFail</tt> field
|
2398
2491
|
# @return [Future<Responses::ExecuteBatch>]
|
2399
2492
|
def execute_batch(requests:, abort_on_fail: nil)
|
2400
2493
|
send_request(Requests::ExecuteBatch.new({requests: requests, abort_on_fail: abort_on_fail}))
|
2401
2494
|
end
|
2495
|
+
# Sends <tt>Sleep</tt> request.
|
2496
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sleep
|
2497
|
+
# @param sleep_millis [Integer] <tt>sleepMillis</tt> field
|
2498
|
+
# @return [Future<Responses::Sleep>]
|
2499
|
+
def sleep(sleep_millis:)
|
2500
|
+
send_request(Requests::Sleep.new({sleep_millis: sleep_millis}))
|
2501
|
+
end
|
2402
2502
|
# Sends <tt>PlayPauseMedia</tt> request.
|
2403
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2503
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#playpausemedia
|
2404
2504
|
# @param source_name [String] <tt>sourceName</tt> field
|
2405
2505
|
# @param play_pause [Boolean] <tt>playPause</tt> field
|
2406
2506
|
# @return [Future<Responses::PlayPauseMedia>]
|
@@ -2408,49 +2508,49 @@ module Request::Mixin
|
|
2408
2508
|
send_request(Requests::PlayPauseMedia.new({source_name: source_name, play_pause: play_pause}))
|
2409
2509
|
end
|
2410
2510
|
# Sends <tt>RestartMedia</tt> request.
|
2411
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2511
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#restartmedia
|
2412
2512
|
# @param source_name [String] <tt>sourceName</tt> field
|
2413
2513
|
# @return [Future<Responses::RestartMedia>]
|
2414
2514
|
def restart_media(source_name:)
|
2415
2515
|
send_request(Requests::RestartMedia.new({source_name: source_name}))
|
2416
2516
|
end
|
2417
2517
|
# Sends <tt>StopMedia</tt> request.
|
2418
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2518
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopmedia
|
2419
2519
|
# @param source_name [String] <tt>sourceName</tt> field
|
2420
2520
|
# @return [Future<Responses::StopMedia>]
|
2421
2521
|
def stop_media(source_name:)
|
2422
2522
|
send_request(Requests::StopMedia.new({source_name: source_name}))
|
2423
2523
|
end
|
2424
2524
|
# Sends <tt>NextMedia</tt> request.
|
2425
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2525
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#nextmedia
|
2426
2526
|
# @param source_name [String] <tt>sourceName</tt> field
|
2427
2527
|
# @return [Future<Responses::NextMedia>]
|
2428
2528
|
def next_media(source_name:)
|
2429
2529
|
send_request(Requests::NextMedia.new({source_name: source_name}))
|
2430
2530
|
end
|
2431
2531
|
# Sends <tt>PreviousMedia</tt> request.
|
2432
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2532
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#previousmedia
|
2433
2533
|
# @param source_name [String] <tt>sourceName</tt> field
|
2434
2534
|
# @return [Future<Responses::PreviousMedia>]
|
2435
2535
|
def previous_media(source_name:)
|
2436
2536
|
send_request(Requests::PreviousMedia.new({source_name: source_name}))
|
2437
2537
|
end
|
2438
2538
|
# Sends <tt>GetMediaDuration</tt> request.
|
2439
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2539
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediaduration
|
2440
2540
|
# @param source_name [String] <tt>sourceName</tt> field
|
2441
2541
|
# @return [Future<Responses::GetMediaDuration>]
|
2442
2542
|
def get_media_duration(source_name:)
|
2443
2543
|
send_request(Requests::GetMediaDuration.new({source_name: source_name}))
|
2444
2544
|
end
|
2445
2545
|
# Sends <tt>GetMediaTime</tt> request.
|
2446
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2546
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediatime
|
2447
2547
|
# @param source_name [String] <tt>sourceName</tt> field
|
2448
2548
|
# @return [Future<Responses::GetMediaTime>]
|
2449
2549
|
def get_media_time(source_name:)
|
2450
2550
|
send_request(Requests::GetMediaTime.new({source_name: source_name}))
|
2451
2551
|
end
|
2452
2552
|
# Sends <tt>SetMediaTime</tt> request.
|
2453
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2553
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setmediatime
|
2454
2554
|
# @param source_name [String] <tt>sourceName</tt> field
|
2455
2555
|
# @param timestamp [Integer] <tt>timestamp</tt> field
|
2456
2556
|
# @return [Future<Responses::SetMediaTime>]
|
@@ -2458,7 +2558,7 @@ module Request::Mixin
|
|
2458
2558
|
send_request(Requests::SetMediaTime.new({source_name: source_name, timestamp: timestamp}))
|
2459
2559
|
end
|
2460
2560
|
# Sends <tt>ScrubMedia</tt> request.
|
2461
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2561
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#scrubmedia
|
2462
2562
|
# @param source_name [String] <tt>sourceName</tt> field
|
2463
2563
|
# @param time_offset [Integer] <tt>timeOffset</tt> field
|
2464
2564
|
# @return [Future<Responses::ScrubMedia>]
|
@@ -2466,20 +2566,20 @@ module Request::Mixin
|
|
2466
2566
|
send_request(Requests::ScrubMedia.new({source_name: source_name, time_offset: time_offset}))
|
2467
2567
|
end
|
2468
2568
|
# Sends <tt>GetMediaState</tt> request.
|
2469
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2569
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediastate
|
2470
2570
|
# @param source_name [String] <tt>sourceName</tt> field
|
2471
2571
|
# @return [Future<Responses::GetMediaState>]
|
2472
2572
|
def get_media_state(source_name:)
|
2473
2573
|
send_request(Requests::GetMediaState.new({source_name: source_name}))
|
2474
2574
|
end
|
2475
2575
|
# Sends <tt>GetMediaSourcesList</tt> request.
|
2476
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2576
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediasourceslist
|
2477
2577
|
# @return [Future<Responses::GetMediaSourcesList>]
|
2478
2578
|
def get_media_sources_list()
|
2479
2579
|
send_request(Requests::GetMediaSourcesList.new({}))
|
2480
2580
|
end
|
2481
2581
|
# Sends <tt>CreateSource</tt> request.
|
2482
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2582
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#createsource
|
2483
2583
|
# @param source_name [String] <tt>sourceName</tt> field
|
2484
2584
|
# @param source_kind [String] <tt>sourceKind</tt> field
|
2485
2585
|
# @param scene_name [String] <tt>sceneName</tt> field
|
@@ -2490,19 +2590,19 @@ module Request::Mixin
|
|
2490
2590
|
send_request(Requests::CreateSource.new({source_name: source_name, source_kind: source_kind, scene_name: scene_name, source_settings: source_settings, set_visible: set_visible}))
|
2491
2591
|
end
|
2492
2592
|
# Sends <tt>GetSourcesList</tt> request.
|
2493
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2593
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourceslist
|
2494
2594
|
# @return [Future<Responses::GetSourcesList>]
|
2495
2595
|
def get_sources_list()
|
2496
2596
|
send_request(Requests::GetSourcesList.new({}))
|
2497
2597
|
end
|
2498
2598
|
# Sends <tt>GetSourceTypesList</tt> request.
|
2499
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2599
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcetypeslist
|
2500
2600
|
# @return [Future<Responses::GetSourceTypesList>]
|
2501
2601
|
def get_source_types_list()
|
2502
2602
|
send_request(Requests::GetSourceTypesList.new({}))
|
2503
2603
|
end
|
2504
2604
|
# Sends <tt>GetVolume</tt> request.
|
2505
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2605
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvolume
|
2506
2606
|
# @param source [String] <tt>source</tt> field
|
2507
2607
|
# @param use_decibel [Boolean, nil] <tt>useDecibel</tt> field
|
2508
2608
|
# @return [Future<Responses::GetVolume>]
|
@@ -2510,7 +2610,7 @@ module Request::Mixin
|
|
2510
2610
|
send_request(Requests::GetVolume.new({source: source, use_decibel: use_decibel}))
|
2511
2611
|
end
|
2512
2612
|
# Sends <tt>SetVolume</tt> request.
|
2513
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2613
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setvolume
|
2514
2614
|
# @param source [String] <tt>source</tt> field
|
2515
2615
|
# @param volume [Float] <tt>volume</tt> field
|
2516
2616
|
# @param use_decibel [Boolean, nil] <tt>useDecibel</tt> field
|
@@ -2518,15 +2618,31 @@ module Request::Mixin
|
|
2518
2618
|
def set_volume(source:, volume:, use_decibel: nil)
|
2519
2619
|
send_request(Requests::SetVolume.new({source: source, volume: volume, use_decibel: use_decibel}))
|
2520
2620
|
end
|
2621
|
+
# Sends <tt>SetTracks</tt> request.
|
2622
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settracks
|
2623
|
+
# @param source_name [String] <tt>sourceName</tt> field
|
2624
|
+
# @param track [Integer] <tt>track</tt> field
|
2625
|
+
# @param active [Boolean] <tt>active</tt> field
|
2626
|
+
# @return [Future<Responses::SetTracks>]
|
2627
|
+
def set_tracks(source_name:, track:, active:)
|
2628
|
+
send_request(Requests::SetTracks.new({source_name: source_name, track: track, active: active}))
|
2629
|
+
end
|
2630
|
+
# Sends <tt>GetTracks</tt> request.
|
2631
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettracks
|
2632
|
+
# @param source_name [String] <tt>sourceName</tt> field
|
2633
|
+
# @return [Future<Responses::GetTracks>]
|
2634
|
+
def get_tracks(source_name:)
|
2635
|
+
send_request(Requests::GetTracks.new({source_name: source_name}))
|
2636
|
+
end
|
2521
2637
|
# Sends <tt>GetMute</tt> request.
|
2522
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2638
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmute
|
2523
2639
|
# @param source [String] <tt>source</tt> field
|
2524
2640
|
# @return [Future<Responses::GetMute>]
|
2525
2641
|
def get_mute(source:)
|
2526
2642
|
send_request(Requests::GetMute.new({source: source}))
|
2527
2643
|
end
|
2528
2644
|
# Sends <tt>SetMute</tt> request.
|
2529
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2645
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setmute
|
2530
2646
|
# @param source [String] <tt>source</tt> field
|
2531
2647
|
# @param mute [Boolean] <tt>mute</tt> field
|
2532
2648
|
# @return [Future<Responses::SetMute>]
|
@@ -2534,21 +2650,28 @@ module Request::Mixin
|
|
2534
2650
|
send_request(Requests::SetMute.new({source: source, mute: mute}))
|
2535
2651
|
end
|
2536
2652
|
# Sends <tt>ToggleMute</tt> request.
|
2537
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2653
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#togglemute
|
2538
2654
|
# @param source [String] <tt>source</tt> field
|
2539
2655
|
# @return [Future<Responses::ToggleMute>]
|
2540
2656
|
def toggle_mute(source:)
|
2541
2657
|
send_request(Requests::ToggleMute.new({source: source}))
|
2542
2658
|
end
|
2659
|
+
# Sends <tt>GetSourceActive</tt> request.
|
2660
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourceactive
|
2661
|
+
# @param source_name [String] <tt>sourceName</tt> field
|
2662
|
+
# @return [Future<Responses::GetSourceActive>]
|
2663
|
+
def get_source_active(source_name:)
|
2664
|
+
send_request(Requests::GetSourceActive.new({source_name: source_name}))
|
2665
|
+
end
|
2543
2666
|
# Sends <tt>GetAudioActive</tt> request.
|
2544
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2667
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getaudioactive
|
2545
2668
|
# @param source_name [String] <tt>sourceName</tt> field
|
2546
2669
|
# @return [Future<Responses::GetAudioActive>]
|
2547
2670
|
def get_audio_active(source_name:)
|
2548
2671
|
send_request(Requests::GetAudioActive.new({source_name: source_name}))
|
2549
2672
|
end
|
2550
2673
|
# Sends <tt>SetSourceName</tt> request.
|
2551
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2674
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcename
|
2552
2675
|
# @param source_name [String] <tt>sourceName</tt> field
|
2553
2676
|
# @param new_name [String] <tt>newName</tt> field
|
2554
2677
|
# @return [Future<Responses::SetSourceName>]
|
@@ -2556,7 +2679,7 @@ module Request::Mixin
|
|
2556
2679
|
send_request(Requests::SetSourceName.new({source_name: source_name, new_name: new_name}))
|
2557
2680
|
end
|
2558
2681
|
# Sends <tt>SetSyncOffset</tt> request.
|
2559
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2682
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsyncoffset
|
2560
2683
|
# @param source [String] <tt>source</tt> field
|
2561
2684
|
# @param offset [Integer] <tt>offset</tt> field
|
2562
2685
|
# @return [Future<Responses::SetSyncOffset>]
|
@@ -2564,14 +2687,14 @@ module Request::Mixin
|
|
2564
2687
|
send_request(Requests::SetSyncOffset.new({source: source, offset: offset}))
|
2565
2688
|
end
|
2566
2689
|
# Sends <tt>GetSyncOffset</tt> request.
|
2567
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2690
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsyncoffset
|
2568
2691
|
# @param source [String] <tt>source</tt> field
|
2569
2692
|
# @return [Future<Responses::GetSyncOffset>]
|
2570
2693
|
def get_sync_offset(source:)
|
2571
2694
|
send_request(Requests::GetSyncOffset.new({source: source}))
|
2572
2695
|
end
|
2573
2696
|
# Sends <tt>GetSourceSettings</tt> request.
|
2574
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2697
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcesettings
|
2575
2698
|
# @param source_name [String] <tt>sourceName</tt> field
|
2576
2699
|
# @param source_type [String, nil] <tt>sourceType</tt> field
|
2577
2700
|
# @return [Future<Responses::GetSourceSettings>]
|
@@ -2579,7 +2702,7 @@ module Request::Mixin
|
|
2579
2702
|
send_request(Requests::GetSourceSettings.new({source_name: source_name, source_type: source_type}))
|
2580
2703
|
end
|
2581
2704
|
# Sends <tt>SetSourceSettings</tt> request.
|
2582
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2705
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcesettings
|
2583
2706
|
# @param source_name [String] <tt>sourceName</tt> field
|
2584
2707
|
# @param source_type [String, nil] <tt>sourceType</tt> field
|
2585
2708
|
# @param source_settings [Hash] <tt>sourceSettings</tt> field
|
@@ -2588,14 +2711,14 @@ module Request::Mixin
|
|
2588
2711
|
send_request(Requests::SetSourceSettings.new({source_name: source_name, source_type: source_type, source_settings: source_settings}))
|
2589
2712
|
end
|
2590
2713
|
# Sends <tt>GetTextGDIPlusProperties</tt> request.
|
2591
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2714
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettextgdiplusproperties
|
2592
2715
|
# @param source [String] <tt>source</tt> field
|
2593
2716
|
# @return [Future<Responses::GetTextGDIPlusProperties>]
|
2594
2717
|
def get_text_gdi_plus_properties(source:)
|
2595
2718
|
send_request(Requests::GetTextGDIPlusProperties.new({source: source}))
|
2596
2719
|
end
|
2597
2720
|
# Sends <tt>SetTextGDIPlusProperties</tt> request.
|
2598
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2721
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settextgdiplusproperties
|
2599
2722
|
# @param source [String] <tt>source</tt> field
|
2600
2723
|
# @param align [String, nil] <tt>align</tt> field
|
2601
2724
|
# @param bk_color [Integer, nil] <tt>bk_color</tt> field
|
@@ -2626,14 +2749,14 @@ module Request::Mixin
|
|
2626
2749
|
send_request(Requests::SetTextGDIPlusProperties.new({source: source, align: align, bk_color: bk_color, bk_opacity: bk_opacity, chatlog: chatlog, chatlog_lines: chatlog_lines, color: color, extents: extents, extents_cx: extents_cx, extents_cy: extents_cy, file: file, read_from_file: read_from_file, font: font, gradient: gradient, gradient_color: gradient_color, gradient_dir: gradient_dir, gradient_opacity: gradient_opacity, outline: outline, outline_color: outline_color, outline_size: outline_size, outline_opacity: outline_opacity, text: text, valign: valign, vertical: vertical, render: render}))
|
2627
2750
|
end
|
2628
2751
|
# Sends <tt>GetTextFreetype2Properties</tt> request.
|
2629
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2752
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettextfreetype2properties
|
2630
2753
|
# @param source [String] <tt>source</tt> field
|
2631
2754
|
# @return [Future<Responses::GetTextFreetype2Properties>]
|
2632
2755
|
def get_text_freetype2_properties(source:)
|
2633
2756
|
send_request(Requests::GetTextFreetype2Properties.new({source: source}))
|
2634
2757
|
end
|
2635
2758
|
# Sends <tt>SetTextFreetype2Properties</tt> request.
|
2636
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2759
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settextfreetype2properties
|
2637
2760
|
# @param source [String] <tt>source</tt> field
|
2638
2761
|
# @param color1 [Integer, nil] <tt>color1</tt> field
|
2639
2762
|
# @param color2 [Integer, nil] <tt>color2</tt> field
|
@@ -2651,7 +2774,7 @@ module Request::Mixin
|
|
2651
2774
|
send_request(Requests::SetTextFreetype2Properties.new({source: source, color1: color1, color2: color2, custom_width: custom_width, drop_shadow: drop_shadow, font: font, from_file: from_file, log_mode: log_mode, outline: outline, text: text, text_file: text_file, word_wrap: word_wrap}))
|
2652
2775
|
end
|
2653
2776
|
# Sends <tt>GetBrowserSourceProperties</tt> request.
|
2654
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2777
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getbrowsersourceproperties
|
2655
2778
|
# @param source [String] <tt>source</tt> field
|
2656
2779
|
# @deprecated This type of request is deprecated.
|
2657
2780
|
# @return [Future<Responses::GetBrowserSourceProperties>]
|
@@ -2659,7 +2782,7 @@ module Request::Mixin
|
|
2659
2782
|
send_request(Requests::GetBrowserSourceProperties.new({source: source}))
|
2660
2783
|
end
|
2661
2784
|
# Sends <tt>SetBrowserSourceProperties</tt> request.
|
2662
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2785
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setbrowsersourceproperties
|
2663
2786
|
# @param source [String] <tt>source</tt> field
|
2664
2787
|
# @param is_local_file [Boolean, nil] <tt>is_local_file</tt> field
|
2665
2788
|
# @param local_file [String, nil] <tt>local_file</tt> field
|
@@ -2676,20 +2799,20 @@ module Request::Mixin
|
|
2676
2799
|
send_request(Requests::SetBrowserSourceProperties.new({source: source, is_local_file: is_local_file, local_file: local_file, url: url, css: css, width: width, height: height, fps: fps, shutdown: shutdown, render: render}))
|
2677
2800
|
end
|
2678
2801
|
# Sends <tt>GetSpecialSources</tt> request.
|
2679
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2802
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getspecialsources
|
2680
2803
|
# @return [Future<Responses::GetSpecialSources>]
|
2681
2804
|
def get_special_sources()
|
2682
2805
|
send_request(Requests::GetSpecialSources.new({}))
|
2683
2806
|
end
|
2684
2807
|
# Sends <tt>GetSourceFilters</tt> request.
|
2685
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2808
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcefilters
|
2686
2809
|
# @param source_name [String] <tt>sourceName</tt> field
|
2687
2810
|
# @return [Future<Responses::GetSourceFilters>]
|
2688
2811
|
def get_source_filters(source_name:)
|
2689
2812
|
send_request(Requests::GetSourceFilters.new({source_name: source_name}))
|
2690
2813
|
end
|
2691
2814
|
# Sends <tt>GetSourceFilterInfo</tt> request.
|
2692
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2815
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcefilterinfo
|
2693
2816
|
# @param source_name [String] <tt>sourceName</tt> field
|
2694
2817
|
# @param filter_name [String] <tt>filterName</tt> field
|
2695
2818
|
# @return [Future<Responses::GetSourceFilterInfo>]
|
@@ -2697,7 +2820,7 @@ module Request::Mixin
|
|
2697
2820
|
send_request(Requests::GetSourceFilterInfo.new({source_name: source_name, filter_name: filter_name}))
|
2698
2821
|
end
|
2699
2822
|
# Sends <tt>AddFilterToSource</tt> request.
|
2700
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2823
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#addfiltertosource
|
2701
2824
|
# @param source_name [String] <tt>sourceName</tt> field
|
2702
2825
|
# @param filter_name [String] <tt>filterName</tt> field
|
2703
2826
|
# @param filter_type [String] <tt>filterType</tt> field
|
@@ -2707,7 +2830,7 @@ module Request::Mixin
|
|
2707
2830
|
send_request(Requests::AddFilterToSource.new({source_name: source_name, filter_name: filter_name, filter_type: filter_type, filter_settings: filter_settings}))
|
2708
2831
|
end
|
2709
2832
|
# Sends <tt>RemoveFilterFromSource</tt> request.
|
2710
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2833
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#removefilterfromsource
|
2711
2834
|
# @param source_name [String] <tt>sourceName</tt> field
|
2712
2835
|
# @param filter_name [String] <tt>filterName</tt> field
|
2713
2836
|
# @return [Future<Responses::RemoveFilterFromSource>]
|
@@ -2715,7 +2838,7 @@ module Request::Mixin
|
|
2715
2838
|
send_request(Requests::RemoveFilterFromSource.new({source_name: source_name, filter_name: filter_name}))
|
2716
2839
|
end
|
2717
2840
|
# Sends <tt>ReorderSourceFilter</tt> request.
|
2718
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2841
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#reordersourcefilter
|
2719
2842
|
# @param source_name [String] <tt>sourceName</tt> field
|
2720
2843
|
# @param filter_name [String] <tt>filterName</tt> field
|
2721
2844
|
# @param new_index [Integer] <tt>newIndex</tt> field
|
@@ -2724,7 +2847,7 @@ module Request::Mixin
|
|
2724
2847
|
send_request(Requests::ReorderSourceFilter.new({source_name: source_name, filter_name: filter_name, new_index: new_index}))
|
2725
2848
|
end
|
2726
2849
|
# Sends <tt>MoveSourceFilter</tt> request.
|
2727
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2850
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#movesourcefilter
|
2728
2851
|
# @param source_name [String] <tt>sourceName</tt> field
|
2729
2852
|
# @param filter_name [String] <tt>filterName</tt> field
|
2730
2853
|
# @param movement_type [String] <tt>movementType</tt> field
|
@@ -2733,7 +2856,7 @@ module Request::Mixin
|
|
2733
2856
|
send_request(Requests::MoveSourceFilter.new({source_name: source_name, filter_name: filter_name, movement_type: movement_type}))
|
2734
2857
|
end
|
2735
2858
|
# Sends <tt>SetSourceFilterSettings</tt> request.
|
2736
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2859
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcefiltersettings
|
2737
2860
|
# @param source_name [String] <tt>sourceName</tt> field
|
2738
2861
|
# @param filter_name [String] <tt>filterName</tt> field
|
2739
2862
|
# @param filter_settings [Hash] <tt>filterSettings</tt> field
|
@@ -2742,7 +2865,7 @@ module Request::Mixin
|
|
2742
2865
|
send_request(Requests::SetSourceFilterSettings.new({source_name: source_name, filter_name: filter_name, filter_settings: filter_settings}))
|
2743
2866
|
end
|
2744
2867
|
# Sends <tt>SetSourceFilterVisibility</tt> request.
|
2745
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2868
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcefiltervisibility
|
2746
2869
|
# @param source_name [String] <tt>sourceName</tt> field
|
2747
2870
|
# @param filter_name [String] <tt>filterName</tt> field
|
2748
2871
|
# @param filter_enabled [Boolean] <tt>filterEnabled</tt> field
|
@@ -2751,14 +2874,14 @@ module Request::Mixin
|
|
2751
2874
|
send_request(Requests::SetSourceFilterVisibility.new({source_name: source_name, filter_name: filter_name, filter_enabled: filter_enabled}))
|
2752
2875
|
end
|
2753
2876
|
# Sends <tt>GetAudioMonitorType</tt> request.
|
2754
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2877
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getaudiomonitortype
|
2755
2878
|
# @param source_name [String] <tt>sourceName</tt> field
|
2756
2879
|
# @return [Future<Responses::GetAudioMonitorType>]
|
2757
2880
|
def get_audio_monitor_type(source_name:)
|
2758
2881
|
send_request(Requests::GetAudioMonitorType.new({source_name: source_name}))
|
2759
2882
|
end
|
2760
2883
|
# Sends <tt>SetAudioMonitorType</tt> request.
|
2761
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2884
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setaudiomonitortype
|
2762
2885
|
# @param source_name [String] <tt>sourceName</tt> field
|
2763
2886
|
# @param monitor_type [String] <tt>monitorType</tt> field
|
2764
2887
|
# @return [Future<Responses::SetAudioMonitorType>]
|
@@ -2766,14 +2889,14 @@ module Request::Mixin
|
|
2766
2889
|
send_request(Requests::SetAudioMonitorType.new({source_name: source_name, monitor_type: monitor_type}))
|
2767
2890
|
end
|
2768
2891
|
# Sends <tt>GetSourceDefaultSettings</tt> request.
|
2769
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2892
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcedefaultsettings
|
2770
2893
|
# @param source_kind [String] <tt>sourceKind</tt> field
|
2771
2894
|
# @return [Future<Responses::GetSourceDefaultSettings>]
|
2772
2895
|
def get_source_default_settings(source_kind:)
|
2773
2896
|
send_request(Requests::GetSourceDefaultSettings.new({source_kind: source_kind}))
|
2774
2897
|
end
|
2775
2898
|
# Sends <tt>TakeSourceScreenshot</tt> request.
|
2776
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2899
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#takesourcescreenshot
|
2777
2900
|
# @param source_name [String, nil] <tt>sourceName</tt> field
|
2778
2901
|
# @param embed_picture_format [String, nil] <tt>embedPictureFormat</tt> field
|
2779
2902
|
# @param save_to_file_path [String, nil] <tt>saveToFilePath</tt> field
|
@@ -2786,34 +2909,34 @@ module Request::Mixin
|
|
2786
2909
|
send_request(Requests::TakeSourceScreenshot.new({source_name: source_name, embed_picture_format: embed_picture_format, save_to_file_path: save_to_file_path, file_format: file_format, compression_quality: compression_quality, width: width, height: height}))
|
2787
2910
|
end
|
2788
2911
|
# Sends <tt>RefreshBrowserSource</tt> request.
|
2789
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2912
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#refreshbrowsersource
|
2790
2913
|
# @param source_name [String] <tt>sourceName</tt> field
|
2791
2914
|
# @return [Future<Responses::RefreshBrowserSource>]
|
2792
2915
|
def refresh_browser_source(source_name:)
|
2793
2916
|
send_request(Requests::RefreshBrowserSource.new({source_name: source_name}))
|
2794
2917
|
end
|
2795
2918
|
# Sends <tt>ListOutputs</tt> request.
|
2796
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2919
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listoutputs
|
2797
2920
|
# @return [Future<Responses::ListOutputs>]
|
2798
2921
|
def list_outputs()
|
2799
2922
|
send_request(Requests::ListOutputs.new({}))
|
2800
2923
|
end
|
2801
2924
|
# Sends <tt>GetOutputInfo</tt> request.
|
2802
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2925
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getoutputinfo
|
2803
2926
|
# @param output_name [String] <tt>outputName</tt> field
|
2804
2927
|
# @return [Future<Responses::GetOutputInfo>]
|
2805
2928
|
def get_output_info(output_name:)
|
2806
2929
|
send_request(Requests::GetOutputInfo.new({output_name: output_name}))
|
2807
2930
|
end
|
2808
2931
|
# Sends <tt>StartOutput</tt> request.
|
2809
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2932
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startoutput
|
2810
2933
|
# @param output_name [String] <tt>outputName</tt> field
|
2811
2934
|
# @return [Future<Responses::StartOutput>]
|
2812
2935
|
def start_output(output_name:)
|
2813
2936
|
send_request(Requests::StartOutput.new({output_name: output_name}))
|
2814
2937
|
end
|
2815
2938
|
# Sends <tt>StopOutput</tt> request.
|
2816
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2939
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopoutput
|
2817
2940
|
# @param output_name [String] <tt>outputName</tt> field
|
2818
2941
|
# @param force [Boolean, nil] <tt>force</tt> field
|
2819
2942
|
# @return [Future<Responses::StopOutput>]
|
@@ -2821,131 +2944,131 @@ module Request::Mixin
|
|
2821
2944
|
send_request(Requests::StopOutput.new({output_name: output_name, force: force}))
|
2822
2945
|
end
|
2823
2946
|
# Sends <tt>SetCurrentProfile</tt> request.
|
2824
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2947
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentprofile
|
2825
2948
|
# @param profile_name [String] <tt>profile-name</tt> field
|
2826
2949
|
# @return [Future<Responses::SetCurrentProfile>]
|
2827
2950
|
def set_current_profile(profile_name:)
|
2828
2951
|
send_request(Requests::SetCurrentProfile.new({profile_name: profile_name}))
|
2829
2952
|
end
|
2830
2953
|
# Sends <tt>GetCurrentProfile</tt> request.
|
2831
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2954
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentprofile
|
2832
2955
|
# @return [Future<Responses::GetCurrentProfile>]
|
2833
2956
|
def get_current_profile()
|
2834
2957
|
send_request(Requests::GetCurrentProfile.new({}))
|
2835
2958
|
end
|
2836
2959
|
# Sends <tt>ListProfiles</tt> request.
|
2837
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2960
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listprofiles
|
2838
2961
|
# @return [Future<Responses::ListProfiles>]
|
2839
2962
|
def list_profiles()
|
2840
2963
|
send_request(Requests::ListProfiles.new({}))
|
2841
2964
|
end
|
2842
2965
|
# Sends <tt>GetRecordingStatus</tt> request.
|
2843
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2966
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getrecordingstatus
|
2844
2967
|
# @return [Future<Responses::GetRecordingStatus>]
|
2845
2968
|
def get_recording_status()
|
2846
2969
|
send_request(Requests::GetRecordingStatus.new({}))
|
2847
2970
|
end
|
2848
2971
|
# Sends <tt>StartStopRecording</tt> request.
|
2849
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2972
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstoprecording
|
2850
2973
|
# @return [Future<Responses::StartStopRecording>]
|
2851
2974
|
def start_stop_recording()
|
2852
2975
|
send_request(Requests::StartStopRecording.new({}))
|
2853
2976
|
end
|
2854
2977
|
# Sends <tt>StartRecording</tt> request.
|
2855
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2978
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startrecording
|
2856
2979
|
# @return [Future<Responses::StartRecording>]
|
2857
2980
|
def start_recording()
|
2858
2981
|
send_request(Requests::StartRecording.new({}))
|
2859
2982
|
end
|
2860
2983
|
# Sends <tt>StopRecording</tt> request.
|
2861
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2984
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stoprecording
|
2862
2985
|
# @return [Future<Responses::StopRecording>]
|
2863
2986
|
def stop_recording()
|
2864
2987
|
send_request(Requests::StopRecording.new({}))
|
2865
2988
|
end
|
2866
2989
|
# Sends <tt>PauseRecording</tt> request.
|
2867
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2990
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#pauserecording
|
2868
2991
|
# @return [Future<Responses::PauseRecording>]
|
2869
2992
|
def pause_recording()
|
2870
2993
|
send_request(Requests::PauseRecording.new({}))
|
2871
2994
|
end
|
2872
2995
|
# Sends <tt>ResumeRecording</tt> request.
|
2873
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
2996
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#resumerecording
|
2874
2997
|
# @return [Future<Responses::ResumeRecording>]
|
2875
2998
|
def resume_recording()
|
2876
2999
|
send_request(Requests::ResumeRecording.new({}))
|
2877
3000
|
end
|
2878
3001
|
# Sends <tt>SetRecordingFolder</tt> request.
|
2879
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3002
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setrecordingfolder
|
2880
3003
|
# @param rec_folder [String] <tt>rec-folder</tt> field
|
2881
3004
|
# @return [Future<Responses::SetRecordingFolder>]
|
2882
3005
|
def set_recording_folder(rec_folder:)
|
2883
3006
|
send_request(Requests::SetRecordingFolder.new({rec_folder: rec_folder}))
|
2884
3007
|
end
|
2885
3008
|
# Sends <tt>GetRecordingFolder</tt> request.
|
2886
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3009
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getrecordingfolder
|
2887
3010
|
# @return [Future<Responses::GetRecordingFolder>]
|
2888
3011
|
def get_recording_folder()
|
2889
3012
|
send_request(Requests::GetRecordingFolder.new({}))
|
2890
3013
|
end
|
2891
3014
|
# Sends <tt>GetReplayBufferStatus</tt> request.
|
2892
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3015
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getreplaybufferstatus
|
2893
3016
|
# @return [Future<Responses::GetReplayBufferStatus>]
|
2894
3017
|
def get_replay_buffer_status()
|
2895
3018
|
send_request(Requests::GetReplayBufferStatus.new({}))
|
2896
3019
|
end
|
2897
3020
|
# Sends <tt>StartStopReplayBuffer</tt> request.
|
2898
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3021
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopreplaybuffer
|
2899
3022
|
# @return [Future<Responses::StartStopReplayBuffer>]
|
2900
3023
|
def start_stop_replay_buffer()
|
2901
3024
|
send_request(Requests::StartStopReplayBuffer.new({}))
|
2902
3025
|
end
|
2903
3026
|
# Sends <tt>StartReplayBuffer</tt> request.
|
2904
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3027
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startreplaybuffer
|
2905
3028
|
# @return [Future<Responses::StartReplayBuffer>]
|
2906
3029
|
def start_replay_buffer()
|
2907
3030
|
send_request(Requests::StartReplayBuffer.new({}))
|
2908
3031
|
end
|
2909
3032
|
# Sends <tt>StopReplayBuffer</tt> request.
|
2910
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3033
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopreplaybuffer
|
2911
3034
|
# @return [Future<Responses::StopReplayBuffer>]
|
2912
3035
|
def stop_replay_buffer()
|
2913
3036
|
send_request(Requests::StopReplayBuffer.new({}))
|
2914
3037
|
end
|
2915
3038
|
# Sends <tt>SaveReplayBuffer</tt> request.
|
2916
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3039
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#savereplaybuffer
|
2917
3040
|
# @return [Future<Responses::SaveReplayBuffer>]
|
2918
3041
|
def save_replay_buffer()
|
2919
3042
|
send_request(Requests::SaveReplayBuffer.new({}))
|
2920
3043
|
end
|
2921
3044
|
# Sends <tt>SetCurrentSceneCollection</tt> request.
|
2922
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3045
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentscenecollection
|
2923
3046
|
# @param sc_name [String] <tt>sc-name</tt> field
|
2924
3047
|
# @return [Future<Responses::SetCurrentSceneCollection>]
|
2925
3048
|
def set_current_scene_collection(sc_name:)
|
2926
3049
|
send_request(Requests::SetCurrentSceneCollection.new({sc_name: sc_name}))
|
2927
3050
|
end
|
2928
3051
|
# Sends <tt>GetCurrentSceneCollection</tt> request.
|
2929
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3052
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentscenecollection
|
2930
3053
|
# @return [Future<Responses::GetCurrentSceneCollection>]
|
2931
3054
|
def get_current_scene_collection()
|
2932
3055
|
send_request(Requests::GetCurrentSceneCollection.new({}))
|
2933
3056
|
end
|
2934
3057
|
# Sends <tt>ListSceneCollections</tt> request.
|
2935
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3058
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listscenecollections
|
2936
3059
|
# @return [Future<Responses::ListSceneCollections>]
|
2937
3060
|
def list_scene_collections()
|
2938
3061
|
send_request(Requests::ListSceneCollections.new({}))
|
2939
3062
|
end
|
2940
3063
|
# Sends <tt>GetSceneItemList</tt> request.
|
2941
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3064
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsceneitemlist
|
2942
3065
|
# @param scene_name [String, nil] <tt>sceneName</tt> field
|
2943
3066
|
# @return [Future<Responses::GetSceneItemList>]
|
2944
3067
|
def get_scene_item_list(scene_name: nil)
|
2945
3068
|
send_request(Requests::GetSceneItemList.new({scene_name: scene_name}))
|
2946
3069
|
end
|
2947
3070
|
# Sends <tt>GetSceneItemProperties</tt> request.
|
2948
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3071
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsceneitemproperties
|
2949
3072
|
# @param scene_name [String, nil] <tt>scene-name</tt> field
|
2950
3073
|
# @param item [String, Object] <tt>item</tt> field
|
2951
3074
|
# @return [Future<Responses::GetSceneItemProperties>]
|
@@ -2953,7 +3076,7 @@ module Request::Mixin
|
|
2953
3076
|
send_request(Requests::GetSceneItemProperties.new({scene_name: scene_name, item: item}))
|
2954
3077
|
end
|
2955
3078
|
# Sends <tt>SetSceneItemProperties</tt> request.
|
2956
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3079
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemproperties
|
2957
3080
|
# @param scene_name [String, nil] <tt>scene-name</tt> field
|
2958
3081
|
# @param item [String, Object] <tt>item</tt> field
|
2959
3082
|
# @param position [Hash] <tt>position</tt> field
|
@@ -2968,7 +3091,7 @@ module Request::Mixin
|
|
2968
3091
|
send_request(Requests::SetSceneItemProperties.new({scene_name: scene_name, item: item, position: position, rotation: rotation, scale: scale, crop: crop, visible: visible, locked: locked, bounds: bounds}))
|
2969
3092
|
end
|
2970
3093
|
# Sends <tt>ResetSceneItem</tt> request.
|
2971
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3094
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#resetsceneitem
|
2972
3095
|
# @param scene_name [String, nil] <tt>scene-name</tt> field
|
2973
3096
|
# @param item [String, Object] <tt>item</tt> field
|
2974
3097
|
# @return [Future<Responses::ResetSceneItem>]
|
@@ -2976,7 +3099,7 @@ module Request::Mixin
|
|
2976
3099
|
send_request(Requests::ResetSceneItem.new({scene_name: scene_name, item: item}))
|
2977
3100
|
end
|
2978
3101
|
# Sends <tt>SetSceneItemRender</tt> request.
|
2979
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3102
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemrender
|
2980
3103
|
# @param scene_name [String, nil] <tt>scene-name</tt> field
|
2981
3104
|
# @param source [String, nil] <tt>source</tt> field
|
2982
3105
|
# @param item [Integer, nil] <tt>item</tt> field
|
@@ -2986,7 +3109,7 @@ module Request::Mixin
|
|
2986
3109
|
send_request(Requests::SetSceneItemRender.new({scene_name: scene_name, source: source, item: item, render: render}))
|
2987
3110
|
end
|
2988
3111
|
# Sends <tt>SetSceneItemPosition</tt> request.
|
2989
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3112
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemposition
|
2990
3113
|
# @param scene_name [String, nil] <tt>scene-name</tt> field
|
2991
3114
|
# @param item [String] <tt>item</tt> field
|
2992
3115
|
# @param x [Float] <tt>x</tt> field
|
@@ -2997,7 +3120,7 @@ module Request::Mixin
|
|
2997
3120
|
send_request(Requests::SetSceneItemPosition.new({scene_name: scene_name, item: item, x: x, y: y}))
|
2998
3121
|
end
|
2999
3122
|
# Sends <tt>SetSceneItemTransform</tt> request.
|
3000
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3123
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemtransform
|
3001
3124
|
# @param scene_name [String, nil] <tt>scene-name</tt> field
|
3002
3125
|
# @param item [String] <tt>item</tt> field
|
3003
3126
|
# @param x_scale [Float] <tt>x-scale</tt> field
|
@@ -3009,7 +3132,7 @@ module Request::Mixin
|
|
3009
3132
|
send_request(Requests::SetSceneItemTransform.new({scene_name: scene_name, item: item, x_scale: x_scale, y_scale: y_scale, rotation: rotation}))
|
3010
3133
|
end
|
3011
3134
|
# Sends <tt>SetSceneItemCrop</tt> request.
|
3012
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3135
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemcrop
|
3013
3136
|
# @param scene_name [String, nil] <tt>scene-name</tt> field
|
3014
3137
|
# @param item [String] <tt>item</tt> field
|
3015
3138
|
# @param top [Integer] <tt>top</tt> field
|
@@ -3022,7 +3145,7 @@ module Request::Mixin
|
|
3022
3145
|
send_request(Requests::SetSceneItemCrop.new({scene_name: scene_name, item: item, top: top, bottom: bottom, left: left, right: right}))
|
3023
3146
|
end
|
3024
3147
|
# Sends <tt>DeleteSceneItem</tt> request.
|
3025
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3148
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#deletesceneitem
|
3026
3149
|
# @param scene [String, nil] <tt>scene</tt> field
|
3027
3150
|
# @param item [Hash] <tt>item</tt> field
|
3028
3151
|
# @return [Future<Responses::DeleteSceneItem>]
|
@@ -3030,16 +3153,16 @@ module Request::Mixin
|
|
3030
3153
|
send_request(Requests::DeleteSceneItem.new({scene: scene, item: item}))
|
3031
3154
|
end
|
3032
3155
|
# Sends <tt>AddSceneItem</tt> request.
|
3033
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3156
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#addsceneitem
|
3034
3157
|
# @param scene_name [String] <tt>sceneName</tt> field
|
3035
3158
|
# @param source_name [String] <tt>sourceName</tt> field
|
3036
|
-
# @param set_visible [Boolean] <tt>setVisible</tt> field
|
3159
|
+
# @param set_visible [Boolean, nil] <tt>setVisible</tt> field
|
3037
3160
|
# @return [Future<Responses::AddSceneItem>]
|
3038
|
-
def add_scene_item(scene_name:, source_name:, set_visible:)
|
3161
|
+
def add_scene_item(scene_name:, source_name:, set_visible: nil)
|
3039
3162
|
send_request(Requests::AddSceneItem.new({scene_name: scene_name, source_name: source_name, set_visible: set_visible}))
|
3040
3163
|
end
|
3041
3164
|
# Sends <tt>DuplicateSceneItem</tt> request.
|
3042
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3165
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#duplicatesceneitem
|
3043
3166
|
# @param from_scene [String, nil] <tt>fromScene</tt> field
|
3044
3167
|
# @param to_scene [String, nil] <tt>toScene</tt> field
|
3045
3168
|
# @param item [Hash] <tt>item</tt> field
|
@@ -3048,33 +3171,33 @@ module Request::Mixin
|
|
3048
3171
|
send_request(Requests::DuplicateSceneItem.new({from_scene: from_scene, to_scene: to_scene, item: item}))
|
3049
3172
|
end
|
3050
3173
|
# Sends <tt>SetCurrentScene</tt> request.
|
3051
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3174
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentscene
|
3052
3175
|
# @param scene_name [String] <tt>scene-name</tt> field
|
3053
3176
|
# @return [Future<Responses::SetCurrentScene>]
|
3054
3177
|
def set_current_scene(scene_name:)
|
3055
3178
|
send_request(Requests::SetCurrentScene.new({scene_name: scene_name}))
|
3056
3179
|
end
|
3057
3180
|
# Sends <tt>GetCurrentScene</tt> request.
|
3058
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3181
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentscene
|
3059
3182
|
# @return [Future<Responses::GetCurrentScene>]
|
3060
3183
|
def get_current_scene()
|
3061
3184
|
send_request(Requests::GetCurrentScene.new({}))
|
3062
3185
|
end
|
3063
3186
|
# Sends <tt>GetSceneList</tt> request.
|
3064
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3187
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getscenelist
|
3065
3188
|
# @return [Future<Responses::GetSceneList>]
|
3066
3189
|
def get_scene_list()
|
3067
3190
|
send_request(Requests::GetSceneList.new({}))
|
3068
3191
|
end
|
3069
3192
|
# Sends <tt>CreateScene</tt> request.
|
3070
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3193
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#createscene
|
3071
3194
|
# @param scene_name [String] <tt>sceneName</tt> field
|
3072
3195
|
# @return [Future<Responses::CreateScene>]
|
3073
3196
|
def create_scene(scene_name:)
|
3074
3197
|
send_request(Requests::CreateScene.new({scene_name: scene_name}))
|
3075
3198
|
end
|
3076
3199
|
# Sends <tt>ReorderSceneItems</tt> request.
|
3077
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3200
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#reordersceneitems
|
3078
3201
|
# @param scene [String, nil] <tt>scene</tt> field
|
3079
3202
|
# @param items [Array<Hash>] <tt>items</tt> field
|
3080
3203
|
# @return [Future<Responses::ReorderSceneItems>]
|
@@ -3082,7 +3205,7 @@ module Request::Mixin
|
|
3082
3205
|
send_request(Requests::ReorderSceneItems.new({scene: scene, items: items}))
|
3083
3206
|
end
|
3084
3207
|
# Sends <tt>SetSceneTransitionOverride</tt> request.
|
3085
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3208
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setscenetransitionoverride
|
3086
3209
|
# @param scene_name [String] <tt>sceneName</tt> field
|
3087
3210
|
# @param transition_name [String] <tt>transitionName</tt> field
|
3088
3211
|
# @param transition_duration [Integer, nil] <tt>transitionDuration</tt> field
|
@@ -3091,46 +3214,46 @@ module Request::Mixin
|
|
3091
3214
|
send_request(Requests::SetSceneTransitionOverride.new({scene_name: scene_name, transition_name: transition_name, transition_duration: transition_duration}))
|
3092
3215
|
end
|
3093
3216
|
# Sends <tt>RemoveSceneTransitionOverride</tt> request.
|
3094
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3217
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#removescenetransitionoverride
|
3095
3218
|
# @param scene_name [String] <tt>sceneName</tt> field
|
3096
3219
|
# @return [Future<Responses::RemoveSceneTransitionOverride>]
|
3097
3220
|
def remove_scene_transition_override(scene_name:)
|
3098
3221
|
send_request(Requests::RemoveSceneTransitionOverride.new({scene_name: scene_name}))
|
3099
3222
|
end
|
3100
3223
|
# Sends <tt>GetSceneTransitionOverride</tt> request.
|
3101
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3224
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getscenetransitionoverride
|
3102
3225
|
# @param scene_name [String] <tt>sceneName</tt> field
|
3103
3226
|
# @return [Future<Responses::GetSceneTransitionOverride>]
|
3104
3227
|
def get_scene_transition_override(scene_name:)
|
3105
3228
|
send_request(Requests::GetSceneTransitionOverride.new({scene_name: scene_name}))
|
3106
3229
|
end
|
3107
3230
|
# Sends <tt>GetStreamingStatus</tt> request.
|
3108
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3231
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstreamingstatus
|
3109
3232
|
# @return [Future<Responses::GetStreamingStatus>]
|
3110
3233
|
def get_streaming_status()
|
3111
3234
|
send_request(Requests::GetStreamingStatus.new({}))
|
3112
3235
|
end
|
3113
3236
|
# Sends <tt>StartStopStreaming</tt> request.
|
3114
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3237
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopstreaming
|
3115
3238
|
# @return [Future<Responses::StartStopStreaming>]
|
3116
3239
|
def start_stop_streaming()
|
3117
3240
|
send_request(Requests::StartStopStreaming.new({}))
|
3118
3241
|
end
|
3119
3242
|
# Sends <tt>StartStreaming</tt> request.
|
3120
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3243
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstreaming
|
3121
3244
|
# @param stream [Hash, nil] <tt>stream</tt> field
|
3122
3245
|
# @return [Future<Responses::StartStreaming>]
|
3123
3246
|
def start_streaming(stream: nil)
|
3124
3247
|
send_request(Requests::StartStreaming.new({stream: stream}))
|
3125
3248
|
end
|
3126
3249
|
# Sends <tt>StopStreaming</tt> request.
|
3127
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3250
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopstreaming
|
3128
3251
|
# @return [Future<Responses::StopStreaming>]
|
3129
3252
|
def stop_streaming()
|
3130
3253
|
send_request(Requests::StopStreaming.new({}))
|
3131
3254
|
end
|
3132
3255
|
# Sends <tt>SetStreamSettings</tt> request.
|
3133
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3256
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setstreamsettings
|
3134
3257
|
# @param type [String] <tt>type</tt> field
|
3135
3258
|
# @param settings [Hash] <tt>settings</tt> field
|
3136
3259
|
# @param save [Boolean] <tt>save</tt> field
|
@@ -3139,115 +3262,115 @@ module Request::Mixin
|
|
3139
3262
|
send_request(Requests::SetStreamSettings.new({type: type, settings: settings, save: save}))
|
3140
3263
|
end
|
3141
3264
|
# Sends <tt>GetStreamSettings</tt> request.
|
3142
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3265
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstreamsettings
|
3143
3266
|
# @return [Future<Responses::GetStreamSettings>]
|
3144
3267
|
def get_stream_settings()
|
3145
3268
|
send_request(Requests::GetStreamSettings.new({}))
|
3146
3269
|
end
|
3147
3270
|
# Sends <tt>SaveStreamSettings</tt> request.
|
3148
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3271
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#savestreamsettings
|
3149
3272
|
# @return [Future<Responses::SaveStreamSettings>]
|
3150
3273
|
def save_stream_settings()
|
3151
3274
|
send_request(Requests::SaveStreamSettings.new({}))
|
3152
3275
|
end
|
3153
3276
|
# Sends <tt>SendCaptions</tt> request.
|
3154
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3277
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sendcaptions
|
3155
3278
|
# @param text [String] <tt>text</tt> field
|
3156
3279
|
# @return [Future<Responses::SendCaptions>]
|
3157
3280
|
def send_captions(text:)
|
3158
3281
|
send_request(Requests::SendCaptions.new({text: text}))
|
3159
3282
|
end
|
3160
3283
|
# Sends <tt>GetStudioModeStatus</tt> request.
|
3161
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3284
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstudiomodestatus
|
3162
3285
|
# @return [Future<Responses::GetStudioModeStatus>]
|
3163
3286
|
def get_studio_mode_status()
|
3164
3287
|
send_request(Requests::GetStudioModeStatus.new({}))
|
3165
3288
|
end
|
3166
3289
|
# Sends <tt>GetPreviewScene</tt> request.
|
3167
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3290
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getpreviewscene
|
3168
3291
|
# @return [Future<Responses::GetPreviewScene>]
|
3169
3292
|
def get_preview_scene()
|
3170
3293
|
send_request(Requests::GetPreviewScene.new({}))
|
3171
3294
|
end
|
3172
3295
|
# Sends <tt>SetPreviewScene</tt> request.
|
3173
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3296
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setpreviewscene
|
3174
3297
|
# @param scene_name [String] <tt>scene-name</tt> field
|
3175
3298
|
# @return [Future<Responses::SetPreviewScene>]
|
3176
3299
|
def set_preview_scene(scene_name:)
|
3177
3300
|
send_request(Requests::SetPreviewScene.new({scene_name: scene_name}))
|
3178
3301
|
end
|
3179
3302
|
# Sends <tt>TransitionToProgram</tt> request.
|
3180
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3303
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitiontoprogram
|
3181
3304
|
# @param with_transition [Hash, nil] <tt>with-transition</tt> field
|
3182
3305
|
# @return [Future<Responses::TransitionToProgram>]
|
3183
3306
|
def transition_to_program(with_transition: nil)
|
3184
3307
|
send_request(Requests::TransitionToProgram.new({with_transition: with_transition}))
|
3185
3308
|
end
|
3186
3309
|
# Sends <tt>EnableStudioMode</tt> request.
|
3187
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3310
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#enablestudiomode
|
3188
3311
|
# @return [Future<Responses::EnableStudioMode>]
|
3189
3312
|
def enable_studio_mode()
|
3190
3313
|
send_request(Requests::EnableStudioMode.new({}))
|
3191
3314
|
end
|
3192
3315
|
# Sends <tt>DisableStudioMode</tt> request.
|
3193
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3316
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#disablestudiomode
|
3194
3317
|
# @return [Future<Responses::DisableStudioMode>]
|
3195
3318
|
def disable_studio_mode()
|
3196
3319
|
send_request(Requests::DisableStudioMode.new({}))
|
3197
3320
|
end
|
3198
3321
|
# Sends <tt>ToggleStudioMode</tt> request.
|
3199
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3322
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#togglestudiomode
|
3200
3323
|
# @return [Future<Responses::ToggleStudioMode>]
|
3201
3324
|
def toggle_studio_mode()
|
3202
3325
|
send_request(Requests::ToggleStudioMode.new({}))
|
3203
3326
|
end
|
3204
3327
|
# Sends <tt>GetTransitionList</tt> request.
|
3205
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3328
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionlist
|
3206
3329
|
# @return [Future<Responses::GetTransitionList>]
|
3207
3330
|
def get_transition_list()
|
3208
3331
|
send_request(Requests::GetTransitionList.new({}))
|
3209
3332
|
end
|
3210
3333
|
# Sends <tt>GetCurrentTransition</tt> request.
|
3211
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3334
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrenttransition
|
3212
3335
|
# @return [Future<Responses::GetCurrentTransition>]
|
3213
3336
|
def get_current_transition()
|
3214
3337
|
send_request(Requests::GetCurrentTransition.new({}))
|
3215
3338
|
end
|
3216
3339
|
# Sends <tt>SetCurrentTransition</tt> request.
|
3217
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3340
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrenttransition
|
3218
3341
|
# @param transition_name [String] <tt>transition-name</tt> field
|
3219
3342
|
# @return [Future<Responses::SetCurrentTransition>]
|
3220
3343
|
def set_current_transition(transition_name:)
|
3221
3344
|
send_request(Requests::SetCurrentTransition.new({transition_name: transition_name}))
|
3222
3345
|
end
|
3223
3346
|
# Sends <tt>SetTransitionDuration</tt> request.
|
3224
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3347
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settransitionduration
|
3225
3348
|
# @param duration [Integer] <tt>duration</tt> field
|
3226
3349
|
# @return [Future<Responses::SetTransitionDuration>]
|
3227
3350
|
def set_transition_duration(duration:)
|
3228
3351
|
send_request(Requests::SetTransitionDuration.new({duration: duration}))
|
3229
3352
|
end
|
3230
3353
|
# Sends <tt>GetTransitionDuration</tt> request.
|
3231
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3354
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionduration
|
3232
3355
|
# @return [Future<Responses::GetTransitionDuration>]
|
3233
3356
|
def get_transition_duration()
|
3234
3357
|
send_request(Requests::GetTransitionDuration.new({}))
|
3235
3358
|
end
|
3236
3359
|
# Sends <tt>GetTransitionPosition</tt> request.
|
3237
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3360
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionposition
|
3238
3361
|
# @return [Future<Responses::GetTransitionPosition>]
|
3239
3362
|
def get_transition_position()
|
3240
3363
|
send_request(Requests::GetTransitionPosition.new({}))
|
3241
3364
|
end
|
3242
3365
|
# Sends <tt>GetTransitionSettings</tt> request.
|
3243
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3366
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionsettings
|
3244
3367
|
# @param transition_name [String] <tt>transitionName</tt> field
|
3245
3368
|
# @return [Future<Responses::GetTransitionSettings>]
|
3246
3369
|
def get_transition_settings(transition_name:)
|
3247
3370
|
send_request(Requests::GetTransitionSettings.new({transition_name: transition_name}))
|
3248
3371
|
end
|
3249
3372
|
# Sends <tt>SetTransitionSettings</tt> request.
|
3250
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3373
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settransitionsettings
|
3251
3374
|
# @param transition_name [String] <tt>transitionName</tt> field
|
3252
3375
|
# @param transition_settings [Hash] <tt>transitionSettings</tt> field
|
3253
3376
|
# @return [Future<Responses::SetTransitionSettings>]
|
@@ -3255,24 +3378,48 @@ module Request::Mixin
|
|
3255
3378
|
send_request(Requests::SetTransitionSettings.new({transition_name: transition_name, transition_settings: transition_settings}))
|
3256
3379
|
end
|
3257
3380
|
# Sends <tt>ReleaseTBar</tt> request.
|
3258
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3381
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#releasetbar
|
3259
3382
|
# @return [Future<Responses::ReleaseTBar>]
|
3260
3383
|
def release_t_bar()
|
3261
3384
|
send_request(Requests::ReleaseTBar.new({}))
|
3262
3385
|
end
|
3263
3386
|
# Sends <tt>SetTBarPosition</tt> request.
|
3264
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3387
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settbarposition
|
3265
3388
|
# @param position [Float] <tt>position</tt> field
|
3266
3389
|
# @param release [Boolean, nil] <tt>release</tt> field
|
3267
3390
|
# @return [Future<Responses::SetTBarPosition>]
|
3268
3391
|
def set_t_bar_position(position:, release: nil)
|
3269
3392
|
send_request(Requests::SetTBarPosition.new({position: position, release: release}))
|
3270
3393
|
end
|
3394
|
+
# Sends <tt>GetVirtualCamStatus</tt> request.
|
3395
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvirtualcamstatus
|
3396
|
+
# @return [Future<Responses::GetVirtualCamStatus>]
|
3397
|
+
def get_virtual_cam_status()
|
3398
|
+
send_request(Requests::GetVirtualCamStatus.new({}))
|
3399
|
+
end
|
3400
|
+
# Sends <tt>StartStopVirtualCam</tt> request.
|
3401
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopvirtualcam
|
3402
|
+
# @return [Future<Responses::StartStopVirtualCam>]
|
3403
|
+
def start_stop_virtual_cam()
|
3404
|
+
send_request(Requests::StartStopVirtualCam.new({}))
|
3405
|
+
end
|
3406
|
+
# Sends <tt>StartVirtualCam</tt> request.
|
3407
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startvirtualcam
|
3408
|
+
# @return [Future<Responses::StartVirtualCam>]
|
3409
|
+
def start_virtual_cam()
|
3410
|
+
send_request(Requests::StartVirtualCam.new({}))
|
3411
|
+
end
|
3412
|
+
# Sends <tt>StopVirtualCam</tt> request.
|
3413
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopvirtualcam
|
3414
|
+
# @return [Future<Responses::StopVirtualCam>]
|
3415
|
+
def stop_virtual_cam()
|
3416
|
+
send_request(Requests::StopVirtualCam.new({}))
|
3417
|
+
end
|
3271
3418
|
end # module Request::Mixin
|
3272
3419
|
end # module Requests
|
3273
3420
|
module Responses
|
3274
3421
|
# @see Requests::GetVersion
|
3275
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3422
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getversion
|
3276
3423
|
class GetVersion < Response
|
3277
3424
|
# @!attribute [r] version
|
3278
3425
|
# @return [Float] <tt>version</tt> field
|
@@ -3292,7 +3439,7 @@ module Responses
|
|
3292
3439
|
Requests::GetVersion::Response = self
|
3293
3440
|
end
|
3294
3441
|
# @see Requests::GetAuthRequired
|
3295
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3442
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getauthrequired
|
3296
3443
|
class GetAuthRequired < Response
|
3297
3444
|
# @!attribute [r] auth_required
|
3298
3445
|
# @return [Boolean] <tt>authRequired</tt> field
|
@@ -3306,22 +3453,22 @@ module Responses
|
|
3306
3453
|
Requests::GetAuthRequired::Response = self
|
3307
3454
|
end
|
3308
3455
|
# @see Requests::Authenticate
|
3309
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3456
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#authenticate
|
3310
3457
|
class Authenticate < Response
|
3311
3458
|
Requests::Authenticate::Response = self
|
3312
3459
|
end
|
3313
3460
|
# @see Requests::SetHeartbeat
|
3314
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3461
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setheartbeat
|
3315
3462
|
class SetHeartbeat < Response
|
3316
3463
|
Requests::SetHeartbeat::Response = self
|
3317
3464
|
end
|
3318
3465
|
# @see Requests::SetFilenameFormatting
|
3319
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3466
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setfilenameformatting
|
3320
3467
|
class SetFilenameFormatting < Response
|
3321
3468
|
Requests::SetFilenameFormatting::Response = self
|
3322
3469
|
end
|
3323
3470
|
# @see Requests::GetFilenameFormatting
|
3324
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3471
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getfilenameformatting
|
3325
3472
|
class GetFilenameFormatting < Response
|
3326
3473
|
# @!attribute [r] filename_formatting
|
3327
3474
|
# @return [String] <tt>filename-formatting</tt> field
|
@@ -3329,7 +3476,7 @@ module Responses
|
|
3329
3476
|
Requests::GetFilenameFormatting::Response = self
|
3330
3477
|
end
|
3331
3478
|
# @see Requests::GetStats
|
3332
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3479
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstats
|
3333
3480
|
class GetStats < Response
|
3334
3481
|
# @!attribute [r] stats
|
3335
3482
|
# @return [OBSStats] <tt>stats</tt> field
|
@@ -3337,12 +3484,12 @@ module Responses
|
|
3337
3484
|
Requests::GetStats::Response = self
|
3338
3485
|
end
|
3339
3486
|
# @see Requests::BroadcastCustomMessage
|
3340
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3487
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#broadcastcustommessage
|
3341
3488
|
class BroadcastCustomMessage < Response
|
3342
3489
|
Requests::BroadcastCustomMessage::Response = self
|
3343
3490
|
end
|
3344
3491
|
# @see Requests::GetVideoInfo
|
3345
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3492
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvideoinfo
|
3346
3493
|
class GetVideoInfo < Response
|
3347
3494
|
# @!attribute [r] base_width
|
3348
3495
|
# @return [Integer] <tt>baseWidth</tt> field
|
@@ -3374,55 +3521,60 @@ module Responses
|
|
3374
3521
|
Requests::GetVideoInfo::Response = self
|
3375
3522
|
end
|
3376
3523
|
# @see Requests::OpenProjector
|
3377
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3524
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#openprojector
|
3378
3525
|
class OpenProjector < Response
|
3379
3526
|
Requests::OpenProjector::Response = self
|
3380
3527
|
end
|
3381
3528
|
# @see Requests::TriggerHotkeyByName
|
3382
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3529
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#triggerhotkeybyname
|
3383
3530
|
class TriggerHotkeyByName < Response
|
3384
3531
|
Requests::TriggerHotkeyByName::Response = self
|
3385
3532
|
end
|
3386
3533
|
# @see Requests::TriggerHotkeyBySequence
|
3387
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3534
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#triggerhotkeybysequence
|
3388
3535
|
class TriggerHotkeyBySequence < Response
|
3389
3536
|
Requests::TriggerHotkeyBySequence::Response = self
|
3390
3537
|
end
|
3391
3538
|
# @see Requests::ExecuteBatch
|
3392
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3539
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#executebatch
|
3393
3540
|
class ExecuteBatch < Response
|
3394
3541
|
# @!attribute [r] results
|
3395
3542
|
# @return [Array<Hash>] <tt>results</tt> field
|
3396
3543
|
def results; get_field("results", Types::Array[Types::Object[{:message_id=>{:type=>Types::String, :json_name=>"message-id"}, :status=>{:type=>Types::String, :json_name=>"status"}, :error=>{:type=>Types::Optional[Types::String], :json_name=>"error"}}]]); end
|
3397
3544
|
Requests::ExecuteBatch::Response = self
|
3398
3545
|
end
|
3546
|
+
# @see Requests::Sleep
|
3547
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sleep
|
3548
|
+
class Sleep < Response
|
3549
|
+
Requests::Sleep::Response = self
|
3550
|
+
end
|
3399
3551
|
# @see Requests::PlayPauseMedia
|
3400
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3552
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#playpausemedia
|
3401
3553
|
class PlayPauseMedia < Response
|
3402
3554
|
Requests::PlayPauseMedia::Response = self
|
3403
3555
|
end
|
3404
3556
|
# @see Requests::RestartMedia
|
3405
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3557
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#restartmedia
|
3406
3558
|
class RestartMedia < Response
|
3407
3559
|
Requests::RestartMedia::Response = self
|
3408
3560
|
end
|
3409
3561
|
# @see Requests::StopMedia
|
3410
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3562
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopmedia
|
3411
3563
|
class StopMedia < Response
|
3412
3564
|
Requests::StopMedia::Response = self
|
3413
3565
|
end
|
3414
3566
|
# @see Requests::NextMedia
|
3415
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3567
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#nextmedia
|
3416
3568
|
class NextMedia < Response
|
3417
3569
|
Requests::NextMedia::Response = self
|
3418
3570
|
end
|
3419
3571
|
# @see Requests::PreviousMedia
|
3420
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3572
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#previousmedia
|
3421
3573
|
class PreviousMedia < Response
|
3422
3574
|
Requests::PreviousMedia::Response = self
|
3423
3575
|
end
|
3424
3576
|
# @see Requests::GetMediaDuration
|
3425
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3577
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediaduration
|
3426
3578
|
class GetMediaDuration < Response
|
3427
3579
|
# @!attribute [r] media_duration
|
3428
3580
|
# @return [Integer] <tt>mediaDuration</tt> field
|
@@ -3430,7 +3582,7 @@ module Responses
|
|
3430
3582
|
Requests::GetMediaDuration::Response = self
|
3431
3583
|
end
|
3432
3584
|
# @see Requests::GetMediaTime
|
3433
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3585
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediatime
|
3434
3586
|
class GetMediaTime < Response
|
3435
3587
|
# @!attribute [r] timestamp
|
3436
3588
|
# @return [Integer] <tt>timestamp</tt> field
|
@@ -3438,17 +3590,17 @@ module Responses
|
|
3438
3590
|
Requests::GetMediaTime::Response = self
|
3439
3591
|
end
|
3440
3592
|
# @see Requests::SetMediaTime
|
3441
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3593
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setmediatime
|
3442
3594
|
class SetMediaTime < Response
|
3443
3595
|
Requests::SetMediaTime::Response = self
|
3444
3596
|
end
|
3445
3597
|
# @see Requests::ScrubMedia
|
3446
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3598
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#scrubmedia
|
3447
3599
|
class ScrubMedia < Response
|
3448
3600
|
Requests::ScrubMedia::Response = self
|
3449
3601
|
end
|
3450
3602
|
# @see Requests::GetMediaState
|
3451
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3603
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediastate
|
3452
3604
|
class GetMediaState < Response
|
3453
3605
|
# @!attribute [r] media_state
|
3454
3606
|
# @return [String] <tt>mediaState</tt> field
|
@@ -3456,7 +3608,7 @@ module Responses
|
|
3456
3608
|
Requests::GetMediaState::Response = self
|
3457
3609
|
end
|
3458
3610
|
# @see Requests::GetMediaSourcesList
|
3459
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3611
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediasourceslist
|
3460
3612
|
class GetMediaSourcesList < Response
|
3461
3613
|
# @!attribute [r] media_sources
|
3462
3614
|
# @return [Array<Hash>] <tt>mediaSources</tt> field
|
@@ -3464,7 +3616,7 @@ module Responses
|
|
3464
3616
|
Requests::GetMediaSourcesList::Response = self
|
3465
3617
|
end
|
3466
3618
|
# @see Requests::CreateSource
|
3467
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3619
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#createsource
|
3468
3620
|
class CreateSource < Response
|
3469
3621
|
# @!attribute [r] item_id
|
3470
3622
|
# @return [Integer] <tt>itemId</tt> field
|
@@ -3472,7 +3624,7 @@ module Responses
|
|
3472
3624
|
Requests::CreateSource::Response = self
|
3473
3625
|
end
|
3474
3626
|
# @see Requests::GetSourcesList
|
3475
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3627
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourceslist
|
3476
3628
|
class GetSourcesList < Response
|
3477
3629
|
# @!attribute [r] sources
|
3478
3630
|
# @return [Array<Hash>] <tt>sources</tt> field
|
@@ -3480,7 +3632,7 @@ module Responses
|
|
3480
3632
|
Requests::GetSourcesList::Response = self
|
3481
3633
|
end
|
3482
3634
|
# @see Requests::GetSourceTypesList
|
3483
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3635
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcetypeslist
|
3484
3636
|
class GetSourceTypesList < Response
|
3485
3637
|
# @!attribute [r] types
|
3486
3638
|
# @return [Array<Hash>] <tt>types</tt> field
|
@@ -3488,7 +3640,7 @@ module Responses
|
|
3488
3640
|
Requests::GetSourceTypesList::Response = self
|
3489
3641
|
end
|
3490
3642
|
# @see Requests::GetVolume
|
3491
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3643
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvolume
|
3492
3644
|
class GetVolume < Response
|
3493
3645
|
# @!attribute [r] name
|
3494
3646
|
# @return [String] <tt>name</tt> field
|
@@ -3502,12 +3654,40 @@ module Responses
|
|
3502
3654
|
Requests::GetVolume::Response = self
|
3503
3655
|
end
|
3504
3656
|
# @see Requests::SetVolume
|
3505
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3657
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setvolume
|
3506
3658
|
class SetVolume < Response
|
3507
3659
|
Requests::SetVolume::Response = self
|
3508
3660
|
end
|
3661
|
+
# @see Requests::SetTracks
|
3662
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settracks
|
3663
|
+
class SetTracks < Response
|
3664
|
+
Requests::SetTracks::Response = self
|
3665
|
+
end
|
3666
|
+
# @see Requests::GetTracks
|
3667
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettracks
|
3668
|
+
class GetTracks < Response
|
3669
|
+
# @!attribute [r] track1
|
3670
|
+
# @return [Boolean] <tt>track1</tt> field
|
3671
|
+
def track1; get_field("track1", Types::Boolean); end
|
3672
|
+
# @!attribute [r] track2
|
3673
|
+
# @return [Boolean] <tt>track2</tt> field
|
3674
|
+
def track2; get_field("track2", Types::Boolean); end
|
3675
|
+
# @!attribute [r] track3
|
3676
|
+
# @return [Boolean] <tt>track3</tt> field
|
3677
|
+
def track3; get_field("track3", Types::Boolean); end
|
3678
|
+
# @!attribute [r] track4
|
3679
|
+
# @return [Boolean] <tt>track4</tt> field
|
3680
|
+
def track4; get_field("track4", Types::Boolean); end
|
3681
|
+
# @!attribute [r] track5
|
3682
|
+
# @return [Boolean] <tt>track5</tt> field
|
3683
|
+
def track5; get_field("track5", Types::Boolean); end
|
3684
|
+
# @!attribute [r] track6
|
3685
|
+
# @return [Boolean] <tt>track6</tt> field
|
3686
|
+
def track6; get_field("track6", Types::Boolean); end
|
3687
|
+
Requests::GetTracks::Response = self
|
3688
|
+
end
|
3509
3689
|
# @see Requests::GetMute
|
3510
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3690
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmute
|
3511
3691
|
class GetMute < Response
|
3512
3692
|
# @!attribute [r] name
|
3513
3693
|
# @return [String] <tt>name</tt> field
|
@@ -3518,17 +3698,25 @@ module Responses
|
|
3518
3698
|
Requests::GetMute::Response = self
|
3519
3699
|
end
|
3520
3700
|
# @see Requests::SetMute
|
3521
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3701
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setmute
|
3522
3702
|
class SetMute < Response
|
3523
3703
|
Requests::SetMute::Response = self
|
3524
3704
|
end
|
3525
3705
|
# @see Requests::ToggleMute
|
3526
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3706
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#togglemute
|
3527
3707
|
class ToggleMute < Response
|
3528
3708
|
Requests::ToggleMute::Response = self
|
3529
3709
|
end
|
3710
|
+
# @see Requests::GetSourceActive
|
3711
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourceactive
|
3712
|
+
class GetSourceActive < Response
|
3713
|
+
# @!attribute [r] source_active
|
3714
|
+
# @return [Boolean] <tt>sourceActive</tt> field
|
3715
|
+
def source_active; get_field("sourceActive", Types::Boolean); end
|
3716
|
+
Requests::GetSourceActive::Response = self
|
3717
|
+
end
|
3530
3718
|
# @see Requests::GetAudioActive
|
3531
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3719
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getaudioactive
|
3532
3720
|
class GetAudioActive < Response
|
3533
3721
|
# @!attribute [r] audio_active
|
3534
3722
|
# @return [Boolean] <tt>audioActive</tt> field
|
@@ -3536,17 +3724,17 @@ module Responses
|
|
3536
3724
|
Requests::GetAudioActive::Response = self
|
3537
3725
|
end
|
3538
3726
|
# @see Requests::SetSourceName
|
3539
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3727
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcename
|
3540
3728
|
class SetSourceName < Response
|
3541
3729
|
Requests::SetSourceName::Response = self
|
3542
3730
|
end
|
3543
3731
|
# @see Requests::SetSyncOffset
|
3544
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3732
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsyncoffset
|
3545
3733
|
class SetSyncOffset < Response
|
3546
3734
|
Requests::SetSyncOffset::Response = self
|
3547
3735
|
end
|
3548
3736
|
# @see Requests::GetSyncOffset
|
3549
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3737
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsyncoffset
|
3550
3738
|
class GetSyncOffset < Response
|
3551
3739
|
# @!attribute [r] name
|
3552
3740
|
# @return [String] <tt>name</tt> field
|
@@ -3557,7 +3745,7 @@ module Responses
|
|
3557
3745
|
Requests::GetSyncOffset::Response = self
|
3558
3746
|
end
|
3559
3747
|
# @see Requests::GetSourceSettings
|
3560
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3748
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcesettings
|
3561
3749
|
class GetSourceSettings < Response
|
3562
3750
|
# @!attribute [r] source_name
|
3563
3751
|
# @return [String] <tt>sourceName</tt> field
|
@@ -3571,7 +3759,7 @@ module Responses
|
|
3571
3759
|
Requests::GetSourceSettings::Response = self
|
3572
3760
|
end
|
3573
3761
|
# @see Requests::SetSourceSettings
|
3574
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3762
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcesettings
|
3575
3763
|
class SetSourceSettings < Response
|
3576
3764
|
# @!attribute [r] source_name
|
3577
3765
|
# @return [String] <tt>sourceName</tt> field
|
@@ -3585,7 +3773,7 @@ module Responses
|
|
3585
3773
|
Requests::SetSourceSettings::Response = self
|
3586
3774
|
end
|
3587
3775
|
# @see Requests::GetTextGDIPlusProperties
|
3588
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3776
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettextgdiplusproperties
|
3589
3777
|
class GetTextGDIPlusProperties < Response
|
3590
3778
|
# @!attribute [r] source
|
3591
3779
|
# @return [String] <tt>source</tt> field
|
@@ -3662,12 +3850,12 @@ module Responses
|
|
3662
3850
|
Requests::GetTextGDIPlusProperties::Response = self
|
3663
3851
|
end
|
3664
3852
|
# @see Requests::SetTextGDIPlusProperties
|
3665
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3853
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settextgdiplusproperties
|
3666
3854
|
class SetTextGDIPlusProperties < Response
|
3667
3855
|
Requests::SetTextGDIPlusProperties::Response = self
|
3668
3856
|
end
|
3669
3857
|
# @see Requests::GetTextFreetype2Properties
|
3670
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3858
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettextfreetype2properties
|
3671
3859
|
class GetTextFreetype2Properties < Response
|
3672
3860
|
# @!attribute [r] source
|
3673
3861
|
# @return [String] <tt>source</tt> field
|
@@ -3708,12 +3896,12 @@ module Responses
|
|
3708
3896
|
Requests::GetTextFreetype2Properties::Response = self
|
3709
3897
|
end
|
3710
3898
|
# @see Requests::SetTextFreetype2Properties
|
3711
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3899
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settextfreetype2properties
|
3712
3900
|
class SetTextFreetype2Properties < Response
|
3713
3901
|
Requests::SetTextFreetype2Properties::Response = self
|
3714
3902
|
end
|
3715
3903
|
# @see Requests::GetBrowserSourceProperties
|
3716
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3904
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getbrowsersourceproperties
|
3717
3905
|
class GetBrowserSourceProperties < Response
|
3718
3906
|
# @!attribute [r] source
|
3719
3907
|
# @return [String] <tt>source</tt> field
|
@@ -3745,12 +3933,12 @@ module Responses
|
|
3745
3933
|
Requests::GetBrowserSourceProperties::Response = self
|
3746
3934
|
end
|
3747
3935
|
# @see Requests::SetBrowserSourceProperties
|
3748
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3936
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setbrowsersourceproperties
|
3749
3937
|
class SetBrowserSourceProperties < Response
|
3750
3938
|
Requests::SetBrowserSourceProperties::Response = self
|
3751
3939
|
end
|
3752
3940
|
# @see Requests::GetSpecialSources
|
3753
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3941
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getspecialsources
|
3754
3942
|
class GetSpecialSources < Response
|
3755
3943
|
# @!attribute [r] desktop_1
|
3756
3944
|
# @return [String, nil] <tt>desktop-1</tt> field
|
@@ -3770,7 +3958,7 @@ module Responses
|
|
3770
3958
|
Requests::GetSpecialSources::Response = self
|
3771
3959
|
end
|
3772
3960
|
# @see Requests::GetSourceFilters
|
3773
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3961
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcefilters
|
3774
3962
|
class GetSourceFilters < Response
|
3775
3963
|
# @!attribute [r] filters
|
3776
3964
|
# @return [Array<Hash>] <tt>filters</tt> field
|
@@ -3778,7 +3966,7 @@ module Responses
|
|
3778
3966
|
Requests::GetSourceFilters::Response = self
|
3779
3967
|
end
|
3780
3968
|
# @see Requests::GetSourceFilterInfo
|
3781
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3969
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcefilterinfo
|
3782
3970
|
class GetSourceFilterInfo < Response
|
3783
3971
|
# @!attribute [r] enabled
|
3784
3972
|
# @return [Boolean] <tt>enabled</tt> field
|
@@ -3795,37 +3983,37 @@ module Responses
|
|
3795
3983
|
Requests::GetSourceFilterInfo::Response = self
|
3796
3984
|
end
|
3797
3985
|
# @see Requests::AddFilterToSource
|
3798
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3986
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#addfiltertosource
|
3799
3987
|
class AddFilterToSource < Response
|
3800
3988
|
Requests::AddFilterToSource::Response = self
|
3801
3989
|
end
|
3802
3990
|
# @see Requests::RemoveFilterFromSource
|
3803
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3991
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#removefilterfromsource
|
3804
3992
|
class RemoveFilterFromSource < Response
|
3805
3993
|
Requests::RemoveFilterFromSource::Response = self
|
3806
3994
|
end
|
3807
3995
|
# @see Requests::ReorderSourceFilter
|
3808
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
3996
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#reordersourcefilter
|
3809
3997
|
class ReorderSourceFilter < Response
|
3810
3998
|
Requests::ReorderSourceFilter::Response = self
|
3811
3999
|
end
|
3812
4000
|
# @see Requests::MoveSourceFilter
|
3813
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4001
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#movesourcefilter
|
3814
4002
|
class MoveSourceFilter < Response
|
3815
4003
|
Requests::MoveSourceFilter::Response = self
|
3816
4004
|
end
|
3817
4005
|
# @see Requests::SetSourceFilterSettings
|
3818
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4006
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcefiltersettings
|
3819
4007
|
class SetSourceFilterSettings < Response
|
3820
4008
|
Requests::SetSourceFilterSettings::Response = self
|
3821
4009
|
end
|
3822
4010
|
# @see Requests::SetSourceFilterVisibility
|
3823
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4011
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcefiltervisibility
|
3824
4012
|
class SetSourceFilterVisibility < Response
|
3825
4013
|
Requests::SetSourceFilterVisibility::Response = self
|
3826
4014
|
end
|
3827
4015
|
# @see Requests::GetAudioMonitorType
|
3828
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4016
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getaudiomonitortype
|
3829
4017
|
class GetAudioMonitorType < Response
|
3830
4018
|
# @!attribute [r] monitor_type
|
3831
4019
|
# @return [String] <tt>monitorType</tt> field
|
@@ -3833,12 +4021,12 @@ module Responses
|
|
3833
4021
|
Requests::GetAudioMonitorType::Response = self
|
3834
4022
|
end
|
3835
4023
|
# @see Requests::SetAudioMonitorType
|
3836
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4024
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setaudiomonitortype
|
3837
4025
|
class SetAudioMonitorType < Response
|
3838
4026
|
Requests::SetAudioMonitorType::Response = self
|
3839
4027
|
end
|
3840
4028
|
# @see Requests::GetSourceDefaultSettings
|
3841
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4029
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcedefaultsettings
|
3842
4030
|
class GetSourceDefaultSettings < Response
|
3843
4031
|
# @!attribute [r] source_kind
|
3844
4032
|
# @return [String] <tt>sourceKind</tt> field
|
@@ -3849,7 +4037,7 @@ module Responses
|
|
3849
4037
|
Requests::GetSourceDefaultSettings::Response = self
|
3850
4038
|
end
|
3851
4039
|
# @see Requests::TakeSourceScreenshot
|
3852
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4040
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#takesourcescreenshot
|
3853
4041
|
class TakeSourceScreenshot < Response
|
3854
4042
|
# @!attribute [r] source_name
|
3855
4043
|
# @return [String] <tt>sourceName</tt> field
|
@@ -3863,12 +4051,12 @@ module Responses
|
|
3863
4051
|
Requests::TakeSourceScreenshot::Response = self
|
3864
4052
|
end
|
3865
4053
|
# @see Requests::RefreshBrowserSource
|
3866
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4054
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#refreshbrowsersource
|
3867
4055
|
class RefreshBrowserSource < Response
|
3868
4056
|
Requests::RefreshBrowserSource::Response = self
|
3869
4057
|
end
|
3870
4058
|
# @see Requests::ListOutputs
|
3871
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4059
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listoutputs
|
3872
4060
|
class ListOutputs < Response
|
3873
4061
|
# @!attribute [r] outputs
|
3874
4062
|
# @return [Array<Output>] <tt>outputs</tt> field
|
@@ -3876,7 +4064,7 @@ module Responses
|
|
3876
4064
|
Requests::ListOutputs::Response = self
|
3877
4065
|
end
|
3878
4066
|
# @see Requests::GetOutputInfo
|
3879
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4067
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getoutputinfo
|
3880
4068
|
class GetOutputInfo < Response
|
3881
4069
|
# @!attribute [r] output_info
|
3882
4070
|
# @return [Output] <tt>outputInfo</tt> field
|
@@ -3884,22 +4072,22 @@ module Responses
|
|
3884
4072
|
Requests::GetOutputInfo::Response = self
|
3885
4073
|
end
|
3886
4074
|
# @see Requests::StartOutput
|
3887
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4075
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startoutput
|
3888
4076
|
class StartOutput < Response
|
3889
4077
|
Requests::StartOutput::Response = self
|
3890
4078
|
end
|
3891
4079
|
# @see Requests::StopOutput
|
3892
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4080
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopoutput
|
3893
4081
|
class StopOutput < Response
|
3894
4082
|
Requests::StopOutput::Response = self
|
3895
4083
|
end
|
3896
4084
|
# @see Requests::SetCurrentProfile
|
3897
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4085
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentprofile
|
3898
4086
|
class SetCurrentProfile < Response
|
3899
4087
|
Requests::SetCurrentProfile::Response = self
|
3900
4088
|
end
|
3901
4089
|
# @see Requests::GetCurrentProfile
|
3902
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4090
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentprofile
|
3903
4091
|
class GetCurrentProfile < Response
|
3904
4092
|
# @!attribute [r] profile_name
|
3905
4093
|
# @return [String] <tt>profile-name</tt> field
|
@@ -3907,7 +4095,7 @@ module Responses
|
|
3907
4095
|
Requests::GetCurrentProfile::Response = self
|
3908
4096
|
end
|
3909
4097
|
# @see Requests::ListProfiles
|
3910
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4098
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listprofiles
|
3911
4099
|
class ListProfiles < Response
|
3912
4100
|
# @!attribute [r] profiles
|
3913
4101
|
# @return [Array<Hash>] <tt>profiles</tt> field
|
@@ -3915,7 +4103,7 @@ module Responses
|
|
3915
4103
|
Requests::ListProfiles::Response = self
|
3916
4104
|
end
|
3917
4105
|
# @see Requests::GetRecordingStatus
|
3918
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4106
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getrecordingstatus
|
3919
4107
|
class GetRecordingStatus < Response
|
3920
4108
|
# @!attribute [r] is_recording
|
3921
4109
|
# @return [Boolean] <tt>isRecording</tt> field
|
@@ -3932,37 +4120,37 @@ module Responses
|
|
3932
4120
|
Requests::GetRecordingStatus::Response = self
|
3933
4121
|
end
|
3934
4122
|
# @see Requests::StartStopRecording
|
3935
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4123
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstoprecording
|
3936
4124
|
class StartStopRecording < Response
|
3937
4125
|
Requests::StartStopRecording::Response = self
|
3938
4126
|
end
|
3939
4127
|
# @see Requests::StartRecording
|
3940
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4128
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startrecording
|
3941
4129
|
class StartRecording < Response
|
3942
4130
|
Requests::StartRecording::Response = self
|
3943
4131
|
end
|
3944
4132
|
# @see Requests::StopRecording
|
3945
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4133
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stoprecording
|
3946
4134
|
class StopRecording < Response
|
3947
4135
|
Requests::StopRecording::Response = self
|
3948
4136
|
end
|
3949
4137
|
# @see Requests::PauseRecording
|
3950
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4138
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#pauserecording
|
3951
4139
|
class PauseRecording < Response
|
3952
4140
|
Requests::PauseRecording::Response = self
|
3953
4141
|
end
|
3954
4142
|
# @see Requests::ResumeRecording
|
3955
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4143
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#resumerecording
|
3956
4144
|
class ResumeRecording < Response
|
3957
4145
|
Requests::ResumeRecording::Response = self
|
3958
4146
|
end
|
3959
4147
|
# @see Requests::SetRecordingFolder
|
3960
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4148
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setrecordingfolder
|
3961
4149
|
class SetRecordingFolder < Response
|
3962
4150
|
Requests::SetRecordingFolder::Response = self
|
3963
4151
|
end
|
3964
4152
|
# @see Requests::GetRecordingFolder
|
3965
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4153
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getrecordingfolder
|
3966
4154
|
class GetRecordingFolder < Response
|
3967
4155
|
# @!attribute [r] rec_folder
|
3968
4156
|
# @return [String] <tt>rec-folder</tt> field
|
@@ -3970,7 +4158,7 @@ module Responses
|
|
3970
4158
|
Requests::GetRecordingFolder::Response = self
|
3971
4159
|
end
|
3972
4160
|
# @see Requests::GetReplayBufferStatus
|
3973
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4161
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getreplaybufferstatus
|
3974
4162
|
class GetReplayBufferStatus < Response
|
3975
4163
|
# @!attribute [r] is_replay_buffer_active
|
3976
4164
|
# @return [Boolean] <tt>isReplayBufferActive</tt> field
|
@@ -3978,32 +4166,32 @@ module Responses
|
|
3978
4166
|
Requests::GetReplayBufferStatus::Response = self
|
3979
4167
|
end
|
3980
4168
|
# @see Requests::StartStopReplayBuffer
|
3981
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4169
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopreplaybuffer
|
3982
4170
|
class StartStopReplayBuffer < Response
|
3983
4171
|
Requests::StartStopReplayBuffer::Response = self
|
3984
4172
|
end
|
3985
4173
|
# @see Requests::StartReplayBuffer
|
3986
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4174
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startreplaybuffer
|
3987
4175
|
class StartReplayBuffer < Response
|
3988
4176
|
Requests::StartReplayBuffer::Response = self
|
3989
4177
|
end
|
3990
4178
|
# @see Requests::StopReplayBuffer
|
3991
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4179
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopreplaybuffer
|
3992
4180
|
class StopReplayBuffer < Response
|
3993
4181
|
Requests::StopReplayBuffer::Response = self
|
3994
4182
|
end
|
3995
4183
|
# @see Requests::SaveReplayBuffer
|
3996
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4184
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#savereplaybuffer
|
3997
4185
|
class SaveReplayBuffer < Response
|
3998
4186
|
Requests::SaveReplayBuffer::Response = self
|
3999
4187
|
end
|
4000
4188
|
# @see Requests::SetCurrentSceneCollection
|
4001
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4189
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentscenecollection
|
4002
4190
|
class SetCurrentSceneCollection < Response
|
4003
4191
|
Requests::SetCurrentSceneCollection::Response = self
|
4004
4192
|
end
|
4005
4193
|
# @see Requests::GetCurrentSceneCollection
|
4006
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4194
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentscenecollection
|
4007
4195
|
class GetCurrentSceneCollection < Response
|
4008
4196
|
# @!attribute [r] sc_name
|
4009
4197
|
# @return [String] <tt>sc-name</tt> field
|
@@ -4011,7 +4199,7 @@ module Responses
|
|
4011
4199
|
Requests::GetCurrentSceneCollection::Response = self
|
4012
4200
|
end
|
4013
4201
|
# @see Requests::ListSceneCollections
|
4014
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4202
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listscenecollections
|
4015
4203
|
class ListSceneCollections < Response
|
4016
4204
|
# @!attribute [r] scene_collections
|
4017
4205
|
# @return [Array<ScenesCollection>] <tt>scene-collections</tt> field
|
@@ -4019,7 +4207,7 @@ module Responses
|
|
4019
4207
|
Requests::ListSceneCollections::Response = self
|
4020
4208
|
end
|
4021
4209
|
# @see Requests::GetSceneItemList
|
4022
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4210
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsceneitemlist
|
4023
4211
|
class GetSceneItemList < Response
|
4024
4212
|
# @!attribute [r] scene_name
|
4025
4213
|
# @return [String] <tt>sceneName</tt> field
|
@@ -4030,7 +4218,7 @@ module Responses
|
|
4030
4218
|
Requests::GetSceneItemList::Response = self
|
4031
4219
|
end
|
4032
4220
|
# @see Requests::GetSceneItemProperties
|
4033
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4221
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsceneitemproperties
|
4034
4222
|
class GetSceneItemProperties < Response
|
4035
4223
|
# @!attribute [r] name
|
4036
4224
|
# @return [String] <tt>name</tt> field
|
@@ -4046,7 +4234,7 @@ module Responses
|
|
4046
4234
|
def rotation; get_field("rotation", Types::Float); end
|
4047
4235
|
# @!attribute [r] scale
|
4048
4236
|
# @return [Hash] <tt>scale</tt> field
|
4049
|
-
def scale; get_field("scale", Types::Object[{:x=>{:type=>Types::Float, :json_name=>"x"}, :y=>{:type=>Types::Float, :json_name=>"y"}}]); end
|
4237
|
+
def scale; get_field("scale", Types::Object[{:x=>{:type=>Types::Float, :json_name=>"x"}, :y=>{:type=>Types::Float, :json_name=>"y"}, :filter=>{:type=>Types::String, :json_name=>"filter"}}]); end
|
4050
4238
|
# @!attribute [r] crop
|
4051
4239
|
# @return [Hash] <tt>crop</tt> field
|
4052
4240
|
def crop; get_field("crop", Types::Object[{:top=>{:type=>Types::Integer, :json_name=>"top"}, :right=>{:type=>Types::Integer, :json_name=>"right"}, :bottom=>{:type=>Types::Integer, :json_name=>"bottom"}, :left=>{:type=>Types::Integer, :json_name=>"left"}}]); end
|
@@ -4083,42 +4271,42 @@ module Responses
|
|
4083
4271
|
Requests::GetSceneItemProperties::Response = self
|
4084
4272
|
end
|
4085
4273
|
# @see Requests::SetSceneItemProperties
|
4086
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4274
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemproperties
|
4087
4275
|
class SetSceneItemProperties < Response
|
4088
4276
|
Requests::SetSceneItemProperties::Response = self
|
4089
4277
|
end
|
4090
4278
|
# @see Requests::ResetSceneItem
|
4091
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4279
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#resetsceneitem
|
4092
4280
|
class ResetSceneItem < Response
|
4093
4281
|
Requests::ResetSceneItem::Response = self
|
4094
4282
|
end
|
4095
4283
|
# @see Requests::SetSceneItemRender
|
4096
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4284
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemrender
|
4097
4285
|
class SetSceneItemRender < Response
|
4098
4286
|
Requests::SetSceneItemRender::Response = self
|
4099
4287
|
end
|
4100
4288
|
# @see Requests::SetSceneItemPosition
|
4101
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4289
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemposition
|
4102
4290
|
class SetSceneItemPosition < Response
|
4103
4291
|
Requests::SetSceneItemPosition::Response = self
|
4104
4292
|
end
|
4105
4293
|
# @see Requests::SetSceneItemTransform
|
4106
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4294
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemtransform
|
4107
4295
|
class SetSceneItemTransform < Response
|
4108
4296
|
Requests::SetSceneItemTransform::Response = self
|
4109
4297
|
end
|
4110
4298
|
# @see Requests::SetSceneItemCrop
|
4111
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4299
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemcrop
|
4112
4300
|
class SetSceneItemCrop < Response
|
4113
4301
|
Requests::SetSceneItemCrop::Response = self
|
4114
4302
|
end
|
4115
4303
|
# @see Requests::DeleteSceneItem
|
4116
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4304
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#deletesceneitem
|
4117
4305
|
class DeleteSceneItem < Response
|
4118
4306
|
Requests::DeleteSceneItem::Response = self
|
4119
4307
|
end
|
4120
4308
|
# @see Requests::AddSceneItem
|
4121
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4309
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#addsceneitem
|
4122
4310
|
class AddSceneItem < Response
|
4123
4311
|
# @!attribute [r] item_id
|
4124
4312
|
# @return [Integer] <tt>itemId</tt> field
|
@@ -4126,7 +4314,7 @@ module Responses
|
|
4126
4314
|
Requests::AddSceneItem::Response = self
|
4127
4315
|
end
|
4128
4316
|
# @see Requests::DuplicateSceneItem
|
4129
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4317
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#duplicatesceneitem
|
4130
4318
|
class DuplicateSceneItem < Response
|
4131
4319
|
# @!attribute [r] scene
|
4132
4320
|
# @return [String] <tt>scene</tt> field
|
@@ -4137,12 +4325,12 @@ module Responses
|
|
4137
4325
|
Requests::DuplicateSceneItem::Response = self
|
4138
4326
|
end
|
4139
4327
|
# @see Requests::SetCurrentScene
|
4140
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4328
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentscene
|
4141
4329
|
class SetCurrentScene < Response
|
4142
4330
|
Requests::SetCurrentScene::Response = self
|
4143
4331
|
end
|
4144
4332
|
# @see Requests::GetCurrentScene
|
4145
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4333
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentscene
|
4146
4334
|
class GetCurrentScene < Response
|
4147
4335
|
# @!attribute [r] name
|
4148
4336
|
# @return [String] <tt>name</tt> field
|
@@ -4153,7 +4341,7 @@ module Responses
|
|
4153
4341
|
Requests::GetCurrentScene::Response = self
|
4154
4342
|
end
|
4155
4343
|
# @see Requests::GetSceneList
|
4156
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4344
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getscenelist
|
4157
4345
|
class GetSceneList < Response
|
4158
4346
|
# @!attribute [r] current_scene
|
4159
4347
|
# @return [String] <tt>current-scene</tt> field
|
@@ -4164,27 +4352,27 @@ module Responses
|
|
4164
4352
|
Requests::GetSceneList::Response = self
|
4165
4353
|
end
|
4166
4354
|
# @see Requests::CreateScene
|
4167
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4355
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#createscene
|
4168
4356
|
class CreateScene < Response
|
4169
4357
|
Requests::CreateScene::Response = self
|
4170
4358
|
end
|
4171
4359
|
# @see Requests::ReorderSceneItems
|
4172
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4360
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#reordersceneitems
|
4173
4361
|
class ReorderSceneItems < Response
|
4174
4362
|
Requests::ReorderSceneItems::Response = self
|
4175
4363
|
end
|
4176
4364
|
# @see Requests::SetSceneTransitionOverride
|
4177
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4365
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setscenetransitionoverride
|
4178
4366
|
class SetSceneTransitionOverride < Response
|
4179
4367
|
Requests::SetSceneTransitionOverride::Response = self
|
4180
4368
|
end
|
4181
4369
|
# @see Requests::RemoveSceneTransitionOverride
|
4182
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4370
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#removescenetransitionoverride
|
4183
4371
|
class RemoveSceneTransitionOverride < Response
|
4184
4372
|
Requests::RemoveSceneTransitionOverride::Response = self
|
4185
4373
|
end
|
4186
4374
|
# @see Requests::GetSceneTransitionOverride
|
4187
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4375
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getscenetransitionoverride
|
4188
4376
|
class GetSceneTransitionOverride < Response
|
4189
4377
|
# @!attribute [r] transition_name
|
4190
4378
|
# @return [String] <tt>transitionName</tt> field
|
@@ -4195,7 +4383,7 @@ module Responses
|
|
4195
4383
|
Requests::GetSceneTransitionOverride::Response = self
|
4196
4384
|
end
|
4197
4385
|
# @see Requests::GetStreamingStatus
|
4198
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4386
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstreamingstatus
|
4199
4387
|
class GetStreamingStatus < Response
|
4200
4388
|
# @!attribute [r] streaming
|
4201
4389
|
# @return [Boolean] <tt>streaming</tt> field
|
@@ -4206,6 +4394,9 @@ module Responses
|
|
4206
4394
|
# @!attribute [r] recording_paused
|
4207
4395
|
# @return [Boolean] <tt>recording-paused</tt> field
|
4208
4396
|
def recording_paused; get_field("recording-paused", Types::Boolean); end
|
4397
|
+
# @!attribute [r] virtualcam
|
4398
|
+
# @return [Boolean] <tt>virtualcam</tt> field
|
4399
|
+
def virtualcam; get_field("virtualcam", Types::Boolean); end
|
4209
4400
|
# @!attribute [r] preview_only
|
4210
4401
|
# @return [Boolean] <tt>preview-only</tt> field
|
4211
4402
|
def preview_only; get_field("preview-only", Types::Boolean); end
|
@@ -4215,30 +4406,33 @@ module Responses
|
|
4215
4406
|
# @!attribute [r] rec_timecode
|
4216
4407
|
# @return [String, nil] <tt>rec-timecode</tt> field
|
4217
4408
|
def rec_timecode; get_field("rec-timecode", Types::Optional[Types::String]); end
|
4409
|
+
# @!attribute [r] virtualcam_timecode
|
4410
|
+
# @return [String, nil] <tt>virtualcam-timecode</tt> field
|
4411
|
+
def virtualcam_timecode; get_field("virtualcam-timecode", Types::Optional[Types::String]); end
|
4218
4412
|
Requests::GetStreamingStatus::Response = self
|
4219
4413
|
end
|
4220
4414
|
# @see Requests::StartStopStreaming
|
4221
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4415
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopstreaming
|
4222
4416
|
class StartStopStreaming < Response
|
4223
4417
|
Requests::StartStopStreaming::Response = self
|
4224
4418
|
end
|
4225
4419
|
# @see Requests::StartStreaming
|
4226
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4420
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstreaming
|
4227
4421
|
class StartStreaming < Response
|
4228
4422
|
Requests::StartStreaming::Response = self
|
4229
4423
|
end
|
4230
4424
|
# @see Requests::StopStreaming
|
4231
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4425
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopstreaming
|
4232
4426
|
class StopStreaming < Response
|
4233
4427
|
Requests::StopStreaming::Response = self
|
4234
4428
|
end
|
4235
4429
|
# @see Requests::SetStreamSettings
|
4236
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4430
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setstreamsettings
|
4237
4431
|
class SetStreamSettings < Response
|
4238
4432
|
Requests::SetStreamSettings::Response = self
|
4239
4433
|
end
|
4240
4434
|
# @see Requests::GetStreamSettings
|
4241
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4435
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstreamsettings
|
4242
4436
|
class GetStreamSettings < Response
|
4243
4437
|
# @!attribute [r] type
|
4244
4438
|
# @return [String] <tt>type</tt> field
|
@@ -4249,17 +4443,17 @@ module Responses
|
|
4249
4443
|
Requests::GetStreamSettings::Response = self
|
4250
4444
|
end
|
4251
4445
|
# @see Requests::SaveStreamSettings
|
4252
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4446
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#savestreamsettings
|
4253
4447
|
class SaveStreamSettings < Response
|
4254
4448
|
Requests::SaveStreamSettings::Response = self
|
4255
4449
|
end
|
4256
4450
|
# @see Requests::SendCaptions
|
4257
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4451
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sendcaptions
|
4258
4452
|
class SendCaptions < Response
|
4259
4453
|
Requests::SendCaptions::Response = self
|
4260
4454
|
end
|
4261
4455
|
# @see Requests::GetStudioModeStatus
|
4262
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4456
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstudiomodestatus
|
4263
4457
|
class GetStudioModeStatus < Response
|
4264
4458
|
# @!attribute [r] studio_mode
|
4265
4459
|
# @return [Boolean] <tt>studio-mode</tt> field
|
@@ -4267,7 +4461,7 @@ module Responses
|
|
4267
4461
|
Requests::GetStudioModeStatus::Response = self
|
4268
4462
|
end
|
4269
4463
|
# @see Requests::GetPreviewScene
|
4270
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4464
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getpreviewscene
|
4271
4465
|
class GetPreviewScene < Response
|
4272
4466
|
# @!attribute [r] name
|
4273
4467
|
# @return [String] <tt>name</tt> field
|
@@ -4278,32 +4472,32 @@ module Responses
|
|
4278
4472
|
Requests::GetPreviewScene::Response = self
|
4279
4473
|
end
|
4280
4474
|
# @see Requests::SetPreviewScene
|
4281
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4475
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setpreviewscene
|
4282
4476
|
class SetPreviewScene < Response
|
4283
4477
|
Requests::SetPreviewScene::Response = self
|
4284
4478
|
end
|
4285
4479
|
# @see Requests::TransitionToProgram
|
4286
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4480
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitiontoprogram
|
4287
4481
|
class TransitionToProgram < Response
|
4288
4482
|
Requests::TransitionToProgram::Response = self
|
4289
4483
|
end
|
4290
4484
|
# @see Requests::EnableStudioMode
|
4291
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4485
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#enablestudiomode
|
4292
4486
|
class EnableStudioMode < Response
|
4293
4487
|
Requests::EnableStudioMode::Response = self
|
4294
4488
|
end
|
4295
4489
|
# @see Requests::DisableStudioMode
|
4296
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4490
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#disablestudiomode
|
4297
4491
|
class DisableStudioMode < Response
|
4298
4492
|
Requests::DisableStudioMode::Response = self
|
4299
4493
|
end
|
4300
4494
|
# @see Requests::ToggleStudioMode
|
4301
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4495
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#togglestudiomode
|
4302
4496
|
class ToggleStudioMode < Response
|
4303
4497
|
Requests::ToggleStudioMode::Response = self
|
4304
4498
|
end
|
4305
4499
|
# @see Requests::GetTransitionList
|
4306
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4500
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionlist
|
4307
4501
|
class GetTransitionList < Response
|
4308
4502
|
# @!attribute [r] current_transition
|
4309
4503
|
# @return [String] <tt>current-transition</tt> field
|
@@ -4314,7 +4508,7 @@ module Responses
|
|
4314
4508
|
Requests::GetTransitionList::Response = self
|
4315
4509
|
end
|
4316
4510
|
# @see Requests::GetCurrentTransition
|
4317
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4511
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrenttransition
|
4318
4512
|
class GetCurrentTransition < Response
|
4319
4513
|
# @!attribute [r] name
|
4320
4514
|
# @return [String] <tt>name</tt> field
|
@@ -4325,17 +4519,17 @@ module Responses
|
|
4325
4519
|
Requests::GetCurrentTransition::Response = self
|
4326
4520
|
end
|
4327
4521
|
# @see Requests::SetCurrentTransition
|
4328
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4522
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrenttransition
|
4329
4523
|
class SetCurrentTransition < Response
|
4330
4524
|
Requests::SetCurrentTransition::Response = self
|
4331
4525
|
end
|
4332
4526
|
# @see Requests::SetTransitionDuration
|
4333
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4527
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settransitionduration
|
4334
4528
|
class SetTransitionDuration < Response
|
4335
4529
|
Requests::SetTransitionDuration::Response = self
|
4336
4530
|
end
|
4337
4531
|
# @see Requests::GetTransitionDuration
|
4338
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4532
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionduration
|
4339
4533
|
class GetTransitionDuration < Response
|
4340
4534
|
# @!attribute [r] transition_duration
|
4341
4535
|
# @return [Integer] <tt>transition-duration</tt> field
|
@@ -4343,7 +4537,7 @@ module Responses
|
|
4343
4537
|
Requests::GetTransitionDuration::Response = self
|
4344
4538
|
end
|
4345
4539
|
# @see Requests::GetTransitionPosition
|
4346
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4540
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionposition
|
4347
4541
|
class GetTransitionPosition < Response
|
4348
4542
|
# @!attribute [r] position
|
4349
4543
|
# @return [Float] <tt>position</tt> field
|
@@ -4351,7 +4545,7 @@ module Responses
|
|
4351
4545
|
Requests::GetTransitionPosition::Response = self
|
4352
4546
|
end
|
4353
4547
|
# @see Requests::GetTransitionSettings
|
4354
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4548
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionsettings
|
4355
4549
|
class GetTransitionSettings < Response
|
4356
4550
|
# @!attribute [r] transition_settings
|
4357
4551
|
# @return [Hash] <tt>transitionSettings</tt> field
|
@@ -4359,7 +4553,7 @@ module Responses
|
|
4359
4553
|
Requests::GetTransitionSettings::Response = self
|
4360
4554
|
end
|
4361
4555
|
# @see Requests::SetTransitionSettings
|
4362
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4556
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settransitionsettings
|
4363
4557
|
class SetTransitionSettings < Response
|
4364
4558
|
# @!attribute [r] transition_settings
|
4365
4559
|
# @return [Hash] <tt>transitionSettings</tt> field
|
@@ -4367,14 +4561,40 @@ module Responses
|
|
4367
4561
|
Requests::SetTransitionSettings::Response = self
|
4368
4562
|
end
|
4369
4563
|
# @see Requests::ReleaseTBar
|
4370
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4564
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#releasetbar
|
4371
4565
|
class ReleaseTBar < Response
|
4372
4566
|
Requests::ReleaseTBar::Response = self
|
4373
4567
|
end
|
4374
4568
|
# @see Requests::SetTBarPosition
|
4375
|
-
# @see https://github.com/Palakis/obs-websocket/blob/4.9.
|
4569
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settbarposition
|
4376
4570
|
class SetTBarPosition < Response
|
4377
4571
|
Requests::SetTBarPosition::Response = self
|
4378
4572
|
end
|
4573
|
+
# @see Requests::GetVirtualCamStatus
|
4574
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvirtualcamstatus
|
4575
|
+
class GetVirtualCamStatus < Response
|
4576
|
+
# @!attribute [r] is_virtual_cam
|
4577
|
+
# @return [Boolean] <tt>isVirtualCam</tt> field
|
4578
|
+
def is_virtual_cam; get_field("isVirtualCam", Types::Boolean); end
|
4579
|
+
# @!attribute [r] virtual_cam_timecode
|
4580
|
+
# @return [String, nil] <tt>virtualCamTimecode</tt> field
|
4581
|
+
def virtual_cam_timecode; get_field("virtualCamTimecode", Types::Optional[Types::String]); end
|
4582
|
+
Requests::GetVirtualCamStatus::Response = self
|
4583
|
+
end
|
4584
|
+
# @see Requests::StartStopVirtualCam
|
4585
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopvirtualcam
|
4586
|
+
class StartStopVirtualCam < Response
|
4587
|
+
Requests::StartStopVirtualCam::Response = self
|
4588
|
+
end
|
4589
|
+
# @see Requests::StartVirtualCam
|
4590
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startvirtualcam
|
4591
|
+
class StartVirtualCam < Response
|
4592
|
+
Requests::StartVirtualCam::Response = self
|
4593
|
+
end
|
4594
|
+
# @see Requests::StopVirtualCam
|
4595
|
+
# @see https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopvirtualcam
|
4596
|
+
class StopVirtualCam < Response
|
4597
|
+
Requests::StopVirtualCam::Response = self
|
4598
|
+
end
|
4379
4599
|
end # module Responses
|
4380
4600
|
end # module OBS::WebSocket::Protocol
|