createWebSocketProvider

createWebSocketProvider(webcastWebSocketConfig, wsClientOptions?): (dynamicParams) => WebcastWebSocketClient

Defined in: src/lib/ws/lib/ws-client.ts:19

Creates a WebSocket provider function that can be used to create WebcastWebSocketClient instances with dynamic parameters.

Parameters

webcastWebSocketConfig

The default WebSocket configuration to use for all clients created by this provider. Dynamic parameters will override these defaults.

DEFAULT_WS_CLIENT_HEADERS

{ User-Agent: string; } = ...

DEFAULT_WS_CLIENT_HEADERS.User-Agent

string = TEMPLATED_VALUE

DEFAULT_WS_CLIENT_PARAMS

{ aid: string; app_language: string; app_name: string; browser_language: string; browser_name: string; browser_online: string; browser_platform: string; browser_version: string; client_enter: string; cookie_enabled: string; device_platform: string; did_rule: string; heartbeat_duration: string; history_comment_count: string; identity: string; last_rtt: string; live_id: string; resp_content_type: string; screen_height: string; screen_width: string; sup_ws_ds_opt: string; tz_name: string; update_version_code: string; version_code: string; webcast_language: string; ws_direct: string; } = ...

DEFAULT_WS_CLIENT_PARAMS.aid

string = ...

DEFAULT_WS_CLIENT_PARAMS.app_language

string = TEMPLATED_VALUE

DEFAULT_WS_CLIENT_PARAMS.app_name

string = 'tiktok_web'

DEFAULT_WS_CLIENT_PARAMS.browser_language

string = TEMPLATED_VALUE

DEFAULT_WS_CLIENT_PARAMS.browser_name

string = TEMPLATED_VALUE

DEFAULT_WS_CLIENT_PARAMS.browser_online

string = 'true'

DEFAULT_WS_CLIENT_PARAMS.browser_platform

string = TEMPLATED_VALUE

DEFAULT_WS_CLIENT_PARAMS.browser_version

string = TEMPLATED_VALUE

DEFAULT_WS_CLIENT_PARAMS.client_enter

string = '1'

DEFAULT_WS_CLIENT_PARAMS.cookie_enabled

string = 'true'

DEFAULT_WS_CLIENT_PARAMS.device_platform

string = 'web'

DEFAULT_WS_CLIENT_PARAMS.did_rule

string = '3'

DEFAULT_WS_CLIENT_PARAMS.heartbeat_duration

string = '0'

DEFAULT_WS_CLIENT_PARAMS.history_comment_count

string = '6'

DEFAULT_WS_CLIENT_PARAMS.identity

string = 'audience'

DEFAULT_WS_CLIENT_PARAMS.last_rtt

string = ...

DEFAULT_WS_CLIENT_PARAMS.live_id

string = '12'

DEFAULT_WS_CLIENT_PARAMS.resp_content_type

string = 'protobuf'

DEFAULT_WS_CLIENT_PARAMS.screen_height

string = TEMPLATED_VALUE

DEFAULT_WS_CLIENT_PARAMS.screen_width

string = TEMPLATED_VALUE

DEFAULT_WS_CLIENT_PARAMS.sup_ws_ds_opt

string = '1'

DEFAULT_WS_CLIENT_PARAMS.tz_name

string = TEMPLATED_VALUE

DEFAULT_WS_CLIENT_PARAMS.update_version_code

string = '2.0.0'

DEFAULT_WS_CLIENT_PARAMS.version_code

string = '180800'

DEFAULT_WS_CLIENT_PARAMS.webcast_language

string = TEMPLATED_VALUE

DEFAULT_WS_CLIENT_PARAMS.ws_direct

string = '0'

DEFAULT_WS_CLIENT_PARAMS_APPEND_PARAMETER

string = '&version_code=270000'

DEFAULT_WS_PING_INTERVAL

number = 10000

TIKTOK_HOST_WS

string = WebcastWebConfigDefaults.TIKTOK_HOST_WEB

wsClientOptions?

ClientOptions

The WebSocket client options to use for all clients created by this provider. These options will be merged with any dynamic parameters provided when creating a client.

Returns

(dynamicParams) => WebcastWebSocketClient