You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[**list()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#list) | List all video objects | **GET**`/videos`
185
185
[**uploadThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#uploadThumbnail) | Upload a thumbnail | **POST**`/videos/{videoId}/thumbnail`
186
186
[**pickThumbnail()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#pickThumbnail) | Set a thumbnail | **PATCH**`/videos/{videoId}/thumbnail`
187
+
[**getDiscarded()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#getDiscarded) | Retrieve a discarded video object | **GET**`/discarded/videos/{videoId}`
187
188
[**getStatus()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#getStatus) | Retrieve video status and details | **GET**`/videos/{videoId}/status`
189
+
[**listDiscarded()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#listDiscarded) | List all discarded video objects | **GET**`/discarded/videos`
190
+
[**updateDiscarded()**](https://github.com/apivideo/api.video-nodejs-client/blob/main/docs/api/VideosApi.md#updateDiscarded) | Update a discarded video object | **PATCH**`/discarded/videos/{videoId}`
|**streamKey**|**string**| no| The unique stream key that allows you to stream videos. |
117
117
|**name**|**string**| no| You can filter live streams by their name or a part of their name. |
118
-
|**sortBy**|**'name'\|'createdAt'\|'updatedAt'**| no| Enables you to sort live stream results. Allowed attributes: `name`, `createdAt`, `updatedAt`. `name` - the name of the live stream. `createdAt` - the time a live stream was created. `updatedAt` - the time a live stream was last updated. When using `createdAt` or `updatedAt`, the API sorts the results based on the ISO-8601 time format. |
118
+
|**sortBy**|**'name'\|'createdAt'\|'updatedAt'**| no| Enables you to sort live stream results. Allowed attributes: `name`, `createdAt`, `updatedAt`. `name` - the name of the live stream. `createdAt` - the time a live stream was created. `updatedAt` - the time a live stream was last updated. When using `createdAt` or `updatedAt`, the API sorts the results based on the ATOM UTC time format. |
119
119
|**sortOrder**|**'asc'\|'desc'**| no| Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending. |
120
120
|**currentPage**|**number**| no| Choose the number of search results to return per page. Minimum value: 1 |
121
121
|**pageSize**|**number**| no| Results per page. Allowed values 1-100, default is 25. |
|**sortBy**|**'name'\|'createdAt'\|'updatedAt'**| no| createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format. |
117
+
|**sortBy**|**'name'\|'createdAt'\|'updatedAt'**| no| createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ATOM UTC format. |
118
118
|**sortOrder**|**'asc'\|'desc'**| no| Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. |
119
119
|**currentPage**|**number**| no| Choose the number of search results to return per page. Minimum value: 1 |
120
120
|**pageSize**|**number**| no| Results per page. Allowed values 1-100, default is 25. |
|**sortBy**|**'createdAt'\|'ttl'**| no| Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ISO-8601 format. |
89
+
|**sortBy**|**'createdAt'\|'ttl'**| no| Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ATOM UTC format. |
90
90
|**sortOrder**|**'asc'\|'desc'**| no| Allowed: asc, desc. Ascending is 0-9 or A-Z. Descending is 9-0 or Z-A. |
91
91
|**currentPage**|**number**| no| Choose the number of search results to return per page. Minimum value: 1 |
92
92
|**pageSize**|**number**| no| Results per page. Allowed values 1-100, default is 25. |
If you do not need a video any longer, you can send a request to delete it. All you need is the videoId.
223
+
If you do not need a video any longer, you can send a request to delete it. All you need is the videoId. By default, deleted videos cannot be recovered. If you have the Video Restore feature enabled, this operation will discard the video instead of permanently deleting it. Make sure you subscribe to the Video Restore feature if you want to be able to restore deleted videos! The Video Restore feature retains videos for 90 days, after which the videos are permanently deleted
221
224
222
225
### Parameters
223
226
@@ -247,7 +250,7 @@ This method returns a list of your videos (with all their details). With no para
|**title**|**string**| no| The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles. |
249
252
|**tags**|**Array<string>**| no| A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. |
250
-
|**metadata**|**{ [key: string]: string; }**| no| Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair. |
253
+
|**metadata**|**{ [key: string]: string; }**| no| Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. |
251
254
|**description**|**string**| no| Retrieve video objects by `description`. |
252
255
|**liveStreamId**|**string**| no| Retrieve video objects that were recorded from a live stream by `liveStreamId`. |
253
256
|**sortBy**|**'title'\|'createdAt'\|'publishedAt'\|'updatedAt'**| no| Use this parameter to sort videos by the their created time, published time, updated time, or by title. |
## **`getDiscarded()` - Retrieve a discarded video object**
341
+
342
+
343
+
This call provides the same information provided on video creation. For private videos, it will generate a unique token url. Use this to retrieve any details you need about a video, or set up a private viewing URL.
## **`listDiscarded()` - List all discarded video objects**
385
+
386
+
387
+
This method returns a list of your discarded videos (with all their details). With no parameters added, the API returns the first page of all discarded videos. You can filter discarded videos using the parameters described below.
|**title**|**string**| no| The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles. |
394
+
|**tags**|**Array<string>**| no| A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. |
395
+
|**metadata**|**{ [key: string]: string; }**| no| Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. |
396
+
|**description**|**string**| no| Retrieve video objects by `description`. |
397
+
|**liveStreamId**|**string**| no| Retrieve video objects that were recorded from a live stream by `liveStreamId`. |
398
+
|**sortBy**|**'title'\|'createdAt'\|'publishedAt'\|'updatedAt'**| no| Use this parameter to sort videos by the their created time, published time, updated time, or by title. |
399
+
|**sortOrder**|**'asc'\|'desc'**| no| Use this parameter to sort results. `asc` is ascending and sorts from A to Z. `desc` is descending and sorts from Z to A. |
400
+
|**currentPage**|**number**| no| Choose the number of search results to return per page. Minimum value: 1 |
401
+
|**pageSize**|**number**| no| Results per page. Allowed values 1-100, default is 25. |
**discarded** | **boolean** | Use this parameter to restore a discarded video when you have the Video Restore feature enabled. This parameter only accepts `false` as a value! | [optional]
Copy file name to clipboardExpand all lines: docs/model/LiveStream.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
13
13
**playerId** | **string** | The unique identifier for the player. | [optional]
14
14
**broadcasting** | **boolean** | Whether or not you are broadcasting the live video you recorded for others to see. True means you are broadcasting to viewers, false means you are not. | [optional]
15
15
**restreams** | [**Array<RestreamsResponseObject>**](RestreamsResponseObject.md) | Returns the list of restream destinations. |
16
-
**createdAt** | **Date** | When the player was created, presented in ISO-8601 format. | [optional]
17
-
**updatedAt** | **Date** | When the player was last updated, presented in ISO-8601 format. | [optional]
16
+
**createdAt** | **Date** | When the player was created, presented in ATOM UTC format. | [optional]
17
+
**updatedAt** | **Date** | When the player was last updated, presented in ATOM UTC format. | [optional]
**videoId** | **string** | The unique identifier of the video object. |
9
-
**createdAt** | **Date** | When a video was created, presented in ISO-8601 format. | [optional]
9
+
**createdAt** | **Date** | When a video was created, presented in ATOM UTC format. | [optional]
10
10
**title** | **string** | The title of the video content. | [optional]
11
11
**description** | **string** | A description for the video content. | [optional]
12
-
**publishedAt** | **Date** | The date and time the API created the video. Date and time are provided using ISO-8601 UTC format. | [optional]
13
-
**updatedAt** | **Date** | The date and time the video was updated. Date and time are provided using ISO-8601 UTC format. | [optional]
12
+
**publishedAt** | **Date** | The date and time the API created the video. Date and time are provided using ATOM UTC format. | [optional]
13
+
**updatedAt** | **Date** | The date and time the video was updated. Date and time are provided using ATOM UTC format. | [optional]
14
+
**discardedAt** | **Date** | The date and time the video was discarded. The API populates this field only if you have the Video Restore feature enabled and discard a video. Date and time are provided using ATOM UTC format. | [optional]
15
+
**deletesAt** | **Date** | The date and time the video will be permanently deleted. The API populates this field only if you have the Video Restore feature enabled and discard a video. Discarded videos are pemanently deleted after 90 days. Date and time are provided using ATOM UTC format. | [optional]
16
+
**discarded** | **boolean** | Returns `true` for videos you discarded when you have the Video Restore feature enabled. Returns `false` for every other video. | [optional]
14
17
**tags** | **Array<string>** | One array of tags (each tag is a string) in order to categorize a video. Tags may include spaces. | [optional]
15
-
**metadata** | [**Array<Metadata>**](Metadata.md) | Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair. | [optional]
18
+
**metadata** | [**Array<Metadata>**](Metadata.md) | Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video. | [optional]
Copy file name to clipboardExpand all lines: docs/model/VideoCreationPayload.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
13
13
**mp4Support** | **boolean** | Enables mp4 version in addition to streamed version. | [optional]
14
14
**playerId** | **string** | The unique identification number for your video player. | [optional]
15
15
**tags** | **Array<string>** | A list of tags you want to use to describe your video. | [optional]
16
-
**metadata** | [**Array<Metadata>**](Metadata.md) | A list of key value pairs that you use to provide metadata for your video. These pairs can be made dynamic, allowing you to segment your audience. Read more on [dynamic metadata](https://api.video/blog/endpoints/dynamic-metadata/). | [optional]
16
+
**metadata** | [**Array<Metadata>**](Metadata.md) | A list of key value pairs that you use to provide metadata for your video. | [optional]
0 commit comments