Skip to content

@advjs/monorepo / plugins/plugin-obs / ConnectOBSWebSocketOptions

Interface: ConnectOBSWebSocketOptions

Defined in: plugins/plugin-obs/src/types.ts:4

Properties

autoDestroy?

optional autoDestroy: boolean

Defined in: plugins/plugin-obs/src/types.ts:53

录制完后是否自动销毁场景

Default

ts
true

duration?

optional duration: number

Defined in: plugins/plugin-obs/src/types.ts:47

录制时间

Default

ts
1000

identificationParams?

optional identificationParams: object

Defined in: plugins/plugin-obs/src/types.ts:17

eventSubscriptions?

optional eventSubscriptions: number

Bitmask of EventSubscription items to subscribe to events and event categories at will. By default, all event categories are subscribed, except for events marked as high volume. High volume events must be explicitly subscribed to.

rpcVersion?

optional rpcVersion: number

Version number that the client would like the obs-websocket server to use


inputName?

optional inputName: string

Defined in: plugins/plugin-obs/src/types.ts:26

自定义浏览器源名


inputSettings?

optional inputSettings: JsonObject | { fps?: number; height?: number; url: string; width?: number; }

Defined in: plugins/plugin-obs/src/types.ts:36

浏览器源设置。

  • url: 要录制的网页地址,可以是 localhost。
  • width: 宽度,默认为 1920。
  • height: 高度,默认为 1080。
  • fps: 帧率(可选,默认为 30)。

password?

optional password: string

Defined in: plugins/plugin-obs/src/types.ts:16

OBS「工具」->「WebSocket 服务器设置」->「服务器密码」。

你自定义的 obs-websocket 密码。


sceneName?

optional sceneName: string

Defined in: plugins/plugin-obs/src/types.ts:22

自定义场景名


url?

optional url: string

Defined in: plugins/plugin-obs/src/types.ts:10

端口号通常为 4455。 如:ws://127.0.0.1:4455。 如:ws://192.168.31.7:4455