Module: OBS::WebSocket::Protocol::Event::Mixin

Included in:
Client
Defined in:
lib/obs/websocket/protocol.rb

Overview

module Events

Instance Method Summary collapse

Instance Method Details

#on_broadcast_custom_message {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for BroadcastCustomMessage event.



903
904
905
# File 'lib/obs/websocket/protocol.rb', line 903

def on_broadcast_custom_message(&listener)
  on("BroadcastCustomMessage", &listener)
end

#on_exiting {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for Exiting event.



889
890
891
# File 'lib/obs/websocket/protocol.rb', line 889

def on_exiting(&listener)
  on("Exiting", &listener)
end

#on_heartbeat {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for Heartbeat event.



896
897
898
# File 'lib/obs/websocket/protocol.rb', line 896

def on_heartbeat(&listener)
  on("Heartbeat", &listener)
end

#on_media_ended {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for MediaEnded event.



1050
1051
1052
# File 'lib/obs/websocket/protocol.rb', line 1050

def on_media_ended(&listener)
  on("MediaEnded", &listener)
end

#on_media_next {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for MediaNext event.



1029
1030
1031
# File 'lib/obs/websocket/protocol.rb', line 1029

def on_media_next(&listener)
  on("MediaNext", &listener)
end

#on_media_paused {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for MediaPaused event.



1008
1009
1010
# File 'lib/obs/websocket/protocol.rb', line 1008

def on_media_paused(&listener)
  on("MediaPaused", &listener)
end

#on_media_playing {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for MediaPlaying event.



1001
1002
1003
# File 'lib/obs/websocket/protocol.rb', line 1001

def on_media_playing(&listener)
  on("MediaPlaying", &listener)
end

#on_media_previous {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for MediaPrevious event.



1036
1037
1038
# File 'lib/obs/websocket/protocol.rb', line 1036

def on_media_previous(&listener)
  on("MediaPrevious", &listener)
end

#on_media_restarted {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for MediaRestarted event.



1015
1016
1017
# File 'lib/obs/websocket/protocol.rb', line 1015

def on_media_restarted(&listener)
  on("MediaRestarted", &listener)
end

#on_media_started {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for MediaStarted event.



1043
1044
1045
# File 'lib/obs/websocket/protocol.rb', line 1043

def on_media_started(&listener)
  on("MediaStarted", &listener)
end

#on_media_stopped {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for MediaStopped event.



1022
1023
1024
# File 'lib/obs/websocket/protocol.rb', line 1022

def on_media_stopped(&listener)
  on("MediaStopped", &listener)
end

#on_preview_scene_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for PreviewSceneChanged event.



1113
1114
1115
# File 'lib/obs/websocket/protocol.rb', line 1113

def on_preview_scene_changed(&listener)
  on("PreviewSceneChanged", &listener)
end

#on_profile_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for ProfileChanged event.



756
757
758
# File 'lib/obs/websocket/protocol.rb', line 756

def on_profile_changed(&listener)
  on("ProfileChanged", &listener)
end

#on_profile_list_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for ProfileListChanged event.



763
764
765
# File 'lib/obs/websocket/protocol.rb', line 763

def on_profile_list_changed(&listener)
  on("ProfileListChanged", &listener)
end

#on_recording_paused {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for RecordingPaused event.



833
834
835
# File 'lib/obs/websocket/protocol.rb', line 833

def on_recording_paused(&listener)
  on("RecordingPaused", &listener)
end

#on_recording_resumed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for RecordingResumed event.



840
841
842
# File 'lib/obs/websocket/protocol.rb', line 840

def on_recording_resumed(&listener)
  on("RecordingResumed", &listener)
end

#on_recording_started {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for RecordingStarted event.



812
813
814
# File 'lib/obs/websocket/protocol.rb', line 812

def on_recording_started(&listener)
  on("RecordingStarted", &listener)
end

#on_recording_starting {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for RecordingStarting event.



805
806
807
# File 'lib/obs/websocket/protocol.rb', line 805

def on_recording_starting(&listener)
  on("RecordingStarting", &listener)
end

#on_recording_stopped {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for RecordingStopped event.



826
827
828
# File 'lib/obs/websocket/protocol.rb', line 826

def on_recording_stopped(&listener)
  on("RecordingStopped", &listener)
end

#on_recording_stopping {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for RecordingStopping event.



819
820
821
# File 'lib/obs/websocket/protocol.rb', line 819

def on_recording_stopping(&listener)
  on("RecordingStopping", &listener)
end

#on_replay_started {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for ReplayStarted event.



868
869
870
# File 'lib/obs/websocket/protocol.rb', line 868

def on_replay_started(&listener)
  on("ReplayStarted", &listener)
end

#on_replay_starting {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for ReplayStarting event.



861
862
863
# File 'lib/obs/websocket/protocol.rb', line 861

def on_replay_starting(&listener)
  on("ReplayStarting", &listener)
end

#on_replay_stopped {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for ReplayStopped event.



882
883
884
# File 'lib/obs/websocket/protocol.rb', line 882

def on_replay_stopped(&listener)
  on("ReplayStopped", &listener)
end

#on_replay_stopping {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for ReplayStopping event.



875
876
877
# File 'lib/obs/websocket/protocol.rb', line 875

def on_replay_stopping(&listener)
  on("ReplayStopping", &listener)
end

#on_scene_collection_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SceneCollectionChanged event.



700
701
702
# File 'lib/obs/websocket/protocol.rb', line 700

def on_scene_collection_changed(&listener)
  on("SceneCollectionChanged", &listener)
end

#on_scene_collection_list_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SceneCollectionListChanged event.



707
708
709
# File 'lib/obs/websocket/protocol.rb', line 707

def on_scene_collection_list_changed(&listener)
  on("SceneCollectionListChanged", &listener)
end

#on_scene_item_added {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SceneItemAdded event.



1064
1065
1066
# File 'lib/obs/websocket/protocol.rb', line 1064

def on_scene_item_added(&listener)
  on("SceneItemAdded", &listener)
end

#on_scene_item_deselected {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SceneItemDeselected event.



1106
1107
1108
# File 'lib/obs/websocket/protocol.rb', line 1106

def on_scene_item_deselected(&listener)
  on("SceneItemDeselected", &listener)
end

#on_scene_item_lock_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SceneItemLockChanged event.



1085
1086
1087
# File 'lib/obs/websocket/protocol.rb', line 1085

def on_scene_item_lock_changed(&listener)
  on("SceneItemLockChanged", &listener)
end

#on_scene_item_removed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SceneItemRemoved event.



1071
1072
1073
# File 'lib/obs/websocket/protocol.rb', line 1071

def on_scene_item_removed(&listener)
  on("SceneItemRemoved", &listener)
end

#on_scene_item_selected {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SceneItemSelected event.



1099
1100
1101
# File 'lib/obs/websocket/protocol.rb', line 1099

def on_scene_item_selected(&listener)
  on("SceneItemSelected", &listener)
end

#on_scene_item_transform_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SceneItemTransformChanged event.



1092
1093
1094
# File 'lib/obs/websocket/protocol.rb', line 1092

def on_scene_item_transform_changed(&listener)
  on("SceneItemTransformChanged", &listener)
end

#on_scene_item_visibility_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SceneItemVisibilityChanged event.



1078
1079
1080
# File 'lib/obs/websocket/protocol.rb', line 1078

def on_scene_item_visibility_changed(&listener)
  on("SceneItemVisibilityChanged", &listener)
end

#on_scenes_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for ScenesChanged event.



693
694
695
# File 'lib/obs/websocket/protocol.rb', line 693

def on_scenes_changed(&listener)
  on("ScenesChanged", &listener)
end

#on_source_audio_activated {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceAudioActivated event.



945
946
947
# File 'lib/obs/websocket/protocol.rb', line 945

def on_source_audio_activated(&listener)
  on("SourceAudioActivated", &listener)
end

#on_source_audio_deactivated {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceAudioDeactivated event.



938
939
940
# File 'lib/obs/websocket/protocol.rb', line 938

def on_source_audio_deactivated(&listener)
  on("SourceAudioDeactivated", &listener)
end

#on_source_audio_mixers_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceAudioMixersChanged event.



959
960
961
# File 'lib/obs/websocket/protocol.rb', line 959

def on_source_audio_mixers_changed(&listener)
  on("SourceAudioMixersChanged", &listener)
end

#on_source_audio_sync_offset_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceAudioSyncOffsetChanged event.



952
953
954
# File 'lib/obs/websocket/protocol.rb', line 952

def on_source_audio_sync_offset_changed(&listener)
  on("SourceAudioSyncOffsetChanged", &listener)
end

#on_source_created {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceCreated event.



910
911
912
# File 'lib/obs/websocket/protocol.rb', line 910

def on_source_created(&listener)
  on("SourceCreated", &listener)
end

#on_source_destroyed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceDestroyed event.



917
918
919
# File 'lib/obs/websocket/protocol.rb', line 917

def on_source_destroyed(&listener)
  on("SourceDestroyed", &listener)
end

#on_source_filter_added {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceFilterAdded event.



973
974
975
# File 'lib/obs/websocket/protocol.rb', line 973

def on_source_filter_added(&listener)
  on("SourceFilterAdded", &listener)
end

#on_source_filter_removed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceFilterRemoved event.



980
981
982
# File 'lib/obs/websocket/protocol.rb', line 980

def on_source_filter_removed(&listener)
  on("SourceFilterRemoved", &listener)
end

#on_source_filter_visibility_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceFilterVisibilityChanged event.



987
988
989
# File 'lib/obs/websocket/protocol.rb', line 987

def on_source_filter_visibility_changed(&listener)
  on("SourceFilterVisibilityChanged", &listener)
end

#on_source_filters_reordered {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceFiltersReordered event.



994
995
996
# File 'lib/obs/websocket/protocol.rb', line 994

def on_source_filters_reordered(&listener)
  on("SourceFiltersReordered", &listener)
end

#on_source_mute_state_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceMuteStateChanged event.



931
932
933
# File 'lib/obs/websocket/protocol.rb', line 931

def on_source_mute_state_changed(&listener)
  on("SourceMuteStateChanged", &listener)
end

#on_source_order_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceOrderChanged event.



1057
1058
1059
# File 'lib/obs/websocket/protocol.rb', line 1057

def on_source_order_changed(&listener)
  on("SourceOrderChanged", &listener)
end

#on_source_renamed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceRenamed event.



966
967
968
# File 'lib/obs/websocket/protocol.rb', line 966

def on_source_renamed(&listener)
  on("SourceRenamed", &listener)
end

#on_source_volume_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SourceVolumeChanged event.



924
925
926
# File 'lib/obs/websocket/protocol.rb', line 924

def on_source_volume_changed(&listener)
  on("SourceVolumeChanged", &listener)
end

#on_stream_started {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for StreamStarted event.



777
778
779
# File 'lib/obs/websocket/protocol.rb', line 777

def on_stream_started(&listener)
  on("StreamStarted", &listener)
end

#on_stream_starting {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for StreamStarting event.



770
771
772
# File 'lib/obs/websocket/protocol.rb', line 770

def on_stream_starting(&listener)
  on("StreamStarting", &listener)
end

#on_stream_status {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for StreamStatus event.



798
799
800
# File 'lib/obs/websocket/protocol.rb', line 798

def on_stream_status(&listener)
  on("StreamStatus", &listener)
end

#on_stream_stopped {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for StreamStopped event.



791
792
793
# File 'lib/obs/websocket/protocol.rb', line 791

def on_stream_stopped(&listener)
  on("StreamStopped", &listener)
end

#on_stream_stopping {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for StreamStopping event.



784
785
786
# File 'lib/obs/websocket/protocol.rb', line 784

def on_stream_stopping(&listener)
  on("StreamStopping", &listener)
end

#on_studio_mode_switched {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for StudioModeSwitched event.



1120
1121
1122
# File 'lib/obs/websocket/protocol.rb', line 1120

def on_studio_mode_switched(&listener)
  on("StudioModeSwitched", &listener)
end

#on_switch_scenes {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SwitchScenes event.



686
687
688
# File 'lib/obs/websocket/protocol.rb', line 686

def on_switch_scenes(&listener)
  on("SwitchScenes", &listener)
end

#on_switch_transition {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for SwitchTransition event.



714
715
716
# File 'lib/obs/websocket/protocol.rb', line 714

def on_switch_transition(&listener)
  on("SwitchTransition", &listener)
end

#on_transition_begin {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for TransitionBegin event.



735
736
737
# File 'lib/obs/websocket/protocol.rb', line 735

def on_transition_begin(&listener)
  on("TransitionBegin", &listener)
end

#on_transition_duration_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for TransitionDurationChanged event.



728
729
730
# File 'lib/obs/websocket/protocol.rb', line 728

def on_transition_duration_changed(&listener)
  on("TransitionDurationChanged", &listener)
end

#on_transition_end {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for TransitionEnd event.



742
743
744
# File 'lib/obs/websocket/protocol.rb', line 742

def on_transition_end(&listener)
  on("TransitionEnd", &listener)
end

#on_transition_list_changed {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for TransitionListChanged event.



721
722
723
# File 'lib/obs/websocket/protocol.rb', line 721

def on_transition_list_changed(&listener)
  on("TransitionListChanged", &listener)
end

#on_transition_video_end {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for TransitionVideoEnd event.



749
750
751
# File 'lib/obs/websocket/protocol.rb', line 749

def on_transition_video_end(&listener)
  on("TransitionVideoEnd", &listener)
end

#on_virtual_cam_started {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for VirtualCamStarted event.



847
848
849
# File 'lib/obs/websocket/protocol.rb', line 847

def on_virtual_cam_started(&listener)
  on("VirtualCamStarted", &listener)
end

#on_virtual_cam_stopped {|event| ... } ⇒ void

This method returns an undefined value.

Adds an event handler for VirtualCamStopped event.



854
855
856
# File 'lib/obs/websocket/protocol.rb', line 854

def on_virtual_cam_stopped(&listener)
  on("VirtualCamStopped", &listener)
end