module OBS::WebSocket::Protocol::Event::Mixin
Public Instance Methods
Adds an event handler for BroadcastCustomMessage
event. @yieldparam event [Events::BroadcastCustomMessage] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#broadcastcustommessage
# File lib/obs/websocket/protocol.rb, line 903 def on_broadcast_custom_message(&listener) on("BroadcastCustomMessage", &listener) end
Adds an event handler for Exiting
event. @yieldparam event [Events::Exiting] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#exiting
# File lib/obs/websocket/protocol.rb, line 889 def on_exiting(&listener) on("Exiting", &listener) end
Adds an event handler for Heartbeat
event. @yieldparam event [Events::Heartbeat] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#heartbeat
# File lib/obs/websocket/protocol.rb, line 896 def on_heartbeat(&listener) on("Heartbeat", &listener) end
Adds an event handler for MediaEnded
event. @yieldparam event [Events::MediaEnded] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediaended
# File lib/obs/websocket/protocol.rb, line 1050 def on_media_ended(&listener) on("MediaEnded", &listener) end
Adds an event handler for MediaNext
event. @yieldparam event [Events::MediaNext] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#medianext
# File lib/obs/websocket/protocol.rb, line 1029 def on_media_next(&listener) on("MediaNext", &listener) end
Adds an event handler for MediaPaused
event. @yieldparam event [Events::MediaPaused] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediapaused
# File lib/obs/websocket/protocol.rb, line 1008 def on_media_paused(&listener) on("MediaPaused", &listener) end
Adds an event handler for MediaPlaying
event. @yieldparam event [Events::MediaPlaying] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediaplaying
# File lib/obs/websocket/protocol.rb, line 1001 def on_media_playing(&listener) on("MediaPlaying", &listener) end
Adds an event handler for MediaPrevious
event. @yieldparam event [Events::MediaPrevious] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediaprevious
# File lib/obs/websocket/protocol.rb, line 1036 def on_media_previous(&listener) on("MediaPrevious", &listener) end
Adds an event handler for MediaRestarted
event. @yieldparam event [Events::MediaRestarted] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediarestarted
# File lib/obs/websocket/protocol.rb, line 1015 def on_media_restarted(&listener) on("MediaRestarted", &listener) end
Adds an event handler for MediaStarted
event. @yieldparam event [Events::MediaStarted] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediastarted
# File lib/obs/websocket/protocol.rb, line 1043 def on_media_started(&listener) on("MediaStarted", &listener) end
Adds an event handler for MediaStopped
event. @yieldparam event [Events::MediaStopped] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#mediastopped
# File lib/obs/websocket/protocol.rb, line 1022 def on_media_stopped(&listener) on("MediaStopped", &listener) end
Adds an event handler for PreviewSceneChanged
event. @yieldparam event [Events::PreviewSceneChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#previewscenechanged
# File lib/obs/websocket/protocol.rb, line 1113 def on_preview_scene_changed(&listener) on("PreviewSceneChanged", &listener) end
Adds an event handler for ProfileChanged
event. @yieldparam event [Events::ProfileChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#profilechanged
# File lib/obs/websocket/protocol.rb, line 756 def on_profile_changed(&listener) on("ProfileChanged", &listener) end
Adds an event handler for ProfileListChanged
event. @yieldparam event [Events::ProfileListChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#profilelistchanged
# File lib/obs/websocket/protocol.rb, line 763 def on_profile_list_changed(&listener) on("ProfileListChanged", &listener) end
Adds an event handler for RecordingPaused
event. @yieldparam event [Events::RecordingPaused] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingpaused
# File lib/obs/websocket/protocol.rb, line 833 def on_recording_paused(&listener) on("RecordingPaused", &listener) end
Adds an event handler for RecordingResumed
event. @yieldparam event [Events::RecordingResumed] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingresumed
# File lib/obs/websocket/protocol.rb, line 840 def on_recording_resumed(&listener) on("RecordingResumed", &listener) end
Adds an event handler for RecordingStarted
event. @yieldparam event [Events::RecordingStarted] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingstarted
# File lib/obs/websocket/protocol.rb, line 812 def on_recording_started(&listener) on("RecordingStarted", &listener) end
Adds an event handler for RecordingStarting
event. @yieldparam event [Events::RecordingStarting] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingstarting
# File lib/obs/websocket/protocol.rb, line 805 def on_recording_starting(&listener) on("RecordingStarting", &listener) end
Adds an event handler for RecordingStopped
event. @yieldparam event [Events::RecordingStopped] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingstopped
# File lib/obs/websocket/protocol.rb, line 826 def on_recording_stopped(&listener) on("RecordingStopped", &listener) end
Adds an event handler for RecordingStopping
event. @yieldparam event [Events::RecordingStopping] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#recordingstopping
# File lib/obs/websocket/protocol.rb, line 819 def on_recording_stopping(&listener) on("RecordingStopping", &listener) end
Adds an event handler for ReplayStarted
event. @yieldparam event [Events::ReplayStarted] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#replaystarted
# File lib/obs/websocket/protocol.rb, line 868 def on_replay_started(&listener) on("ReplayStarted", &listener) end
Adds an event handler for ReplayStarting
event. @yieldparam event [Events::ReplayStarting] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#replaystarting
# File lib/obs/websocket/protocol.rb, line 861 def on_replay_starting(&listener) on("ReplayStarting", &listener) end
Adds an event handler for ReplayStopped
event. @yieldparam event [Events::ReplayStopped] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#replaystopped
# File lib/obs/websocket/protocol.rb, line 882 def on_replay_stopped(&listener) on("ReplayStopped", &listener) end
Adds an event handler for ReplayStopping
event. @yieldparam event [Events::ReplayStopping] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#replaystopping
# File lib/obs/websocket/protocol.rb, line 875 def on_replay_stopping(&listener) on("ReplayStopping", &listener) end
Adds an event handler for SceneCollectionChanged
event. @yieldparam event [Events::SceneCollectionChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#scenecollectionchanged
# File lib/obs/websocket/protocol.rb, line 700 def on_scene_collection_changed(&listener) on("SceneCollectionChanged", &listener) end
Adds an event handler for SceneCollectionListChanged
event. @yieldparam event [Events::SceneCollectionListChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#scenecollectionlistchanged
# File lib/obs/websocket/protocol.rb, line 707 def on_scene_collection_list_changed(&listener) on("SceneCollectionListChanged", &listener) end
Adds an event handler for SceneItemAdded
event. @yieldparam event [Events::SceneItemAdded] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemadded
# File lib/obs/websocket/protocol.rb, line 1064 def on_scene_item_added(&listener) on("SceneItemAdded", &listener) end
Adds an event handler for SceneItemDeselected
event. @yieldparam event [Events::SceneItemDeselected] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemdeselected
# File lib/obs/websocket/protocol.rb, line 1106 def on_scene_item_deselected(&listener) on("SceneItemDeselected", &listener) end
Adds an event handler for SceneItemLockChanged
event. @yieldparam event [Events::SceneItemLockChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemlockchanged
# File lib/obs/websocket/protocol.rb, line 1085 def on_scene_item_lock_changed(&listener) on("SceneItemLockChanged", &listener) end
Adds an event handler for SceneItemRemoved
event. @yieldparam event [Events::SceneItemRemoved] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemremoved
# File lib/obs/websocket/protocol.rb, line 1071 def on_scene_item_removed(&listener) on("SceneItemRemoved", &listener) end
Adds an event handler for SceneItemSelected
event. @yieldparam event [Events::SceneItemSelected] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemselected
# File lib/obs/websocket/protocol.rb, line 1099 def on_scene_item_selected(&listener) on("SceneItemSelected", &listener) end
Adds an event handler for SceneItemTransformChanged
event. @yieldparam event [Events::SceneItemTransformChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemtransformchanged
# File lib/obs/websocket/protocol.rb, line 1092 def on_scene_item_transform_changed(&listener) on("SceneItemTransformChanged", &listener) end
Adds an event handler for SceneItemVisibilityChanged
event. @yieldparam event [Events::SceneItemVisibilityChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneitemvisibilitychanged
# File lib/obs/websocket/protocol.rb, line 1078 def on_scene_item_visibility_changed(&listener) on("SceneItemVisibilityChanged", &listener) end
Adds an event handler for ScenesChanged
event. @yieldparam event [Events::ScenesChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sceneschanged
# File lib/obs/websocket/protocol.rb, line 693 def on_scenes_changed(&listener) on("ScenesChanged", &listener) end
Adds an event handler for SourceAudioActivated
event. @yieldparam event [Events::SourceAudioActivated] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourceaudioactivated
# File lib/obs/websocket/protocol.rb, line 945 def on_source_audio_activated(&listener) on("SourceAudioActivated", &listener) end
Adds an event handler for SourceAudioDeactivated
event. @yieldparam event [Events::SourceAudioDeactivated] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourceaudiodeactivated
# File lib/obs/websocket/protocol.rb, line 938 def on_source_audio_deactivated(&listener) on("SourceAudioDeactivated", &listener) end
Adds an event handler for SourceAudioMixersChanged
event. @yieldparam event [Events::SourceAudioMixersChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourceaudiomixerschanged
# File lib/obs/websocket/protocol.rb, line 959 def on_source_audio_mixers_changed(&listener) on("SourceAudioMixersChanged", &listener) end
Adds an event handler for SourceAudioSyncOffsetChanged
event. @yieldparam event [Events::SourceAudioSyncOffsetChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourceaudiosyncoffsetchanged
# File lib/obs/websocket/protocol.rb, line 952 def on_source_audio_sync_offset_changed(&listener) on("SourceAudioSyncOffsetChanged", &listener) end
Adds an event handler for SourceCreated
event. @yieldparam event [Events::SourceCreated] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcecreated
# File lib/obs/websocket/protocol.rb, line 910 def on_source_created(&listener) on("SourceCreated", &listener) end
Adds an event handler for SourceDestroyed
event. @yieldparam event [Events::SourceDestroyed] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcedestroyed
# File lib/obs/websocket/protocol.rb, line 917 def on_source_destroyed(&listener) on("SourceDestroyed", &listener) end
Adds an event handler for SourceFilterAdded
event. @yieldparam event [Events::SourceFilterAdded] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcefilteradded
# File lib/obs/websocket/protocol.rb, line 973 def on_source_filter_added(&listener) on("SourceFilterAdded", &listener) end
Adds an event handler for SourceFilterRemoved
event. @yieldparam event [Events::SourceFilterRemoved] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcefilterremoved
# File lib/obs/websocket/protocol.rb, line 980 def on_source_filter_removed(&listener) on("SourceFilterRemoved", &listener) end
Adds an event handler for SourceFilterVisibilityChanged
event. @yieldparam event [Events::SourceFilterVisibilityChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcefiltervisibilitychanged
# File lib/obs/websocket/protocol.rb, line 987 def on_source_filter_visibility_changed(&listener) on("SourceFilterVisibilityChanged", &listener) end
Adds an event handler for SourceFiltersReordered
event. @yieldparam event [Events::SourceFiltersReordered] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcefiltersreordered
# File lib/obs/websocket/protocol.rb, line 994 def on_source_filters_reordered(&listener) on("SourceFiltersReordered", &listener) end
Adds an event handler for SourceMuteStateChanged
event. @yieldparam event [Events::SourceMuteStateChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcemutestatechanged
# File lib/obs/websocket/protocol.rb, line 931 def on_source_mute_state_changed(&listener) on("SourceMuteStateChanged", &listener) end
Adds an event handler for SourceOrderChanged
event. @yieldparam event [Events::SourceOrderChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourceorderchanged
# File lib/obs/websocket/protocol.rb, line 1057 def on_source_order_changed(&listener) on("SourceOrderChanged", &listener) end
Adds an event handler for SourceRenamed
event. @yieldparam event [Events::SourceRenamed] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcerenamed
# File lib/obs/websocket/protocol.rb, line 966 def on_source_renamed(&listener) on("SourceRenamed", &listener) end
Adds an event handler for SourceVolumeChanged
event. @yieldparam event [Events::SourceVolumeChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sourcevolumechanged
# File lib/obs/websocket/protocol.rb, line 924 def on_source_volume_changed(&listener) on("SourceVolumeChanged", &listener) end
Adds an event handler for StreamStarted
event. @yieldparam event [Events::StreamStarted] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#streamstarted
# File lib/obs/websocket/protocol.rb, line 777 def on_stream_started(&listener) on("StreamStarted", &listener) end
Adds an event handler for StreamStarting
event. @yieldparam event [Events::StreamStarting] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#streamstarting
# File lib/obs/websocket/protocol.rb, line 770 def on_stream_starting(&listener) on("StreamStarting", &listener) end
Adds an event handler for StreamStatus
event. @yieldparam event [Events::StreamStatus] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#streamstatus
# File lib/obs/websocket/protocol.rb, line 798 def on_stream_status(&listener) on("StreamStatus", &listener) end
Adds an event handler for StreamStopped
event. @yieldparam event [Events::StreamStopped] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#streamstopped
# File lib/obs/websocket/protocol.rb, line 791 def on_stream_stopped(&listener) on("StreamStopped", &listener) end
Adds an event handler for StreamStopping
event. @yieldparam event [Events::StreamStopping] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#streamstopping
# File lib/obs/websocket/protocol.rb, line 784 def on_stream_stopping(&listener) on("StreamStopping", &listener) end
Adds an event handler for StudioModeSwitched
event. @yieldparam event [Events::StudioModeSwitched] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#studiomodeswitched
# File lib/obs/websocket/protocol.rb, line 1120 def on_studio_mode_switched(&listener) on("StudioModeSwitched", &listener) end
Adds an event handler for SwitchScenes
event. @yieldparam event [Events::SwitchScenes] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#switchscenes
# File lib/obs/websocket/protocol.rb, line 686 def on_switch_scenes(&listener) on("SwitchScenes", &listener) end
Adds an event handler for SwitchTransition
event. @yieldparam event [Events::SwitchTransition] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#switchtransition
# File lib/obs/websocket/protocol.rb, line 714 def on_switch_transition(&listener) on("SwitchTransition", &listener) end
Adds an event handler for TransitionBegin
event. @yieldparam event [Events::TransitionBegin] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitionbegin
# File lib/obs/websocket/protocol.rb, line 735 def on_transition_begin(&listener) on("TransitionBegin", &listener) end
Adds an event handler for TransitionDurationChanged
event. @yieldparam event [Events::TransitionDurationChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitiondurationchanged
# File lib/obs/websocket/protocol.rb, line 728 def on_transition_duration_changed(&listener) on("TransitionDurationChanged", &listener) end
Adds an event handler for TransitionEnd
event. @yieldparam event [Events::TransitionEnd] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitionend
# File lib/obs/websocket/protocol.rb, line 742 def on_transition_end(&listener) on("TransitionEnd", &listener) end
Adds an event handler for TransitionListChanged
event. @yieldparam event [Events::TransitionListChanged] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitionlistchanged
# File lib/obs/websocket/protocol.rb, line 721 def on_transition_list_changed(&listener) on("TransitionListChanged", &listener) end
Adds an event handler for TransitionVideoEnd
event. @yieldparam event [Events::TransitionVideoEnd] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitionvideoend
# File lib/obs/websocket/protocol.rb, line 749 def on_transition_video_end(&listener) on("TransitionVideoEnd", &listener) end
Adds an event handler for VirtualCamStarted
event. @yieldparam event [Events::VirtualCamStarted] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#virtualcamstarted
# File lib/obs/websocket/protocol.rb, line 847 def on_virtual_cam_started(&listener) on("VirtualCamStarted", &listener) end
Adds an event handler for VirtualCamStopped
event. @yieldparam event [Events::VirtualCamStopped] the event object @return [void] @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#virtualcamstopped
# File lib/obs/websocket/protocol.rb, line 854 def on_virtual_cam_stopped(&listener) on("VirtualCamStopped", &listener) end