Skip to content

Commit f0d9e29

Browse files
authored
Update ports in readme (#302)
New default port is 4455
1 parent 86c0060 commit f0d9e29

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,14 @@ const obs = new OBSWebSocket();
8585
### Connecting
8686

8787
```ts
88-
connect(url = 'ws://127.0.0.1:4444', password?: string, identificationParams = {}): Promise
88+
connect(url = 'ws://127.0.0.1:4455', password?: string, identificationParams = {}): Promise
8989
```
9090

9191
To connect to obs-websocket server use the `connect` method.
9292

9393
Parameter | Description
9494
---|---
95-
`url`<br />`string (optional)` | Websocket URL to connect to, including protocol. (For example when connecting via a proxy that supports https use `wss://127.0.0.1:4444`)
95+
`url`<br />`string (optional)` | Websocket URL to connect to, including protocol. (For example when connecting via a proxy that supports https use `wss://127.0.0.1:4455`)
9696
`password`<br />`string (optional)` | Password required to authenticate with obs-websocket server
9797
`identificationParams`<br />`object (optional)` | Object with parameters to send with the [Identify message](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#identify-opcode-1)<br />Use this to include RPC version to guarantee compatibility with server
9898

@@ -106,16 +106,16 @@ const obs = new OBSWebSocket();
106106
await obs.connect();
107107

108108
// Connect to obs-ws running on 192.168.0.4
109-
await obs.connect('ws://192.168.0.4:4444');
109+
await obs.connect('ws://192.168.0.4:4455');
110110

111111
// Connect to localhost with password
112-
await obs.connect('ws://127.0.0.1:4444', 'super-sekret');
112+
await obs.connect('ws://127.0.0.1:4455', 'super-sekret');
113113

114114
// Connect expecting RPC version 1
115-
await obs.connect('ws://127.0.0.1:4444', undefined, {rpcVersion: 1});
115+
await obs.connect('ws://127.0.0.1:4455', undefined, {rpcVersion: 1});
116116

117117
// Connect with request for high-volume event
118-
await obs.connect('ws://127.0.0.1:4444', undefined, {
118+
await obs.connect('ws://127.0.0.1:4455', undefined, {
119119
eventSubscriptions: EventSubscription.All | EventSubscription.InputVolumeMeters,
120120
rpcVersion: 1
121121
});
@@ -125,7 +125,7 @@ try {
125125
const {
126126
obsWebSocketVersion,
127127
negotiatedRpcVersion
128-
} = await obs.connect('ws://192.168.0.4:4444', 'password', {
128+
} = await obs.connect('ws://192.168.0.4:4455', 'password', {
129129
rpcVersion: 1
130130
});
131131
console.log(`Connected to server ${obsWebSocketVersion} (using RPC ${negotiatedRpcVersion})`)

0 commit comments

Comments
 (0)