Expand description
§Mapping from obs-websocket to obws
The following is a mapping from commands in the obs-websocket docs to the function calls in
obws. The latest API v5 made significant changes to the naming style, and obws derives from
that.
This mapping may help developers, that come from the original obs-websocket documentation, to find the equivalent function calls.
§General Requests
| obs-websocket | obws |
|---|---|
| GetVersion | General::get_version |
| GetStats | General::stats |
| BroadcastCustomEvent | General::broadcast_custom_event |
| CallVendorRequest | General::call_vendor_request |
| GetHotkeyList | Hotkeys::list |
| TriggerHotkeyByName | Hotkeys::trigger_by_name |
| TriggerHotkeyByKeySequence | Hotkeys::trigger_by_sequence |
| Sleep1 | - |
§Config Requests
| obs-websocket | obws |
|---|---|
| GetPersistentData | Config::get_persistent_data |
| SetPersistentData | Config::set_persistent_data |
| GetSceneCollectionList | SceneCollections::list |
| - | SceneCollections::current |
| SetCurrentSceneCollection | SceneCollections::set_current |
| CreateSceneCollection | SceneCollections::create |
| GetProfileList | Profiles::list |
| - | Profiles::current |
| SetCurrentProfile | Profiles::set_current |
| CreateProfile | Profiles::create |
| RemoveProfile | Profiles::remove |
| GetProfileParameter | Profiles::parameter |
| SetProfileParameter | Profiles::set_parameter |
| GetVideoSettings | Config::video_settings |
| SetVideoSettings | Config::set_video_settings |
| GetStreamServiceSettings | Config::stream_service_settings |
| SetStreamServiceSettings | Config::set_stream_service_settings |
| GetRecordDirectory | Config::record_directory |
§Sources Requests
| obs-websocket | obws |
|---|---|
| GetSourceActive | Sources::active |
| GetSourceScreenshot | Sources::take_screenshot |
| SaveSourceScreenshot | Sources::save_screenshot |
§Scenes Requests
| obs-websocket | obws |
|---|---|
| GetSceneList | Scenes::list |
| GetGroupList | Scenes::list_groups |
| GetCurrentProgramScene | Scenes::current_program_scene |
| SetCurrentProgramScene | Scenes::set_current_program_scene |
| GetCurrentPreviewScene | Scenes::current_preview_scene |
| SetCurrentPreviewScene | Scenes::set_current_preview_scene |
| CreateScene | Scenes::create |
| RemoveScene | Scenes::remove |
| SetSceneName | Scenes::set_name |
| GetSceneSceneTransitionOverride | Scenes::transition_override |
| SetSceneSceneTransitionOverride | Scenes::set_transition_override |
§Inputs Requests
| obs-websocket | obws |
|---|---|
| GetInputList | Inputs::list |
| GetInputKindList | Inputs::list_kinds |
| GetSpecialInputs | Inputs::specials |
| CreateInput | Inputs::create |
| RemoveInput | Inputs::remove |
| SetInputName | Inputs::set_name |
| GetInputDefaultSettings | Inputs::default_settings |
| GetInputSettings | Inputs::settings |
| SetInputSettings | Inputs::set_settings |
| GetInputMute | Inputs::muted |
| SetInputMute | Inputs::set_muted |
| ToggleInputMute | Inputs::toggle_mute |
| GetInputVolume | Inputs::volume |
| SetInputVolume | Inputs::set_volume |
| GetInputAudioBalance | `Inputs::audio_balance |
| SetInputAudioBalance | `Inputs::set_audio_balance |
| GetInputAudioSyncOffset | Inputs::audio_sync_offset |
| SetInputAudioSyncOffset | Inputs::set_audio_sync_offset |
| GetInputAudioMonitorType | Inputs::audio_monitor_type |
| SetInputAudioMonitorType | Inputs::set_audio_monitor_type |
| GetInputAudioTracks | `Inputs::audio_tracks |
| SetInputAudioTracks | `Inputs::set_audio_tracks |
| GetInputPropertiesListPropertyItems | Inputs::properties_list_property_items |
| PressInputPropertiesButton | Inputs::press_properties_button |
§Transitions Requests
| obs-websocket | obws |
|---|---|
| GetTransitionKindList | Transitions::list_kinds |
| GetSceneTransitionList | Transitions::list |
| GetCurrentSceneTransition | Transitions::current |
| SetCurrentSceneTransition | Transitions::set_current |
| SetCurrentSceneTransitionDuration | Transitions::set_current_duration |
| SetCurrentSceneTransitionSettings | Transitions::set_current_settings |
| GetCurrentSceneTransitionCursor | Transitions::current_cursor |
| TriggerStudioModeTransition | Transitions::trigger |
| SetTBarPosition | Transitions::set_tbar_position |
§Filters Requests
| obs-websocket | obws |
|---|---|
| GetSourceFilterList | Filters::list |
| GetSourceFilterDefaultSettings | Filters::default_settings |
| CreateSourceFilter | Filters::create |
| RemoveSourceFilter | Filters::remove |
| SetSourceFilterName | Filters::set_name |
| GetSourceFilter | Filters::get |
| SetSourceFilterIndex | Filters::set_index |
| SetSourceFilterSettings | Filters::set_settings |
| SetSourceFilterEnabled | Filters::set_enabled |
§Scene Items Requests
| obs-websocket | obws |
|---|---|
| GetSceneItemList | SceneItems::list |
| GetGroupSceneItemList | SceneItems::list_group |
| GetSceneItemId | SceneItems::id |
| CreateSceneItem | SceneItems::create |
| RemoveSceneItem | SceneItems::remove |
| DuplicateSceneItem | SceneItems::duplicate |
| GetSceneItemTransform | SceneItems::transform |
| SetSceneItemTransform | SceneItems::set_transform |
| GetSceneItemEnabled | SceneItems::enabled |
| SetSceneItemEnabled | SceneItems::set_enabled |
| GetSceneItemLocked | SceneItems::locked |
| SetSceneItemLocked | SceneItems::set_locked |
| GetSceneItemIndex | SceneItems::index |
| SetSceneItemIndex | SceneItems::set_index |
| GetSceneItemBlendMode | SceneItems::blend_mode |
| SetSceneItemBlendMode | SceneItems::set_blend_mode |
| GetSceneItemPrivateSettings2 | SceneItems::private_settings |
| SetSceneItemPrivateSettings2 | SceneItems::set_private_settings |
§Outputs Requests
| obs-websocket | obws |
|---|---|
| GetVirtualCamStatus | VirtualCam::status |
| ToggleVirtualCam | VirtualCam::toggle |
| StartVirtualCam | VirtualCam::start |
| StopVirtualCam | VirtualCam::stop |
| GetReplayBufferStatus | ReplayBuffer::status |
| ToggleReplayBuffer | ReplayBuffer::toggle |
| StartReplayBuffer | ReplayBuffer::start |
| StopReplayBuffer | ReplayBuffer::stop |
| SaveReplayBuffer | ReplayBuffer::save |
| GetLastReplayBufferReplay | ReplayBuffer::last_replay |
| GetOutputList | Outputs::list |
| GetOutputStatus | Outputs::status |
| ToggleOutput | Outputs::toggle |
| StartOutput | Outputs::start |
| StopOutput | Outputs::stop |
| GetOutputSettings | Outputs::settings |
| SetOutputSettings | Outputs::set_settings |
§Stream Requests
| obs-websocket | obws |
|---|---|
| GetStreamStatus | Streaming::status |
| ToggleStream | Streaming::toggle |
| StartStream | Streaming::start |
| StopStream | Streaming::stop |
| SendStreamCaption | Streaming::send_caption |
§Record Requests
| obs-websocket | obws |
|---|---|
| GetRecordStatus | Recording::status |
| ToggleRecord | Recording::toggle |
| StartRecord | Recording::start |
| StopRecord | Recording::stop |
| ToggleRecordPause | Recording::toggle_pause |
| PauseRecord | Recording::pause |
| ResumeRecord | Recording::resume |
§Media Inputs Requests
| obs-websocket | obws |
|---|---|
| GetMediaInputStatus | MediaInputs::status |
| SetMediaInputCursor | MediaInputs::set_cursor |
| OffsetMediaInputCursor | MediaInputs::offset_cursor |
| TriggerMediaInputAction | MediaInputs::trigger_action |
§UI Requests
| obs-websocket | obws |
|---|---|
| GetStudioModeEnabled | Ui::studio_mode_enabled |
| SetStudioModeEnabled | Ui::set_studio_mode_enabled |
| OpenInputPropertiesDialog | Ui::open_properties_dialog |
| OpenInputFiltersDialog | Ui::open_filters_dialog |
| OpenInputInteractDialog | Ui::open_interact_dialog |
| GetMonitorList | Ui::list_monitors |
| OpenVideoMixProjector | Ui::open_video_mix_projector |
| OpenSourceProjector | Ui::open_source_projector |