Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add @since

Browse Source
This commit is contained in:
Brendan Hagan 2017-08-25 15:50:58 -05:00
parent 44bd25646d
commit 4e642d97fc
5 changed files with 872 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
WSEvents.cpp
View File

@ -280,6 +280,7 @@ const char* WSEvents::GetRecordingTimecode() {
* @api events * @api events
* @name SwitchScenes * @name SwitchScenes
* @category scenes * @category scenes
* @since 0.3
*/ */
void WSEvents::OnSceneChange() { void WSEvents::OnSceneChange() {
obs_data_t* data = obs_data_create(); obs_data_t* data = obs_data_create();
@ -312,6 +313,7 @@ void WSEvents::OnSceneChange() {
* @api events * @api events
* @name ScenesChanged * @name ScenesChanged
* @category scenes * @category scenes
* @since 0.3
*/ */
void WSEvents::OnSceneListChange() { void WSEvents::OnSceneListChange() {
broadcastUpdate("ScenesChanged"); broadcastUpdate("ScenesChanged");
@ -323,6 +325,7 @@ void WSEvents::OnSceneListChange() {
* @api events * @api events
* @name SceneCollectionChanged * @name SceneCollectionChanged
* @category scenes * @category scenes
* @since 4.0.0
*/ */
void WSEvents::OnSceneCollectionChange() { void WSEvents::OnSceneCollectionChange() {
broadcastUpdate("SceneCollectionChanged"); broadcastUpdate("SceneCollectionChanged");
@ -343,6 +346,7 @@ void WSEvents::OnSceneCollectionChange() {
* @api events * @api events
* @name SceneCollectionListChanged * @name SceneCollectionListChanged
* @category scenes * @category scenes
* @since 4.0.0
*/ */
void WSEvents::OnSceneCollectionListChange() { void WSEvents::OnSceneCollectionListChange() {
broadcastUpdate("SceneCollectionListChanged"); broadcastUpdate("SceneCollectionListChanged");
@ -356,6 +360,7 @@ void WSEvents::OnSceneCollectionListChange() {
* @api events * @api events
* @name SwitchTransition * @name SwitchTransition
* @category transitions * @category transitions
* @since 4.0.0
*/ */
void WSEvents::OnTransitionChange() { void WSEvents::OnTransitionChange() {
obs_source_t* current_transition = obs_frontend_get_current_transition(); obs_source_t* current_transition = obs_frontend_get_current_transition();
@ -378,6 +383,7 @@ void WSEvents::OnTransitionChange() {
* @api events * @api events
* @name TransitionListChanged * @name TransitionListChanged
* @category transitions * @category transitions
* @since 4.0.0
*/ */
void WSEvents::OnTransitionListChange() { void WSEvents::OnTransitionListChange() {
broadcastUpdate("TransitionListChanged"); broadcastUpdate("TransitionListChanged");
@ -389,6 +395,7 @@ void WSEvents::OnTransitionListChange() {
* @api events * @api events
* @name ProfileChanged * @name ProfileChanged
* @category profiles * @category profiles
* @since 4.0.0
*/ */
void WSEvents::OnProfileChange() { void WSEvents::OnProfileChange() {
broadcastUpdate("ProfileChanged"); broadcastUpdate("ProfileChanged");
@ -400,6 +407,7 @@ void WSEvents::OnProfileChange() {
* @api events * @api events
* @name ProfileListChanged * @name ProfileListChanged
* @category profiles * @category profiles
* @since 4.0.0
*/ */
void WSEvents::OnProfileListChange() { void WSEvents::OnProfileListChange() {
broadcastUpdate("ProfileListChanged"); broadcastUpdate("ProfileListChanged");
@ -413,6 +421,7 @@ void WSEvents::OnProfileListChange() {
* @api events * @api events
* @name StreamStarting * @name StreamStarting
* @category streaming * @category streaming
* @since 0.3
*/ */
void WSEvents::OnStreamStarting() { void WSEvents::OnStreamStarting() {
obs_data_t* data = obs_data_create(); obs_data_t* data = obs_data_create();
@ -429,6 +438,7 @@ void WSEvents::OnStreamStarting() {
* @api events * @api events
* @name StreamStarted * @name StreamStarted
* @category streaming * @category streaming
* @since 0.3
*/ */
void WSEvents::OnStreamStarted() { void WSEvents::OnStreamStarted() {
_stream_starttime = os_gettime_ns(); _stream_starttime = os_gettime_ns();
@ -444,6 +454,7 @@ void WSEvents::OnStreamStarted() {
* @api events * @api events
* @name StreamStopping * @name StreamStopping
* @category streaming * @category streaming
* @since 0.3
*/ */
void WSEvents::OnStreamStopping() { void WSEvents::OnStreamStopping() {
obs_data_t* data = obs_data_create(); obs_data_t* data = obs_data_create();
@ -460,6 +471,7 @@ void WSEvents::OnStreamStopping() {
* @api events * @api events
* @name StreamStopped * @name StreamStopped
* @category streaming * @category streaming
* @since 0.3
*/ */
void WSEvents::OnStreamStopped() { void WSEvents::OnStreamStopped() {
_stream_starttime = 0; _stream_starttime = 0;
@ -472,6 +484,7 @@ void WSEvents::OnStreamStopped() {
* @api events * @api events
* @name RecordingStarting * @name RecordingStarting
* @category recording * @category recording
* @since 0.3
*/ */
void WSEvents::OnRecordingStarting() { void WSEvents::OnRecordingStarting() {
broadcastUpdate("RecordingStarting"); broadcastUpdate("RecordingStarting");
@ -483,6 +496,7 @@ void WSEvents::OnRecordingStarting() {
* @api events * @api events
* @name RecordingStarted * @name RecordingStarted
* @category recording * @category recording
* @since 0.3
*/ */
void WSEvents::OnRecordingStarted() { void WSEvents::OnRecordingStarted() {
_rec_starttime = os_gettime_ns(); _rec_starttime = os_gettime_ns();
@ -495,6 +509,7 @@ void WSEvents::OnRecordingStarted() {
* @api events * @api events
* @name RecordingStopping * @name RecordingStopping
* @category recording * @category recording
* @since 0.3
*/ */
void WSEvents::OnRecordingStopping() { void WSEvents::OnRecordingStopping() {
broadcastUpdate("RecordingStopping"); broadcastUpdate("RecordingStopping");
@ -506,6 +521,7 @@ void WSEvents::OnRecordingStopping() {
* @api events * @api events
* @name RecordingStopped * @name RecordingStopped
* @category recording * @category recording
* @since 0.3
*/ */
void WSEvents::OnRecordingStopped() { void WSEvents::OnRecordingStopped() {
_rec_starttime = 0; _rec_starttime = 0;
@ -518,6 +534,7 @@ void WSEvents::OnRecordingStopped() {
* @api events * @api events
* @name ReplayStarting * @name ReplayStarting
* @category replay buffer * @category replay buffer
* @since unreleased
*/ */
void WSEvents::OnReplayStarting() { void WSEvents::OnReplayStarting() {
broadcastUpdate("ReplayStarting"); broadcastUpdate("ReplayStarting");
@ -529,6 +546,7 @@ void WSEvents::OnReplayStarting() {
* @api events * @api events
* @name ReplayStarted * @name ReplayStarted
* @category replay buffer * @category replay buffer
* @since unreleased
*/ */
void WSEvents::OnReplayStarted() { void WSEvents::OnReplayStarted() {
broadcastUpdate("ReplayStarted"); broadcastUpdate("ReplayStarted");
@ -540,6 +558,7 @@ void WSEvents::OnReplayStarted() {
* @api events * @api events
* @name ReplayStopping * @name ReplayStopping
* @category replay buffer * @category replay buffer
* @since unreleased
*/ */
void WSEvents::OnReplayStopping() { void WSEvents::OnReplayStopping() {
broadcastUpdate("ReplayStopping"); broadcastUpdate("ReplayStopping");
@ -551,6 +570,7 @@ void WSEvents::OnReplayStopping() {
* @api events * @api events
* @name ReplayStopped * @name ReplayStopped
* @category replay buffer * @category replay buffer
* @since unreleased
*/ */
void WSEvents::OnReplayStopped() { void WSEvents::OnReplayStopped() {
broadcastUpdate("ReplayStopped"); broadcastUpdate("ReplayStopped");
@ -562,6 +582,7 @@ void WSEvents::OnReplayStopped() {
* @api events * @api events
* @name Exiting * @name Exiting
* @category other * @category other
* @since 0.3
*/ */
void WSEvents::OnExit() { void WSEvents::OnExit() {
broadcastUpdate("Exiting"); broadcastUpdate("Exiting");
@ -584,6 +605,7 @@ void WSEvents::OnExit() {
* @api events * @api events
* @name StreamStatus * @name StreamStatus
* @category streaming * @category streaming
* @since 0.3
*/ */
void WSEvents::StreamStatus() { void WSEvents::StreamStatus() {
bool streaming_active = obs_frontend_streaming_active(); bool streaming_active = obs_frontend_streaming_active();
@ -650,6 +672,7 @@ void WSEvents::StreamStatus() {
* @api events * @api events
* @name TransitionDurationChanged * @name TransitionDurationChanged
* @category transitions * @category transitions
* @since 4.0.0
*/ */
void WSEvents::TransitionDurationChanged(int ms) { void WSEvents::TransitionDurationChanged(int ms) {
obs_data_t* fields = obs_data_create(); obs_data_t* fields = obs_data_create();
@ -668,6 +691,7 @@ void WSEvents::TransitionDurationChanged(int ms) {
* @api events * @api events
* @name TransitionBegin * @name TransitionBegin
* @category transitions * @category transitions
* @since 4.0.0
*/ */
void WSEvents::OnTransitionBegin(void* param, calldata_t* data) { void WSEvents::OnTransitionBegin(void* param, calldata_t* data) {
UNUSED_PARAMETER(data); UNUSED_PARAMETER(data);
@ -694,6 +718,7 @@ void WSEvents::OnTransitionBegin(void* param, calldata_t* data) {
* @api events * @api events
* @name SourceOrderChanged * @name SourceOrderChanged
* @category sources * @category sources
* @since 4.0.0
*/ */
void WSEvents::OnSceneReordered(void* param, calldata_t* data) { void WSEvents::OnSceneReordered(void* param, calldata_t* data) {
WSEvents* instance = static_cast<WSEvents*>(param); WSEvents* instance = static_cast<WSEvents*>(param);
@ -718,6 +743,7 @@ void WSEvents::OnSceneReordered(void* param, calldata_t* data) {
* @api events * @api events
* @name SceneItemAdded * @name SceneItemAdded
* @category sources * @category sources
* @since 4.0.0
*/ */
void WSEvents::OnSceneItemAdd(void* param, calldata_t* data) { void WSEvents::OnSceneItemAdd(void* param, calldata_t* data) {
WSEvents* instance = static_cast<WSEvents*>(param); WSEvents* instance = static_cast<WSEvents*>(param);
@ -750,6 +776,7 @@ void WSEvents::OnSceneItemAdd(void* param, calldata_t* data) {
* @api events * @api events
* @name SceneItemRemoved * @name SceneItemRemoved
* @category sources * @category sources
* @since 4.0.0
*/ */
void WSEvents::OnSceneItemDelete(void* param, calldata_t* data) { void WSEvents::OnSceneItemDelete(void* param, calldata_t* data) {
WSEvents* instance = static_cast<WSEvents*>(param); WSEvents* instance = static_cast<WSEvents*>(param);
@ -783,6 +810,7 @@ void WSEvents::OnSceneItemDelete(void* param, calldata_t* data) {
* @api events * @api events
* @name SceneItemVisibilityChanged * @name SceneItemVisibilityChanged
* @category sources * @category sources
* @since 4.0.0
*/ */
void WSEvents::OnSceneItemVisibilityChanged(void* param, calldata_t* data) { void WSEvents::OnSceneItemVisibilityChanged(void* param, calldata_t* data) {
WSEvents* instance = static_cast<WSEvents*>(param); WSEvents* instance = static_cast<WSEvents*>(param);
@ -819,6 +847,7 @@ void WSEvents::OnSceneItemVisibilityChanged(void* param, calldata_t* data) {
* @api events * @api events
* @name PreviewSceneChanged * @name PreviewSceneChanged
* @category studio mode * @category studio mode
* @since 4.1.0
*/ */
void WSEvents::SelectedSceneChanged(QListWidgetItem* current, QListWidgetItem* prev) { void WSEvents::SelectedSceneChanged(QListWidgetItem* current, QListWidgetItem* prev) {
if (Utils::IsPreviewModeActive()) { if (Utils::IsPreviewModeActive()) {
@ -847,6 +876,7 @@ void WSEvents::SelectedSceneChanged(QListWidgetItem* current, QListWidgetItem* p
* @api events * @api events
* @name StudioModeSwitched * @name StudioModeSwitched
* @category studio mode * @category studio mode
* @since 4.1.0
*/ */
void WSEvents::ModeSwitchClicked(bool checked) { void WSEvents::ModeSwitchClicked(bool checked) {
obs_data_t* data = obs_data_create(); obs_data_t* data = obs_data_create();

56
WSRequestHandler.cpp
View File

@ -212,6 +212,7 @@ bool WSRequestHandler::hasField(const char* name) {
* @api requests * @api requests
* @name GetVersion * @name GetVersion
* @category general * @category general
* @since 0.3
*/ */
void WSRequestHandler::HandleGetVersion(WSRequestHandler* req) { void WSRequestHandler::HandleGetVersion(WSRequestHandler* req) {
const char* obs_version = Utils::OBSVersionString(); const char* obs_version = Utils::OBSVersionString();
@ -246,6 +247,7 @@ void WSRequestHandler::HandleGetVersion(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetAuthRequired * @name GetAuthRequired
* @category general * @category general
* @since 0.3
*/ */
void WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) { void WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
bool authRequired = Config::Current()->AuthRequired; bool authRequired = Config::Current()->AuthRequired;
@ -273,6 +275,7 @@ void WSRequestHandler::HandleGetAuthRequired(WSRequestHandler* req) {
* @api requests * @api requests
* @name Authenticate * @name Authenticate
* @category general * @category general
* @since 0.3
*/ */
void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) { void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
if (!req->hasField("auth")) { if (!req->hasField("auth")) {
@ -303,6 +306,7 @@ void WSRequestHandler::HandleAuthenticate(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetCurrentScene * @name SetCurrentScene
* @category scenes * @category scenes
* @since 0.3
*/ */
void WSRequestHandler::HandleSetCurrentScene(WSRequestHandler* req) { void WSRequestHandler::HandleSetCurrentScene(WSRequestHandler* req) {
if (!req->hasField("scene-name")) { if (!req->hasField("scene-name")) {
@ -332,6 +336,7 @@ void WSRequestHandler::HandleSetCurrentScene(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetCurrentScene * @name GetCurrentScene
* @category scenes * @category scenes
* @since 0.3
*/ */
void WSRequestHandler::HandleGetCurrentScene(WSRequestHandler* req) { void WSRequestHandler::HandleGetCurrentScene(WSRequestHandler* req) {
obs_source_t* current_scene = obs_frontend_get_current_scene(); obs_source_t* current_scene = obs_frontend_get_current_scene();
@ -359,6 +364,7 @@ void WSRequestHandler::HandleGetCurrentScene(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetSceneList * @name GetSceneList
* @category scenes * @category scenes
* @since 0.3
*/ */
void WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) { void WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
obs_source_t* current_scene = obs_frontend_get_current_scene(); obs_source_t* current_scene = obs_frontend_get_current_scene();
@ -386,6 +392,7 @@ void WSRequestHandler::HandleGetSceneList(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetSourceRender * @name SetSourceRender
* @category sources * @category sources
* @since 0.3
*/ */
void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) { void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
if (!req->hasField("source") || if (!req->hasField("source") ||
@ -433,6 +440,7 @@ void WSRequestHandler::HandleSetSceneItemRender(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetStreamingStatus * @name GetStreamingStatus
* @category streaming * @category streaming
* @since 0.3
*/ */
void WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler* req) { void WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler* req) {
obs_data_t* data = obs_data_create(); obs_data_t* data = obs_data_create();
@ -463,6 +471,7 @@ void WSRequestHandler::HandleGetStreamingStatus(WSRequestHandler* req) {
* @api requests * @api requests
* @name StartStopStreaming * @name StartStopStreaming
* @category streaming * @category streaming
* @since 0.3
*/ */
void WSRequestHandler::HandleStartStopStreaming(WSRequestHandler* req) { void WSRequestHandler::HandleStartStopStreaming(WSRequestHandler* req) {
if (obs_frontend_streaming_active()) if (obs_frontend_streaming_active())
@ -477,6 +486,7 @@ void WSRequestHandler::HandleStartStopStreaming(WSRequestHandler* req) {
* @api requests * @api requests
* @name StartStopRecording * @name StartStopRecording
* @category recording * @category recording
* @since 0.3
*/ */
void WSRequestHandler::HandleStartStopRecording(WSRequestHandler* req) void WSRequestHandler::HandleStartStopRecording(WSRequestHandler* req)
{ {
@ -505,6 +515,7 @@ void WSRequestHandler::HandleStartStopRecording(WSRequestHandler* req)
* @api requests * @api requests
* @name StartStreaming * @name StartStreaming
* @category streaming * @category streaming
* @since 4.1.0
*/ */
void WSRequestHandler::HandleStartStreaming(WSRequestHandler* req) void WSRequestHandler::HandleStartStreaming(WSRequestHandler* req)
{ {
@ -606,6 +617,7 @@ void WSRequestHandler::HandleStartStreaming(WSRequestHandler* req)
* @api requests * @api requests
* @name StopStreaming * @name StopStreaming
* @category streaming * @category streaming
* @since 4.1.0
*/ */
void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) { void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
if (obs_frontend_streaming_active() == true) { if (obs_frontend_streaming_active() == true) {
@ -623,6 +635,7 @@ void WSRequestHandler::HandleStopStreaming(WSRequestHandler* req) {
* @api requests * @api requests
* @name StartRecording * @name StartRecording
* @category recording * @category recording
* @since 4.1.0
*/ */
void WSRequestHandler::HandleStartRecording(WSRequestHandler* req) { void WSRequestHandler::HandleStartRecording(WSRequestHandler* req) {
if (obs_frontend_recording_active() == false) { if (obs_frontend_recording_active() == false) {
@ -640,6 +653,7 @@ void WSRequestHandler::HandleStartRecording(WSRequestHandler* req) {
* @api requests * @api requests
* @name StopRecording * @name StopRecording
* @category recording * @category recording
* @since 4.1.0
*/ */
void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) { void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
if (obs_frontend_recording_active() == true) { if (obs_frontend_recording_active() == true) {
@ -656,6 +670,7 @@ void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
* @api requests * @api requests
* @name StartStopReplayBuffer * @name StartStopReplayBuffer
* @category replay buffer * @category replay buffer
* @since unreleased
*/ */
void WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) { void WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
if (obs_frontend_replay_buffer_active()) { if (obs_frontend_replay_buffer_active()) {
@ -680,6 +695,7 @@ void WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
* @api requests * @api requests
* @name StartReplayBuffer * @name StartReplayBuffer
* @category replay buffer * @category replay buffer
* @since unreleased
*/ */
void WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) { void WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
if (!Utils::ReplayBufferEnabled()) { if (!Utils::ReplayBufferEnabled()) {
@ -708,6 +724,7 @@ void WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
* @api requests * @api requests
* @name StopReplayBuffer * @name StopReplayBuffer
* @category replay buffer * @category replay buffer
* @since unreleased
*/ */
void WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) { void WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
if (obs_frontend_replay_buffer_active() == true) { if (obs_frontend_replay_buffer_active() == true) {
@ -726,6 +743,7 @@ void WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
* @api requests * @api requests
* @name SaveReplayBuffer * @name SaveReplayBuffer
* @category replay buffer * @category replay buffer
* @since unreleased
*/ */
void WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req) { void WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req) {
if (!obs_frontend_replay_buffer_active()) { if (!obs_frontend_replay_buffer_active()) {
@ -752,6 +770,7 @@ void WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetTransitionList * @name GetTransitionList
* @category transitions * @category transitions
* @since 4.1.0
*/ */
void WSRequestHandler::HandleGetTransitionList(WSRequestHandler* req) { void WSRequestHandler::HandleGetTransitionList(WSRequestHandler* req) {
obs_source_t* current_transition = obs_frontend_get_current_transition(); obs_source_t* current_transition = obs_frontend_get_current_transition();
@ -791,6 +810,7 @@ void WSRequestHandler::HandleGetTransitionList(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetCurrentTransition * @name GetCurrentTransition
* @category transitions * @category transitions
* @since 0.3
*/ */
void WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) { void WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
obs_source_t* current_transition = obs_frontend_get_current_transition(); obs_source_t* current_transition = obs_frontend_get_current_transition();
@ -816,6 +836,7 @@ void WSRequestHandler::HandleGetCurrentTransition(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetCurrentTransition * @name SetCurrentTransition
* @category transitions * @category transitions
* @since 0.3
*/ */
void WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) { void WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
if (!req->hasField("transition-name")) { if (!req->hasField("transition-name")) {
@ -839,6 +860,7 @@ void WSRequestHandler::HandleSetCurrentTransition(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetTransitionDuration * @name SetTransitionDuration
* @category transitions * @category transitions
* @since 4.0.0
*/ */
void WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) { void WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
if (!req->hasField("duration")) { if (!req->hasField("duration")) {
@ -859,6 +881,7 @@ void WSRequestHandler::HandleSetTransitionDuration(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetTransitionDuration * @name GetTransitionDuration
* @category transitions * @category transitions
* @since 4.1.0
*/ */
void WSRequestHandler::HandleGetTransitionDuration(WSRequestHandler* req) { void WSRequestHandler::HandleGetTransitionDuration(WSRequestHandler* req) {
obs_data_t* response = obs_data_create(); obs_data_t* response = obs_data_create();
@ -878,6 +901,7 @@ void WSRequestHandler::HandleGetTransitionDuration(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetVolume * @name SetVolume
* @category sources * @category sources
* @since 4.0.0
*/ */
void WSRequestHandler::HandleSetVolume(WSRequestHandler* req) { void WSRequestHandler::HandleSetVolume(WSRequestHandler* req) {
if (!req->hasField("source") || if (!req->hasField("source") ||
@ -919,6 +943,7 @@ void WSRequestHandler::HandleSetVolume(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetVolume * @name GetVolume
* @category sources * @category sources
* @since 4.0.0
*/ */
void WSRequestHandler::HandleGetVolume(WSRequestHandler* req) { void WSRequestHandler::HandleGetVolume(WSRequestHandler* req) {
if (!req->hasField("source")) { if (!req->hasField("source")) {
@ -952,6 +977,7 @@ void WSRequestHandler::HandleGetVolume(WSRequestHandler* req) {
* @api requests * @api requests
* @name ToggleMute * @name ToggleMute
* @category sources * @category sources
* @since 4.0.0
*/ */
void WSRequestHandler::HandleToggleMute(WSRequestHandler* req) { void WSRequestHandler::HandleToggleMute(WSRequestHandler* req) {
if (!req->hasField("source")) { if (!req->hasField("source")) {
@ -986,6 +1012,7 @@ void WSRequestHandler::HandleToggleMute(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetMute * @name SetMute
* @category sources * @category sources
* @since 4.0.0
*/ */
void WSRequestHandler::HandleSetMute(WSRequestHandler* req) { void WSRequestHandler::HandleSetMute(WSRequestHandler* req) {
if (!req->hasField("source") || if (!req->hasField("source") ||
@ -1025,6 +1052,7 @@ void WSRequestHandler::HandleSetMute(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetMute * @name GetMute
* @category sources * @category sources
* @since 4.0.0
*/ */
void WSRequestHandler::HandleGetMute(WSRequestHandler* req) { void WSRequestHandler::HandleGetMute(WSRequestHandler* req) {
if (!req->hasField("source")) { if (!req->hasField("source")) {
@ -1063,6 +1091,7 @@ void WSRequestHandler::HandleGetMute(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetSyncOffset * @name SetSyncOffset
* @category sources * @category sources
* @since unreleased
*/ */
void WSRequestHandler::HandleSetSyncOffset(WSRequestHandler* req) { void WSRequestHandler::HandleSetSyncOffset(WSRequestHandler* req) {
if (!req->hasField("source") || !req->hasField("offset")) { if (!req->hasField("source") || !req->hasField("offset")) {
@ -1101,6 +1130,7 @@ void WSRequestHandler::HandleSetSyncOffset(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetSyncOffset * @name GetSyncOffset
* @category sources * @category sources
* @since unreleased
*/ */
void WSRequestHandler::HandleGetSyncOffset(WSRequestHandler* req) { void WSRequestHandler::HandleGetSyncOffset(WSRequestHandler* req) {
if (!req->hasField("source")) { if (!req->hasField("source")) {
@ -1137,6 +1167,7 @@ void WSRequestHandler::HandleGetSyncOffset(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetSceneItemPosition * @name SetSceneItemPosition
* @category sources * @category sources
* @since 4.0.0
*/ */
void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) { void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
if (!req->hasField("item") || if (!req->hasField("item") ||
@ -1187,6 +1218,7 @@ void WSRequestHandler::HandleSetSceneItemPosition(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetSceneItemTransform * @name SetSceneItemTransform
* @category sources * @category sources
* @since 4.0.0
*/ */
void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) { void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
if (!req->hasField("item") || if (!req->hasField("item") ||
@ -1242,6 +1274,7 @@ void WSRequestHandler::HandleSetSceneItemTransform(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetSceneItemCrop * @name SetSceneItemCrop
* @category sources * @category sources
* @since 4.1.0
*/ */
void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) { void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
if (!req->hasField("item")) { if (!req->hasField("item")) {
@ -1289,6 +1322,7 @@ void WSRequestHandler::HandleSetSceneItemCrop(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetCurrentSceneCollection * @name SetCurrentSceneCollection
* @category scene collections * @category scene collections
* @since 4.0.0
*/ */
void WSRequestHandler::HandleSetCurrentSceneCollection(WSRequestHandler* req) { void WSRequestHandler::HandleSetCurrentSceneCollection(WSRequestHandler* req) {
if (!req->hasField("sc-name")) { if (!req->hasField("sc-name")) {
@ -1314,6 +1348,7 @@ void WSRequestHandler::HandleSetCurrentSceneCollection(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetCurrentSceneCollection * @name GetCurrentSceneCollection
* @category scene collections * @category scene collections
* @since 4.0.0
*/ */
void WSRequestHandler::HandleGetCurrentSceneCollection(WSRequestHandler* req) { void WSRequestHandler::HandleGetCurrentSceneCollection(WSRequestHandler* req) {
obs_data_t* response = obs_data_create(); obs_data_t* response = obs_data_create();
@ -1343,6 +1378,7 @@ void WSRequestHandler::HandleListSceneCollections(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetCurrentProfile * @name SetCurrentProfile
* @category profiles * @category profiles
* @since 4.0.0
*/ */
void WSRequestHandler::HandleSetCurrentProfile(WSRequestHandler* req) { void WSRequestHandler::HandleSetCurrentProfile(WSRequestHandler* req) {
if (!req->hasField("profile-name")) { if (!req->hasField("profile-name")) {
@ -1368,6 +1404,7 @@ void WSRequestHandler::HandleSetCurrentProfile(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetCurrentProfile * @name GetCurrentProfile
* @category profiles * @category profiles
* @since 4.0.0
*/ */
void WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) { void WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) {
obs_data_t* response = obs_data_create(); obs_data_t* response = obs_data_create();
@ -1393,6 +1430,7 @@ void WSRequestHandler::HandleGetCurrentProfile(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetStreamingSettings * @name SetStreamingSettings
* @category settings * @category settings
* @since 4.1.0
*/ */
void WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req) { void WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req) {
obs_service_t* service = obs_frontend_get_streaming_service(); obs_service_t* service = obs_frontend_get_streaming_service();
@ -1454,6 +1492,7 @@ void WSRequestHandler::HandleSetStreamSettings(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetStreamSettings * @name GetStreamSettings
* @category settings * @category settings
* @since 4.1.0
*/ */
void WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) { void WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
obs_service_t* service = obs_frontend_get_streaming_service(); obs_service_t* service = obs_frontend_get_streaming_service();
@ -1475,6 +1514,7 @@ void WSRequestHandler::HandleGetStreamSettings(WSRequestHandler* req) {
* @api requests * @api requests
* @name SaveStreamSettings * @name SaveStreamSettings
* @category settings * @category settings
* @since 4.1.0
*/ */
void WSRequestHandler::HandleSaveStreamSettings(WSRequestHandler* req) { void WSRequestHandler::HandleSaveStreamSettings(WSRequestHandler* req) {
obs_frontend_save_streaming_service(); obs_frontend_save_streaming_service();
@ -1489,6 +1529,7 @@ void WSRequestHandler::HandleSaveStreamSettings(WSRequestHandler* req) {
* @api requests * @api requests
* @name ListProfiles * @name ListProfiles
* @category profiles * @category profiles
* @since 4.0.0
*/ */
void WSRequestHandler::HandleListProfiles(WSRequestHandler* req) { void WSRequestHandler::HandleListProfiles(WSRequestHandler* req) {
obs_data_array_t* profiles = Utils::GetProfiles(); obs_data_array_t* profiles = Utils::GetProfiles();
@ -1509,6 +1550,7 @@ void WSRequestHandler::HandleListProfiles(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetStudioModeStatus * @name GetStudioModeStatus
* @category studio mode * @category studio mode
* @since 4.1.0
*/ */
void WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* req) { void WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* req) {
bool previewActive = Utils::IsPreviewModeActive(); bool previewActive = Utils::IsPreviewModeActive();
@ -1530,6 +1572,7 @@ void WSRequestHandler::HandleGetStudioModeStatus(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetPreviewScene * @name GetPreviewScene
* @category studio mode * @category studio mode
* @since 4.1.0
*/ */
void WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) { void WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
if (!Utils::IsPreviewModeActive()) { if (!Utils::IsPreviewModeActive()) {
@ -1562,6 +1605,7 @@ void WSRequestHandler::HandleGetPreviewScene(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetPreviewScene * @name SetPreviewScene
* @category studio mode * @category studio mode
* @since 4.1.0
*/ */
void WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) { void WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
if (!Utils::IsPreviewModeActive()) { if (!Utils::IsPreviewModeActive()) {
@ -1593,6 +1637,7 @@ void WSRequestHandler::HandleSetPreviewScene(WSRequestHandler* req) {
* @api requests * @api requests
* @name TransitionToProgram * @name TransitionToProgram
* @category studio mode * @category studio mode
* @since 4.1.0
*/ */
void WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) { void WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
if (!Utils::IsPreviewModeActive()) { if (!Utils::IsPreviewModeActive()) {
@ -1639,6 +1684,7 @@ void WSRequestHandler::HandleTransitionToProgram(WSRequestHandler* req) {
* @api requests * @api requests
* @name EnableStudioMode * @name EnableStudioMode
* @category studio mode * @category studio mode
* @since 4.1.0
*/ */
void WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) { void WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
Utils::EnablePreviewMode(); Utils::EnablePreviewMode();
@ -1651,6 +1697,7 @@ void WSRequestHandler::HandleEnableStudioMode(WSRequestHandler* req) {
* @api requests * @api requests
* @name DisableStudioMode * @name DisableStudioMode
* @category studio mode * @category studio mode
* @since 4.1.0
*/ */
void WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) { void WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
Utils::DisablePreviewMode(); Utils::DisablePreviewMode();
@ -1663,6 +1710,7 @@ void WSRequestHandler::HandleDisableStudioMode(WSRequestHandler* req) {
* @api requests * @api requests
* @name ToggleStudioMode * @name ToggleStudioMode
* @category studio mode * @category studio mode
* @since 4.1.0
*/ */
void WSRequestHandler::HandleToggleStudioMode(WSRequestHandler* req) { void WSRequestHandler::HandleToggleStudioMode(WSRequestHandler* req) {
Utils::TogglePreviewMode(); Utils::TogglePreviewMode();
@ -1681,6 +1729,7 @@ void WSRequestHandler::HandleToggleStudioMode(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetSpecialSources * @name GetSpecialSources
* @category studio mode * @category studio mode
* @since 4.1.0
*/ */
void WSRequestHandler::HandleGetSpecialSources(WSRequestHandler* req) { void WSRequestHandler::HandleGetSpecialSources(WSRequestHandler* req) {
obs_data_t* response = obs_data_create(); obs_data_t* response = obs_data_create();
@ -1718,6 +1767,7 @@ void WSRequestHandler::HandleGetSpecialSources(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetRecordingFolder * @name SetRecordingFolder
* @category recording * @category recording
* @since 4.1.0
*/ */
void WSRequestHandler::HandleSetRecordingFolder(WSRequestHandler* req) { void WSRequestHandler::HandleSetRecordingFolder(WSRequestHandler* req) {
if (!req->hasField("rec-folder")) { if (!req->hasField("rec-folder")) {
@ -1741,6 +1791,7 @@ void WSRequestHandler::HandleSetRecordingFolder(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetRecordingFolder * @name GetRecordingFolder
* @category recording * @category recording
* @since 4.1.0
*/ */
void WSRequestHandler::HandleGetRecordingFolder(WSRequestHandler* req) { void WSRequestHandler::HandleGetRecordingFolder(WSRequestHandler* req) {
const char* recFolder = Utils::GetRecordingFolder(); const char* recFolder = Utils::GetRecordingFolder();
@ -1790,6 +1841,7 @@ void WSRequestHandler::HandleGetRecordingFolder(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetTextGDIPlusProperties * @name GetTextGDIPlusProperties
* @category sources * @category sources
* @since 4.1.0
*/ */
void WSRequestHandler::HandleGetTextGDIPlusProperties(WSRequestHandler* req) { void WSRequestHandler::HandleGetTextGDIPlusProperties(WSRequestHandler* req) {
const char* itemName = obs_data_get_string(req->data, "source"); const char* itemName = obs_data_get_string(req->data, "source");
@ -1868,6 +1920,7 @@ void WSRequestHandler::HandleGetTextGDIPlusProperties(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetTextGDIPlusProperties * @name SetTextGDIPlusProperties
* @category sources * @category sources
* @since 4.1.0
*/ */
void WSRequestHandler::HandleSetTextGDIPlusProperties(WSRequestHandler* req) { void WSRequestHandler::HandleSetTextGDIPlusProperties(WSRequestHandler* req) {
if (!req->hasField("source")) { if (!req->hasField("source")) {
@ -2079,6 +2132,7 @@ void WSRequestHandler::HandleSetTextGDIPlusProperties(WSRequestHandler* req) {
* @api requests * @api requests
* @name GetBrowserSourceProperties * @name GetBrowserSourceProperties
* @category sources * @category sources
* @since 4.1.0
*/ */
void WSRequestHandler::HandleGetBrowserSourceProperties(WSRequestHandler* req) { void WSRequestHandler::HandleGetBrowserSourceProperties(WSRequestHandler* req) {
const char* itemName = obs_data_get_string(req->data, "source"); const char* itemName = obs_data_get_string(req->data, "source");
@ -2136,6 +2190,7 @@ void WSRequestHandler::HandleGetBrowserSourceProperties(WSRequestHandler* req) {
* @api requests * @api requests
* @name SetBrowserSourceProperties * @name SetBrowserSourceProperties
* @category sources * @category sources
* @since 4.1.0
*/ */
void WSRequestHandler::HandleSetBrowserSourceProperties(WSRequestHandler* req) { void WSRequestHandler::HandleSetBrowserSourceProperties(WSRequestHandler* req) {
if (!req->hasField("source")) { if (!req->hasField("source")) {
@ -2233,6 +2288,7 @@ void WSRequestHandler::HandleSetBrowserSourceProperties(WSRequestHandler* req) {
* @api requests * @api requests
* @name ResetSceneItem * @name ResetSceneItem
* @category sources * @category sources
* @since unreleased
*/ */
void WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) { void WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
if (!req->hasField("item")) { if (!req->hasField("item")) {

602
docs/generated/comments.json
View File

File diff suppressed because it is too large Load Diff

172
docs/generated/protocol.md
View File

@ -175,6 +175,8 @@ Additional fields may be present in the event message depending on the event typ
### SwitchScenes ### SwitchScenes
- Added in v0.3
Indicates a scene change. Indicates a scene change.
**Response Items:** **Response Items:**
@ -189,6 +191,8 @@ Indicates a scene change.
### ScenesChanged ### ScenesChanged
- Added in v0.3
The scene list has been modified. The scene list has been modified.
Scenes have been added, removed, or renamed. Scenes have been added, removed, or renamed.
@ -200,6 +204,8 @@ _No additional response items._
### SceneCollectionChanged ### SceneCollectionChanged
- Added in v4.0.0
Triggered when switching to another scene collection or when renaming the current scene collection. Triggered when switching to another scene collection or when renaming the current scene collection.
**Response Items:** **Response Items:**
@ -210,6 +216,8 @@ _No additional response items._
### SceneCollectionListChanged ### SceneCollectionListChanged
- Added in v4.0.0
Triggered when a scene collection is created, added, renamed, or removed. Triggered when a scene collection is created, added, renamed, or removed.
**Response Items:** **Response Items:**
@ -222,6 +230,8 @@ _No additional response items._
### SwitchTransition ### SwitchTransition
- Added in v4.0.0
The active transition has been changed. The active transition has been changed.
**Response Items:** **Response Items:**
@ -235,6 +245,8 @@ The active transition has been changed.
### TransitionListChanged ### TransitionListChanged
- Added in v4.0.0
The list of available transitions has been modified. The list of available transitions has been modified.
Transitions have been added, removed, or renamed. Transitions have been added, removed, or renamed.
@ -246,6 +258,8 @@ _No additional response items._
### TransitionDurationChanged ### TransitionDurationChanged
- Added in v4.0.0
The active transition duration has been changed. The active transition duration has been changed.
**Response Items:** **Response Items:**
@ -259,6 +273,8 @@ The active transition duration has been changed.
### TransitionBegin ### TransitionBegin
- Added in v4.0.0
A transition (other than "cut") has begun. A transition (other than "cut") has begun.
**Response Items:** **Response Items:**
@ -275,6 +291,8 @@ A transition (other than "cut") has begun.
### ProfileChanged ### ProfileChanged
- Added in v4.0.0
Triggered when switching to another profile or when renaming the current profile. Triggered when switching to another profile or when renaming the current profile.
**Response Items:** **Response Items:**
@ -285,6 +303,8 @@ _No additional response items._
### ProfileListChanged ### ProfileListChanged
- Added in v4.0.0
Triggered when a profile is created, added, renamed, or removed. Triggered when a profile is created, added, renamed, or removed.
**Response Items:** **Response Items:**
@ -297,6 +317,8 @@ _No additional response items._
### StreamStarting ### StreamStarting
- Added in v0.3
A request to start streaming has been issued. A request to start streaming has been issued.
**Response Items:** **Response Items:**
@ -310,6 +332,8 @@ A request to start streaming has been issued.
### StreamStarted ### StreamStarted
- Added in v0.3
Streaming started successfully. Streaming started successfully.
**Response Items:** **Response Items:**
@ -320,6 +344,8 @@ _No additional response items._
### StreamStopping ### StreamStopping
- Added in v0.3
A request to stop streaming has been issued. A request to stop streaming has been issued.
**Response Items:** **Response Items:**
@ -333,6 +359,8 @@ A request to stop streaming has been issued.
### StreamStopped ### StreamStopped
- Added in v0.3
Streaming stopped successfully. Streaming stopped successfully.
**Response Items:** **Response Items:**
@ -343,6 +371,8 @@ _No additional response items._
### StreamStatus ### StreamStatus
- Added in v0.3
Emit every 2 seconds. Emit every 2 seconds.
**Response Items:** **Response Items:**
@ -367,6 +397,8 @@ Emit every 2 seconds.
### RecordingStarting ### RecordingStarting
- Added in v0.3
A request to start recording has been issued. A request to start recording has been issued.
**Response Items:** **Response Items:**
@ -377,6 +409,8 @@ _No additional response items._
### RecordingStarted ### RecordingStarted
- Added in v0.3
Recording started successfully. Recording started successfully.
**Response Items:** **Response Items:**
@ -387,6 +421,8 @@ _No additional response items._
### RecordingStopping ### RecordingStopping
- Added in v0.3
A request to stop recording has been issued. A request to stop recording has been issued.
**Response Items:** **Response Items:**
@ -397,6 +433,8 @@ _No additional response items._
### RecordingStopped ### RecordingStopped
- Added in v0.3
Recording stopped successfully. Recording stopped successfully.
**Response Items:** **Response Items:**
@ -409,6 +447,8 @@ _No additional response items._
### ReplayStarting ### ReplayStarting
- Unreleased
A request to start the replay buffer has been issued. A request to start the replay buffer has been issued.
**Response Items:** **Response Items:**
@ -419,6 +459,8 @@ _No additional response items._
### ReplayStarted ### ReplayStarted
- Unreleased
Replay Buffer started successfully Replay Buffer started successfully
**Response Items:** **Response Items:**
@ -429,6 +471,8 @@ _No additional response items._
### ReplayStopping ### ReplayStopping
- Unreleased
A request to start the replay buffer has been issued. A request to start the replay buffer has been issued.
**Response Items:** **Response Items:**
@ -439,6 +483,8 @@ _No additional response items._
### ReplayStopped ### ReplayStopped
- Unreleased
Replay Buffer stopped successfully Replay Buffer stopped successfully
**Response Items:** **Response Items:**
@ -451,6 +497,8 @@ _No additional response items._
### Exiting ### Exiting
- Added in v0.3
OBS is exiting. OBS is exiting.
**Response Items:** **Response Items:**
@ -463,6 +511,8 @@ _No additional response items._
### SourceOrderChanged ### SourceOrderChanged
- Added in v4.0.0
Scene items have been reordered. Scene items have been reordered.
**Response Items:** **Response Items:**
@ -476,6 +526,8 @@ Scene items have been reordered.
### SceneItemAdded ### SceneItemAdded
- Added in v4.0.0
An item has been added to the current scene. An item has been added to the current scene.
**Response Items:** **Response Items:**
@ -490,6 +542,8 @@ An item has been added to the current scene.
### SceneItemRemoved ### SceneItemRemoved
- Added in v4.0.0
An item has been removed from the current scene. An item has been removed from the current scene.
**Response Items:** **Response Items:**
@ -504,6 +558,8 @@ An item has been removed from the current scene.
### SceneItemVisibilityChanged ### SceneItemVisibilityChanged
- Added in v4.0.0
An item's visibility has been toggled. An item's visibility has been toggled.
**Response Items:** **Response Items:**
@ -521,6 +577,8 @@ An item's visibility has been toggled.
### PreviewSceneChanged ### PreviewSceneChanged
- Added in v4.1.0
The selected preview scene has changed (only available in Studio Mode). The selected preview scene has changed (only available in Studio Mode).
**Response Items:** **Response Items:**
@ -535,6 +593,8 @@ The selected preview scene has changed (only available in Studio Mode).
### StudioModeSwitched ### StudioModeSwitched
- Added in v4.1.0
Studio Mode has been enabled or disabled. Studio Mode has been enabled or disabled.
**Response Items:** **Response Items:**
@ -566,6 +626,8 @@ Additional information may be required/returned depending on the request type. S
### GetVersion ### GetVersion
- Added in v0.3
Returns the latest version of the plugin and the API. Returns the latest version of the plugin and the API.
**Request Fields:** **Request Fields:**
@ -586,6 +648,8 @@ _No specified parameters._
### GetAuthRequired ### GetAuthRequired
- Added in v0.3
Tells the client if authentication is required. If so, returns authentication parameters `challenge` Tells the client if authentication is required. If so, returns authentication parameters `challenge`
and `salt` (see "Authentication" for more information). and `salt` (see "Authentication" for more information).
@ -606,6 +670,8 @@ _No specified parameters._
### Authenticate ### Authenticate
- Added in v0.3
Attempt to authenticate the client to the server. Attempt to authenticate the client to the server.
**Request Fields:** **Request Fields:**
@ -625,6 +691,8 @@ _No additional response items._
### SetCurrentScene ### SetCurrentScene
- Added in v0.3
Switch to the specified scene. Switch to the specified scene.
**Request Fields:** **Request Fields:**
@ -642,6 +710,8 @@ _No additional response items._
### GetCurrentScene ### GetCurrentScene
- Added in v0.3
Get the current scene's name and source items. Get the current scene's name and source items.
**Request Fields:** **Request Fields:**
@ -660,6 +730,8 @@ _No specified parameters._
### GetSceneList ### GetSceneList
- Added in v0.3
Get a list of scenes in the currently active profile. Get a list of scenes in the currently active profile.
**Request Fields:** **Request Fields:**
@ -680,6 +752,8 @@ _No specified parameters._
### SetSourceRender ### SetSourceRender
- Added in v0.3
Show or hide a specified source item in a specified scene. Show or hide a specified source item in a specified scene.
**Request Fields:** **Request Fields:**
@ -699,6 +773,8 @@ _No additional response items._
### SetVolume ### SetVolume
- Added in v4.0.0
Set the volume of the specified source. Set the volume of the specified source.
**Request Fields:** **Request Fields:**
@ -717,6 +793,8 @@ _No additional response items._
### GetVolume ### GetVolume
- Added in v4.0.0
Get the volume of the specified source. Get the volume of the specified source.
**Request Fields:** **Request Fields:**
@ -739,6 +817,8 @@ Get the volume of the specified source.
### ToggleMute ### ToggleMute
- Added in v4.0.0
Inverts the mute status of a specified source. Inverts the mute status of a specified source.
**Request Fields:** **Request Fields:**
@ -756,6 +836,8 @@ _No additional response items._
### SetMute ### SetMute
- Added in v4.0.0
Sets the mute status of a specified source. Sets the mute status of a specified source.
**Request Fields:** **Request Fields:**
@ -774,6 +856,8 @@ _No additional response items._
### GetMute ### GetMute
- Added in v4.0.0
Get the mute status of a specified source. Get the mute status of a specified source.
**Request Fields:** **Request Fields:**
@ -795,6 +879,8 @@ Get the mute status of a specified source.
### SetSyncOffset ### SetSyncOffset
- Unreleased
Set the audio sync offset of a specified source. Set the audio sync offset of a specified source.
**Request Fields:** **Request Fields:**
@ -813,6 +899,8 @@ _No additional response items._
### GetSyncOffset ### GetSyncOffset
- Unreleased
Get the audio sync offset of a specified source. Get the audio sync offset of a specified source.
**Request Fields:** **Request Fields:**
@ -834,6 +922,8 @@ Get the audio sync offset of a specified source.
### SetSceneItemPosition ### SetSceneItemPosition
- Added in v4.0.0
Sets the coordinates of a specified source item. Sets the coordinates of a specified source item.
**Request Fields:** **Request Fields:**
@ -854,6 +944,8 @@ _No additional response items._
### SetSceneItemTransform ### SetSceneItemTransform
- Added in v4.0.0
Set the transform of the specified source item. Set the transform of the specified source item.
**Request Fields:** **Request Fields:**
@ -875,6 +967,8 @@ _No additional response items._
### SetSceneItemCrop ### SetSceneItemCrop
- Added in v4.1.0
Sets the crop coordinates of the specified source item. Sets the crop coordinates of the specified source item.
**Request Fields:** **Request Fields:**
@ -897,6 +991,8 @@ _No additional response items._
### GetTextGDIPlusProperties ### GetTextGDIPlusProperties
- Added in v4.1.0
Get the current properties of a Text GDI Plus source. Get the current properties of a Text GDI Plus source.
**Request Fields:** **Request Fields:**
@ -945,6 +1041,8 @@ Get the current properties of a Text GDI Plus source.
### SetTextGDIPlusProperties ### SetTextGDIPlusProperties
- Added in v4.1.0
Get the current properties of a Text GDI Plus source. Get the current properties of a Text GDI Plus source.
**Request Fields:** **Request Fields:**
@ -991,6 +1089,8 @@ _No additional response items._
### GetBrowserSourceProperties ### GetBrowserSourceProperties
- Added in v4.1.0
Get current properties for a Browser Source. Get current properties for a Browser Source.
**Request Fields:** **Request Fields:**
@ -1019,6 +1119,8 @@ Get current properties for a Browser Source.
### SetBrowserSourceProperties ### SetBrowserSourceProperties
- Added in v4.1.0
Set current properties for a Browser Source. Set current properties for a Browser Source.
**Request Fields:** **Request Fields:**
@ -1045,6 +1147,8 @@ _No additional response items._
### ResetSceneItem ### ResetSceneItem
- Unreleased
Reset a source item. Reset a source item.
**Request Fields:** **Request Fields:**
@ -1065,6 +1169,8 @@ _No additional response items._
### GetStreamingStatus ### GetStreamingStatus
- Added in v0.3
Get current streaming and recording status. Get current streaming and recording status.
**Request Fields:** **Request Fields:**
@ -1086,6 +1192,8 @@ _No specified parameters._
### StartStopStreaming ### StartStopStreaming
- Added in v0.3
Toggle streaming on or off. Toggle streaming on or off.
**Request Fields:** **Request Fields:**
@ -1100,6 +1208,8 @@ _No additional response items._
### StartStreaming ### StartStreaming
- Added in v4.1.0
Start streaming. Start streaming.
Will return an `error` if streaming is already active. Will return an `error` if streaming is already active.
@ -1126,6 +1236,8 @@ _No additional response items._
### StopStreaming ### StopStreaming
- Added in v4.1.0
Stop streaming. Stop streaming.
Will return an `error` if streaming is not active. Will return an `error` if streaming is not active.
@ -1143,6 +1255,8 @@ _No additional response items._
### StartStopRecording ### StartStopRecording
- Added in v0.3
Toggle recording on or off. Toggle recording on or off.
**Request Fields:** **Request Fields:**
@ -1157,6 +1271,8 @@ _No additional response items._
### StartRecording ### StartRecording
- Added in v4.1.0
Start recording. Start recording.
Will return an `error` if recording is already active. Will return an `error` if recording is already active.
@ -1172,6 +1288,8 @@ _No additional response items._
### StopRecording ### StopRecording
- Added in v4.1.0
Stop recording. Stop recording.
Will return an `error` if recording is not active. Will return an `error` if recording is not active.
@ -1187,6 +1305,8 @@ _No additional response items._
### SetRecordingFolder ### SetRecordingFolder
- Added in v4.1.0
Change the current recording folder. Change the current recording folder.
**Request Fields:** **Request Fields:**
@ -1204,6 +1324,8 @@ _No additional response items._
### GetRecordingFolder ### GetRecordingFolder
- Added in v4.1.0
Get the path of the current recording folder. Get the path of the current recording folder.
**Request Fields:** **Request Fields:**
@ -1223,6 +1345,8 @@ _No specified parameters._
### StartStopReplayBuffer ### StartStopReplayBuffer
- Unreleased
Toggle the Replay Buffer on/off. Toggle the Replay Buffer on/off.
**Request Fields:** **Request Fields:**
@ -1237,6 +1361,8 @@ _No additional response items._
### StartReplayBuffer ### StartReplayBuffer
- Unreleased
Start recording into the Replay Buffer. Start recording into the Replay Buffer.
Will return an `error` if the Replay Buffer is already active or if the Will return an `error` if the Replay Buffer is already active or if the
"Save Replay Buffer" hotkey is not set in OBS' settings. "Save Replay Buffer" hotkey is not set in OBS' settings.
@ -1255,6 +1381,8 @@ _No additional response items._
### StopReplayBuffer ### StopReplayBuffer
- Unreleased
Stop recording into the Replay Buffer. Stop recording into the Replay Buffer.
Will return an `error` if the Replay Buffer is not active. Will return an `error` if the Replay Buffer is not active.
@ -1270,6 +1398,8 @@ _No additional response items._
### SaveReplayBuffer ### SaveReplayBuffer
- Unreleased
Save and flush the contents of the Replay Buffer to disk. This is Save and flush the contents of the Replay Buffer to disk. This is
basically the same as triggering the "Save Replay Buffer" hotkey. basically the same as triggering the "Save Replay Buffer" hotkey.
Will return an `error` if the Replay Buffer is not active. Will return an `error` if the Replay Buffer is not active.
@ -1288,6 +1418,8 @@ _No additional response items._
### GetTransitionList ### GetTransitionList
- Added in v4.1.0
List of all transitions available in the frontend's dropdown menu. List of all transitions available in the frontend's dropdown menu.
**Request Fields:** **Request Fields:**
@ -1307,6 +1439,8 @@ _No specified parameters._
### GetCurrentTransition ### GetCurrentTransition
- Added in v0.3
Get the name of the currently selected transition in the frontend's dropdown menu. Get the name of the currently selected transition in the frontend's dropdown menu.
**Request Fields:** **Request Fields:**
@ -1325,6 +1459,8 @@ _No specified parameters._
### SetCurrentTransition ### SetCurrentTransition
- Added in v0.3
Set the active transition. Set the active transition.
**Request Fields:** **Request Fields:**
@ -1342,6 +1478,8 @@ _No additional response items._
### SetTransitionDuration ### SetTransitionDuration
- Added in v4.0.0
Set the duration of the currently selected transition if supported. Set the duration of the currently selected transition if supported.
**Request Fields:** **Request Fields:**
@ -1359,6 +1497,8 @@ _No additional response items._
### GetTransitionDuration ### GetTransitionDuration
- Added in v4.1.0
Get the duration of the currently selected transition if supported. Get the duration of the currently selected transition if supported.
**Request Fields:** **Request Fields:**
@ -1378,6 +1518,8 @@ _No specified parameters._
### SetCurrentSceneCollection ### SetCurrentSceneCollection
- Added in v4.0.0
Change the active scene collection. Change the active scene collection.
**Request Fields:** **Request Fields:**
@ -1395,6 +1537,8 @@ _No additional response items._
### GetCurrentSceneCollection ### GetCurrentSceneCollection
- Added in v4.0.0
Get the name of the current scene collection. Get the name of the current scene collection.
**Request Fields:** **Request Fields:**
@ -1414,6 +1558,8 @@ _No specified parameters._
### SetCurrentProfile ### SetCurrentProfile
- Added in v4.0.0
Set the currently active profile. Set the currently active profile.
**Request Fields:** **Request Fields:**
@ -1431,6 +1577,8 @@ _No additional response items._
### GetCurrentProfile ### GetCurrentProfile
- Added in v4.0.0
Get the name of the current profile. Get the name of the current profile.
**Request Fields:** **Request Fields:**
@ -1448,6 +1596,8 @@ _No specified parameters._
### ListProfiles ### ListProfiles
- Added in v4.0.0
Get a list of available profiles. Get a list of available profiles.
**Request Fields:** **Request Fields:**
@ -1467,6 +1617,8 @@ _No specified parameters._
### SetStreamingSettings ### SetStreamingSettings
- Added in v4.1.0
Sets one or more attributes of the current streaming server settings. Any options not passed will remain unchanged. Returns the updated settings in response. If 'type' is different than the current streaming service type, all settings are required. Returns the full settings of the stream (the same as GetStreamSettings). Sets one or more attributes of the current streaming server settings. Any options not passed will remain unchanged. Returns the updated settings in response. If 'type' is different than the current streaming service type, all settings are required. Returns the full settings of the stream (the same as GetStreamSettings).
**Request Fields:** **Request Fields:**
@ -1491,6 +1643,8 @@ _No additional response items._
### GetStreamSettings ### GetStreamSettings
- Added in v4.1.0
Get the current streaming server settings. Get the current streaming server settings.
**Request Fields:** **Request Fields:**
@ -1514,6 +1668,8 @@ _No specified parameters._
### SaveStreamSettings ### SaveStreamSettings
- Added in v4.1.0
Save the current streaming server settings to disk. Save the current streaming server settings to disk.
**Request Fields:** **Request Fields:**
@ -1530,6 +1686,8 @@ _No additional response items._
### GetStudioModeStatus ### GetStudioModeStatus
- Added in v4.1.0
Indicates if Studio Mode is currently enabled. Indicates if Studio Mode is currently enabled.
**Request Fields:** **Request Fields:**
@ -1547,6 +1705,8 @@ _No specified parameters._
### GetPreviewScene ### GetPreviewScene
- Added in v4.1.0
Get the name of the currently previewed scene and its list of sources. Get the name of the currently previewed scene and its list of sources.
Will return an `error` if Studio Mode is not enabled. Will return an `error` if Studio Mode is not enabled.
@ -1566,6 +1726,8 @@ _No specified parameters._
### SetPreviewScene ### SetPreviewScene
- Added in v4.1.0
Set the active preview scene. Set the active preview scene.
Will return an `error` if Studio Mode is not enabled. Will return an `error` if Studio Mode is not enabled.
@ -1584,6 +1746,8 @@ _No additional response items._
### TransitionToProgram ### TransitionToProgram
- Added in v4.1.0
Transitions the currently previewed scene to the main output. Transitions the currently previewed scene to the main output.
Will return an `error` if Studio Mode is not enabled. Will return an `error` if Studio Mode is not enabled.
@ -1604,6 +1768,8 @@ _No additional response items._
### EnableStudioMode ### EnableStudioMode
- Added in v4.1.0
Enables Studio Mode. Enables Studio Mode.
**Request Fields:** **Request Fields:**
@ -1618,6 +1784,8 @@ _No additional response items._
### DisableStudioMode ### DisableStudioMode
- Added in v4.1.0
Disables Studio Mode. Disables Studio Mode.
**Request Fields:** **Request Fields:**
@ -1632,6 +1800,8 @@ _No additional response items._
### ToggleStudioMode ### ToggleStudioMode
- Added in v4.1.0
Toggles Studio Mode. Toggles Studio Mode.
**Request Fields:** **Request Fields:**
@ -1646,6 +1816,8 @@ _No additional response items._
### GetSpecialSources ### GetSpecialSources
- Added in v4.1.0
Get configured special sources like Desktop Audio and Mic/Aux sources. Get configured special sources like Desktop Audio and Mic/Aux sources.
**Request Fields:** **Request Fields:**

12
docs/protocol.hbs
View File

@ -15,6 +15,12 @@
{{#each this}} {{#each this}}
### {{name}} ### {{name}}
{{#eq since "unreleased"}}
- Unreleased
{{else}}
- Added in v{{since}}
{{/eq}}
{{{description}}} {{{description}}}
**Response Items:** **Response Items:**
@ -45,6 +51,12 @@ _No additional response items._
{{#each this}} {{#each this}}
### {{name}} ### {{name}}
{{#eq since "unreleased"}}
- Unreleased
{{else}}
- Added in v{{since}}
{{/eq}}
{{{description}}} {{{description}}}
**Request Fields:** **Request Fields:**