Revision History¶
| Release Date | OBS.Live Build | API Version | Comments |
|---|---|---|---|
| 2018-07-30 | 18.7.25.133 | 1.0 | Initial revision |
| 2018-08-02 | 18.8.2.151 | 1.1 | Document Status switch to WORK IN PROGRESS Add API methods: getSystemCPUUsageTimes getSystemMemoryUsage getSystemHardwareProperties |
| 2018-08-12 | 18.8.12.165 | 1.2 | Add API methods: getAvailableInputSourceTypes Add host events: hostUIThemeChanged |
| 2018-08-22 | 18.8.22.185 | 1.3 | Add API methods: getAllHotkeyBindings getAllManagedHotkeyBindings addHotkeyBinding removeHotkeyBindingById Add host events: hostHotkeyPressed hostHotkeyReleased hostContainerKeyCombinationPressed hostContainerKeyCombinationReleased |
| 2018-08-23 | 18.8.23.188 | 1.4 | Add API methods: getHostProperties Add host events: hostHotkeyBindingsChanged |
| 2018-09-15 | 18.9.15.205 | 1.5 | Extend getHostProperties response object (HostInfo) with: hostMachineUniqueId hostSessionUniqueId |
| 2018-09-25 | 18.9.25.211 | 1.6 | Add API methods: adviseSignedIn adviseSignedOut |
| 2018-10-07 | 18.10.11.235 | 1.7 | Extend showModalDialog properties object (ModalDialogInfo) with: incognitoMode = true/false (default false) |
| 2018-11-11 | 18.11.11.293 | 1.8 | Add API methods: toggleDockingWidgetFloatingById setDockingWidgetDimensionsById setDockingWidgetPositionById broadcastMessage getHostCapabilities getAllSceneCollections getCurrentSceneCollectionProperties addSceneCollection setCurrentSceneCollectionById Add host events: hostMessageReceived Add data structures: HostCapabilities DimensionsInfo PositionInfo MessageBusMessageInfo |
| 2018-12-22 | 18.12.22.297 | 1.9 | Add API methods: broadcastEvent Add host events: hostEventReceived Add data structures: EventInfo |
| 2019-01-06 | 19.1.6.301 | 1.10 | Add API methods: addCurrentSceneItemBrowserSource getAllCurrentSceneItems |
| 2019-01-24 | 19.1.23.315 | 1.11 | Add API methods: setHostReleaseGroupProperties getHostReleaseGroupProperties queryHostReleaseGroupUpdateAvailability Add Data Structures: ReleaseGroupInfo Change the way non-logged-in users identity string is built to ensure it’s unique across computers with the same SMBIOS UUID. |
| 2019-01-28 | 19.1.28.319 | 1.12 | Add host properties: window.host.hostContainerHidden Add host events: hostContainerVisibilityChanged |
| 2019-02-10 | 19.2.10.323 | 1.13 | Add API methods: setContainerForeignPopupWindowsProperties getContainerForeignPopupWindowsProperties Add Data Structures: ForeignPopupWindowsInfo |
| 2019-02-26 | 19.2.26.339 | 1.14 | Change Data Structures: ContainerInfo: add `dockingArea` property, remove `area` property Add events: hostResetState |
| 2019-04-16 | 19.4.16.377 | 1.15 | Add API methods: getExternalSceneDataProviders getExternalSceneDataSceneCollections getExternalSceneDataSceneCollectionContent Add Data Structures: ExternalSceneDataProviderInfo ExternalSceneDataSceneCollectionInfo ExternalSceneDataSceneCollectionContent |
| 2019-04-21 | 19.4.21.384 | 1.16 | Add API methods: httpRequestText Add Data Structures: HTTPRequestInfo HTTPResponseInfo |
| 2019-05-29 | 19.5.29.398 | 1.17 | Add API methods: getStreamingStatus Add Data Structures: StreamingStatusInfo |
| 2019-06-26 | 19.6.26.414 | 1.18 | Add Events: hostStreamingStartRequested Add API methods: requestStreamingStart requestStreamingStop setStreamingStartUIHandlerProperties adviseStreamingStartUIRequestAccepted adviseStreamingStartUIRequestRejected Add Data Structures: StreamingStartUIHandlerProperties |
| 2019-07-14 | 19.7.14.421 | 1.19 | Add API methods: getEncodingSettings |
| 2019-09-15 | 19.9.11.461 | 1.20 | Add Events: hostUserInterfaceStateChanged Add API methods: getUserInterfaceState setUserInterfaceState |
| 2019-11-07 | 19.11.6.514 | 1.21 | obs-browser: API 1.21: scene/source API Add API methods: getAllScenes getCurrentScene addScene setCurrentSceneById removeScenesByIds setScenePropertiesById addCurrentSceneItemGameCaptureSource addCurrentSceneItemVideoCaptureSource addCurrentSceneItemObsNativeSource getAllCurrentSceneItems removeCurrentSceneItemsByIds setCurrentSceneItemPropertiesById getAvailableInputSourceClasses getSourceClassProperties addCurrentSceneItemGroup ungroupCurrentSceneItemGroupById Add Events: hostSceneListChanged hostActiveSceneItemListChanged Change Data Structures: SceneItemInfo - add alignment and bounding box info to 'composition' - add support for 'group' scene items - add support for 'scene' scene items - add 'preferExistingSourceReference' property - add 'visible' property (get/set) - add 'parentId' property indicating parent group - add 'order' property to get/set item order - add 'selected' property (get/set) - add 'locked' property (get/set) Add Data Structures: ObsPropertyInfo |
| 2019-12-16 | 19.12.16.531 | 1.22 | Add API Methods: setAuxiliaryMenuItems getAuxiliaryMenuItems getAllProfiles getCurrentProfile setCurrentProfile getAllSceneCollections getCurrentSceneCollectionProperties addSceneCollection setCurrentSceneCollectionById createUserEnvironmentBackupPackage queryUserEnvironmentBackupPackageContent restoreUserEnvironmentBackupPackageContent Add Data Structures: MenuItemInfo ProfileInfo BackupRequestInfo BackupContentInfo |
| 2020-01-07 | 20.1.7.540 | 1.23 | Add API Methods: setDockingWidgetUrlById showDockingWidgetById hideDockingWidgetById Add Events: hostActiveSceneItemAdded hostActiveSceneItemRemoved hostActiveSceneItemTransformed hostActiveSceneItemsOrderChanged hostActiveSceneItemSelected hostActiveSceneItemUnselected hostActiveSceneItemPropertiesChanged hostActiveSceneItemSettingsChanged hostActiveSceneItemRenamed hostVideoPreviewMouseDoubleClicked hostCurrentSceneItemsListMouseDoubleClicked * hostBeforeFocusChange |
| 2020-01-29 | 20.1.29.545 | 1.24 | Add API Methods: invokeCurrentSceneItemDefaultActionById invokeCurrentSceneItemDefaultContextMenuById setCurrentSceneItemsAuxiliaryActions getCurrentSceneItemsAuxiliaryActions setScenesAuxiliaryActions getScenesAuxiliaryActions Add Data Structures: ActionInfo IconInfo Add Properties: SceneItemInfo.actions SceneItemInfo.defaultAction SceneItemInfo.contextMenu SceneItemInfo.icon SceneItemInfo.auxiliaryData SceneInfo.icon SceneInfo.defaultAction SceneInfo.contextMenu SceneInfo.auxiliaryData MenuItemInfo.icon |
| 2020-02-03 | 20.2.3.551 | 1.25 | Add Events: hostSceneItemAdded hostSceneItemListChanged hostSceneItemOrderChanged hostSceneItemPropertiesChanged hostSceneItemRemoved hostSceneItemRenamed hostSceneItemSelected hostSceneItemSettingsChanged hostSceneItemTransformed hostSceneItemUnselected |
| 2020-02-14 | 20.2.14.563 | 1.26 | Add API Methods: getAllSceneItems removeSceneItemsByIds setSceneItemPropertiesById ungroupSceneItemGroupById addSceneItemBrowserSource addSceneItemGameCaptureSource addSceneItemVideoCaptureSource addSceneItemObsNativeSource addSceneItemGroup Add Properties: SceneInfo.active * SceneItemInfo.sceneId |
| 2020-02-17 | 20.2.17.565 | 1.27 | Add Properties: * BackgroundWorkerInfo.executeJavaScriptOnLoad |
| 2020-02-20 | 20.2.20.567 | 1.28 | Add API Methods: * reloadAllBrowserSources |
| 2020-03-05 | 20.3.5.585 | 1.29 | Modify API Methods: queryHostReleaseGroupUpdateAvailability Add Data Structures: QuerySoftwareUpdateArgs |
| 2020-03-06 | 20.3.6.601 | 1.30 | Add Properties: * MenuItemInfo.enabled |
| 2020-03-16 | 20.3.16.609 | 1.31 | Add Properties: * DockingWidgetInfo.reloadPolicy |
| 2020-04-23 | 20.4.23.625 | 1.32 | Add Events: hostSceneCollectionChanged hostSceneCollectionListChanged hostProfileChanged hostProfileListChanged Add Properties: SceneItemInfo.uiSettings.enabled SceneItemInfo.uiSettings.opacity SceneItemInfo.uiSettings.multipleItemsContextMenuEnabled ActionInfo.color Add Property Values: * ActionInfo.invoke = ":none" |
| 2020-05-01 | 20.5.1.627 | 1.33 | Add API Methods: beginDeferSaveTransaction completeDeferSaveTransaction |
| 2020-05-03 | 20.5.3.629 | 1.34 | Add API Methods: getAllCookies Add Data Structures: CookieFilterInfo * CookieInfo |
| 2020-06-18 | 20.6.18.631 | 1.35 | Add API methods: batchInvokeSeries Add Data Structures: InvokeInfo |
| 2020-06-24 | Windows: 20.6.24.633 Mac: 20.12.7.56 |
1.36 | Add API methods: dispatchKeyboardEvent dispatchMouseEvent Add Data Structures: KeyboardEventInfo MouseEventInfo |
| 2020-12-17 | Windows: 20.12.17.682 Mac: 20.12.17.65 |
1.37 | Add API methods: addBrowserScopedHttpServer getAllBrowserScopedHttpServers removeBrowserScopedHttpServersByIds sendHttpRequestResponse Add Data Structures: GenericNetworkServiceInfo Add Properties: HTTPRequestInfo.query HTTPRequestInfo.id HTTPResponseInfo.headers |
| 2021-01-17 | Windows: 21.1.17.688 Mac: 21.1.17.71 |
1.38 | Add API methods: setShowBuiltInMenuItems getShowBuildInMenuItems Add Properties: * MenuItemInfo.itemsSource |
| 2021-02-15 | Windows: 21.2.15.719 Mac: 21.2.10.111 |
2.0 | Remove Properties: * BackgroundWorkerInfo.content |
| 2021-03-10 | Windows: 21.3.8.729 Mac: 21.3.10.133 |
2.1 | Add API methods: showOutputPreviewTitleBar hideOutputPreviewTitleBar showOutputPreviewFrame hideOutputPreviewFrame Add Data Structures: * FrameInfo |
| 2021-06-10 | Windows: 21.6.8.742 Mac: 21.6.8.147 |
2.2 | Add API methods: queryUserEnvironmentBackupReferencedFiles Add Data Structures: BackupReferencedFileInfo Add Properties: * SceneCollectionInfo.referencedFiles |
| 2021-11-17 | Windows: 21.11.17.788 Mac: 21.11.17.195 |
2.3 | Add API Methods: getNativeStreamingServiceIntegrationStatus Add Events: hostNativeManageBroadcastButtonVisible hostNativeManageBroadcastButtonHidden hostNativeManageBroadcastButtonVisible * hostNativeManageBroadcastButtonHidden |
| 2022-06-21 | Windows: 22.6.21.28 |
3.0 | Remove API Methods: getAllCookies setContainerForeignPopupWindowsProperties getContainerForeignPopupWindowsProperties dispatchKeyboardEvent dispatchMouseEvent reloadAllBrowserSources Remove Data Structures: * ForeignPopupWindowsInfo |
| 2023-11-21 | Windows: 23.11.21.88 |
3.1 | Add API Methods: groupDockingWidgetsPairByIds insertDockingWidgetBeforeId * insertDockingWidgetAfterId |
| 2023-11-24 | Windows: 23.11.24.92 |
3.2 | Add API Methods: showNonModalDialog endNonModalDialog * endDialog |
| 2023-11-29 | Windows: 23.11.29.94 |
3.3 | Modify Data Structures: DialogInfo Add API Methods: getAllNonModalDialogs closeNonModalDialogsByIds focusNonModalDialogById * setNonModalDialogDimensionsById |
| 2023-12-08 | Windows: 23.12.8.95 |
3.3 | Modify Data Structures: * ContainerInfo |
| 2024-05-27 | Windows: 24.5.27.105 |
4.0 | Modify Data Structures: SceneInfo Remove SceneInfo.icon Remove SceneInfo.defaultAction Remove SceneInfo.contextMenu SceneItemInfo Remove SceneItemInfo.icon Remove SceneItemInfo.defaultAction Remove SceneItemInfo.contextMenu Remove SceneItemInfo.actions Remove SceneItemInfo.uiSettings Remove API Methods: showOutputPreviewTitleBar hideOutputPreviewTitleBar showOutputPreviewFrame hideOutputPreviewFrame |
| 2024-07-08 | Windows: 24.7.8.137 |
5.0 | Add Data Structures: OutputInfo ScopedStorageItemInfo Add API Methods: addStreamingOutput removeStreamingOutputsByIds enableStreamingOutputsByIds disableStreamingOutputsByIds writeScopedStorageJsonItem readScopedStorageJsonItem removeScopedStorageJsonItem getAllScopedStorageJsonItems Add Events: hostStreamingOutputListChanged hostStreamingOutputStarted hostStreamingOutputError hostStreamingOutputStopped hostStreamingOutputPaused hostStreamingOutputUnpaused hostStreamingOutputStarting hostStreamingOutputStopping hostStreamingOutputActivated hostStreamingOutputDeactivated hostStreamingOutputReconnecting hostStreamingOutputReconnected |
| 2024-08-26 | Windows: 24.8.26.151 |
6.0 | Document Status switch to WORK IN PROGRESS Add API Methods: getAllAvailableVideoEncoderClasses getAllAvailableAudioEncoderClasses getAllVideoCompositions removeVideoCompositionsByIds addVideoComposition setVideoCompositionViewOverlayProperties removeVideoCompositionViewOverlay openSceneItemPropertiesDialogById openSceneItemFiltersDialogById openSceneItemInteractionDialogById openSceneItemTransformEditorDialogById takeScreenshot getAvailableTransitionClasses getVideoCompositionTransition setVideoCompositionTransition Add Data Structures: VideoCompositionInfo ObsEncoderInfo VideoCompositionViewOverlayInfo TransitionInfo Modify Data Structures: SceneInfo |
| 2024-09-03 | Windows: 24.9.3.167 |
6.0 | Support for Local Recording Outputs Add API Methods: getAllRecordingOutputs addRecordingOutput removeRecordingOutputsByIds enableRecordingOutputsByIds disableRecordingOutputsByIds triggerRecordingOutputSplitById Add Events: hostRecordingOutputListChanged hostRecordingOutputStarted hostRecordingOutputError hostRecordingOutputStopped hostRecordingOutputPaused hostRecordingOutputUnpaused hostRecordingOutputStarting hostRecordingOutputStopping hostRecordingOutputActivated hostRecordingOutputDeactivated hostRecordingOutputReconnecting Modify Data Structures VideoCompositionInfo (add `recordingVideoEncoders`) OutputInfo (add `type`, `recordingSettings`, `isObsNativeOutput`) Add Data Structures RecordingSettings |
| 2024-09-16 | Windows: 24.9.16.180 |
6.0 | Add support for adding specific sources by reference Add API Methods getAllExistingVideoInputSources Modify Data Structures InputSourceTypeInfo (add `class`, `className`, `settings`, `defaultSettings`, `properties`, modify `id`) * SceneItemInfo (add `existingSourceId`) |
| 2024-09-16 | Windows: 24.9.16.182 |
6.0 | Add support for tracking scene renames Add Events hostSceneRenamed hostActiveSceneRenamed |
| 2024-09-17 | Windows 24.9.17.184 |
6.0 | Hydrate SceneItemInfo with video composition info Modify Data Structures * SceneItemInfo (add `videoCompositionId` and `sceneId` on enum and events) |
| 2024-09-17 | Windows: 24.9.17.186 |
6.0 | Add support for native pop-up menus Add API Methods * showPopupMenuAtMousePointerPosition |
| 2024-09-27 | Windows: 24.9.27.187 |
6.0 | Support changing docks titles and video composition names Add API Methods: setDockingWidgetTitleById setVideoCompositionProperties Add Events: hostVideoCompositionChanged hostVideoCompositionListChanged |
| 2024-10-09 | Windows: 24.10.9.198 |
6.0 | Add support for Audio compositions and track selection Add API Methods: getAllAudioCompositions removeAudioCompositionsByIds addAudioComposition setAudioCompositionProperties Add Data Structures: AudioCompositionInfo Modify Data Structures: OutputInfo (add `audioCompositionId`, `isObsNativeAudioComposition`, `audioTracks`) Add Events: hostAudioCompositionListChanged hostAudioCompositionChanged |
| 2024-10-17 | Windows: 24.10.17.218 |
6.0 | Support retrieving OBS encoder properties from EncoderInfo Add API Methods: * getEncoderProperties |
| 2024-11-19 | Windows: 24.11.19.255 |
6.0 | Support saving/restoring video composition state on scene collection change Add Events: hostVideoCompositionBeforeScenesReset hostVideoCompositionAfterScenesReset |
| 2024-11-27 | Windows: 24.11.27.266 |
6.0 | Add support for identifying deprecated sources Modify Data Structures: * InputSourceTypeInfo (add `unversionedClass`, `isDeprecated`) |
| 6.0 | Add support for resizable dialogs Modify Data Structures: * DialogInfo (add `isResizable`) |
||
| Windows: 24.12.13.298 |
6.0 | API support for querying for Video, Audio and All input sources Add API Methods: getAllExistingAudioInputSources getAllExistingInputSources getAvailableVideoInputSourceTypes getAvailableAudioInputSourceTypes |
|
| Windows: 24.12.16.303 |
6.0 | API: Support rotation around center and positioning of scene items in viewport Add API Methods: getSceneItemRotationInViewport setSceneItemRotationInViewport getSceneItemBoundingBoxInViewport setSceneItemPositionInViewport Add Data Structures: ViewportSceneItemRotationInfo ViewportSceneItemGeometryInfo |
|
| Windows: 24.12.18.306 |
6.0 | API support for source filters Add API Methods: getAvailableFilterSourceTypes getAvailableAudioFilterSourceTypes getAvailableVideoFilterSourceTypes Modify Data Structures: SceneItemInfo (add `filters`) * InputSourceTypeInfo (add `filters`, `isFilterSource`, `isInputSource`, `isTransitionSource`, `isSceneSource`, `order`) |
|
| 6.0 | API: Selective source `properties` retrieval Add API Methods: - getSceneItemPropertiesById - getCurrentSceneItemPropertiesById |
||
| 2024-12-20 | Windows: 24.12.20.320 |
6.0 | API: Source and filter properties Add API Methods: - getInputSourceProperties - getFilterSourceProperties |
| 6.1 | API 6.1: Added event at the beginning of scene change sequence Add Events: - hostActiveSceneChanging |
||
| 2025-01-22 | Windows: 25.1.22.347 |
6.1 | API 6.1: Replay buffer support Add API Methods: - getAllReplayBufferOutputs - addReplayBufferOutput - removeReplayBufferOutputsByIds - enableReplayBufferOutputsByIds - disableReplayBufferOutputsByIds - triggerReplayBufferOutputSaveById Add Events: - hostReplayBufferOutputListChanged - hostReplayBufferOutputStarted - hostReplayBufferOutputError - hostReplayBufferOutputStopped - hostReplayBufferOutputPaused - hostReplayBufferOutputUnpaused - hostReplayBufferOutputStarting - hostReplayBufferOutputStopping - hostReplayBufferOutputActivated - hostReplayBufferOutputDeactivated - hostReplayBufferOutputReconnecting - hostReplayBufferOutputReconnected - hostReplayBufferOutputSavedToLocalFile |
| 2025-02-25 | Windows: 25.2.25.425 |
6.2 | API 6.2: Support multiple encoders per canvas and output Modify Data Structures: - OutputInfo (add `videoEncoders` field) - VideoCompositionInfo (add `view` field, support multiple video encoders) |
| 2025-02-26 | Windows: 25.2.26.428 |
6.2 | API 6.2: Add encoder deprecation information and hide internal encoders Modify Data Structures: - EncoderInfo (add `isDeprecated` field) - ObsEncoderInfo (add `isDeprecated` field) |
| 2025-03-05 | Windows: 25.3.5.435 |
6.3 | API 6.3: Support dynamic encoder property sheets Add API Methods: - getAvailableAudioEncoderClassProperties - getAvailableVideoEncoderClassProperties Modify Data Structures: - ObsEncoderInfo (add `type` field) |
| 2025-03-06 | Windows: 25.3.6.438 |
6.4 | API 6.4: Support output video encoders override Modify Data Structures: - ObsEncoderInfo (add `audioMix` field to audio encoders) - OutputInfo (`videoEncoders` array accepts ObsEncoderInfo in addition to VideoComposition encoder index) |
| 6.5 | API 6.5: Support for transition properties dialog Add API Methods: - showVideoCompositionTransitionPropertiesDialog Add Events: - hostActiveTransitionChanged Change Behavior: - Custom video compositions will fire hostActiveSceneChanging event in custom video compositions and hostActiveSceneChanged only when transition has stopped. |
||
| 6.5 | API 6.5: Support for setting hotkey triggers for any hotkey Add API Methods: - setHotkeyBindingTriggers |
||
| 2025-04-07 | Windows: 25.4.5.467 |
6.5 | API 6.5: Support for detecting loaded OBS modules Add API Methods: - getAllLoadedHostModules - openFileLocationInHostFileManager Add Data Structures: - LoadedHostModuleInfo |
| 2025-09-29 | Windows: 25.9.29.509 MacOS: 25.9.29.509 |
6.6 | API 6.6: Shared video compositions support Add API Methods - addSharedVideoComposition - removeSharedVideoCompositionsByIds - getAllSharedVideoCompositions - connectVideoCompositionToSharedVideoComposition - disconnectVideoCompositionsFromSharedVideoCompositionsByIds Add Events - hostSharedVideoCompositionListChanged Add Data Objects - SharedVideoCompositionInfo |
| 2025-10-07 | 25.10.7.513 | 6.6 | API 6.6: Shared video compositions API tweaks Add API Methods: - setSharedVideoCompositionProperties Modify Data Objects - SharedVideoCompositionInfo: rename `sharedVideoCompositionId` to `id` to match convention |
| 2025-11-25 | 25.11.25.527 | 6.7 | API 6.7: Support for overriding output frame size at the encoder level Modify Data Structures: - ObsEncoderInfo: `width` and `height` are now writable (value above 0 = override) |