TikTokLiveConnection

Defined in: src/lib/client/index.ts:43

Extends

• TypedEventEmitter<ClientEventMap, this>

Constructors

Constructor

new TikTokLiveConnection(uniqueId, options?): TikTokLiveConnection

Defined in: src/lib/client/index.ts:76

Create a new TikTokLiveConnection instance.

Parameters

uniqueId

string

TikTok username (with or without leading @, or a full https://www.tiktok.com/@user/live URL).

options?

Partial<object & object & object> & object & object | Partial<object & object & object> & object & object | Partial<object & object & object> & object & object | never | Partial<object & object & object> & object & object | Partial<object & object & object> & object & object | never | Partial<object & object & object> & object & object | Partial<object & object & object> & object & object = {}

Optional connection options.

Partial<object & object & object> & object & object

---

Partial<object & object & object> & object & object

---

Partial<object & object & object> & object & object

---

never

---

Partial<object & object & object> & object & object

---

Partial<object & object & object> & object & object

---

never

---

Partial<object & object & object> & object & object

---

Partial<object & object & object> & object & object

Returns

TikTokLiveConnection

Overrides

(EventEmitter as WebcastTypedClient).constructor

Properties

options

readonly options: TikTokLiveConnectionMutableOptions

Defined in: src/lib/client/index.ts:46

---

uniqueId

readonly uniqueId: string

Defined in: src/lib/client/index.ts:77

TikTok username (with or without leading @, or a full https://www.tiktok.com/@user/live URL).

Accessors

apiClient

Get Signature

get apiClient(): EulerStreamApiClient

Defined in: src/lib/client/index.ts:145

Get an instance of the underlying API Client

Returns

EulerStreamApiClient

---

availableGifts

Get Signature

get availableGifts(): any

Defined in: src/lib/client/index.ts:181

Get the available gifts

Returns

any

---

clientParams

Get Signature

get clientParams(): Record<string, string>

Defined in: src/lib/client/index.ts:202

Get the current client parameters

Returns

Record<string, string>

---

isConnected

Get Signature

get isConnected(): boolean

Defined in: src/lib/client/index.ts:195

Check if the connection is established

Returns

boolean

---

isConnecting

Get Signature

get isConnecting(): boolean

Defined in: src/lib/client/index.ts:188

Get the current connection state

Returns

boolean

---

roomId

Get Signature

get roomId(): string

Defined in: src/lib/client/index.ts:209

Get the current room ID

Returns

string

---

roomInfo

Get Signature

get roomInfo(): any

Defined in: src/lib/client/index.ts:174

Get the current Room Info

Returns

any

---

state

Get Signature

get state(): TikTokLiveConnectionState

Defined in: src/lib/client/index.ts:218

Get the current connection state including the cached room info and all available gifts (if enableExtendedGiftInfo option enabled)

Returns

TikTokLiveConnectionState

---

webClient

Get Signature

get webClient(): WebcastHttpClient

Defined in: src/lib/client/index.ts:138

Get the current Web Client instance

Returns

WebcastHttpClient

---

wsClient

Get Signature

get wsClient(): WebcastWebSocketClient | null

Defined in: src/lib/client/index.ts:152

Get the current WebSocket client instance. Will be null if not connected.

Returns

WebcastWebSocketClient | null

Methods

connect()

connect(roomId?): Promise<TikTokLiveConnectionState>

Defined in: src/lib/client/index.ts:234

Connects to the live stream of the specified streamer

Parameters

roomId?

string

Room ID to connect to. If not specified, the room ID will be retrieved from the TikTok API

Returns

Promise<TikTokLiveConnectionState>

The current connection state

---

disconnect()

disconnect(): Promise<void>

Defined in: src/lib/client/index.ts:369

Disconnects the connection to the live stream

Returns

Promise<void>

---

fetchAvailableGifts()

fetchAvailableGifts(): Promise<any>

Defined in: src/lib/client/index.ts:440

Get the available gifts in the current room

Returns

Promise<any>

Promise that will be resolved when the available gifts have been retrieved from the API

---

fetchIsLive()

fetchIsLive(uniqueId?): Promise<boolean>

Defined in: src/lib/client/index.ts:410

Fetch whether the streamer is currently live

Parameters

uniqueId?

string = ...

Returns

Promise<boolean>

---

fetchRoomId()

fetchRoomId(uniqueId?): Promise<string>

Defined in: src/lib/client/index.ts:395

Fetch the room ID from the TikTok API

Parameters

uniqueId?

string = ...

Optional unique ID to use instead of the current one

Returns

Promise<string>

---

fetchRoomInfo()

fetchRoomInfo(roomId?): Promise<any>

Defined in: src/lib/client/index.ts:425

Get the current room info (including streamer info, room status and statistics)

Parameters

roomId?

string = ...

Returns

Promise<any>

Promise that will be resolved when the room info has been retrieved from the API

---

sendMessage()

sendMessage(content, roomId?): Promise<WebcastRoomChatRouteResponse>

Defined in: src/lib/client/index.ts:456

Send a message to a TikTok LIVE Room

Parameters

content

string

Message content to send to the stream

roomId?

string = ...

Target room ID. If not specified, the message will be sent to the currently connected room. Note that a room ID is required to send a message, so if you’re not currently connected to a room you must specify a room ID.

Returns

Promise<WebcastRoomChatRouteResponse>

---

waitUntilLive()

waitUntilLive(seconds?, abortSignal?): Promise<void>

Defined in: src/lib/client/index.ts:708

Wait until the streamer is live

Parameters

seconds?

number = 60

Number of seconds to wait before checking if the streamer is live again

abortSignal?

AbortSignal

Process will keep checking if the streamer is live every seconds seconds until the streamer is live or the abort signal is triggered

Returns

Promise<void>