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

Included in:

Client

Defined in:

lib/obs/websocket/protocol.rb

Overview

module Events

Instance Method Summary

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

  Adds an event handler for BroadcastCustomMessage event.

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

  Adds an event handler for Exiting event.

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

  Adds an event handler for Heartbeat event.

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

  Adds an event handler for MediaEnded event.

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

  Adds an event handler for MediaNext event.

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

  Adds an event handler for MediaPaused event.

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

  Adds an event handler for MediaPlaying event.

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

  Adds an event handler for MediaPrevious event.

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

  Adds an event handler for MediaRestarted event.

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

  Adds an event handler for MediaStarted event.

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

  Adds an event handler for MediaStopped event.

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

  Adds an event handler for PreviewSceneChanged event.

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

  Adds an event handler for ProfileChanged event.

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

  Adds an event handler for ProfileListChanged event.

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

  Adds an event handler for RecordingPaused event.

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

  Adds an event handler for RecordingResumed event.

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

  Adds an event handler for RecordingStarted event.

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

  Adds an event handler for RecordingStarting event.

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

  Adds an event handler for RecordingStopped event.

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

  Adds an event handler for RecordingStopping event.

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

  Adds an event handler for ReplayStarted event.

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

  Adds an event handler for ReplayStarting event.

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

  Adds an event handler for ReplayStopped event.

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

  Adds an event handler for ReplayStopping event.

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

  Adds an event handler for SceneCollectionChanged event.

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

  Adds an event handler for SceneCollectionListChanged event.

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

  Adds an event handler for SceneItemAdded event.

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

  Adds an event handler for SceneItemDeselected event.

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

  Adds an event handler for SceneItemLockChanged event.

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

  Adds an event handler for SceneItemRemoved event.

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

  Adds an event handler for SceneItemSelected event.

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

  Adds an event handler for SceneItemTransformChanged event.

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

  Adds an event handler for SceneItemVisibilityChanged event.

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

  Adds an event handler for ScenesChanged event.

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

  Adds an event handler for SourceAudioActivated event.

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

  Adds an event handler for SourceAudioDeactivated event.

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

  Adds an event handler for SourceAudioMixersChanged event.

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

  Adds an event handler for SourceAudioSyncOffsetChanged event.

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

  Adds an event handler for SourceCreated event.

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

  Adds an event handler for SourceDestroyed event.

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

  Adds an event handler for SourceFilterAdded event.

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

  Adds an event handler for SourceFilterRemoved event.

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

  Adds an event handler for SourceFilterVisibilityChanged event.

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

  Adds an event handler for SourceFiltersReordered event.

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

  Adds an event handler for SourceMuteStateChanged event.

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

  Adds an event handler for SourceOrderChanged event.

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

  Adds an event handler for SourceRenamed event.

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

  Adds an event handler for SourceVolumeChanged event.

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

  Adds an event handler for StreamStarted event.

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

  Adds an event handler for StreamStarting event.

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

  Adds an event handler for StreamStatus event.

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

  Adds an event handler for StreamStopped event.

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

  Adds an event handler for StreamStopping event.

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

  Adds an event handler for StudioModeSwitched event.

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

  Adds an event handler for SwitchScenes event.

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

  Adds an event handler for SwitchTransition event.

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

  Adds an event handler for TransitionBegin event.

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

  Adds an event handler for TransitionDurationChanged event.

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

  Adds an event handler for TransitionEnd event.

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

  Adds an event handler for TransitionListChanged event.

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

  Adds an event handler for TransitionVideoEnd event.

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

  Adds an event handler for VirtualCamStarted event.

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

  Adds an event handler for VirtualCamStopped event.

Instance Method Details

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

This method returns an undefined value.

Adds an event handler for BroadcastCustomMessage event.

Yield Parameters:

• event (Events::BroadcastCustomMessage) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for Exiting event.

Yield Parameters:

• event (Events::Exiting) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for Heartbeat event.

Yield Parameters:

• event (Events::Heartbeat) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for MediaEnded event.

Yield Parameters:

• event (Events::MediaEnded) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for MediaNext event.

Yield Parameters:

• event (Events::MediaNext) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for MediaPaused event.

Yield Parameters:

• event (Events::MediaPaused) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for MediaPlaying event.

Yield Parameters:

• event (Events::MediaPlaying) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for MediaPrevious event.

Yield Parameters:

• event (Events::MediaPrevious) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for MediaRestarted event.

Yield Parameters:

• event (Events::MediaRestarted) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for MediaStarted event.

Yield Parameters:

• event (Events::MediaStarted) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for MediaStopped event.

Yield Parameters:

• event (Events::MediaStopped) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for PreviewSceneChanged event.

Yield Parameters:

• event (Events::PreviewSceneChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for ProfileChanged event.

Yield Parameters:

• event (Events::ProfileChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for ProfileListChanged event.

Yield Parameters:

• event (Events::ProfileListChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for RecordingPaused event.

Yield Parameters:

• event (Events::RecordingPaused) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for RecordingResumed event.

Yield Parameters:

• event (Events::RecordingResumed) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for RecordingStarted event.

Yield Parameters:

• event (Events::RecordingStarted) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for RecordingStarting event.

Yield Parameters:

• event (Events::RecordingStarting) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for RecordingStopped event.

Yield Parameters:

• event (Events::RecordingStopped) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for RecordingStopping event.

Yield Parameters:

• event (Events::RecordingStopping) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for ReplayStarted event.

Yield Parameters:

• event (Events::ReplayStarted) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for ReplayStarting event.

Yield Parameters:

• event (Events::ReplayStarting) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for ReplayStopped event.

Yield Parameters:

• event (Events::ReplayStopped) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for ReplayStopping event.

Yield Parameters:

• event (Events::ReplayStopping) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SceneCollectionChanged event.

Yield Parameters:

• event (Events::SceneCollectionChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SceneCollectionListChanged event.

Yield Parameters:

• event (Events::SceneCollectionListChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SceneItemAdded event.

Yield Parameters:

• event (Events::SceneItemAdded) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SceneItemDeselected event.

Yield Parameters:

• event (Events::SceneItemDeselected) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SceneItemLockChanged event.

Yield Parameters:

• event (Events::SceneItemLockChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SceneItemRemoved event.

Yield Parameters:

• event (Events::SceneItemRemoved) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SceneItemSelected event.

Yield Parameters:

• event (Events::SceneItemSelected) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SceneItemTransformChanged event.

Yield Parameters:

• event (Events::SceneItemTransformChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SceneItemVisibilityChanged event.

Yield Parameters:

• event (Events::SceneItemVisibilityChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for ScenesChanged event.

Yield Parameters:

• event (Events::ScenesChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceAudioActivated event.

Yield Parameters:

• event (Events::SourceAudioActivated) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceAudioDeactivated event.

Yield Parameters:

• event (Events::SourceAudioDeactivated) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceAudioMixersChanged event.

Yield Parameters:

• event (Events::SourceAudioMixersChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceAudioSyncOffsetChanged event.

Yield Parameters:

• event (Events::SourceAudioSyncOffsetChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceCreated event.

Yield Parameters:

• event (Events::SourceCreated) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceDestroyed event.

Yield Parameters:

• event (Events::SourceDestroyed) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceFilterAdded event.

Yield Parameters:

• event (Events::SourceFilterAdded) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceFilterRemoved event.

Yield Parameters:

• event (Events::SourceFilterRemoved) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceFilterVisibilityChanged event.

Yield Parameters:

• event (Events::SourceFilterVisibilityChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceFiltersReordered event.

Yield Parameters:

• event (Events::SourceFiltersReordered) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceMuteStateChanged event.

Yield Parameters:

• event (Events::SourceMuteStateChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceOrderChanged event.

Yield Parameters:

• event (Events::SourceOrderChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceRenamed event.

Yield Parameters:

• event (Events::SourceRenamed) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SourceVolumeChanged event.

Yield Parameters:

• event (Events::SourceVolumeChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for StreamStarted event.

Yield Parameters:

• event (Events::StreamStarted) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for StreamStarting event.

Yield Parameters:

• event (Events::StreamStarting) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for StreamStatus event.

Yield Parameters:

• event (Events::StreamStatus) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for StreamStopped event.

Yield Parameters:

• event (Events::StreamStopped) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for StreamStopping event.

Yield Parameters:

• event (Events::StreamStopping) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for StudioModeSwitched event.

Yield Parameters:

• event (Events::StudioModeSwitched) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SwitchScenes event.

Yield Parameters:

• event (Events::SwitchScenes) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for SwitchTransition event.

Yield Parameters:

• event (Events::SwitchTransition) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for TransitionBegin event.

Yield Parameters:

• event (Events::TransitionBegin) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for TransitionDurationChanged event.

Yield Parameters:

• event (Events::TransitionDurationChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for TransitionEnd event.

Yield Parameters:

• event (Events::TransitionEnd) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for TransitionListChanged event.

Yield Parameters:

• event (Events::TransitionListChanged) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for TransitionVideoEnd event.

Yield Parameters:

• event (Events::TransitionVideoEnd) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for VirtualCamStarted event.

Yield Parameters:

• event (Events::VirtualCamStarted) —

  the event object

See Also:

• https://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

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

This method returns an undefined value.

Adds an event handler for VirtualCamStopped event.

Yield Parameters:

• event (Events::VirtualCamStopped) —

  the event object

See Also:

• https://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