Overview
Methods
Can be accessed using client.kraken.search on an
ApiClient
instance.
Example
const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const channel = await api.kraken.search.searchStreams('Hearthstone');
Methods
searchChannels(term, page, limit)
asyncRetrieves a list of channels that match the given search term.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| term | string | none |
The term you want to search for. |
|
| page | number | none |
The result page you want to retrieve. |
|
| limit | number | 25 |
The number of results you want to retrieve. |
Return type:
Array<Channel>
searchStreams(term, page, limit, hls)
asyncRetrieves a list of streams that match the given search term.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| term | string | none |
The term you want to search for. |
|
| page | number | none |
The result page you want to retrieve. |
|
| limit | number | 25 |
The number of results you want to retrieve. |
|
| hls | boolean | none |
Whether you want only HLS or only non-HLS (RTMP) streams. If not set, finds both types of streams. |
Return type:
Array<Stream>