WebcastWebSocketClient
Defined in: src/lib/ws/lib/ws-client.ts:35
Extends
Section titled “Extends”WebSocket<this> &TypedEventEmitter<WebcastWebSocketEventMap,this>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebcastWebSocketClient(
webcastWebSocketConfig,wsClientOptions?):WebcastWebSocketClient
Defined in: src/lib/ws/lib/ws-client.ts:44
Parameters
Section titled “Parameters”webcastWebSocketConfig
Section titled “webcastWebSocketConfig”wsClientOptions?
Section titled “wsClientOptions?”ClientOptions
Returns
Section titled “Returns”WebcastWebSocketClient
Overrides
Section titled “Overrides”(WebSocket as WebcastTypedWebSocket).constructor
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get open():
boolean
Defined in: src/lib/ws/lib/ws-client.ts:79
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”sendBytes()
Section titled “sendBytes()”sendBytes(
data):boolean
Defined in: src/lib/ws/lib/ws-client.ts:88
Send a message to the WebSocket server
Parameters
Section titled “Parameters”Uint8Array
The message to send
Returns
Section titled “Returns”boolean
True if the message was sent, false otherwise
switchRooms()
Section titled “switchRooms()”switchRooms(
roomId):void
Defined in: src/lib/ws/lib/ws-client.ts:176
Switch to a different TikTok LIVE room while connected to the WebSocket
Parameters
Section titled “Parameters”roomId
Section titled “roomId”string
The room ID to switch to
Returns
Section titled “Returns”void