Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add: OBS Websocket v5.5 features #357

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
# How to Contribute

## Issues/Feedback/Requests

- Create a new issue [here](https://github.com/obs-websocket-community-projects/obs-websocket-js/issues/new), please be as descriptive as possible.

## Building the Project Locally
- Install [node.js](http://nodejs.org)

- Install [node.js v20 or greater](http://nodejs.org)
- Clone/Fork the repo
- Install dependencies with `npm install`
- Generate the browser distributable Javascript file with `npm run build`
- Or `npm run watch` to automatically build when files are modified.
- This project makes use of eslint, run `npm run test:static` for linting and `npm run test:ava` for basic unit testing. If you have the types compiled you can also run `npm run test:types`.
- This project makes use of eslint, run `npm run lint` for linting and `npm run test` for basic unit testing.

## Building Typings Locally

- Export GH_TOKEN as an environment variable, using a generated Personal Access Token.
- `npm run build:types`

## Contributing Guidelines

- Please use descriptive commit messages.
- When submitting a Pull Request, reference related [Issues](https://github.com/obs-websocket-community-projects/obs-websocket-js/issues) if any exist.
16 changes: 16 additions & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -718,6 +718,12 @@ export interface OBSEventTypes {
*/
outputPath: string;
};
RecordFileChanged: {
/**
* File name that the output has begun writing to
*/
newOutputPath: string;
};
ReplayBufferStateChanged: {
/**
* Whether the output is active
Expand Down Expand Up @@ -1858,6 +1864,14 @@ export interface OBSRequestTypes {
ToggleRecordPause: never;
PauseRecord: never;
ResumeRecord: never;
SplitRecordFile: never;
CreateRecordChapter: {
/**
* Name of the new chapter
* @defaultValue Unknown
*/
chapterName?: string;
};
GetSceneItemList: {
/**
* Name of the scene to get the items of
Expand Down Expand Up @@ -3001,6 +3015,8 @@ export interface OBSResponseTypes {
ToggleRecordPause: undefined;
PauseRecord: undefined;
ResumeRecord: undefined;
SplitRecordFile: undefined;
CreateRecordChapter: undefined;
GetSceneItemList: {
/**
* Array of scene items in the scene
Expand Down
Loading