Overview
Can be accessed using client.kraken.videos on an
ApiClient
instance.
Example
const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const user = await api.kraken.videos.getVideo('85448040');
Methods
completeVideoUpload(id, token)
asyncCompletes a video upload.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | none | The ID of the video. |
|
| token | string | none | The upload token. |
createVideo(channel, createData)
asyncCreates a new video.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none |
The channel to upload the video to. |
|
| createData | VideoCreateData | none | The data for the video. |
deleteVideo(id)
asyncDeletes a video.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | none | The ID of the video. |
getFollowedVideos(type, languageCode, sort, page, limit)
asyncRetrieves the videos from channels followed by the authenticated user.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| type |
VideoType
Possible video types to search for. Aliased type: "archive" | "highlight" | "upload" |
none |
Show only videos of a certain type. |
|
| languageCode | string | none |
Show only videos in a certain language. |
|
| sort |
VideoSort
Possible ways to sort videos. Aliased type: "time" | "views" |
none |
Sort the videos by specified criteria. |
|
| page | number | none |
The result page you want to retrieve. |
|
| limit | number | 10 |
The number of results you want to retrieve. |
getTopVideos(game, searchPeriod, type, languageCode, sort, page, limit)
asyncRetrieves the top videos.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| game | string | none |
Show only videos of a certain game. |
|
| searchPeriod |
VideoSearchPeriod
Possible periods to search videos in. Aliased type: "week" | "month" | "all" |
none |
Show only videos from a certain time period. |
|
| type |
VideoType
Possible video types to search for. Aliased type: "archive" | "highlight" | "upload" |
none |
Show only videos of a certain type. |
|
| languageCode | string | none |
Show only videos in a certain language. |
|
| sort |
VideoSort
Possible ways to sort videos. Aliased type: "time" | "views" |
none |
Sort the videos by specified criteria. |
|
| page | number | none |
The result page you want to retrieve. |
|
| limit | number | 10 |
The number of results you want to retrieve. |
getVideo(id)
asyncRetrieves a video by ID.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | none | The ID of the video. |
updateVideo(id, updateData)
asyncUpdates an already uploaded video.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | none | The ID of the video. |
|
| updateData | VideoUpdateData | none |
The data to change for the video. |