Merge pull request #197 from apivideo/Add-clip-object-timecode-descri…

…ptions Update video-clip schema with descriptions
apivideo · Oct 16, 2023 · 1664322 · 1664322
2 parents 9c000e4 + 4d480f2
commit 1664322
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 5 deletions.
diff --git a/docs/model/VideoClip.md b/docs/model/VideoClip.md
@@ -1,12 +1,13 @@
 
 # VideoClip
 
+Use this object to create a smaller clip from a video you upload.  - You can only create video clips in the same request where you create the video container. - You cannot update the starting or ending timestamps of a video clip after you created the video container. - When you upload a video file into a container where you defined a starting and ending timestamp, the API trims the video according to those timestamps to create a clip.
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**startTimecode** | **string** |  |  [optional]
-**endTimecode** | **string** |  |  [optional]
+**startTimecode** | **string** | The timestamp that defines the beginning of the video clip you want to create. The value must follow the &#x60;HH:MM:SS&#x60; format. |  [optional]
+**endTimecode** | **string** | The timestamp that defines the end of the video clip you want to create. The value must follow the &#x60;HH:MM:SS&#x60; format. |  [optional]
 
 
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/model/VideoClip.ts b/src/model/VideoClip.ts
@@ -11,8 +11,17 @@
 
 import AttributeType from './AttributeType.js';
 
+/**
+ * Use this object to create a smaller clip from a video you upload.  - You can only create video clips in the same request where you create the video container. - You cannot update the starting or ending timestamps of a video clip after you created the video container. - When you upload a video file into a container where you defined a starting and ending timestamp, the API trims the video according to those timestamps to create a clip.
+ */
 export default class VideoClip {
+  /**
+   * The timestamp that defines the beginning of the video clip you want to create. The value must follow the `HH:MM:SS` format.
+   */
   'startTimecode'?: string;
+  /**
+   * The timestamp that defines the end of the video clip you want to create. The value must follow the `HH:MM:SS` format.
+   */
   'endTimecode'?: string;
 
   static readonly discriminator?: string = undefined;