obs-ws-sdk 0.0.1

package/README.md

@@ -0,0 +1,63 @@
+# obs-ws-sdk
+
+A high-level TypeScript SDK for [OBS WebSocket](https://github.com/obsproject/obs-websocket), built on top of [`obs-websocket-js`](https://github.com/obs-websocket-community-projects/obs-websocket-js) with [`zod`](https://zod.dev) runtime validation.
+
+## Features
+
+- **Full Type Safety** — Precise TypeScript types for all requests and responses
+- **Semantic API** — Namespace-style method calls instead of raw string-based requests
+- **Runtime Validation** — Zod schemas validate both request parameters and responses
+- **IDE Support** — Complete IntelliSense and auto-completion
+
+## Install
+
+```bash
+pnpm add obs-ws-sdk
+```
+
+## Usage
+
+```ts
+import { OBSDK } from 'obs-ws-sdk'
+
+const sdk = new OBSDK()
+await sdk.connect('ws://localhost:4455', 'your-password')
+
+// Namespace-style API with full type safety
+const version = await sdk.general.getVersion()
+console.log(version.obsVersion)
+
+const scenes = await sdk.scenes.getSceneList()
+console.log(scenes.scenes)
+
+await sdk.scenes.setCurrentProgramScene({ sceneName: 'Scene 1' })
+
+// Event handling (transparent passthrough from obs-websocket-js)
+sdk.on('CurrentProgramSceneChanged', (event) => {
+  console.log('Scene changed to:', event.sceneName)
+})
+
+await sdk.disconnect()
+```
+
+## Modules
+
+| Module | Description |
+|--------|-------------|
+| `sdk.general` | Version info, stats, hotkeys, custom events |
+| `sdk.config` | Scene collections, profiles, video/stream settings |
+| `sdk.sources` | Source active state, screenshots |
+| `sdk.scenes` | Scene list, program/preview scene, create/remove |
+| `sdk.inputs` | Input management, settings, audio controls |
+| `sdk.transitions` | Transition kinds, current transition, T-Bar |
+| `sdk.filters` | Filter management, settings, enable state |
+| `sdk.sceneItems` | Scene item list, transform, enable/lock state |
+| `sdk.outputs` | Virtual cam, replay buffer, output management |
+| `sdk.stream` | Stream status, start/stop/toggle |
+| `sdk.record` | Record status, start/stop/pause/resume |
+| `sdk.mediaInputs` | Media input status, cursor, playback actions |
+| `sdk.ui` | Studio mode, dialogs, projectors |
+
+## License
+
+[MIT](./LICENSE)

package/dist/client.d.ts

@@ -0,0 +1,41 @@
+import OBSWebSocket from "obs-websocket-js";
+import { ConfigModule } from "./modules/config";
+import { FiltersModule } from "./modules/filters";
+import { GeneralModule } from "./modules/general";
+import { InputsModule } from "./modules/inputs";
+import { MediaInputsModule } from "./modules/media-inputs";
+import { OutputsModule } from "./modules/outputs";
+import { RecordModule } from "./modules/record";
+import { SceneItemsModule } from "./modules/scene-items";
+import { ScenesModule } from "./modules/scenes";
+import { SourcesModule } from "./modules/sources";
+import { StreamModule } from "./modules/stream";
+import { TransitionsModule } from "./modules/transitions";
+import { UiModule } from "./modules/ui";
+export declare class OBSDK {
+    private obs;
+    readonly general: GeneralModule;
+    readonly config: ConfigModule;
+    readonly sources: SourcesModule;
+    readonly scenes: ScenesModule;
+    readonly inputs: InputsModule;
+    readonly transitions: TransitionsModule;
+    readonly filters: FiltersModule;
+    readonly sceneItems: SceneItemsModule;
+    readonly outputs: OutputsModule;
+    readonly stream: StreamModule;
+    readonly record: RecordModule;
+    readonly mediaInputs: MediaInputsModule;
+    readonly ui: UiModule;
+    constructor();
+    connect(url?: string, password?: string, identificationParams?: object): Promise<void>;
+    disconnect(): Promise<void>;
+    callBatch: OBSWebSocket["callBatch"];
+    on: OBSWebSocket["on"];
+    once: OBSWebSocket["once"];
+    off: OBSWebSocket["off"];
+    addListener: OBSWebSocket["addListener"];
+    removeListener: OBSWebSocket["removeListener"];
+    removeAllListeners: OBSWebSocket["removeAllListeners"];
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,qBAAa,KAAK;IAChB,OAAO,CAAC,GAAG,CAAe;IAE1B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,gBAAgB,CAAC;IACtC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAC;IACxC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;;IAoBhB,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItF,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAIjC,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC,CAElC;IAEF,EAAE,EAAE,YAAY,CAAC,IAAI,CAAC,CAEpB;IAEF,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,CAExB;IAEF,GAAG,EAAE,YAAY,CAAC,KAAK,CAAC,CAEtB;IAEF,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,CAEtC;IAEF,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAE5C;IAEF,kBAAkB,EAAE,YAAY,CAAC,oBAAoB,CAAC,CAIpD;CACH"}

package/dist/client.js

@@ -0,0 +1,74 @@
+import OBSWebSocket from "obs-websocket-js";
+import { ConfigModule } from "./modules/config";
+import { FiltersModule } from "./modules/filters";
+import { GeneralModule } from "./modules/general";
+import { InputsModule } from "./modules/inputs";
+import { MediaInputsModule } from "./modules/media-inputs";
+import { OutputsModule } from "./modules/outputs";
+import { RecordModule } from "./modules/record";
+import { SceneItemsModule } from "./modules/scene-items";
+import { ScenesModule } from "./modules/scenes";
+import { SourcesModule } from "./modules/sources";
+import { StreamModule } from "./modules/stream";
+import { TransitionsModule } from "./modules/transitions";
+import { UiModule } from "./modules/ui";
+export class OBSDK {
+    obs;
+    general;
+    config;
+    sources;
+    scenes;
+    inputs;
+    transitions;
+    filters;
+    sceneItems;
+    outputs;
+    stream;
+    record;
+    mediaInputs;
+    ui;
+    constructor() {
+        this.obs = new OBSWebSocket();
+        this.general = new GeneralModule(this.obs);
+        this.config = new ConfigModule(this.obs);
+        this.sources = new SourcesModule(this.obs);
+        this.scenes = new ScenesModule(this.obs);
+        this.inputs = new InputsModule(this.obs);
+        this.transitions = new TransitionsModule(this.obs);
+        this.filters = new FiltersModule(this.obs);
+        this.sceneItems = new SceneItemsModule(this.obs);
+        this.outputs = new OutputsModule(this.obs);
+        this.stream = new StreamModule(this.obs);
+        this.record = new RecordModule(this.obs);
+        this.mediaInputs = new MediaInputsModule(this.obs);
+        this.ui = new UiModule(this.obs);
+    }
+    async connect(url, password, identificationParams) {
+        await this.obs.connect(url, password, identificationParams);
+    }
+    async disconnect() {
+        await this.obs.disconnect();
+    }
+    callBatch = (...args) => {
+        return this.obs.callBatch(...args);
+    };
+    on = (...args) => {
+        return this.obs.on(...args);
+    };
+    once = (...args) => {
+        return this.obs.once(...args);
+    };
+    off = (...args) => {
+        return this.obs.off(...args);
+    };
+    addListener = (...args) => {
+        return this.obs.addListener(...args);
+    };
+    removeListener = (...args) => {
+        return this.obs.removeListener(...args);
+    };
+    removeAllListeners = (...args) => {
+        return this.obs.removeAllListeners(...args);
+    };
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,MAAM,OAAO,KAAK;IACR,GAAG,CAAe;IAEjB,OAAO,CAAgB;IACvB,MAAM,CAAe;IACrB,OAAO,CAAgB;IACvB,MAAM,CAAe;IACrB,MAAM,CAAe;IACrB,WAAW,CAAoB;IAC/B,OAAO,CAAgB;IACvB,UAAU,CAAmB;IAC7B,OAAO,CAAgB;IACvB,MAAM,CAAe;IACrB,MAAM,CAAe;IACrB,WAAW,CAAoB;IAC/B,EAAE,CAAW;IAEtB;QACE,IAAI,CAAC,GAAG,GAAG,IAAI,YAAY,EAAE,CAAC;QAE9B,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnD,IAAI,CAAC,EAAE,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAY,EAAE,QAAiB,EAAE,oBAA6B;QAC1E,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC;IAC9D,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC;IAED,SAAS,GAA8B,CAAC,GAAG,IAA2C,EAAE,EAAE;QACxF,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;IACrC,CAAC,CAAC;IAEF,EAAE,GAAuB,CAAC,GAAG,IAAoC,EAAE,EAAE;QACnE,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC,CAAC;IAEF,IAAI,GAAyB,CAAC,GAAG,IAAsC,EAAE,EAAE;QACzE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IAChC,CAAC,CAAC;IAEF,GAAG,GAAwB,CAAC,GAAG,IAAqC,EAAE,EAAE;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC;IAEF,WAAW,GAAgC,CAAC,GAAG,IAA6C,EAAE,EAAE;QAC9F,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC,CAAC;IAEF,cAAc,GAAmC,CAAC,GAAG,IAAgD,EAAE,EAAE;QACvG,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,kBAAkB,GAAuC,CACvD,GAAG,IAAoD,EACvD,EAAE;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC;CACH"}