From b9c84fd7a77d39d5cf9c0be788c59cb7310e11b6 Mon Sep 17 00:00:00 2001 From: szekelyzol Date: Sun, 15 Oct 2023 18:34:02 +0000 Subject: [PATCH] Update video-clip schema with descriptions --- apivideo/model/video_clip.py | 4 ++-- docs/VideoClip.md | 5 +++-- docs/VideosApi.md | 4 ++-- test/test_videos_api.py | 4 ++-- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/apivideo/model/video_clip.py b/apivideo/model/video_clip.py index 20f836d..09692e0 100644 --- a/apivideo/model/video_clip.py +++ b/apivideo/model/video_clip.py @@ -141,8 +141,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - start_timecode (str): [optional] # noqa: E501 - end_timecode (str): [optional] # noqa: E501 + start_timecode (str): The timestamp that defines the beginning of the video clip you want to create. The value must follow the `HH:MM:SS` format.. [optional] # noqa: E501 + end_timecode (str): The timestamp that defines the end of the video clip you want to create. The value must follow the `HH:MM:SS` format.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/docs/VideoClip.md b/docs/VideoClip.md index 0262219..f6abfa3 100644 --- a/docs/VideoClip.md +++ b/docs/VideoClip.md @@ -1,10 +1,11 @@ # 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 ------------ | ------------- | ------------- | ------------- -**start_timecode** | **str** | | [optional] -**end_timecode** | **str** | | [optional] +**start_timecode** | **str** | The timestamp that defines the beginning of the video clip you want to create. The value must follow the `HH:MM:SS` format. | [optional] +**end_timecode** | **str** | 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) diff --git a/docs/VideosApi.md b/docs/VideosApi.md index 90f357e..1af8e87 100644 --- a/docs/VideosApi.md +++ b/docs/VideosApi.md @@ -53,8 +53,8 @@ with apivideo.AuthenticatedApiClient(__API_KEY__) as api_client: ), ], clip=VideoClip( - start_timecode="8072", - end_timecode="8072", + start_timecode="00:01:15", + end_timecode="00:02:33", ), watermark=VideoWatermark( id="watermark_1BWr2L5MTQwxGkuxKjzh6i", diff --git a/test/test_videos_api.py b/test/test_videos_api.py index 488606e..fcb3229 100644 --- a/test/test_videos_api.py +++ b/test/test_videos_api.py @@ -65,8 +65,8 @@ def test_create(self): ), ], clip=VideoClip( - start_timecode="8072", - end_timecode="8072", + start_timecode="00:01:15", + end_timecode="00:02:33", ), watermark=VideoWatermark( id="watermark_1BWr2L5MTQwxGkuxKjzh6i",