Overview
Can be accessed using client.helix.videos on an ApiClient instance.
Example
const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const { data: videos } = await api.helix.videos.getVideosByUser('125328655');
Methods
getVideoById(id)
asyncRetrieves the video data for the given video ID.
| Parameter | Type | Description |
|---|---|---|
| id | string | The video ID you want to look up. |
Return type: HelixVideo | null
getVideosByGame(gameId, filter)
asyncRetrieves the videos of the given game.
| Parameter | Type | Description |
|---|---|---|
| gameId | string | The game you want to retrieve videos from. |
| filter | HelixVideoFilter | Additional filters for the result set. |
Return type: HelixPaginatedResult<HelixVideo>
getVideosByGamePaginated(gameId, filter)
Creates a paginator for videos of the given game.
| Parameter | Type | Description |
|---|---|---|
| gameId | string | The game you want to retrieve videos from. |
| filter | HelixVideoFilter | Additional filters for the result set. |
Return type: HelixPaginatedRequest<HelixVideoData, HelixVideo>
getVideosByIds(ids)
asyncRetrieves the video data for the given list of video IDs.
| Parameter | Type | Description |
|---|---|---|
| ids | string | Array<string> | The video IDs you want to look up. |
Return type: Array<HelixVideo>
getVideosByUser(user, filter)
asyncRetrieves the videos of the given user.
| Parameter | Type | Description |
|---|---|---|
| user | UserIdResolvable | The user you want to retrieve videos from. |
| filter | HelixPaginatedVideoFilter | Additional filters for the result set. |
Return type: HelixPaginatedResult<HelixVideo>
getVideosByUserPaginated(user, filter)
Creates a paginator for videos of the given user.
| Parameter | Type | Description |
|---|---|---|
| user | UserIdResolvable | The user you want to retrieve videos from. |
| filter | HelixVideoFilter | Additional filters for the result set. |
Return type: HelixPaginatedRequest<HelixVideoData, HelixVideo>