TikTokLiveConnectionOptions
TikTokLiveConnectionOptions =
TikTokLiveConnectionProviderOptions&object
Defined in: src/types/client.ts:67
Type Declaration
Section titled “Type Declaration”clientPresets?
Section titled “clientPresets?”
optionalclientPresets?:GetWebConfigParams
Device, location, and screen presets. Randomization defaults are controlled by the environment.
enableExtendedGiftInfo
Section titled “enableExtendedGiftInfo”enableExtendedGiftInfo:
boolean
Fetch and cache gifts during connection, then attach matching metadata to gift events. Defaults to false.
fetchRoomInfoOnConnect
Section titled “fetchRoomInfoOnConnect”fetchRoomInfoOnConnect:
boolean
Fetch and cache room information before opening the socket. Defaults to true.
processInitialData
Section titled “processInitialData”processInitialData:
boolean
Emit messages from the initial signing response. Defaults to true.
webClientOptions?
Section titled “webClientOptions?”
optionalwebClientOptions?:WebcastGotHttpConfig
Got options. Headers and searchParams are merged; the current constructor drops timeout.
webConfigOverrides?
Section titled “webConfigOverrides?”
optionalwebConfigOverrides?:Partial<WebcastWebConfigDefaults>
Shallow replacement of resolved HTTP protocol config fields, including whole nested objects.
wsClientOptions?
Section titled “wsClientOptions?”
optionalwsClientOptions?:WsWebSocketConfig
ws transport options. Dynamic connection headers take precedence over supplied headers.
wsConfigOverrides?
Section titled “wsConfigOverrides?”
optionalwsConfigOverrides?:Partial<WebcastWebSocketConfigDefaults>
Shallow replacement of resolved WebSocket protocol config fields, including whole nested objects.