Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update video-clip schema with descriptions #83

Merged
merged 1 commit into from
Oct 16, 2023
Merged

Update video-clip schema with descriptions #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apivideo/model/video_clip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 3 additions & 2 deletions docs/VideoClip.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
4 changes: 2 additions & 2 deletions docs/VideosApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions test/test_videos_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading