Skip to content

Commit

Permalink
Merge pull request #117 from apivideo/Add-clip-object-timecode-descri…
Browse files Browse the repository at this point in the history
…ptions

Update video-clip schema with descriptions
  • Loading branch information
bot-api-video authored Oct 16, 2023
2 parents 07f22e4 + 00ca94b commit 8e36c8d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
Original file line number Diff line number Diff line change
@@ -1 +1 @@
82b644869a006f53bab9fce638d82babbcf438d5667b85e39dfd007344f2afd9
d5f71186fe3b8eda08bc651966e39edc2245b72f430868c1af68505883c25b30
5 changes: 3 additions & 2 deletions docs/VideoClip.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# ApiVideo.Model.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 `HH:MM:SS` format. | [optional]
**EndTimecode** | **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]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8 changes: 5 additions & 3 deletions src/Model/VideoClip.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,21 @@
namespace ApiVideo.Model {

/// <summary>
///
/// 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.
/// </summary>
[DataContract]
public class VideoClip {
/// <summary>
/// Gets or Sets StartTimecode
/// The timestamp that defines the beginning of the video clip you want to create. The value must follow the `HH:MM:SS` format.
/// </summary>
/// <value>The timestamp that defines the beginning of the video clip you want to create. The value must follow the `HH:MM:SS` format.</value>
[DataMember(Name="startTimecode", EmitDefaultValue=false)]
[JsonProperty(PropertyName = "startTimecode")]
public string starttimecode { get; set; }
/// <summary>
/// Gets or Sets EndTimecode
/// The timestamp that defines the end of the video clip you want to create. The value must follow the `HH:MM:SS` format.
/// </summary>
/// <value>The timestamp that defines the end of the video clip you want to create. The value must follow the `HH:MM:SS` format.</value>
[DataMember(Name="endTimecode", EmitDefaultValue=false)]
[JsonProperty(PropertyName = "endTimecode")]
public string endtimecode { get; set; }
Expand Down

0 comments on commit 8e36c8d

Please sign in to comment.