diff --git a/api/openapi.yaml b/api/openapi.yaml index ea9974d..7034464 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -11470,11 +11470,23 @@ components: type: string type: object video-clip: + description: "Use this object to create a smaller clip from a video you upload.\ + \ \n- You can only create video clips in the same request where you create\ + \ the video container.\n- You cannot update the starting or ending timestamps\ + \ of a video clip after you created the video container.\n- 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: startTimecode: + description: The timestamp that defines the beginning of the video clip + you want to create. The value must follow the `HH:MM:SS` format. + example: 00:01:15 pattern: ^(?:\d{2,3}:[0-5]\d:[0-5]\d(?:\.\d{1,3}|\:\d{1,2})?|\d{1,7})$ type: string endTimecode: + description: The timestamp that defines the end of the video clip you want + to create. The value must follow the `HH:MM:SS` format. + example: 00:02:33 pattern: ^(?:\d{2,3}:[0-5]\d:[0-5]\d(?:\.\d{1,3}|\:\d{1,2})?|\d{1,7})$ type: string type: object diff --git a/docs/VideoClip.md b/docs/VideoClip.md index 477b369..e1db1cc 100644 --- a/docs/VideoClip.md +++ b/docs/VideoClip.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**StartTimecode** | Pointer to **string** | | [optional] -**EndTimecode** | Pointer to **string** | | [optional] +**StartTimecode** | Pointer to **string** | The timestamp that defines the beginning of the video clip you want to create. The value must follow the `HH:MM:SS` format. | [optional] +**EndTimecode** | Pointer to **string** | The timestamp that defines the end of the video clip you want to create. The value must follow the `HH:MM:SS` format. | [optional] ## Methods diff --git a/model_video_clip.go b/model_video_clip.go index 6472fe2..9607a82 100644 --- a/model_video_clip.go +++ b/model_video_clip.go @@ -14,10 +14,12 @@ import ( //"encoding/json" ) -// VideoClip struct for VideoClip +// 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. type VideoClip struct { + // 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 `json:"startTimecode,omitempty"` - EndTimecode *string `json:"endTimecode,omitempty"` + // 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 `json:"endTimecode,omitempty"` } // NewVideoClip instantiates a new VideoClip object