module OBS::WebSocket::Protocol::Request::Mixin
Public Instance Methods
Sends AddFilterToSource
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#addfiltertosource @param source_name [String] sourceName
field @param filter_name [String] filterName
field @param filter_type [String] filterType
field @param filter_settings [Hash] filterSettings
field @return [Future<Responses::AddFilterToSource>]
# File lib/obs/websocket/protocol.rb, line 2829 def add_filter_to_source(source_name:, filter_name:, filter_type:, filter_settings:) send_request(Requests::AddFilterToSource.new({source_name: source_name, filter_name: filter_name, filter_type: filter_type, filter_settings: filter_settings})) end
Sends AddSceneItem
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#addsceneitem @param scene_name [String] sceneName
field @param source_name [String] sourceName
field @param set_visible [Boolean, nil] setVisible
field @return [Future<Responses::AddSceneItem>]
# File lib/obs/websocket/protocol.rb, line 3161 def add_scene_item(scene_name:, source_name:, set_visible: nil) send_request(Requests::AddSceneItem.new({scene_name: scene_name, source_name: source_name, set_visible: set_visible})) end
Sends Authenticate
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#authenticate @param auth [String] auth
field @return [Future<Responses::Authenticate>]
# File lib/obs/websocket/protocol.rb, line 2418 def authenticate(auth:) send_request(Requests::Authenticate.new({auth: auth})) end
Sends BroadcastCustomMessage
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#broadcastcustommessage @param realm [String] realm
field @param data [Hash] data
field @return [Future<Responses::BroadcastCustomMessage>]
# File lib/obs/websocket/protocol.rb, line 2453 def broadcast_custom_message(realm:, data:) send_request(Requests::BroadcastCustomMessage.new({realm: realm, data: data})) end
Sends CreateScene
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#createscene @param scene_name [String] sceneName
field @return [Future<Responses::CreateScene>]
# File lib/obs/websocket/protocol.rb, line 3196 def create_scene(scene_name:) send_request(Requests::CreateScene.new({scene_name: scene_name})) end
Sends CreateSource
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#createsource @param source_name [String] sourceName
field @param source_kind [String] sourceKind
field @param scene_name [String] sceneName
field @param source_settings [Hash, nil] sourceSettings
field @param set_visible [Boolean, nil] setVisible
field @return [Future<Responses::CreateSource>]
# File lib/obs/websocket/protocol.rb, line 2589 def create_source(source_name:, source_kind:, scene_name:, source_settings: nil, set_visible: nil) 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})) end
Sends DeleteSceneItem
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#deletesceneitem @param scene [String, nil] scene
field @param item [Hash] item
field @return [Future<Responses::DeleteSceneItem>]
# File lib/obs/websocket/protocol.rb, line 3152 def delete_scene_item(scene: nil, item:) send_request(Requests::DeleteSceneItem.new({scene: scene, item: item})) end
Sends DisableStudioMode
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#disablestudiomode @return [Future<Responses::DisableStudioMode>]
# File lib/obs/websocket/protocol.rb, line 3318 def disable_studio_mode() send_request(Requests::DisableStudioMode.new({})) end
Sends DuplicateSceneItem
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#duplicatesceneitem @param from_scene [String, nil] fromScene
field @param to_scene [String, nil] toScene
field @param item [Hash] item
field @return [Future<Responses::DuplicateSceneItem>]
# File lib/obs/websocket/protocol.rb, line 3170 def duplicate_scene_item(from_scene: nil, to_scene: nil, item:) send_request(Requests::DuplicateSceneItem.new({from_scene: from_scene, to_scene: to_scene, item: item})) end
Sends EnableStudioMode
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#enablestudiomode @return [Future<Responses::EnableStudioMode>]
# File lib/obs/websocket/protocol.rb, line 3312 def enable_studio_mode() send_request(Requests::EnableStudioMode.new({})) end
Sends ExecuteBatch
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#executebatch @param requests [Array<Hash>] requests
field @param abort_on_fail [Boolean, nil] abortOnFail
field @return [Future<Responses::ExecuteBatch>]
# File lib/obs/websocket/protocol.rb, line 2492 def execute_batch(requests:, abort_on_fail: nil) send_request(Requests::ExecuteBatch.new({requests: requests, abort_on_fail: abort_on_fail})) end
Sends GetAudioActive
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getaudioactive @param source_name [String] sourceName
field @return [Future<Responses::GetAudioActive>]
# File lib/obs/websocket/protocol.rb, line 2670 def get_audio_active(source_name:) send_request(Requests::GetAudioActive.new({source_name: source_name})) end
Sends GetAudioMonitorType
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getaudiomonitortype @param source_name [String] sourceName
field @return [Future<Responses::GetAudioMonitorType>]
# File lib/obs/websocket/protocol.rb, line 2880 def get_audio_monitor_type(source_name:) send_request(Requests::GetAudioMonitorType.new({source_name: source_name})) end
Sends GetAuthRequired
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getauthrequired @return [Future<Responses::GetAuthRequired>]
# File lib/obs/websocket/protocol.rb, line 2411 def get_auth_required() send_request(Requests::GetAuthRequired.new({})) end
Sends GetBrowserSourceProperties
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getbrowsersourceproperties @param source [String] source
field @deprecated This type of request is deprecated. @return [Future<Responses::GetBrowserSourceProperties>]
# File lib/obs/websocket/protocol.rb, line 2781 def get_browser_source_properties(source:) send_request(Requests::GetBrowserSourceProperties.new({source: source})) end
Sends GetCurrentProfile
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentprofile @return [Future<Responses::GetCurrentProfile>]
# File lib/obs/websocket/protocol.rb, line 2956 def get_current_profile() send_request(Requests::GetCurrentProfile.new({})) end
Sends GetCurrentScene
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentscene @return [Future<Responses::GetCurrentScene>]
# File lib/obs/websocket/protocol.rb, line 3183 def get_current_scene() send_request(Requests::GetCurrentScene.new({})) end
Sends GetCurrentSceneCollection
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrentscenecollection @return [Future<Responses::GetCurrentSceneCollection>]
# File lib/obs/websocket/protocol.rb, line 3054 def get_current_scene_collection() send_request(Requests::GetCurrentSceneCollection.new({})) end
Sends GetCurrentTransition
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getcurrenttransition @return [Future<Responses::GetCurrentTransition>]
# File lib/obs/websocket/protocol.rb, line 3336 def get_current_transition() send_request(Requests::GetCurrentTransition.new({})) end
Sends GetFilenameFormatting
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getfilenameformatting @return [Future<Responses::GetFilenameFormatting>]
# File lib/obs/websocket/protocol.rb, line 2439 def get_filename_formatting() send_request(Requests::GetFilenameFormatting.new({})) end
Sends GetMediaDuration
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediaduration @param source_name [String] sourceName
field @return [Future<Responses::GetMediaDuration>]
# File lib/obs/websocket/protocol.rb, line 2542 def get_media_duration(source_name:) send_request(Requests::GetMediaDuration.new({source_name: source_name})) end
Sends GetMediaSourcesList
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediasourceslist @return [Future<Responses::GetMediaSourcesList>]
# File lib/obs/websocket/protocol.rb, line 2578 def get_media_sources_list() send_request(Requests::GetMediaSourcesList.new({})) end
Sends GetMediaState
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediastate @param source_name [String] sourceName
field @return [Future<Responses::GetMediaState>]
# File lib/obs/websocket/protocol.rb, line 2572 def get_media_state(source_name:) send_request(Requests::GetMediaState.new({source_name: source_name})) end
Sends GetMediaTime
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmediatime @param source_name [String] sourceName
field @return [Future<Responses::GetMediaTime>]
# File lib/obs/websocket/protocol.rb, line 2549 def get_media_time(source_name:) send_request(Requests::GetMediaTime.new({source_name: source_name})) end
Sends GetMute
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getmute @param source [String] source
field @return [Future<Responses::GetMute>]
# File lib/obs/websocket/protocol.rb, line 2641 def get_mute(source:) send_request(Requests::GetMute.new({source: source})) end
Sends GetOutputInfo
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getoutputinfo @param output_name [String] outputName
field @return [Future<Responses::GetOutputInfo>]
# File lib/obs/websocket/protocol.rb, line 2928 def get_output_info(output_name:) send_request(Requests::GetOutputInfo.new({output_name: output_name})) end
Sends GetPreviewScene
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getpreviewscene @return [Future<Responses::GetPreviewScene>]
# File lib/obs/websocket/protocol.rb, line 3292 def get_preview_scene() send_request(Requests::GetPreviewScene.new({})) end
Sends GetRecordingFolder
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getrecordingfolder @return [Future<Responses::GetRecordingFolder>]
# File lib/obs/websocket/protocol.rb, line 3011 def get_recording_folder() send_request(Requests::GetRecordingFolder.new({})) end
Sends GetRecordingStatus
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getrecordingstatus @return [Future<Responses::GetRecordingStatus>]
# File lib/obs/websocket/protocol.rb, line 2968 def get_recording_status() send_request(Requests::GetRecordingStatus.new({})) end
Sends GetReplayBufferStatus
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getreplaybufferstatus @return [Future<Responses::GetReplayBufferStatus>]
# File lib/obs/websocket/protocol.rb, line 3017 def get_replay_buffer_status() send_request(Requests::GetReplayBufferStatus.new({})) end
Sends GetSceneItemList
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsceneitemlist @param scene_name [String, nil] sceneName
field @return [Future<Responses::GetSceneItemList>]
# File lib/obs/websocket/protocol.rb, line 3067 def get_scene_item_list(scene_name: nil) send_request(Requests::GetSceneItemList.new({scene_name: scene_name})) end
Sends GetSceneItemProperties
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsceneitemproperties @param scene_name [String, nil] scene-name
field @param item [String, Object] item
field @return [Future<Responses::GetSceneItemProperties>]
# File lib/obs/websocket/protocol.rb, line 3075 def get_scene_item_properties(scene_name: nil, item:) send_request(Requests::GetSceneItemProperties.new({scene_name: scene_name, item: item})) end
Sends GetSceneList
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getscenelist @return [Future<Responses::GetSceneList>]
# File lib/obs/websocket/protocol.rb, line 3189 def get_scene_list() send_request(Requests::GetSceneList.new({})) end
Sends GetSceneTransitionOverride
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getscenetransitionoverride @param scene_name [String] sceneName
field @return [Future<Responses::GetSceneTransitionOverride>]
# File lib/obs/websocket/protocol.rb, line 3227 def get_scene_transition_override(scene_name:) send_request(Requests::GetSceneTransitionOverride.new({scene_name: scene_name})) end
Sends GetSourceActive
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourceactive @param source_name [String] sourceName
field @return [Future<Responses::GetSourceActive>]
# File lib/obs/websocket/protocol.rb, line 2663 def get_source_active(source_name:) send_request(Requests::GetSourceActive.new({source_name: source_name})) end
Sends GetSourceDefaultSettings
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcedefaultsettings @param source_kind [String] sourceKind
field @return [Future<Responses::GetSourceDefaultSettings>]
# File lib/obs/websocket/protocol.rb, line 2895 def get_source_default_settings(source_kind:) send_request(Requests::GetSourceDefaultSettings.new({source_kind: source_kind})) end
Sends GetSourceFilterInfo
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcefilterinfo @param source_name [String] sourceName
field @param filter_name [String] filterName
field @return [Future<Responses::GetSourceFilterInfo>]
# File lib/obs/websocket/protocol.rb, line 2819 def get_source_filter_info(source_name:, filter_name:) send_request(Requests::GetSourceFilterInfo.new({source_name: source_name, filter_name: filter_name})) end
Sends GetSourceFilters
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcefilters @param source_name [String] sourceName
field @return [Future<Responses::GetSourceFilters>]
# File lib/obs/websocket/protocol.rb, line 2811 def get_source_filters(source_name:) send_request(Requests::GetSourceFilters.new({source_name: source_name})) end
Sends GetSourceSettings
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcesettings @param source_name [String] sourceName
field @param source_type [String, nil] sourceType
field @return [Future<Responses::GetSourceSettings>]
# File lib/obs/websocket/protocol.rb, line 2701 def get_source_settings(source_name:, source_type: nil) send_request(Requests::GetSourceSettings.new({source_name: source_name, source_type: source_type})) end
Sends GetSourceTypesList
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourcetypeslist @return [Future<Responses::GetSourceTypesList>]
# File lib/obs/websocket/protocol.rb, line 2601 def get_source_types_list() send_request(Requests::GetSourceTypesList.new({})) end
Sends GetSourcesList
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsourceslist @return [Future<Responses::GetSourcesList>]
# File lib/obs/websocket/protocol.rb, line 2595 def get_sources_list() send_request(Requests::GetSourcesList.new({})) end
Sends GetSpecialSources
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getspecialsources @return [Future<Responses::GetSpecialSources>]
# File lib/obs/websocket/protocol.rb, line 2804 def get_special_sources() send_request(Requests::GetSpecialSources.new({})) end
Sends GetStats
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstats @return [Future<Responses::GetStats>]
# File lib/obs/websocket/protocol.rb, line 2445 def get_stats() send_request(Requests::GetStats.new({})) end
Sends GetStreamSettings
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstreamsettings @return [Future<Responses::GetStreamSettings>]
# File lib/obs/websocket/protocol.rb, line 3267 def get_stream_settings() send_request(Requests::GetStreamSettings.new({})) end
Sends GetStreamingStatus
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstreamingstatus @return [Future<Responses::GetStreamingStatus>]
# File lib/obs/websocket/protocol.rb, line 3233 def get_streaming_status() send_request(Requests::GetStreamingStatus.new({})) end
Sends GetStudioModeStatus
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getstudiomodestatus @return [Future<Responses::GetStudioModeStatus>]
# File lib/obs/websocket/protocol.rb, line 3286 def get_studio_mode_status() send_request(Requests::GetStudioModeStatus.new({})) end
Sends GetSyncOffset
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getsyncoffset @param source [String] source
field @return [Future<Responses::GetSyncOffset>]
# File lib/obs/websocket/protocol.rb, line 2693 def get_sync_offset(source:) send_request(Requests::GetSyncOffset.new({source: source})) end
Sends GetTextFreetype2Properties
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettextfreetype2properties @param source [String] source
field @return [Future<Responses::GetTextFreetype2Properties>]
# File lib/obs/websocket/protocol.rb, line 2755 def get_text_freetype2_properties(source:) send_request(Requests::GetTextFreetype2Properties.new({source: source})) end
Sends GetTextGDIPlusProperties
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettextgdiplusproperties @param source [String] source
field @return [Future<Responses::GetTextGDIPlusProperties>]
# File lib/obs/websocket/protocol.rb, line 2717 def get_text_gdi_plus_properties(source:) send_request(Requests::GetTextGDIPlusProperties.new({source: source})) end
Sends GetTracks
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettracks @param source_name [String] sourceName
field @return [Future<Responses::GetTracks>]
# File lib/obs/websocket/protocol.rb, line 2634 def get_tracks(source_name:) send_request(Requests::GetTracks.new({source_name: source_name})) end
Sends GetTransitionDuration
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionduration @return [Future<Responses::GetTransitionDuration>]
# File lib/obs/websocket/protocol.rb, line 3356 def get_transition_duration() send_request(Requests::GetTransitionDuration.new({})) end
Sends GetTransitionList
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionlist @return [Future<Responses::GetTransitionList>]
# File lib/obs/websocket/protocol.rb, line 3330 def get_transition_list() send_request(Requests::GetTransitionList.new({})) end
Sends GetTransitionPosition
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionposition @return [Future<Responses::GetTransitionPosition>]
# File lib/obs/websocket/protocol.rb, line 3362 def get_transition_position() send_request(Requests::GetTransitionPosition.new({})) end
Sends GetTransitionSettings
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#gettransitionsettings @param transition_name [String] transitionName
field @return [Future<Responses::GetTransitionSettings>]
# File lib/obs/websocket/protocol.rb, line 3369 def get_transition_settings(transition_name:) send_request(Requests::GetTransitionSettings.new({transition_name: transition_name})) end
Sends GetVersion
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getversion @return [Future<Responses::GetVersion>]
# File lib/obs/websocket/protocol.rb, line 2405 def get_version() send_request(Requests::GetVersion.new({})) end
Sends GetVideoInfo
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvideoinfo @return [Future<Responses::GetVideoInfo>]
# File lib/obs/websocket/protocol.rb, line 2459 def get_video_info() send_request(Requests::GetVideoInfo.new({})) end
Sends GetVirtualCamStatus
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvirtualcamstatus @return [Future<Responses::GetVirtualCamStatus>]
# File lib/obs/websocket/protocol.rb, line 3397 def get_virtual_cam_status() send_request(Requests::GetVirtualCamStatus.new({})) end
Sends GetVolume
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getvolume @param source [String] source
field @param use_decibel [Boolean, nil] useDecibel
field @return [Future<Responses::GetVolume>]
# File lib/obs/websocket/protocol.rb, line 2609 def get_volume(source:, use_decibel: nil) send_request(Requests::GetVolume.new({source: source, use_decibel: use_decibel})) end
Sends ListOutputs
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listoutputs @return [Future<Responses::ListOutputs>]
# File lib/obs/websocket/protocol.rb, line 2921 def list_outputs() send_request(Requests::ListOutputs.new({})) end
Sends ListProfiles
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listprofiles @return [Future<Responses::ListProfiles>]
# File lib/obs/websocket/protocol.rb, line 2962 def list_profiles() send_request(Requests::ListProfiles.new({})) end
Sends ListSceneCollections
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#listscenecollections @return [Future<Responses::ListSceneCollections>]
# File lib/obs/websocket/protocol.rb, line 3060 def list_scene_collections() send_request(Requests::ListSceneCollections.new({})) end
Sends MoveSourceFilter
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#movesourcefilter @param source_name [String] sourceName
field @param filter_name [String] filterName
field @param movement_type [String] movementType
field @return [Future<Responses::MoveSourceFilter>]
# File lib/obs/websocket/protocol.rb, line 2855 def move_source_filter(source_name:, filter_name:, movement_type:) send_request(Requests::MoveSourceFilter.new({source_name: source_name, filter_name: filter_name, movement_type: movement_type})) end
Sends NextMedia
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#nextmedia @param source_name [String] sourceName
field @return [Future<Responses::NextMedia>]
# File lib/obs/websocket/protocol.rb, line 2528 def next_media(source_name:) send_request(Requests::NextMedia.new({source_name: source_name})) end
Sends OpenProjector
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#openprojector @param type [String, nil] type
field @param monitor [Integer, nil] monitor
field @param geometry [String, nil] geometry
field @param name [String, nil] name
field @return [Future<Responses::OpenProjector>]
# File lib/obs/websocket/protocol.rb, line 2469 def open_projector(type: nil, monitor: nil, geometry: nil, name: nil) send_request(Requests::OpenProjector.new({type: type, monitor: monitor, geometry: geometry, name: name})) end
Sends PauseRecording
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#pauserecording @return [Future<Responses::PauseRecording>]
# File lib/obs/websocket/protocol.rb, line 2992 def pause_recording() send_request(Requests::PauseRecording.new({})) end
Sends PlayPauseMedia
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#playpausemedia @param source_name [String] sourceName
field @param play_pause [Boolean] playPause
field @return [Future<Responses::PlayPauseMedia>]
# File lib/obs/websocket/protocol.rb, line 2507 def play_pause_media(source_name:, play_pause:) send_request(Requests::PlayPauseMedia.new({source_name: source_name, play_pause: play_pause})) end
Sends PreviousMedia
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#previousmedia @param source_name [String] sourceName
field @return [Future<Responses::PreviousMedia>]
# File lib/obs/websocket/protocol.rb, line 2535 def previous_media(source_name:) send_request(Requests::PreviousMedia.new({source_name: source_name})) end
Sends RefreshBrowserSource
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#refreshbrowsersource @param source_name [String] sourceName
field @return [Future<Responses::RefreshBrowserSource>]
# File lib/obs/websocket/protocol.rb, line 2915 def refresh_browser_source(source_name:) send_request(Requests::RefreshBrowserSource.new({source_name: source_name})) end
Sends ReleaseTBar
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#releasetbar @return [Future<Responses::ReleaseTBar>]
# File lib/obs/websocket/protocol.rb, line 3383 def release_t_bar() send_request(Requests::ReleaseTBar.new({})) end
Sends RemoveFilterFromSource
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#removefilterfromsource @param source_name [String] sourceName
field @param filter_name [String] filterName
field @return [Future<Responses::RemoveFilterFromSource>]
# File lib/obs/websocket/protocol.rb, line 2837 def remove_filter_from_source(source_name:, filter_name:) send_request(Requests::RemoveFilterFromSource.new({source_name: source_name, filter_name: filter_name})) end
Sends RemoveSceneTransitionOverride
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#removescenetransitionoverride @param scene_name [String] sceneName
field @return [Future<Responses::RemoveSceneTransitionOverride>]
# File lib/obs/websocket/protocol.rb, line 3220 def remove_scene_transition_override(scene_name:) send_request(Requests::RemoveSceneTransitionOverride.new({scene_name: scene_name})) end
Sends ReorderSceneItems
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#reordersceneitems @param scene [String, nil] scene
field @param items [Array<Hash>] items
field @return [Future<Responses::ReorderSceneItems>]
# File lib/obs/websocket/protocol.rb, line 3204 def reorder_scene_items(scene: nil, items:) send_request(Requests::ReorderSceneItems.new({scene: scene, items: items})) end
Sends ReorderSourceFilter
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#reordersourcefilter @param source_name [String] sourceName
field @param filter_name [String] filterName
field @param new_index [Integer] newIndex
field @return [Future<Responses::ReorderSourceFilter>]
# File lib/obs/websocket/protocol.rb, line 2846 def reorder_source_filter(source_name:, filter_name:, new_index:) send_request(Requests::ReorderSourceFilter.new({source_name: source_name, filter_name: filter_name, new_index: new_index})) end
Sends ResetSceneItem
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#resetsceneitem @param scene_name [String, nil] scene-name
field @param item [String, Object] item
field @return [Future<Responses::ResetSceneItem>]
# File lib/obs/websocket/protocol.rb, line 3098 def reset_scene_item(scene_name: nil, item:) send_request(Requests::ResetSceneItem.new({scene_name: scene_name, item: item})) end
Sends RestartMedia
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#restartmedia @param source_name [String] sourceName
field @return [Future<Responses::RestartMedia>]
# File lib/obs/websocket/protocol.rb, line 2514 def restart_media(source_name:) send_request(Requests::RestartMedia.new({source_name: source_name})) end
Sends ResumeRecording
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#resumerecording @return [Future<Responses::ResumeRecording>]
# File lib/obs/websocket/protocol.rb, line 2998 def resume_recording() send_request(Requests::ResumeRecording.new({})) end
Sends SaveReplayBuffer
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#savereplaybuffer @return [Future<Responses::SaveReplayBuffer>]
# File lib/obs/websocket/protocol.rb, line 3041 def save_replay_buffer() send_request(Requests::SaveReplayBuffer.new({})) end
Sends SaveStreamSettings
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#savestreamsettings @return [Future<Responses::SaveStreamSettings>]
# File lib/obs/websocket/protocol.rb, line 3273 def save_stream_settings() send_request(Requests::SaveStreamSettings.new({})) end
Sends ScrubMedia
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#scrubmedia @param source_name [String] sourceName
field @param time_offset [Integer] timeOffset
field @return [Future<Responses::ScrubMedia>]
# File lib/obs/websocket/protocol.rb, line 2565 def scrub_media(source_name:, time_offset:) send_request(Requests::ScrubMedia.new({source_name: source_name, time_offset: time_offset})) end
Sends SendCaptions
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sendcaptions @param text [String] text
field @return [Future<Responses::SendCaptions>]
# File lib/obs/websocket/protocol.rb, line 3280 def send_captions(text:) send_request(Requests::SendCaptions.new({text: text})) end
Sends SetAudioMonitorType
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setaudiomonitortype @param source_name [String] sourceName
field @param monitor_type [String] monitorType
field @return [Future<Responses::SetAudioMonitorType>]
# File lib/obs/websocket/protocol.rb, line 2888 def set_audio_monitor_type(source_name:, monitor_type:) send_request(Requests::SetAudioMonitorType.new({source_name: source_name, monitor_type: monitor_type})) end
Sends SetBrowserSourceProperties
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setbrowsersourceproperties @param source [String] source
field @param is_local_file [Boolean, nil] is_local_file
field @param local_file [String, nil] local_file
field @param url [String, nil] url
field @param css [String, nil] css
field @param width [Integer, nil] width
field @param height [Integer, nil] height
field @param fps [Integer, nil] fps
field @param shutdown [Boolean, nil] shutdown
field @param render [Boolean, nil] render
field @deprecated This type of request is deprecated. @return [Future<Responses::SetBrowserSourceProperties>]
# File lib/obs/websocket/protocol.rb, line 2798 def set_browser_source_properties(source:, is_local_file: nil, local_file: nil, url: nil, css: nil, width: nil, height: nil, fps: nil, shutdown: nil, render: nil) 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})) end
Sends SetCurrentProfile
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentprofile @param profile_name [String] profile-name
field @return [Future<Responses::SetCurrentProfile>]
# File lib/obs/websocket/protocol.rb, line 2950 def set_current_profile(profile_name:) send_request(Requests::SetCurrentProfile.new({profile_name: profile_name})) end
Sends SetCurrentScene
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentscene @param scene_name [String] scene-name
field @return [Future<Responses::SetCurrentScene>]
# File lib/obs/websocket/protocol.rb, line 3177 def set_current_scene(scene_name:) send_request(Requests::SetCurrentScene.new({scene_name: scene_name})) end
Sends SetCurrentSceneCollection
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrentscenecollection @param sc_name [String] sc-name
field @return [Future<Responses::SetCurrentSceneCollection>]
# File lib/obs/websocket/protocol.rb, line 3048 def set_current_scene_collection(sc_name:) send_request(Requests::SetCurrentSceneCollection.new({sc_name: sc_name})) end
Sends SetCurrentTransition
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setcurrenttransition @param transition_name [String] transition-name
field @return [Future<Responses::SetCurrentTransition>]
# File lib/obs/websocket/protocol.rb, line 3343 def set_current_transition(transition_name:) send_request(Requests::SetCurrentTransition.new({transition_name: transition_name})) end
Sends SetFilenameFormatting
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setfilenameformatting @param filename_formatting [String] filename-formatting
field @return [Future<Responses::SetFilenameFormatting>]
# File lib/obs/websocket/protocol.rb, line 2433 def set_filename_formatting(filename_formatting:) send_request(Requests::SetFilenameFormatting.new({filename_formatting: filename_formatting})) end
Sends SetHeartbeat
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setheartbeat @param enable [Boolean] enable
field @deprecated This type of request is deprecated. @return [Future<Responses::SetHeartbeat>]
# File lib/obs/websocket/protocol.rb, line 2426 def set_heartbeat(enable:) send_request(Requests::SetHeartbeat.new({enable: enable})) end
Sends SetMediaTime
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setmediatime @param source_name [String] sourceName
field @param timestamp [Integer] timestamp
field @return [Future<Responses::SetMediaTime>]
# File lib/obs/websocket/protocol.rb, line 2557 def set_media_time(source_name:, timestamp:) send_request(Requests::SetMediaTime.new({source_name: source_name, timestamp: timestamp})) end
Sends SetMute
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setmute @param source [String] source
field @param mute [Boolean] mute
field @return [Future<Responses::SetMute>]
# File lib/obs/websocket/protocol.rb, line 2649 def set_mute(source:, mute:) send_request(Requests::SetMute.new({source: source, mute: mute})) end
Sends SetPreviewScene
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setpreviewscene @param scene_name [String] scene-name
field @return [Future<Responses::SetPreviewScene>]
# File lib/obs/websocket/protocol.rb, line 3299 def set_preview_scene(scene_name:) send_request(Requests::SetPreviewScene.new({scene_name: scene_name})) end
Sends SetRecordingFolder
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setrecordingfolder @param rec_folder [String] rec-folder
field @return [Future<Responses::SetRecordingFolder>]
# File lib/obs/websocket/protocol.rb, line 3005 def set_recording_folder(rec_folder:) send_request(Requests::SetRecordingFolder.new({rec_folder: rec_folder})) end
Sends SetSceneItemCrop
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemcrop @param scene_name [String, nil] scene-name
field @param item [String] item
field @param top [Integer] top
field @param bottom [Integer] bottom
field @param left [Integer] left
field @param right [Integer] right
field @deprecated This type of request is deprecated. @return [Future<Responses::SetSceneItemCrop>]
# File lib/obs/websocket/protocol.rb, line 3144 def set_scene_item_crop(scene_name: nil, item:, top:, bottom:, left:, right:) send_request(Requests::SetSceneItemCrop.new({scene_name: scene_name, item: item, top: top, bottom: bottom, left: left, right: right})) end
Sends SetSceneItemPosition
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemposition @param scene_name [String, nil] scene-name
field @param item [String] item
field @param x [Float] x
field @param y [Float] y
field @deprecated This type of request is deprecated. @return [Future<Responses::SetSceneItemPosition>]
# File lib/obs/websocket/protocol.rb, line 3119 def set_scene_item_position(scene_name: nil, item:, x:, y:) send_request(Requests::SetSceneItemPosition.new({scene_name: scene_name, item: item, x: x, y: y})) end
Sends SetSceneItemProperties
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemproperties @param scene_name [String, nil] scene-name
field @param item [String, Object] item
field @param position [Hash] position
field @param rotation [Float, nil] rotation
field @param scale [Hash] scale
field @param crop [Hash] crop
field @param visible [Boolean, nil] visible
field @param locked [Boolean, nil] locked
field @param bounds [Hash] bounds
field @return [Future<Responses::SetSceneItemProperties>]
# File lib/obs/websocket/protocol.rb, line 3090 def set_scene_item_properties(scene_name: nil, item:, position:, rotation: nil, scale:, crop:, visible: nil, locked: nil, bounds:) 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})) end
Sends SetSceneItemRender
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemrender @param scene_name [String, nil] scene-name
field @param source [String, nil] source
field @param item [Integer, nil] item
field @param render [Boolean] render
field @return [Future<Responses::SetSceneItemRender>]
# File lib/obs/websocket/protocol.rb, line 3108 def set_scene_item_render(scene_name: nil, source: nil, item: nil, render:) send_request(Requests::SetSceneItemRender.new({scene_name: scene_name, source: source, item: item, render: render})) end
Sends SetSceneItemTransform
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsceneitemtransform @param scene_name [String, nil] scene-name
field @param item [String] item
field @param x_scale [Float] x-scale
field @param y_scale [Float] y-scale
field @param rotation [Float] rotation
field @deprecated This type of request is deprecated. @return [Future<Responses::SetSceneItemTransform>]
# File lib/obs/websocket/protocol.rb, line 3131 def set_scene_item_transform(scene_name: nil, item:, x_scale:, y_scale:, rotation:) send_request(Requests::SetSceneItemTransform.new({scene_name: scene_name, item: item, x_scale: x_scale, y_scale: y_scale, rotation: rotation})) end
Sends SetSceneTransitionOverride
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setscenetransitionoverride @param scene_name [String] sceneName
field @param transition_name [String] transitionName
field @param transition_duration [Integer, nil] transitionDuration
field @return [Future<Responses::SetSceneTransitionOverride>]
# File lib/obs/websocket/protocol.rb, line 3213 def set_scene_transition_override(scene_name:, transition_name:, transition_duration: nil) send_request(Requests::SetSceneTransitionOverride.new({scene_name: scene_name, transition_name: transition_name, transition_duration: transition_duration})) end
Sends SetSourceFilterSettings
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcefiltersettings @param source_name [String] sourceName
field @param filter_name [String] filterName
field @param filter_settings [Hash] filterSettings
field @return [Future<Responses::SetSourceFilterSettings>]
# File lib/obs/websocket/protocol.rb, line 2864 def set_source_filter_settings(source_name:, filter_name:, filter_settings:) send_request(Requests::SetSourceFilterSettings.new({source_name: source_name, filter_name: filter_name, filter_settings: filter_settings})) end
Sends SetSourceFilterVisibility
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcefiltervisibility @param source_name [String] sourceName
field @param filter_name [String] filterName
field @param filter_enabled [Boolean] filterEnabled
field @return [Future<Responses::SetSourceFilterVisibility>]
# File lib/obs/websocket/protocol.rb, line 2873 def set_source_filter_visibility(source_name:, filter_name:, filter_enabled:) send_request(Requests::SetSourceFilterVisibility.new({source_name: source_name, filter_name: filter_name, filter_enabled: filter_enabled})) end
Sends SetSourceName
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcename @param source_name [String] sourceName
field @param new_name [String] newName
field @return [Future<Responses::SetSourceName>]
# File lib/obs/websocket/protocol.rb, line 2678 def set_source_name(source_name:, new_name:) send_request(Requests::SetSourceName.new({source_name: source_name, new_name: new_name})) end
Sends SetSourceSettings
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsourcesettings @param source_name [String] sourceName
field @param source_type [String, nil] sourceType
field @param source_settings [Hash] sourceSettings
field @return [Future<Responses::SetSourceSettings>]
# File lib/obs/websocket/protocol.rb, line 2710 def set_source_settings(source_name:, source_type: nil, source_settings:) send_request(Requests::SetSourceSettings.new({source_name: source_name, source_type: source_type, source_settings: source_settings})) end
Sends SetStreamSettings
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setstreamsettings @param type [String] type
field @param settings [Hash] settings
field @param save [Boolean] save
field @return [Future<Responses::SetStreamSettings>]
# File lib/obs/websocket/protocol.rb, line 3261 def set_stream_settings(type:, settings:, save:) send_request(Requests::SetStreamSettings.new({type: type, settings: settings, save: save})) end
Sends SetSyncOffset
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setsyncoffset @param source [String] source
field @param offset [Integer] offset
field @return [Future<Responses::SetSyncOffset>]
# File lib/obs/websocket/protocol.rb, line 2686 def set_sync_offset(source:, offset:) send_request(Requests::SetSyncOffset.new({source: source, offset: offset})) end
Sends SetTBarPosition
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settbarposition @param position [Float] position
field @param release [Boolean, nil] release
field @return [Future<Responses::SetTBarPosition>]
# File lib/obs/websocket/protocol.rb, line 3391 def set_t_bar_position(position:, release: nil) send_request(Requests::SetTBarPosition.new({position: position, release: release})) end
Sends SetTextFreetype2Properties
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settextfreetype2properties @param source [String] source
field @param color1 [Integer, nil] color1
field @param color2 [Integer, nil] color2
field @param custom_width [Integer, nil] custom_width
field @param drop_shadow [Boolean, nil] drop_shadow
field @param font [Hash, nil] font
field @param from_file [Boolean, nil] from_file
field @param log_mode [Boolean, nil] log_mode
field @param outline [Boolean, nil] outline
field @param text [String, nil] text
field @param text_file [String, nil] text_file
field @param word_wrap [Boolean, nil] word_wrap
field @return [Future<Responses::SetTextFreetype2Properties>]
# File lib/obs/websocket/protocol.rb, line 2773 def set_text_freetype2_properties(source:, color1: nil, color2: nil, custom_width: nil, drop_shadow: nil, font: nil, from_file: nil, log_mode: nil, outline: nil, text: nil, text_file: nil, word_wrap: nil) 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})) end
Sends SetTextGDIPlusProperties
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settextgdiplusproperties @param source [String] source
field @param align [String, nil] align
field @param bk_color [Integer, nil] bk_color
field @param bk_opacity [Integer, nil] bk_opacity
field @param chatlog [Boolean, nil] chatlog
field @param chatlog_lines [Integer, nil] chatlog_lines
field @param color [Integer, nil] color
field @param extents [Boolean, nil] extents
field @param extents_cx [Integer, nil] extents_cx
field @param extents_cy [Integer, nil] extents_cy
field @param file [String, nil] file
field @param read_from_file [Boolean, nil] read_from_file
field @param font [Hash, nil] font
field @param gradient [Boolean, nil] gradient
field @param gradient_color [Integer, nil] gradient_color
field @param gradient_dir [Float, nil] gradient_dir
field @param gradient_opacity [Integer, nil] gradient_opacity
field @param outline [Boolean, nil] outline
field @param outline_color [Integer, nil] outline_color
field @param outline_size [Integer, nil] outline_size
field @param outline_opacity [Integer, nil] outline_opacity
field @param text [String, nil] text
field @param valign [String, nil] valign
field @param vertical [Boolean, nil] vertical
field @param render [Boolean, nil] render
field @return [Future<Responses::SetTextGDIPlusProperties>]
# File lib/obs/websocket/protocol.rb, line 2748 def set_text_gdi_plus_properties(source:, align: nil, bk_color: nil, bk_opacity: nil, chatlog: nil, chatlog_lines: nil, color: nil, extents: nil, extents_cx: nil, extents_cy: nil, file: nil, read_from_file: nil, font: nil, gradient: nil, gradient_color: nil, gradient_dir: nil, gradient_opacity: nil, outline: nil, outline_color: nil, outline_size: nil, outline_opacity: nil, text: nil, valign: nil, vertical: nil, render: nil) 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})) end
Sends SetTracks
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settracks @param source_name [String] sourceName
field @param track [Integer] track
field @param active [Boolean] active
field @return [Future<Responses::SetTracks>]
# File lib/obs/websocket/protocol.rb, line 2627 def set_tracks(source_name:, track:, active:) send_request(Requests::SetTracks.new({source_name: source_name, track: track, active: active})) end
Sends SetTransitionDuration
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settransitionduration @param duration [Integer] duration
field @return [Future<Responses::SetTransitionDuration>]
# File lib/obs/websocket/protocol.rb, line 3350 def set_transition_duration(duration:) send_request(Requests::SetTransitionDuration.new({duration: duration})) end
Sends SetTransitionSettings
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#settransitionsettings @param transition_name [String] transitionName
field @param transition_settings [Hash] transitionSettings
field @return [Future<Responses::SetTransitionSettings>]
# File lib/obs/websocket/protocol.rb, line 3377 def set_transition_settings(transition_name:, transition_settings:) send_request(Requests::SetTransitionSettings.new({transition_name: transition_name, transition_settings: transition_settings})) end
Sends SetVolume
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#setvolume @param source [String] source
field @param volume [Float] volume
field @param use_decibel [Boolean, nil] useDecibel
field @return [Future<Responses::SetVolume>]
# File lib/obs/websocket/protocol.rb, line 2618 def set_volume(source:, volume:, use_decibel: nil) send_request(Requests::SetVolume.new({source: source, volume: volume, use_decibel: use_decibel})) end
Sends Sleep
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#sleep @param sleep_millis [Integer] sleepMillis
field @return [Future<Responses::Sleep>]
# File lib/obs/websocket/protocol.rb, line 2499 def sleep(sleep_millis:) send_request(Requests::Sleep.new({sleep_millis: sleep_millis})) end
Sends StartOutput
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startoutput @param output_name [String] outputName
field @return [Future<Responses::StartOutput>]
# File lib/obs/websocket/protocol.rb, line 2935 def start_output(output_name:) send_request(Requests::StartOutput.new({output_name: output_name})) end
Sends StartRecording
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startrecording @return [Future<Responses::StartRecording>]
# File lib/obs/websocket/protocol.rb, line 2980 def start_recording() send_request(Requests::StartRecording.new({})) end
Sends StartReplayBuffer
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startreplaybuffer @return [Future<Responses::StartReplayBuffer>]
# File lib/obs/websocket/protocol.rb, line 3029 def start_replay_buffer() send_request(Requests::StartReplayBuffer.new({})) end
Sends StartStopRecording
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstoprecording @return [Future<Responses::StartStopRecording>]
# File lib/obs/websocket/protocol.rb, line 2974 def start_stop_recording() send_request(Requests::StartStopRecording.new({})) end
Sends StartStopReplayBuffer
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopreplaybuffer @return [Future<Responses::StartStopReplayBuffer>]
# File lib/obs/websocket/protocol.rb, line 3023 def start_stop_replay_buffer() send_request(Requests::StartStopReplayBuffer.new({})) end
Sends StartStopStreaming
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopstreaming @return [Future<Responses::StartStopStreaming>]
# File lib/obs/websocket/protocol.rb, line 3239 def start_stop_streaming() send_request(Requests::StartStopStreaming.new({})) end
Sends StartStopVirtualCam
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstopvirtualcam @return [Future<Responses::StartStopVirtualCam>]
# File lib/obs/websocket/protocol.rb, line 3403 def start_stop_virtual_cam() send_request(Requests::StartStopVirtualCam.new({})) end
Sends StartStreaming
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startstreaming @param stream [Hash, nil] stream
field @return [Future<Responses::StartStreaming>]
# File lib/obs/websocket/protocol.rb, line 3246 def start_streaming(stream: nil) send_request(Requests::StartStreaming.new({stream: stream})) end
Sends StartVirtualCam
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#startvirtualcam @return [Future<Responses::StartVirtualCam>]
# File lib/obs/websocket/protocol.rb, line 3409 def start_virtual_cam() send_request(Requests::StartVirtualCam.new({})) end
Sends StopMedia
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopmedia @param source_name [String] sourceName
field @return [Future<Responses::StopMedia>]
# File lib/obs/websocket/protocol.rb, line 2521 def stop_media(source_name:) send_request(Requests::StopMedia.new({source_name: source_name})) end
Sends StopOutput
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopoutput @param output_name [String] outputName
field @param force [Boolean, nil] force
field @return [Future<Responses::StopOutput>]
# File lib/obs/websocket/protocol.rb, line 2943 def stop_output(output_name:, force: nil) send_request(Requests::StopOutput.new({output_name: output_name, force: force})) end
Sends StopRecording
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stoprecording @return [Future<Responses::StopRecording>]
# File lib/obs/websocket/protocol.rb, line 2986 def stop_recording() send_request(Requests::StopRecording.new({})) end
Sends StopReplayBuffer
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopreplaybuffer @return [Future<Responses::StopReplayBuffer>]
# File lib/obs/websocket/protocol.rb, line 3035 def stop_replay_buffer() send_request(Requests::StopReplayBuffer.new({})) end
Sends StopStreaming
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopstreaming @return [Future<Responses::StopStreaming>]
# File lib/obs/websocket/protocol.rb, line 3252 def stop_streaming() send_request(Requests::StopStreaming.new({})) end
Sends StopVirtualCam
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#stopvirtualcam @return [Future<Responses::StopVirtualCam>]
# File lib/obs/websocket/protocol.rb, line 3415 def stop_virtual_cam() send_request(Requests::StopVirtualCam.new({})) end
Sends TakeSourceScreenshot
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#takesourcescreenshot @param source_name [String, nil] sourceName
field @param embed_picture_format [String, nil] embedPictureFormat
field @param save_to_file_path [String, nil] saveToFilePath
field @param file_format [String, nil] fileFormat
field @param compression_quality [Integer, nil] compressionQuality
field @param width [Integer, nil] width
field @param height [Integer, nil] height
field @return [Future<Responses::TakeSourceScreenshot>]
# File lib/obs/websocket/protocol.rb, line 2908 def take_source_screenshot(source_name: nil, embed_picture_format: nil, save_to_file_path: nil, file_format: nil, compression_quality: nil, width: nil, height: nil) 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})) end
Sends ToggleMute
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#togglemute @param source [String] source
field @return [Future<Responses::ToggleMute>]
# File lib/obs/websocket/protocol.rb, line 2656 def toggle_mute(source:) send_request(Requests::ToggleMute.new({source: source})) end
Sends ToggleStudioMode
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#togglestudiomode @return [Future<Responses::ToggleStudioMode>]
# File lib/obs/websocket/protocol.rb, line 3324 def toggle_studio_mode() send_request(Requests::ToggleStudioMode.new({})) end
Sends TransitionToProgram
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#transitiontoprogram @param with_transition [Hash, nil] with-transition
field @return [Future<Responses::TransitionToProgram>]
# File lib/obs/websocket/protocol.rb, line 3306 def transition_to_program(with_transition: nil) send_request(Requests::TransitionToProgram.new({with_transition: with_transition})) end
Sends TriggerHotkeyByName
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#triggerhotkeybyname @param hotkey_name [String] hotkeyName
field @return [Future<Responses::TriggerHotkeyByName>]
# File lib/obs/websocket/protocol.rb, line 2476 def trigger_hotkey_by_name(hotkey_name:) send_request(Requests::TriggerHotkeyByName.new({hotkey_name: hotkey_name})) end
Sends TriggerHotkeyBySequence
request. @see github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#triggerhotkeybysequence @param key_id [String] keyId
field @param key_modifiers [Hash, nil] keyModifiers
field @return [Future<Responses::TriggerHotkeyBySequence>]
# File lib/obs/websocket/protocol.rb, line 2484 def trigger_hotkey_by_sequence(key_id:, key_modifiers: nil) send_request(Requests::TriggerHotkeyBySequence.new({key_id: key_id, key_modifiers: key_modifiers})) end