CreateScene: invalid request type

[BarryCarlyon]

Issue type

• Bug report

Description

CreateScene is documented in PROTOCOL as since v4.8.0
It's not in the change log for 4.8.0
Upon attempting to call it I get a invalid request type error

Steps to reproduce and other useful info

• Create a browser source
• Implement OBS Websocket JS (in this case v4.0.0 and v4.0.1)
• Attempt to call CreateScene
• Recieve Error

Example JS code

var obs = new OBSWebSocket();

obs.connect({
    address: '127.0.0.1:4444',
    password: 'someExamplePassword'
})
.then(() => {
    obs.send('CreateScene', {sceneName: 'Barry'}).then(resp => {console.log(resp)}).catch(err => {console.error(err)});
});

Alternatively, call GetVersion and receive a response which doesn't list CreateScene as available.

Technical information

• Operating System : Windows 10
• OBS Studio version : 25.0.4 and 25.0.8 tested
• obs-websocket version : 4.8.0

Response to GetVersion:

{"available-requests":"AddFilterToSource,Authenticate,BroadcastCustomMessage,DeleteSceneItem,DisableStudioMode,DuplicateSceneItem,EnableStudioMode,GetAudioMonitorType,GetAuthRequired,GetBrowserSourceProperties,GetCurrentProfile,GetCurrentScene,GetCurrentSceneCollection,GetCurrentTransition,GetFilenameFormatting,GetMute,GetOutputInfo,GetPreviewScene,GetRecordingFolder,GetSceneItemProperties,GetSceneList,GetSceneTransitionOverride,GetSourceFilterInfo,GetSourceFilters,GetSourceSettings,GetSourcesList,GetSourceTypesList,GetSpecialSources,GetStats,GetStreamingStatus,GetStreamSettings,GetStudioModeStatus,GetSyncOffset,GetTextFreetype2Properties,GetTextGDIPlusProperties,GetTransitionDuration,GetTransitionList,GetTransitionPosition,GetVersion,GetVideoInfo,GetVolume,ListOutputs,ListProfiles,ListSceneCollections,MoveSourceFilter,OpenProjector,PauseRecording,RemoveFilterFromSource,RemoveSceneTransitionOverride,ReorderSceneItems,ReorderSourceFilter,ResetSceneItem,ResumeRecording,SaveReplayBuffer,SaveStreamSettings,SendCaptions,SetAudioMonitorType,SetBrowserSourceProperties,SetCurrentProfile,SetCurrentScene,SetCurrentSceneCollection,SetCurrentTransition,SetFilenameFormatting,SetHeartbeat,SetMute,SetPreviewScene,SetRecordingFolder,SetSceneItemCrop,SetSceneItemPosition,SetSceneItemProperties,SetSceneItemRender,SetSceneItemTransform,SetSceneTransitionOverride,SetSourceFilterSettings,SetSourceFilterVisibility,SetSourceName,SetSourceRender,SetSourceSettings,SetStreamSettings,SetSyncOffset,SetTextFreetype2Properties,SetTextGDIPlusProperties,SetTransitionDuration,SetVolume,StartOutput,StartRecording,StartReplayBuffer,StartStopRecording,StartStopReplayBuffer,StartStopStreaming,StartStreaming,StopOutput,StopRecording,StopReplayBuffer,StopStreaming,TakeSourceScreenshot,ToggleMute,ToggleStudioMode,TransitionToProgram","message-id":"5","obs-studio-version":"25.0.4","obs-websocket-version":"4.8.0","status":"ok","supported-image-export-formats":"bmp,jpeg,jpg,pbm,pgm,png,ppm,xbm,xpm","version":1.1,"availableRequests":"AddFilterToSource,Authenticate,BroadcastCustomMessage,DeleteSceneItem,DisableStudioMode,DuplicateSceneItem,EnableStudioMode,GetAudioMonitorType,GetAuthRequired,GetBrowserSourceProperties,GetCurrentProfile,GetCurrentScene,GetCurrentSceneCollection,GetCurrentTransition,GetFilenameFormatting,GetMute,GetOutputInfo,GetPreviewScene,GetRecordingFolder,GetSceneItemProperties,GetSceneList,GetSceneTransitionOverride,GetSourceFilterInfo,GetSourceFilters,GetSourceSettings,GetSourcesList,GetSourceTypesList,GetSpecialSources,GetStats,GetStreamingStatus,GetStreamSettings,GetStudioModeStatus,GetSyncOffset,GetTextFreetype2Properties,GetTextGDIPlusProperties,GetTransitionDuration,GetTransitionList,GetTransitionPosition,GetVersion,GetVideoInfo,GetVolume,ListOutputs,ListProfiles,ListSceneCollections,MoveSourceFilter,OpenProjector,PauseRecording,RemoveFilterFromSource,RemoveSceneTransitionOverride,ReorderSceneItems,ReorderSourceFilter,ResetSceneItem,ResumeRecording,SaveReplayBuffer,SaveStreamSettings,SendCaptions,SetAudioMonitorType,SetBrowserSourceProperties,SetCurrentProfile,SetCurrentScene,SetCurrentSceneCollection,SetCurrentTransition,SetFilenameFormatting,SetHeartbeat,SetMute,SetPreviewScene,SetRecordingFolder,SetSceneItemCrop,SetSceneItemPosition,SetSceneItemProperties,SetSceneItemRender,SetSceneItemTransform,SetSceneTransitionOverride,SetSourceFilterSettings,SetSourceFilterVisibility,SetSourceName,SetSourceRender,SetSourceSettings,SetStreamSettings,SetSyncOffset,SetTextFreetype2Properties,SetTextGDIPlusProperties,SetTransitionDuration,SetVolume,StartOutput,StartRecording,StartReplayBuffer,StartStopRecording,StartStopReplayBuffer,StartStopStreaming,StartStreaming,StopOutput,StopRecording,StopReplayBuffer,StopStreaming,TakeSourceScreenshot,ToggleMute,ToggleStudioMode,TransitionToProgram","messageId":"5","obsStudioVersion":"25.0.4","obsWebsocketVersion":"4.8.0","supportedImageExportFormats":"bmp,jpeg,jpg,pbm,pgm,png,ppm,xbm,xpm"}

[tt2468]

CreateScene is currently unreleased and not in v4.8.0. You need to use our nightly build: https://dev.azure.com/Palakis/obs-websocket/_build/results?buildId=1340&view=artifacts&type=publishedArtifacts

[BarryCarlyon]

Gotcha.

Some of the new stuff is tagged as "not in yet" but this was, hence the confusion!

Ta!

[tt2468]

I believe they are tagged as v4.9.0 but yeah

[ruanorz]

CreateScene is currently unreleased and not in v4.8.0. You need to use our nightly build: https://dev.azure.com/Palakis/obs-websocket/_build/results?buildId=1340&view=artifacts&type=publishedArtifacts

I have downloaded this version and "CreateScene" appear in the list of 'available-requests' when i do the GetVersion request, but it still saying to me "module 'obswebsocket.requests' has no attribute 'CreateScene'"

any idea? Thank you!

[tt2468]

Because obs-websocket-py needs manual updates for new requests, and is therefore outdated.