Module: OBS::WebSocket::Protocol::Request::Mixin

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

Instance Method Summary collapse

Instance Method Details

#add_filter_to_source(source_name:, filter_name:, filter_type:, filter_settings:) ⇒ Future<Responses::AddFilterToSource>

Sends AddFilterToSource request.

Parameters:

  • source_name (String) —

    sourceName field

  • filter_name (String) —

    filterName field

  • filter_type (String) —

    filterType field

  • filter_settings (Hash) —

    filterSettings field

Returns:

See Also:



2829
2830
2831
 
# 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

#add_scene_item(scene_name:, source_name:, set_visible: nil) ⇒ Future<Responses::AddSceneItem>

Sends AddSceneItem request.

Parameters:

  • scene_name (String) —

    sceneName field

  • source_name (String) —

    sourceName field

  • set_visible (Boolean, nil) (defaults to: nil) —

    setVisible field

Returns:

See Also:



3161
3162
3163
 
# 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

#authenticate(auth:) ⇒ Future<Responses::Authenticate>

Sends Authenticate request.

Parameters:

  • auth (String) —

    auth field

Returns:

See Also:



2418
2419
2420
 
# File 'lib/obs/websocket/protocol.rb', line 2418

def authenticate(auth:)
  send_request(Requests::Authenticate.new({auth: auth}))
end

#broadcast_custom_message(realm:, data:) ⇒ Future<Responses::BroadcastCustomMessage>

Sends BroadcastCustomMessage request.

Parameters:

  • realm (String) —

    realm field

  • data (Hash) —

    data field

Returns:

See Also:



2453
2454
2455
 
# File 'lib/obs/websocket/protocol.rb', line 2453

def broadcast_custom_message(realm:, data:)
  send_request(Requests::BroadcastCustomMessage.new({realm: realm, data: data}))
end

#create_scene(scene_name:) ⇒ Future<Responses::CreateScene>

Sends CreateScene request.

Parameters:

  • scene_name (String) —

    sceneName field

Returns:

See Also:



3196
3197
3198
 
# File 'lib/obs/websocket/protocol.rb', line 3196

def create_scene(scene_name:)
  send_request(Requests::CreateScene.new({scene_name: scene_name}))
end

#create_source(source_name:, source_kind:, scene_name:, source_settings: nil, set_visible: nil) ⇒ Future<Responses::CreateSource>

Sends CreateSource request.

Parameters:

  • source_name (String) —

    sourceName field

  • source_kind (String) —

    sourceKind field

  • scene_name (String) —

    sceneName field

  • source_settings (Hash, nil) (defaults to: nil) —

    sourceSettings field

  • set_visible (Boolean, nil) (defaults to: nil) —

    setVisible field

Returns:

See Also:



2589
2590
2591
 
# 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

#delete_scene_item(scene: nil, item:) ⇒ Future<Responses::DeleteSceneItem>

Sends DeleteSceneItem request.

Parameters:

  • scene (String, nil) (defaults to: nil) —

    scene field

  • item (Hash) —

    item field

Returns:

See Also:



3152
3153
3154
 
# 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

#disable_studio_mode ⇒ Future<Responses::DisableStudioMode>

Sends DisableStudioMode request.

Returns:

See Also:



3318
3319
3320
 
# File 'lib/obs/websocket/protocol.rb', line 3318

def disable_studio_mode()
  send_request(Requests::DisableStudioMode.new({}))
end

#duplicate_scene_item(from_scene: nil, to_scene: nil, item:) ⇒ Future<Responses::DuplicateSceneItem>

Sends DuplicateSceneItem request.

Parameters:

  • from_scene (String, nil) (defaults to: nil) —

    fromScene field

  • to_scene (String, nil) (defaults to: nil) —

    toScene field

  • item (Hash) —

    item field

Returns:

See Also:



3170
3171
3172
 
# 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

#enable_studio_mode ⇒ Future<Responses::EnableStudioMode>

Sends EnableStudioMode request.

Returns:

See Also:



3312
3313
3314
 
# File 'lib/obs/websocket/protocol.rb', line 3312

def enable_studio_mode()
  send_request(Requests::EnableStudioMode.new({}))
end

#execute_batch(requests:, abort_on_fail: nil) ⇒ Future<Responses::ExecuteBatch>

Sends ExecuteBatch request.

Parameters:

  • requests (Array<Hash>) —

    requests field

  • abort_on_fail (Boolean, nil) (defaults to: nil) —

    abortOnFail field

Returns:

See Also:



2492
2493
2494
 
# 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

#get_audio_active(source_name:) ⇒ Future<Responses::GetAudioActive>

Sends GetAudioActive request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2670
2671
2672
 
# File 'lib/obs/websocket/protocol.rb', line 2670

def get_audio_active(source_name:)
  send_request(Requests::GetAudioActive.new({source_name: source_name}))
end

#get_audio_monitor_type(source_name:) ⇒ Future<Responses::GetAudioMonitorType>

Sends GetAudioMonitorType request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2880
2881
2882
 
# 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

#get_auth_required ⇒ Future<Responses::GetAuthRequired>

Sends GetAuthRequired request.

Returns:

See Also:



2411
2412
2413
 
# File 'lib/obs/websocket/protocol.rb', line 2411

def get_auth_required()
  send_request(Requests::GetAuthRequired.new({}))
end

#get_browser_source_properties(source:) ⇒ Future<Responses::GetBrowserSourceProperties>

Deprecated.

This type of request is deprecated.

Sends GetBrowserSourceProperties request.

Parameters:

  • source (String) —

    source field

Returns:

See Also:



2781
2782
2783
 
# File 'lib/obs/websocket/protocol.rb', line 2781

def get_browser_source_properties(source:)
  send_request(Requests::GetBrowserSourceProperties.new({source: source}))
end

#get_current_profile ⇒ Future<Responses::GetCurrentProfile>

Sends GetCurrentProfile request.

Returns:

See Also:



2956
2957
2958
 
# File 'lib/obs/websocket/protocol.rb', line 2956

def get_current_profile()
  send_request(Requests::GetCurrentProfile.new({}))
end

#get_current_scene ⇒ Future<Responses::GetCurrentScene>

Sends GetCurrentScene request.

Returns:

See Also:



3183
3184
3185
 
# File 'lib/obs/websocket/protocol.rb', line 3183

def get_current_scene()
  send_request(Requests::GetCurrentScene.new({}))
end

#get_current_scene_collection ⇒ Future<Responses::GetCurrentSceneCollection>

Sends GetCurrentSceneCollection request.

Returns:

See Also:



3054
3055
3056
 
# File 'lib/obs/websocket/protocol.rb', line 3054

def get_current_scene_collection()
  send_request(Requests::GetCurrentSceneCollection.new({}))
end

#get_current_transition ⇒ Future<Responses::GetCurrentTransition>

Sends GetCurrentTransition request.

Returns:

See Also:



3336
3337
3338
 
# File 'lib/obs/websocket/protocol.rb', line 3336

def get_current_transition()
  send_request(Requests::GetCurrentTransition.new({}))
end

#get_filename_formatting ⇒ Future<Responses::GetFilenameFormatting>

Sends GetFilenameFormatting request.

Returns:

See Also:



2439
2440
2441
 
# File 'lib/obs/websocket/protocol.rb', line 2439

def get_filename_formatting()
  send_request(Requests::GetFilenameFormatting.new({}))
end

#get_media_duration(source_name:) ⇒ Future<Responses::GetMediaDuration>

Sends GetMediaDuration request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2542
2543
2544
 
# File 'lib/obs/websocket/protocol.rb', line 2542

def get_media_duration(source_name:)
  send_request(Requests::GetMediaDuration.new({source_name: source_name}))
end

#get_media_sources_list ⇒ Future<Responses::GetMediaSourcesList>

Sends GetMediaSourcesList request.

Returns:

See Also:



2578
2579
2580
 
# File 'lib/obs/websocket/protocol.rb', line 2578

def get_media_sources_list()
  send_request(Requests::GetMediaSourcesList.new({}))
end

#get_media_state(source_name:) ⇒ Future<Responses::GetMediaState>

Sends GetMediaState request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2572
2573
2574
 
# File 'lib/obs/websocket/protocol.rb', line 2572

def get_media_state(source_name:)
  send_request(Requests::GetMediaState.new({source_name: source_name}))
end

#get_media_time(source_name:) ⇒ Future<Responses::GetMediaTime>

Sends GetMediaTime request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2549
2550
2551
 
# File 'lib/obs/websocket/protocol.rb', line 2549

def get_media_time(source_name:)
  send_request(Requests::GetMediaTime.new({source_name: source_name}))
end

#get_mute(source:) ⇒ Future<Responses::GetMute>

Sends GetMute request.

Parameters:

  • source (String) —

    source field

Returns:

See Also:



2641
2642
2643
 
# File 'lib/obs/websocket/protocol.rb', line 2641

def get_mute(source:)
  send_request(Requests::GetMute.new({source: source}))
end

#get_output_info(output_name:) ⇒ Future<Responses::GetOutputInfo>

Sends GetOutputInfo request.

Parameters:

  • output_name (String) —

    outputName field

Returns:

See Also:



2928
2929
2930
 
# File 'lib/obs/websocket/protocol.rb', line 2928

def get_output_info(output_name:)
  send_request(Requests::GetOutputInfo.new({output_name: output_name}))
end

#get_preview_scene ⇒ Future<Responses::GetPreviewScene>

Sends GetPreviewScene request.

Returns:

See Also:



3292
3293
3294
 
# File 'lib/obs/websocket/protocol.rb', line 3292

def get_preview_scene()
  send_request(Requests::GetPreviewScene.new({}))
end

#get_recording_folder ⇒ Future<Responses::GetRecordingFolder>

Sends GetRecordingFolder request.

Returns:

See Also:



3011
3012
3013
 
# File 'lib/obs/websocket/protocol.rb', line 3011

def get_recording_folder()
  send_request(Requests::GetRecordingFolder.new({}))
end

#get_recording_status ⇒ Future<Responses::GetRecordingStatus>

Sends GetRecordingStatus request.

Returns:

See Also:



2968
2969
2970
 
# File 'lib/obs/websocket/protocol.rb', line 2968

def get_recording_status()
  send_request(Requests::GetRecordingStatus.new({}))
end

#get_replay_buffer_status ⇒ Future<Responses::GetReplayBufferStatus>

Sends GetReplayBufferStatus request.

Returns:

See Also:



3017
3018
3019
 
# File 'lib/obs/websocket/protocol.rb', line 3017

def get_replay_buffer_status()
  send_request(Requests::GetReplayBufferStatus.new({}))
end

#get_scene_item_list(scene_name: nil) ⇒ Future<Responses::GetSceneItemList>

Sends GetSceneItemList request.

Parameters:

  • scene_name (String, nil) (defaults to: nil) —

    sceneName field

Returns:

See Also:



3067
3068
3069
 
# 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

#get_scene_item_properties(scene_name: nil, item:) ⇒ Future<Responses::GetSceneItemProperties>

Sends GetSceneItemProperties request.

Parameters:

  • scene_name (String, nil) (defaults to: nil) —

    scene-name field

  • item (String, Object) —

    item field

Returns:

See Also:



3075
3076
3077
 
# 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

#get_scene_list ⇒ Future<Responses::GetSceneList>

Sends GetSceneList request.

Returns:

See Also:



3189
3190
3191
 
# File 'lib/obs/websocket/protocol.rb', line 3189

def get_scene_list()
  send_request(Requests::GetSceneList.new({}))
end

#get_scene_transition_override(scene_name:) ⇒ Future<Responses::GetSceneTransitionOverride>

Sends GetSceneTransitionOverride request.

Parameters:

  • scene_name (String) —

    sceneName field

Returns:

See Also:



3227
3228
3229
 
# 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

#get_source_active(source_name:) ⇒ Future<Responses::GetSourceActive>

Sends GetSourceActive request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2663
2664
2665
 
# File 'lib/obs/websocket/protocol.rb', line 2663

def get_source_active(source_name:)
  send_request(Requests::GetSourceActive.new({source_name: source_name}))
end

#get_source_default_settings(source_kind:) ⇒ Future<Responses::GetSourceDefaultSettings>

Sends GetSourceDefaultSettings request.

Parameters:

  • source_kind (String) —

    sourceKind field

Returns:

See Also:



2895
2896
2897
 
# 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

#get_source_filter_info(source_name:, filter_name:) ⇒ Future<Responses::GetSourceFilterInfo>

Sends GetSourceFilterInfo request.

Parameters:

  • source_name (String) —

    sourceName field

  • filter_name (String) —

    filterName field

Returns:

See Also:



2819
2820
2821
 
# 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

#get_source_filters(source_name:) ⇒ Future<Responses::GetSourceFilters>

Sends GetSourceFilters request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2811
2812
2813
 
# File 'lib/obs/websocket/protocol.rb', line 2811

def get_source_filters(source_name:)
  send_request(Requests::GetSourceFilters.new({source_name: source_name}))
end

#get_source_settings(source_name:, source_type: nil) ⇒ Future<Responses::GetSourceSettings>

Sends GetSourceSettings request.

Parameters:

  • source_name (String) —

    sourceName field

  • source_type (String, nil) (defaults to: nil) —

    sourceType field

Returns:

See Also:



2701
2702
2703
 
# 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

#get_source_types_list ⇒ Future<Responses::GetSourceTypesList>

Sends GetSourceTypesList request.

Returns:

See Also:



2601
2602
2603
 
# File 'lib/obs/websocket/protocol.rb', line 2601

def get_source_types_list()
  send_request(Requests::GetSourceTypesList.new({}))
end

#get_sources_list ⇒ Future<Responses::GetSourcesList>

Sends GetSourcesList request.

Returns:

See Also:



2595
2596
2597
 
# File 'lib/obs/websocket/protocol.rb', line 2595

def get_sources_list()
  send_request(Requests::GetSourcesList.new({}))
end

#get_special_sources ⇒ Future<Responses::GetSpecialSources>

Sends GetSpecialSources request.

Returns:

See Also:



2804
2805
2806
 
# File 'lib/obs/websocket/protocol.rb', line 2804

def get_special_sources()
  send_request(Requests::GetSpecialSources.new({}))
end

#get_stats ⇒ Future<Responses::GetStats>

Sends GetStats request.

Returns:

See Also:



2445
2446
2447
 
# File 'lib/obs/websocket/protocol.rb', line 2445

def get_stats()
  send_request(Requests::GetStats.new({}))
end

#get_stream_settings ⇒ Future<Responses::GetStreamSettings>

Sends GetStreamSettings request.

Returns:

See Also:



3267
3268
3269
 
# File 'lib/obs/websocket/protocol.rb', line 3267

def get_stream_settings()
  send_request(Requests::GetStreamSettings.new({}))
end

#get_streaming_status ⇒ Future<Responses::GetStreamingStatus>

Sends GetStreamingStatus request.

Returns:

See Also:



3233
3234
3235
 
# File 'lib/obs/websocket/protocol.rb', line 3233

def get_streaming_status()
  send_request(Requests::GetStreamingStatus.new({}))
end

#get_studio_mode_status ⇒ Future<Responses::GetStudioModeStatus>

Sends GetStudioModeStatus request.

Returns:

See Also:



3286
3287
3288
 
# File 'lib/obs/websocket/protocol.rb', line 3286

def get_studio_mode_status()
  send_request(Requests::GetStudioModeStatus.new({}))
end

#get_sync_offset(source:) ⇒ Future<Responses::GetSyncOffset>

Sends GetSyncOffset request.

Parameters:

  • source (String) —

    source field

Returns:

See Also:



2693
2694
2695
 
# File 'lib/obs/websocket/protocol.rb', line 2693

def get_sync_offset(source:)
  send_request(Requests::GetSyncOffset.new({source: source}))
end

#get_text_freetype2_properties(source:) ⇒ Future<Responses::GetTextFreetype2Properties>

Sends GetTextFreetype2Properties request.

Parameters:

  • source (String) —

    source field

Returns:

See Also:



2755
2756
2757
 
# File 'lib/obs/websocket/protocol.rb', line 2755

def get_text_freetype2_properties(source:)
  send_request(Requests::GetTextFreetype2Properties.new({source: source}))
end

#get_text_gdi_plus_properties(source:) ⇒ Future<Responses::GetTextGDIPlusProperties>

Sends GetTextGDIPlusProperties request.

Parameters:

  • source (String) —

    source field

Returns:

See Also:



2717
2718
2719
 
# File 'lib/obs/websocket/protocol.rb', line 2717

def get_text_gdi_plus_properties(source:)
  send_request(Requests::GetTextGDIPlusProperties.new({source: source}))
end

#get_tracks(source_name:) ⇒ Future<Responses::GetTracks>

Sends GetTracks request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2634
2635
2636
 
# File 'lib/obs/websocket/protocol.rb', line 2634

def get_tracks(source_name:)
  send_request(Requests::GetTracks.new({source_name: source_name}))
end

#get_transition_duration ⇒ Future<Responses::GetTransitionDuration>

Sends GetTransitionDuration request.

Returns:

See Also:



3356
3357
3358
 
# File 'lib/obs/websocket/protocol.rb', line 3356

def get_transition_duration()
  send_request(Requests::GetTransitionDuration.new({}))
end

#get_transition_list ⇒ Future<Responses::GetTransitionList>

Sends GetTransitionList request.

Returns:

See Also:



3330
3331
3332
 
# File 'lib/obs/websocket/protocol.rb', line 3330

def get_transition_list()
  send_request(Requests::GetTransitionList.new({}))
end

#get_transition_position ⇒ Future<Responses::GetTransitionPosition>

Sends GetTransitionPosition request.

Returns:

See Also:



3362
3363
3364
 
# File 'lib/obs/websocket/protocol.rb', line 3362

def get_transition_position()
  send_request(Requests::GetTransitionPosition.new({}))
end

#get_transition_settings(transition_name:) ⇒ Future<Responses::GetTransitionSettings>

Sends GetTransitionSettings request.

Parameters:

  • transition_name (String) —

    transitionName field

Returns:

See Also:



3369
3370
3371
 
# File 'lib/obs/websocket/protocol.rb', line 3369

def get_transition_settings(transition_name:)
  send_request(Requests::GetTransitionSettings.new({transition_name: transition_name}))
end

#get_version ⇒ Future<Responses::GetVersion>

Sends GetVersion request.

Returns:

See Also:



2405
2406
2407
 
# File 'lib/obs/websocket/protocol.rb', line 2405

def get_version()
  send_request(Requests::GetVersion.new({}))
end

#get_video_info ⇒ Future<Responses::GetVideoInfo>

Sends GetVideoInfo request.

Returns:

See Also:



2459
2460
2461
 
# File 'lib/obs/websocket/protocol.rb', line 2459

def get_video_info()
  send_request(Requests::GetVideoInfo.new({}))
end

#get_virtual_cam_status ⇒ Future<Responses::GetVirtualCamStatus>

Sends GetVirtualCamStatus request.

Returns:

See Also:



3397
3398
3399
 
# File 'lib/obs/websocket/protocol.rb', line 3397

def get_virtual_cam_status()
  send_request(Requests::GetVirtualCamStatus.new({}))
end

#get_volume(source:, use_decibel: nil) ⇒ Future<Responses::GetVolume>

Sends GetVolume request.

Parameters:

  • source (String) —

    source field

  • use_decibel (Boolean, nil) (defaults to: nil) —

    useDecibel field

Returns:

See Also:



2609
2610
2611
 
# 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

#list_outputs ⇒ Future<Responses::ListOutputs>

Sends ListOutputs request.

Returns:

See Also:



2921
2922
2923
 
# File 'lib/obs/websocket/protocol.rb', line 2921

def list_outputs()
  send_request(Requests::ListOutputs.new({}))
end

#list_profiles ⇒ Future<Responses::ListProfiles>

Sends ListProfiles request.

Returns:

See Also:



2962
2963
2964
 
# File 'lib/obs/websocket/protocol.rb', line 2962

def list_profiles()
  send_request(Requests::ListProfiles.new({}))
end

#list_scene_collections ⇒ Future<Responses::ListSceneCollections>

Sends ListSceneCollections request.

Returns:

See Also:



3060
3061
3062
 
# File 'lib/obs/websocket/protocol.rb', line 3060

def list_scene_collections()
  send_request(Requests::ListSceneCollections.new({}))
end

#move_source_filter(source_name:, filter_name:, movement_type:) ⇒ Future<Responses::MoveSourceFilter>

Sends MoveSourceFilter request.

Parameters:

  • source_name (String) —

    sourceName field

  • filter_name (String) —

    filterName field

  • movement_type (String) —

    movementType field

Returns:

See Also:



2855
2856
2857
 
# 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

#next_media(source_name:) ⇒ Future<Responses::NextMedia>

Sends NextMedia request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2528
2529
2530
 
# File 'lib/obs/websocket/protocol.rb', line 2528

def next_media(source_name:)
  send_request(Requests::NextMedia.new({source_name: source_name}))
end

#open_projector(type: nil, monitor: nil, geometry: nil, name: nil) ⇒ Future<Responses::OpenProjector>

Sends OpenProjector request.

Parameters:

  • type (String, nil) (defaults to: nil) —

    type field

  • monitor (Integer, nil) (defaults to: nil) —

    monitor field

  • geometry (String, nil) (defaults to: nil) —

    geometry field

  • name (String, nil) (defaults to: nil) —

    name field

Returns:

See Also:



2469
2470
2471
 
# 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

#pause_recording ⇒ Future<Responses::PauseRecording>

Sends PauseRecording request.

Returns:

See Also:



2992
2993
2994
 
# File 'lib/obs/websocket/protocol.rb', line 2992

def pause_recording()
  send_request(Requests::PauseRecording.new({}))
end

#play_pause_media(source_name:, play_pause:) ⇒ Future<Responses::PlayPauseMedia>

Sends PlayPauseMedia request.

Parameters:

  • source_name (String) —

    sourceName field

  • play_pause (Boolean) —

    playPause field

Returns:

See Also:



2507
2508
2509
 
# 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

#previous_media(source_name:) ⇒ Future<Responses::PreviousMedia>

Sends PreviousMedia request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2535
2536
2537
 
# File 'lib/obs/websocket/protocol.rb', line 2535

def previous_media(source_name:)
  send_request(Requests::PreviousMedia.new({source_name: source_name}))
end

#refresh_browser_source(source_name:) ⇒ Future<Responses::RefreshBrowserSource>

Sends RefreshBrowserSource request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2915
2916
2917
 
# File 'lib/obs/websocket/protocol.rb', line 2915

def refresh_browser_source(source_name:)
  send_request(Requests::RefreshBrowserSource.new({source_name: source_name}))
end

#release_t_bar ⇒ Future<Responses::ReleaseTBar>

Sends ReleaseTBar request.

Returns:

See Also:



3383
3384
3385
 
# File 'lib/obs/websocket/protocol.rb', line 3383

def release_t_bar()
  send_request(Requests::ReleaseTBar.new({}))
end

#remove_filter_from_source(source_name:, filter_name:) ⇒ Future<Responses::RemoveFilterFromSource>

Sends RemoveFilterFromSource request.

Parameters:

  • source_name (String) —

    sourceName field

  • filter_name (String) —

    filterName field

Returns:

See Also:



2837
2838
2839
 
# 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

#remove_scene_transition_override(scene_name:) ⇒ Future<Responses::RemoveSceneTransitionOverride>

Sends RemoveSceneTransitionOverride request.

Parameters:

  • scene_name (String) —

    sceneName field

Returns:

See Also:



3220
3221
3222
 
# 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

#reorder_scene_items(scene: nil, items:) ⇒ Future<Responses::ReorderSceneItems>

Sends ReorderSceneItems request.

Parameters:

  • scene (String, nil) (defaults to: nil) —

    scene field

  • items (Array<Hash>) —

    items field

Returns:

See Also:



3204
3205
3206
 
# 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

#reorder_source_filter(source_name:, filter_name:, new_index:) ⇒ Future<Responses::ReorderSourceFilter>

Sends ReorderSourceFilter request.

Parameters:

  • source_name (String) —

    sourceName field

  • filter_name (String) —

    filterName field

  • new_index (Integer) —

    newIndex field

Returns:

See Also:



2846
2847
2848
 
# 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

#reset_scene_item(scene_name: nil, item:) ⇒ Future<Responses::ResetSceneItem>

Sends ResetSceneItem request.

Parameters:

  • scene_name (String, nil) (defaults to: nil) —

    scene-name field

  • item (String, Object) —

    item field

Returns:

See Also:



3098
3099
3100
 
# 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

#restart_media(source_name:) ⇒ Future<Responses::RestartMedia>

Sends RestartMedia request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2514
2515
2516
 
# File 'lib/obs/websocket/protocol.rb', line 2514

def restart_media(source_name:)
  send_request(Requests::RestartMedia.new({source_name: source_name}))
end

#resume_recording ⇒ Future<Responses::ResumeRecording>

Sends ResumeRecording request.

Returns:

See Also:



2998
2999
3000
 
# File 'lib/obs/websocket/protocol.rb', line 2998

def resume_recording()
  send_request(Requests::ResumeRecording.new({}))
end

#save_replay_buffer ⇒ Future<Responses::SaveReplayBuffer>

Sends SaveReplayBuffer request.

Returns:

See Also:



3041
3042
3043
 
# File 'lib/obs/websocket/protocol.rb', line 3041

def save_replay_buffer()
  send_request(Requests::SaveReplayBuffer.new({}))
end

#save_stream_settings ⇒ Future<Responses::SaveStreamSettings>

Sends SaveStreamSettings request.

Returns:

See Also:



3273
3274
3275
 
# File 'lib/obs/websocket/protocol.rb', line 3273

def save_stream_settings()
  send_request(Requests::SaveStreamSettings.new({}))
end

#scrub_media(source_name:, time_offset:) ⇒ Future<Responses::ScrubMedia>

Sends ScrubMedia request.

Parameters:

  • source_name (String) —

    sourceName field

  • time_offset (Integer) —

    timeOffset field

Returns:

See Also:



2565
2566
2567
 
# 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

#send_captions(text:) ⇒ Future<Responses::SendCaptions>

Sends SendCaptions request.

Parameters:

  • text (String) —

    text field

Returns:

See Also:



3280
3281
3282
 
# File 'lib/obs/websocket/protocol.rb', line 3280

def send_captions(text:)
  send_request(Requests::SendCaptions.new({text: text}))
end

#set_audio_monitor_type(source_name:, monitor_type:) ⇒ Future<Responses::SetAudioMonitorType>

Sends SetAudioMonitorType request.

Parameters:

  • source_name (String) —

    sourceName field

  • monitor_type (String) —

    monitorType field

Returns:

See Also:



2888
2889
2890
 
# 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

#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) ⇒ Future<Responses::SetBrowserSourceProperties>

Deprecated.

This type of request is deprecated.

Sends SetBrowserSourceProperties request.

Parameters:

  • source (String) —

    source field

  • is_local_file (Boolean, nil) (defaults to: nil) —

    is_local_file field

  • local_file (String, nil) (defaults to: nil) —

    local_file field

  • url (String, nil) (defaults to: nil) —

    url field

  • css (String, nil) (defaults to: nil) —

    css field

  • width (Integer, nil) (defaults to: nil) —

    width field

  • height (Integer, nil) (defaults to: nil) —

    height field

  • fps (Integer, nil) (defaults to: nil) —

    fps field

  • shutdown (Boolean, nil) (defaults to: nil) —

    shutdown field

  • render (Boolean, nil) (defaults to: nil) —

    render field

Returns:

See Also:



2798
2799
2800
 
# 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

#set_current_profile(profile_name:) ⇒ Future<Responses::SetCurrentProfile>

Sends SetCurrentProfile request.

Parameters:

  • profile_name (String) —

    profile-name field

Returns:

See Also:



2950
2951
2952
 
# File 'lib/obs/websocket/protocol.rb', line 2950

def set_current_profile(profile_name:)
  send_request(Requests::SetCurrentProfile.new({profile_name: profile_name}))
end

#set_current_scene(scene_name:) ⇒ Future<Responses::SetCurrentScene>

Sends SetCurrentScene request.

Parameters:

  • scene_name (String) —

    scene-name field

Returns:

See Also:



3177
3178
3179
 
# File 'lib/obs/websocket/protocol.rb', line 3177

def set_current_scene(scene_name:)
  send_request(Requests::SetCurrentScene.new({scene_name: scene_name}))
end

#set_current_scene_collection(sc_name:) ⇒ Future<Responses::SetCurrentSceneCollection>

Sends SetCurrentSceneCollection request.

Parameters:

  • sc_name (String) —

    sc-name field

Returns:

See Also:



3048
3049
3050
 
# 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

#set_current_transition(transition_name:) ⇒ Future<Responses::SetCurrentTransition>

Sends SetCurrentTransition request.

Parameters:

  • transition_name (String) —

    transition-name field

Returns:

See Also:



3343
3344
3345
 
# File 'lib/obs/websocket/protocol.rb', line 3343

def set_current_transition(transition_name:)
  send_request(Requests::SetCurrentTransition.new({transition_name: transition_name}))
end

#set_filename_formatting(filename_formatting:) ⇒ Future<Responses::SetFilenameFormatting>

Sends SetFilenameFormatting request.

Parameters:

  • filename_formatting (String) —

    filename-formatting field

Returns:

See Also:



2433
2434
2435
 
# File 'lib/obs/websocket/protocol.rb', line 2433

def set_filename_formatting(filename_formatting:)
  send_request(Requests::SetFilenameFormatting.new({filename_formatting: filename_formatting}))
end

#set_heartbeat(enable:) ⇒ Future<Responses::SetHeartbeat>

Deprecated.

This type of request is deprecated.

Sends SetHeartbeat request.

Parameters:

  • enable (Boolean) —

    enable field

Returns:

See Also:



2426
2427
2428
 
# File 'lib/obs/websocket/protocol.rb', line 2426

def set_heartbeat(enable:)
  send_request(Requests::SetHeartbeat.new({enable: enable}))
end

#set_media_time(source_name:, timestamp:) ⇒ Future<Responses::SetMediaTime>

Sends SetMediaTime request.

Parameters:

  • source_name (String) —

    sourceName field

  • timestamp (Integer) —

    timestamp field

Returns:

See Also:



2557
2558
2559
 
# 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

#set_mute(source:, mute:) ⇒ Future<Responses::SetMute>

Sends SetMute request.

Parameters:

  • source (String) —

    source field

  • mute (Boolean) —

    mute field

Returns:

See Also:



2649
2650
2651
 
# File 'lib/obs/websocket/protocol.rb', line 2649

def set_mute(source:, mute:)
  send_request(Requests::SetMute.new({source: source, mute: mute}))
end

#set_preview_scene(scene_name:) ⇒ Future<Responses::SetPreviewScene>

Sends SetPreviewScene request.

Parameters:

  • scene_name (String) —

    scene-name field

Returns:

See Also:



3299
3300
3301
 
# File 'lib/obs/websocket/protocol.rb', line 3299

def set_preview_scene(scene_name:)
  send_request(Requests::SetPreviewScene.new({scene_name: scene_name}))
end

#set_recording_folder(rec_folder:) ⇒ Future<Responses::SetRecordingFolder>

Sends SetRecordingFolder request.

Parameters:

  • rec_folder (String) —

    rec-folder field

Returns:

See Also:



3005
3006
3007
 
# File 'lib/obs/websocket/protocol.rb', line 3005

def set_recording_folder(rec_folder:)
  send_request(Requests::SetRecordingFolder.new({rec_folder: rec_folder}))
end

#set_scene_item_crop(scene_name: nil, item:, top:, bottom:, left:, right:) ⇒ Future<Responses::SetSceneItemCrop>

Deprecated.

This type of request is deprecated.

Sends SetSceneItemCrop request.

Parameters:

  • scene_name (String, nil) (defaults to: nil) —

    scene-name field

  • item (String) —

    item field

  • top (Integer) —

    top field

  • bottom (Integer) —

    bottom field

  • left (Integer) —

    left field

  • right (Integer) —

    right field

Returns:

See Also:



3144
3145
3146
 
# 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

#set_scene_item_position(scene_name: nil, item:, x:, y:) ⇒ Future<Responses::SetSceneItemPosition>

Deprecated.

This type of request is deprecated.

Sends SetSceneItemPosition request.

Parameters:

  • scene_name (String, nil) (defaults to: nil) —

    scene-name field

  • item (String) —

    item field

  • x (Float) —

    x field

  • y (Float) —

    y field

Returns:

See Also:



3119
3120
3121
 
# 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

#set_scene_item_properties(scene_name: nil, item:, position:, rotation: nil, scale:, crop:, visible: nil, locked: nil, bounds:) ⇒ Future<Responses::SetSceneItemProperties>

Sends SetSceneItemProperties request.

Parameters:

  • scene_name (String, nil) (defaults to: nil) —

    scene-name field

  • item (String, Object) —

    item field

  • position (Hash) —

    position field

  • rotation (Float, nil) (defaults to: nil) —

    rotation field

  • scale (Hash) —

    scale field

  • crop (Hash) —

    crop field

  • visible (Boolean, nil) (defaults to: nil) —

    visible field

  • locked (Boolean, nil) (defaults to: nil) —

    locked field

  • bounds (Hash) —

    bounds field

Returns:

See Also:



3090
3091
3092
 
# 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

#set_scene_item_render(scene_name: nil, source: nil, item: nil, render:) ⇒ Future<Responses::SetSceneItemRender>

Sends SetSceneItemRender request.

Parameters:

  • scene_name (String, nil) (defaults to: nil) —

    scene-name field

  • source (String, nil) (defaults to: nil) —

    source field

  • item (Integer, nil) (defaults to: nil) —

    item field

  • render (Boolean) —

    render field

Returns:

See Also:



3108
3109
3110
 
# 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

#set_scene_item_transform(scene_name: nil, item:, x_scale:, y_scale:, rotation:) ⇒ Future<Responses::SetSceneItemTransform>

Deprecated.

This type of request is deprecated.

Sends SetSceneItemTransform request.

Parameters:

  • scene_name (String, nil) (defaults to: nil) —

    scene-name field

  • item (String) —

    item field

  • x_scale (Float) —

    x-scale field

  • y_scale (Float) —

    y-scale field

  • rotation (Float) —

    rotation field

Returns:

See Also:



3131
3132
3133
 
# 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

#set_scene_transition_override(scene_name:, transition_name:, transition_duration: nil) ⇒ Future<Responses::SetSceneTransitionOverride>

Sends SetSceneTransitionOverride request.

Parameters:

  • scene_name (String) —

    sceneName field

  • transition_name (String) —

    transitionName field

  • transition_duration (Integer, nil) (defaults to: nil) —

    transitionDuration field

Returns:

See Also:



3213
3214
3215
 
# 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

#set_source_filter_settings(source_name:, filter_name:, filter_settings:) ⇒ Future<Responses::SetSourceFilterSettings>

Sends SetSourceFilterSettings request.

Parameters:

  • source_name (String) —

    sourceName field

  • filter_name (String) —

    filterName field

  • filter_settings (Hash) —

    filterSettings field

Returns:

See Also:



2864
2865
2866
 
# 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

#set_source_filter_visibility(source_name:, filter_name:, filter_enabled:) ⇒ Future<Responses::SetSourceFilterVisibility>

Sends SetSourceFilterVisibility request.

Parameters:

  • source_name (String) —

    sourceName field

  • filter_name (String) —

    filterName field

  • filter_enabled (Boolean) —

    filterEnabled field

Returns:

See Also:



2873
2874
2875
 
# 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

#set_source_name(source_name:, new_name:) ⇒ Future<Responses::SetSourceName>

Sends SetSourceName request.

Parameters:

  • source_name (String) —

    sourceName field

  • new_name (String) —

    newName field

Returns:

See Also:



2678
2679
2680
 
# 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

#set_source_settings(source_name:, source_type: nil, source_settings:) ⇒ Future<Responses::SetSourceSettings>

Sends SetSourceSettings request.

Parameters:

  • source_name (String) —

    sourceName field

  • source_type (String, nil) (defaults to: nil) —

    sourceType field

  • source_settings (Hash) —

    sourceSettings field

Returns:

See Also:



2710
2711
2712
 
# 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

#set_stream_settings(type:, settings:, save:) ⇒ Future<Responses::SetStreamSettings>

Sends SetStreamSettings request.

Parameters:

  • type (String) —

    type field

  • settings (Hash) —

    settings field

  • save (Boolean) —

    save field

Returns:

See Also:



3261
3262
3263
 
# 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

#set_sync_offset(source:, offset:) ⇒ Future<Responses::SetSyncOffset>

Sends SetSyncOffset request.

Parameters:

  • source (String) —

    source field

  • offset (Integer) —

    offset field

Returns:

See Also:



2686
2687
2688
 
# File 'lib/obs/websocket/protocol.rb', line 2686

def set_sync_offset(source:, offset:)
  send_request(Requests::SetSyncOffset.new({source: source, offset: offset}))
end

#set_t_bar_position(position:, release: nil) ⇒ Future<Responses::SetTBarPosition>

Sends SetTBarPosition request.

Parameters:

  • position (Float) —

    position field

  • release (Boolean, nil) (defaults to: nil) —

    release field

Returns:

See Also:



3391
3392
3393
 
# 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

#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) ⇒ Future<Responses::SetTextFreetype2Properties>

Sends SetTextFreetype2Properties request.

Parameters:

  • source (String) —

    source field

  • color1 (Integer, nil) (defaults to: nil) —

    color1 field

  • color2 (Integer, nil) (defaults to: nil) —

    color2 field

  • custom_width (Integer, nil) (defaults to: nil) —

    custom_width field

  • drop_shadow (Boolean, nil) (defaults to: nil) —

    drop_shadow field

  • font (Hash, nil) (defaults to: nil) —

    font field

  • from_file (Boolean, nil) (defaults to: nil) —

    from_file field

  • log_mode (Boolean, nil) (defaults to: nil) —

    log_mode field

  • outline (Boolean, nil) (defaults to: nil) —

    outline field

  • text (String, nil) (defaults to: nil) —

    text field

  • text_file (String, nil) (defaults to: nil) —

    text_file field

  • word_wrap (Boolean, nil) (defaults to: nil) —

    word_wrap field

Returns:

See Also:



2773
2774
2775
 
# 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

#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) ⇒ Future<Responses::SetTextGDIPlusProperties>

Sends SetTextGDIPlusProperties request.

Parameters:

  • source (String) —

    source field

  • align (String, nil) (defaults to: nil) —

    align field

  • bk_color (Integer, nil) (defaults to: nil) —

    bk_color field

  • bk_opacity (Integer, nil) (defaults to: nil) —

    bk_opacity field

  • chatlog (Boolean, nil) (defaults to: nil) —

    chatlog field

  • chatlog_lines (Integer, nil) (defaults to: nil) —

    chatlog_lines field

  • color (Integer, nil) (defaults to: nil) —

    color field

  • extents (Boolean, nil) (defaults to: nil) —

    extents field

  • extents_cx (Integer, nil) (defaults to: nil) —

    extents_cx field

  • extents_cy (Integer, nil) (defaults to: nil) —

    extents_cy field

  • file (String, nil) (defaults to: nil) —

    file field

  • read_from_file (Boolean, nil) (defaults to: nil) —

    read_from_file field

  • font (Hash, nil) (defaults to: nil) —

    font field

  • gradient (Boolean, nil) (defaults to: nil) —

    gradient field

  • gradient_color (Integer, nil) (defaults to: nil) —

    gradient_color field

  • gradient_dir (Float, nil) (defaults to: nil) —

    gradient_dir field

  • gradient_opacity (Integer, nil) (defaults to: nil) —

    gradient_opacity field

  • outline (Boolean, nil) (defaults to: nil) —

    outline field

  • outline_color (Integer, nil) (defaults to: nil) —

    outline_color field

  • outline_size (Integer, nil) (defaults to: nil) —

    outline_size field

  • outline_opacity (Integer, nil) (defaults to: nil) —

    outline_opacity field

  • text (String, nil) (defaults to: nil) —

    text field

  • valign (String, nil) (defaults to: nil) —

    valign field

  • vertical (Boolean, nil) (defaults to: nil) —

    vertical field

  • render (Boolean, nil) (defaults to: nil) —

    render field

Returns:

See Also:



2748
2749
2750
 
# 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

#set_tracks(source_name:, track:, active:) ⇒ Future<Responses::SetTracks>

Sends SetTracks request.

Parameters:

  • source_name (String) —

    sourceName field

  • track (Integer) —

    track field

  • active (Boolean) —

    active field

Returns:

See Also:



2627
2628
2629
 
# 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

#set_transition_duration(duration:) ⇒ Future<Responses::SetTransitionDuration>

Sends SetTransitionDuration request.

Parameters:

  • duration (Integer) —

    duration field

Returns:

See Also:



3350
3351
3352
 
# File 'lib/obs/websocket/protocol.rb', line 3350

def set_transition_duration(duration:)
  send_request(Requests::SetTransitionDuration.new({duration: duration}))
end

#set_transition_settings(transition_name:, transition_settings:) ⇒ Future<Responses::SetTransitionSettings>

Sends SetTransitionSettings request.

Parameters:

  • transition_name (String) —

    transitionName field

  • transition_settings (Hash) —

    transitionSettings field

Returns:

See Also:



3377
3378
3379
 
# 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

#set_volume(source:, volume:, use_decibel: nil) ⇒ Future<Responses::SetVolume>

Sends SetVolume request.

Parameters:

  • source (String) —

    source field

  • volume (Float) —

    volume field

  • use_decibel (Boolean, nil) (defaults to: nil) —

    useDecibel field

Returns:

See Also:



2618
2619
2620
 
# 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

#sleep(sleep_millis:) ⇒ Future<Responses::Sleep>

Sends Sleep request.

Parameters:

  • sleep_millis (Integer) —

    sleepMillis field

Returns:

See Also:



2499
2500
2501
 
# File 'lib/obs/websocket/protocol.rb', line 2499

def sleep(sleep_millis:)
  send_request(Requests::Sleep.new({sleep_millis: sleep_millis}))
end

#start_output(output_name:) ⇒ Future<Responses::StartOutput>

Sends StartOutput request.

Parameters:

  • output_name (String) —

    outputName field

Returns:

See Also:



2935
2936
2937
 
# File 'lib/obs/websocket/protocol.rb', line 2935

def start_output(output_name:)
  send_request(Requests::StartOutput.new({output_name: output_name}))
end

#start_recording ⇒ Future<Responses::StartRecording>

Sends StartRecording request.

Returns:

See Also:



2980
2981
2982
 
# File 'lib/obs/websocket/protocol.rb', line 2980

def start_recording()
  send_request(Requests::StartRecording.new({}))
end

#start_replay_buffer ⇒ Future<Responses::StartReplayBuffer>

Sends StartReplayBuffer request.

Returns:

See Also:



3029
3030
3031
 
# File 'lib/obs/websocket/protocol.rb', line 3029

def start_replay_buffer()
  send_request(Requests::StartReplayBuffer.new({}))
end

#start_stop_recording ⇒ Future<Responses::StartStopRecording>

Sends StartStopRecording request.

Returns:

See Also:



2974
2975
2976
 
# File 'lib/obs/websocket/protocol.rb', line 2974

def start_stop_recording()
  send_request(Requests::StartStopRecording.new({}))
end

#start_stop_replay_buffer ⇒ Future<Responses::StartStopReplayBuffer>

Sends StartStopReplayBuffer request.

Returns:

See Also:



3023
3024
3025
 
# File 'lib/obs/websocket/protocol.rb', line 3023

def start_stop_replay_buffer()
  send_request(Requests::StartStopReplayBuffer.new({}))
end

#start_stop_streaming ⇒ Future<Responses::StartStopStreaming>

Sends StartStopStreaming request.

Returns:

See Also:



3239
3240
3241
 
# File 'lib/obs/websocket/protocol.rb', line 3239

def start_stop_streaming()
  send_request(Requests::StartStopStreaming.new({}))
end

#start_stop_virtual_cam ⇒ Future<Responses::StartStopVirtualCam>

Sends StartStopVirtualCam request.

Returns:

See Also:



3403
3404
3405
 
# File 'lib/obs/websocket/protocol.rb', line 3403

def start_stop_virtual_cam()
  send_request(Requests::StartStopVirtualCam.new({}))
end

#start_streaming(stream: nil) ⇒ Future<Responses::StartStreaming>

Sends StartStreaming request.

Parameters:

  • stream (Hash, nil) (defaults to: nil) —

    stream field

Returns:

See Also:



3246
3247
3248
 
# File 'lib/obs/websocket/protocol.rb', line 3246

def start_streaming(stream: nil)
  send_request(Requests::StartStreaming.new({stream: stream}))
end

#start_virtual_cam ⇒ Future<Responses::StartVirtualCam>

Sends StartVirtualCam request.

Returns:

See Also:



3409
3410
3411
 
# File 'lib/obs/websocket/protocol.rb', line 3409

def start_virtual_cam()
  send_request(Requests::StartVirtualCam.new({}))
end

#stop_media(source_name:) ⇒ Future<Responses::StopMedia>

Sends StopMedia request.

Parameters:

  • source_name (String) —

    sourceName field

Returns:

See Also:



2521
2522
2523
 
# File 'lib/obs/websocket/protocol.rb', line 2521

def stop_media(source_name:)
  send_request(Requests::StopMedia.new({source_name: source_name}))
end

#stop_output(output_name:, force: nil) ⇒ Future<Responses::StopOutput>

Sends StopOutput request.

Parameters:

  • output_name (String) —

    outputName field

  • force (Boolean, nil) (defaults to: nil) —

    force field

Returns:

See Also:



2943
2944
2945
 
# 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

#stop_recording ⇒ Future<Responses::StopRecording>

Sends StopRecording request.

Returns:

See Also:



2986
2987
2988
 
# File 'lib/obs/websocket/protocol.rb', line 2986

def stop_recording()
  send_request(Requests::StopRecording.new({}))
end

#stop_replay_buffer ⇒ Future<Responses::StopReplayBuffer>

Sends StopReplayBuffer request.

Returns:

See Also:



3035
3036
3037
 
# File 'lib/obs/websocket/protocol.rb', line 3035

def stop_replay_buffer()
  send_request(Requests::StopReplayBuffer.new({}))
end

#stop_streaming ⇒ Future<Responses::StopStreaming>

Sends StopStreaming request.

Returns:

See Also:



3252
3253
3254
 
# File 'lib/obs/websocket/protocol.rb', line 3252

def stop_streaming()
  send_request(Requests::StopStreaming.new({}))
end

#stop_virtual_cam ⇒ Future<Responses::StopVirtualCam>

Sends StopVirtualCam request.

Returns:

See Also:



3415
3416
3417
 
# File 'lib/obs/websocket/protocol.rb', line 3415

def stop_virtual_cam()
  send_request(Requests::StopVirtualCam.new({}))
end

#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) ⇒ Future<Responses::TakeSourceScreenshot>

Sends TakeSourceScreenshot request.

Parameters:

  • source_name (String, nil) (defaults to: nil) —

    sourceName field

  • embed_picture_format (String, nil) (defaults to: nil) —

    embedPictureFormat field

  • save_to_file_path (String, nil) (defaults to: nil) —

    saveToFilePath field

  • file_format (String, nil) (defaults to: nil) —

    fileFormat field

  • compression_quality (Integer, nil) (defaults to: nil) —

    compressionQuality field

  • width (Integer, nil) (defaults to: nil) —

    width field

  • height (Integer, nil) (defaults to: nil) —

    height field

Returns:

See Also:



2908
2909
2910
 
# 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

#toggle_mute(source:) ⇒ Future<Responses::ToggleMute>

Sends ToggleMute request.

Parameters:

  • source (String) —

    source field

Returns:

See Also:



2656
2657
2658
 
# File 'lib/obs/websocket/protocol.rb', line 2656

def toggle_mute(source:)
  send_request(Requests::ToggleMute.new({source: source}))
end

#toggle_studio_mode ⇒ Future<Responses::ToggleStudioMode>

Sends ToggleStudioMode request.

Returns:

See Also:



3324
3325
3326
 
# File 'lib/obs/websocket/protocol.rb', line 3324

def toggle_studio_mode()
  send_request(Requests::ToggleStudioMode.new({}))
end

#transition_to_program(with_transition: nil) ⇒ Future<Responses::TransitionToProgram>

Sends TransitionToProgram request.

Parameters:

  • with_transition (Hash, nil) (defaults to: nil) —

    with-transition field

Returns:

See Also:



3306
3307
3308
 
# 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

#trigger_hotkey_by_name(hotkey_name:) ⇒ Future<Responses::TriggerHotkeyByName>

Sends TriggerHotkeyByName request.

Parameters:

  • hotkey_name (String) —

    hotkeyName field

Returns:

See Also:



2476
2477
2478
 
# 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

#trigger_hotkey_by_sequence(key_id:, key_modifiers: nil) ⇒ Future<Responses::TriggerHotkeyBySequence>

Sends TriggerHotkeyBySequence request.

Parameters:

  • key_id (String) —

    keyId field

  • key_modifiers (Hash, nil) (defaults to: nil) —

    keyModifiers field

Returns:

See Also:



2484
2485
2486
 
# 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