diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 23058a3..bf3786c 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.0.5" + ".": "1.0.6" } diff --git a/CHANGELOG.md b/CHANGELOG.md index 40eda33..b9dd2e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## [1.0.6](https://github.com/gumlet/python-sdk/compare/v1.0.5...v1.0.6) (2026-09-21) + + +### Chores + +* **api:** update generated SDK content ([2eb4c7e](https://github.com/gumlet/python-sdk/commit/2eb4c7e2e70a942e6a70cb823778971720fca95b)) +* **api:** update generated SDK content ([687091f](https://github.com/gumlet/python-sdk/commit/687091f7e8d5d5b3ad53cf7903d2994b9fae851c)) +* **api:** update generated SDK content ([7a90920](https://github.com/gumlet/python-sdk/commit/7a9092023d74162fad2033615b58a76952866d9e)) + ## [1.0.5](https://github.com/gumlet/python-sdk/compare/v1.0.4...v1.0.5) (2026-09-21) diff --git a/api.md b/api.md index b94a3d3..6c0b034 100644 --- a/api.md +++ b/api.md @@ -135,7 +135,7 @@ Upload, manage, and retrieve video assets, including thumbnails, subtitles, audi ### Create Asset -An asset refers to a media content/video that is processed, stored, and delivered through Gumlet. This endpoint creates an asset allowing users to ingest media content into the Gumlet system for processing and delivery. +An asset refers to media content/video that is processed, stored, and delivered through Gumlet. This endpoint creates an asset allowing users to ingest media content into the Gumlet system for processing and delivery. | Direction | Type | | --- | --- | @@ -153,7 +153,7 @@ video_asset = client.video_assets.create( ### Create Asset Direct Upload -This endpoint creates a video asset allowing to upload of the video from the local file system and ingest media content into the Gumlet system for processing and delivery.Body Parameters are the same as the Create Asset Body Parameters except for the `input` parameter which this endpoint does not take.A successful response will be returned with `upload_url` field. You can make `PUT` request to that URL to upload video. To upload video using `upload_url` refer to [this](https://docs.gumlet.com/docs/direct-upload#2-use-the-url-to-upload-a-file). +This endpoint creates a video asset allowing upload of a video from the local file system and ingest media content into the Gumlet system for processing and delivery. Body parameters are the same as the Create Asset body parameters except for the `input` parameter, which this endpoint does not take. A successful response will be returned with `upload_url` field. You can make `PUT` request to that URL to upload video. To upload video using `upload_url` refer to [this](https://docs.gumlet.com/docs/direct-upload#2-use-the-url-to-upload-a-file). | Direction | Type | | --- | --- | @@ -373,7 +373,7 @@ Add subtitles to an existing asset. ### Upload Subtitles -Upload `.srt` or `.vtt` file to the video asset. The response of this API call gives `upload_url` for each language specified. You need to send a `PUT` request of the subtitle files to those URLs. Once that's done, you need to call the subtitle upload complete API. Only after that, Gumlet will add subtitles to asset. +Upload `.srt` or `.vtt` file to the video asset. The response of this API call gives `upload_url` for each language specified. You need to send a `PUT` request of the subtitle files to those URLs. Once that's done, you need to call the subtitle upload complete API. Only after that, Gumlet will add subtitles to asset. | Direction | Type | | --- | --- | @@ -976,7 +976,7 @@ Create, control, and monitor live stream assets. ### Create Live Asset -A live asset refers to a media content/video that is live-streamed through Gumlet. This endpoint creates a live streaming asset allowing users to live stream a video that will be pushed to Gumlet. +A live asset refers to media content/video that is live-streamed through Gumlet. This endpoint creates a live streaming asset allowing users to live stream a video that will be pushed to Gumlet. | Direction | Type | | --- | --- | @@ -992,7 +992,7 @@ live_stream_asset = client.live_stream_assets.create( ### Update Live Asset -A live asset refers to a media content/video that is live-streamed through Gumlet. This endpoint allows user to update a live streaming asset. +A live asset refers to media content/video that is live-streamed through Gumlet. This endpoint allows users to update a live streaming asset. | Direction | Type | | --- | --- | diff --git a/pyproject.toml b/pyproject.toml index d42552e..154c0fc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "gumlet" -version = "1.0.5" # x-release-please-version +version = "1.0.6" # x-release-please-version description = "Gumlet helps developers deliver online video and images. This API encompasses Gumlet Video, Image and Video Analytics functionality to help you build your products better and faster than ever before." readme = "README.md" license = "Apache-2.0" diff --git a/src/gumlet/_version.py b/src/gumlet/_version.py index 3cdc380..53c9cad 100644 --- a/src/gumlet/_version.py +++ b/src/gumlet/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Scalar. See README.md for details. __title__ = "gumlet" -__version__ = "1.0.5" # x-release-please-version +__version__ = "1.0.6" # x-release-please-version diff --git a/src/gumlet/resources/audio_upload.py b/src/gumlet/resources/audio_upload.py index 0df9998..af892c9 100644 --- a/src/gumlet/resources/audio_upload.py +++ b/src/gumlet/resources/audio_upload.py @@ -52,7 +52,7 @@ def upload( Args: asset_id: An asset id for the previously created asset. - language_codes: List of language Code to upload audio file (use ISO 639-1 Language Codes) + language_codes: List of language codes to upload audio file (use ISO 639-1 Language Codes) extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. @@ -160,7 +160,7 @@ async def upload( Args: asset_id: An asset id for the previously created asset. - language_codes: List of language Code to upload audio file (use ISO 639-1 Language Codes) + language_codes: List of language codes to upload audio file (use ISO 639-1 Language Codes) extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. diff --git a/src/gumlet/resources/image_usage_analytics.py b/src/gumlet/resources/image_usage_analytics.py index 56e4c2e..085bce3 100644 --- a/src/gumlet/resources/image_usage_analytics.py +++ b/src/gumlet/resources/image_usage_analytics.py @@ -69,7 +69,7 @@ def retrieve( This endpoint helps you get image analytics data like bandwidth consumption, request count, CDN hit ratio, etc. Args: - metrics: Define the metric you need the data for, currently we support "bandwidth_consumption", "requests_count","status_4xx","status_5xx","avg_response_time"" + metrics: Define the metric you need the data for. Currently we support `bandwidth_consumption`, `requests_count`, `status_4xx`, `status_5xx`, and `avg_response_time`. date_range: The timeframe to get the data for. Currently we only support a maximum of 30 days between `start_at` and `end_at`. group_by: Body parameter. filters: Body parameter. @@ -153,7 +153,7 @@ async def retrieve( This endpoint helps you get image analytics data like bandwidth consumption, request count, CDN hit ratio, etc. Args: - metrics: Define the metric you need the data for, currently we support "bandwidth_consumption", "requests_count","status_4xx","status_5xx","avg_response_time"" + metrics: Define the metric you need the data for. Currently we support `bandwidth_consumption`, `requests_count`, `status_4xx`, `status_5xx`, and `avg_response_time`. date_range: The timeframe to get the data for. Currently we only support a maximum of 30 days between `start_at` and `end_at`. group_by: Body parameter. filters: Body parameter. diff --git a/src/gumlet/resources/live_stream_assets.py b/src/gumlet/resources/live_stream_assets.py index 60f0296..27ed19c 100644 --- a/src/gumlet/resources/live_stream_assets.py +++ b/src/gumlet/resources/live_stream_assets.py @@ -63,11 +63,11 @@ def create( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> LiveStreamAssetCreateResponse: """ - A live asset refers to a media content/video that is live-streamed through Gumlet. This endpoint creates a live streaming asset allowing users to live stream a video that will be pushed to Gumlet. + A live asset refers to media content/video that is live-streamed through Gumlet. This endpoint creates a live streaming asset allowing users to live stream a video that will be pushed to Gumlet. Args: live_source_id: Gumlet live video source/collection id. - resolution: Required resolutions in HLS delivery format for live stream. Can be an array of string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Re-sized rendition will retain the input aspect ratio. + resolution: Required resolutions in HLS delivery format for live stream. Can be an array of string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Resized rendition will retain the input aspect ratio. title: Your live stream asset title mp4_access: Creates MP4 version for download purpose. orientation: Body parameter. @@ -121,7 +121,7 @@ def update( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> LiveStreamAssetUpdateResponse: """ - A live asset refers to a media content/video that is live-streamed through Gumlet. This endpoint allows user to update a live streaming asset. + A live asset refers to media content/video that is live-streamed through Gumlet. This endpoint allows users to update a live streaming asset. Args: live_asset_id: Gumlet live video asset id. @@ -173,7 +173,7 @@ def retrieve_status( This endpoint retrieves the details of a live video asset that has previously been created. Args: - live_asset_id: An live asset id for the previously created asset. + live_asset_id: A live asset id for the previously created asset. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. @@ -438,7 +438,7 @@ def status_history( This endpoint retrieves the history of a live video asset that has previously been created. Args: - live_asset_id: An live asset id for the previously created asset. + live_asset_id: A live asset id for the previously created asset. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. @@ -491,11 +491,11 @@ async def create( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> LiveStreamAssetCreateResponse: """ - A live asset refers to a media content/video that is live-streamed through Gumlet. This endpoint creates a live streaming asset allowing users to live stream a video that will be pushed to Gumlet. + A live asset refers to media content/video that is live-streamed through Gumlet. This endpoint creates a live streaming asset allowing users to live stream a video that will be pushed to Gumlet. Args: live_source_id: Gumlet live video source/collection id. - resolution: Required resolutions in HLS delivery format for live stream. Can be an array of string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Re-sized rendition will retain the input aspect ratio. + resolution: Required resolutions in HLS delivery format for live stream. Can be an array of string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Resized rendition will retain the input aspect ratio. title: Your live stream asset title mp4_access: Creates MP4 version for download purpose. orientation: Body parameter. @@ -549,7 +549,7 @@ async def update( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> LiveStreamAssetUpdateResponse: """ - A live asset refers to a media content/video that is live-streamed through Gumlet. This endpoint allows user to update a live streaming asset. + A live asset refers to media content/video that is live-streamed through Gumlet. This endpoint allows users to update a live streaming asset. Args: live_asset_id: Gumlet live video asset id. @@ -601,7 +601,7 @@ async def retrieve_status( This endpoint retrieves the details of a live video asset that has previously been created. Args: - live_asset_id: An live asset id for the previously created asset. + live_asset_id: A live asset id for the previously created asset. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. @@ -866,7 +866,7 @@ async def status_history( This endpoint retrieves the history of a live video asset that has previously been created. Args: - live_asset_id: An live asset id for the previously created asset. + live_asset_id: A live asset id for the previously created asset. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. diff --git a/src/gumlet/resources/subtitle_upload.py b/src/gumlet/resources/subtitle_upload.py index d105bc0..3ee61d5 100644 --- a/src/gumlet/resources/subtitle_upload.py +++ b/src/gumlet/resources/subtitle_upload.py @@ -47,11 +47,11 @@ def upload( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> SubtitleUploadUploadResponse: """ - Upload `.srt` or `.vtt` file to the video asset. The response of this API call gives `upload_url` for each language specified. You need to send a `PUT` request of the subtitle files to those URLs. Once that's done, you need to call the subtitle upload complete API. Only after that, Gumlet will add subtitles to asset. + Upload `.srt` or `.vtt` file to the video asset. The response of this API call gives `upload_url` for each language specified. You need to send a `PUT` request of the subtitle files to those URLs. Once that's done, you need to call the subtitle upload complete API. Only after that, Gumlet will add subtitles to asset. Args: asset_id: An asset id for the previously created asset. - language_codes: List of language Code to upload subtitle file (use ISO 639-1 Language Codes) + language_codes: List of language codes to upload subtitle file (use ISO 639-1 Language Codes) extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. @@ -154,11 +154,11 @@ async def upload( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> SubtitleUploadUploadResponse: """ - Upload `.srt` or `.vtt` file to the video asset. The response of this API call gives `upload_url` for each language specified. You need to send a `PUT` request of the subtitle files to those URLs. Once that's done, you need to call the subtitle upload complete API. Only after that, Gumlet will add subtitles to asset. + Upload `.srt` or `.vtt` file to the video asset. The response of this API call gives `upload_url` for each language specified. You need to send a `PUT` request of the subtitle files to those URLs. Once that's done, you need to call the subtitle upload complete API. Only after that, Gumlet will add subtitles to asset. Args: asset_id: An asset id for the previously created asset. - language_codes: List of language Code to upload subtitle file (use ISO 639-1 Language Codes) + language_codes: List of language codes to upload subtitle file (use ISO 639-1 Language Codes) extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. diff --git a/src/gumlet/resources/video_analytics.py b/src/gumlet/resources/video_analytics.py index 34a2ebb..ac35f9d 100644 --- a/src/gumlet/resources/video_analytics.py +++ b/src/gumlet/resources/video_analytics.py @@ -65,7 +65,7 @@ def chart_data( date_range: The timeframe to get the data for. filters: Build *segments* of users using multiple filters on the data, `value` should be an *exact match* group_by: Data can be grouped by `daily`, `weekly` or `monthly`. - chart_dimension: Metrics result Group by selected dimension, You can select upto 3 dimensions to get nested category result. result will follow selection orders. + chart_dimension: Group metrics by the selected dimension. You can select up to 3 dimensions for nested category results; results follow the selection order. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. @@ -254,7 +254,7 @@ async def chart_data( date_range: The timeframe to get the data for. filters: Build *segments* of users using multiple filters on the data, `value` should be an *exact match* group_by: Data can be grouped by `daily`, `weekly` or `monthly`. - chart_dimension: Metrics result Group by selected dimension, You can select upto 3 dimensions to get nested category result. result will follow selection orders. + chart_dimension: Group metrics by the selected dimension. You can select up to 3 dimensions for nested category results; results follow the selection order. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. diff --git a/src/gumlet/resources/video_assets.py b/src/gumlet/resources/video_assets.py index 45f18b6..712988b 100644 --- a/src/gumlet/resources/video_assets.py +++ b/src/gumlet/resources/video_assets.py @@ -94,19 +94,19 @@ def create( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> VideoAssetCreateResponse: """ - An asset refers to a media content/video that is processed, stored, and delivered through Gumlet. This endpoint creates an asset allowing users to ingest media content into the Gumlet system for processing and delivery. + An asset refers to media content/video that is processed, stored, and delivered through Gumlet. This endpoint creates an asset allowing users to ingest media content into the Gumlet system for processing and delivery. Args: input: URL or web address of a file that Gumlet should download to create a new asset. profile_id: Provide `profile_id` of the previously created video profile. This parameter will override all the parameters (except `input` and `collection_id`) from the video profile. - format: Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and`MP4`. + format: Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`. tag: Specify a text string or identifier which can identify an asset or bunch of assets later. title: Specify a text string or identifier which can be used for filtering or searching the asset. description: Attach some textual data with the asset. This field is neither searchable nor filterable. metadata: Add your metadata you want to associate with this asset.
Example:
{ "internal_video_id" : "123Abc" } width: Resize video with the given width. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset width will be ignored. Applicable only when specified format is `MP4`. height: Resize video with the given height. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset height will be ignored. Applicable only when specified format is `MP4`. - resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Re-sized rendition will retain the input aspect ratio. + resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma-separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Resized rendition will retain the input aspect ratio. crop: This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video. pad: This transformation can be used to add padding to the video. trim: Trim transformation can be used to trim videos based on time duration. @@ -114,13 +114,13 @@ def create( text_overlay: Text overlay can be used to brand a video or add a label in the form of text. animated_gif: Create an animated GIF from the video. additional_tracks: Add additional Audio / Subtitle tracks to Gumlet for transcoding and delivery along with video asset track. - generate_subtitles: Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes) + generate_subtitles: Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes) mp4_access: Creates `MP4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`** per_title_encoding: Gumlet analyzes each input video on a wide range of visual aspects. Based on the analysis, it chooses a unique set of transcoding options for processing the video. This ensures that the output video is of optimal size and best quality. **Default: `true`** process_low_resolution_input: Currently, the minimum supported frame size is `57600` (`240x240`) pixels for `HLS/DASH` and `21025` (`145x145`) pixels for `MP4` format. However, enabling this flag will allow Gumlet to simply put your video asset into the specified delivery format without transcoding and optimization. Enabling this flag will cause any kind of specified video transformation to be ignored if you input video asset frame size is lower than the minimum supported frame size for the specified format. **Default: `false`** audio_only: This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`** - enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs. - call_to_actions: CTA, is an explicit prompt within the video content encouraging viewers to take a particular action. + enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs. + call_to_actions: A CTA is an explicit prompt within the video content encouraging viewers to take a particular action. playlist_id: Add this asset to a playlist. folder: Add this asset to an existing folder by `folder_id`. workspace_id: Gumlet video workspace id. @@ -219,19 +219,19 @@ def upload( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> VideoAssetUploadResponse: """ - This endpoint creates a video asset allowing to upload of the video from the local file system and ingest media content into the Gumlet system for processing and delivery.Body Parameters are the same as the Create Asset Body Parameters except for the `input` parameter which this endpoint does not take.A successful response will be returned with `upload_url` field. You can make `PUT` request to that URL to upload video. To upload video using `upload_url` refer to [this](https://docs.gumlet.com/docs/direct-upload#2-use-the-url-to-upload-a-file). + This endpoint creates a video asset allowing upload of a video from the local file system and ingest media content into the Gumlet system for processing and delivery. Body parameters are the same as the Create Asset body parameters except for the `input` parameter, which this endpoint does not take. A successful response will be returned with `upload_url` field. You can make `PUT` request to that URL to upload video. To upload video using `upload_url` refer to [this](https://docs.gumlet.com/docs/direct-upload#2-use-the-url-to-upload-a-file). Args: collection_id: Gumlet video workspace id. profile_id: Provide `profile_id` of the previously created video profile. This parameter will override all the parameters (except `input` and `collection_id`) from the video profile. - format: Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and`MP4`. + format: Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`. tag: Specify a text string or identifier which can identify an asset or bunch of assets later. title: Specify a text string or identifier which can be used for filtering or searching the asset. description: Attach some textual data with the asset. This field is neither searchable nor filterable. metadata: Add your metadata you want to associate with this asset.
Example:
{ "internal_video_id" : "123Abc" } width: Resize video with the given width. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset width will be ignored. Applicable only when specified format is `MP4`. height: Resize video with the given height. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset height will be ignored. Applicable only when specified format is `MP4`. - resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Re-sized rendition will retain the input aspect ratio. + resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma-separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Resized rendition will retain the input aspect ratio. crop: This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video. pad: This transformation can be used to add padding to the video. trim: Trim transformation can be used to trim videos based on time duration. @@ -239,13 +239,13 @@ def upload( text_overlay: Text overlay can be used to brand a video or add a label in the form of text. animated_gif: Create an animated GIF from the video. additional_tracks: Add additional Audio / Subtitle tracks to Gumlet for transcoding and delivery along with video asset track. - generate_subtitles: Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes) + generate_subtitles: Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes) mp4_access: Creates `MP4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`** per_title_encoding: Gumlet analyzes each input video on a wide range of visual aspects. Based on the analysis, it chooses a unique set of transcoding options for processing the video. This ensures that the output video is of optimal size and best quality. **Default: `true`** process_low_resolution_input: Currently, the minimum supported frame size is `57600` (`240x240`) pixels for `HLS/DASH` and `21025` (`145x145`) pixels for `MP4` format. However, enabling this flag will allow Gumlet to simply put your video asset into the specified delivery format without transcoding and optimization. Enabling this flag will cause any kind of specified video transformation to be ignored if you input video asset frame size is lower than the minimum supported frame size for the specified format. **Default: `false`** audio_only: This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`** - enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs. - call_to_actions: CTA, is an explicit prompt within the video content encouraging viewers to take a particular action. + enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs. + call_to_actions: A CTA is an explicit prompt within the video content encouraging viewers to take a particular action. playlist_id: Add this asset to a playlist. folder: Add this asset to an existing folder by `folder_id`. extra_headers: Send extra headers with the request. @@ -431,8 +431,8 @@ def update( asset_id: Asset Id title: Specify a text string or identifier which can be used for filtering or searching the asset. description: Attach some textual data with the asset. This field is neither searchable nor filterable. - tag: Specify a text string or identifier which can identify an asset or bunch of assets later. You can pass multiple comma separated values. - call_to_actions: CTA, is an explicit prompt within the video content encouraging viewers to take a particular action. + tag: Specify a text string or identifier which can identify an asset or bunch of assets later. You can pass multiple comma-separated values. + call_to_actions: A CTA is an explicit prompt within the video content encouraging viewers to take a particular action. metadata: Set of key-value pairs that you can attach to this Asset. This can be useful for storing additional information.
Example:
{ "internal_video_id" : "123Abc" } remove_subtitles: Comma separated string of language codes. input: For replacing videos, pass this along with `asset_id` @@ -1035,19 +1035,19 @@ async def create( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> VideoAssetCreateResponse: """ - An asset refers to a media content/video that is processed, stored, and delivered through Gumlet. This endpoint creates an asset allowing users to ingest media content into the Gumlet system for processing and delivery. + An asset refers to media content/video that is processed, stored, and delivered through Gumlet. This endpoint creates an asset allowing users to ingest media content into the Gumlet system for processing and delivery. Args: input: URL or web address of a file that Gumlet should download to create a new asset. profile_id: Provide `profile_id` of the previously created video profile. This parameter will override all the parameters (except `input` and `collection_id`) from the video profile. - format: Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and`MP4`. + format: Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`. tag: Specify a text string or identifier which can identify an asset or bunch of assets later. title: Specify a text string or identifier which can be used for filtering or searching the asset. description: Attach some textual data with the asset. This field is neither searchable nor filterable. metadata: Add your metadata you want to associate with this asset.
Example:
{ "internal_video_id" : "123Abc" } width: Resize video with the given width. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset width will be ignored. Applicable only when specified format is `MP4`. height: Resize video with the given height. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset height will be ignored. Applicable only when specified format is `MP4`. - resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Re-sized rendition will retain the input aspect ratio. + resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma-separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Resized rendition will retain the input aspect ratio. crop: This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video. pad: This transformation can be used to add padding to the video. trim: Trim transformation can be used to trim videos based on time duration. @@ -1055,13 +1055,13 @@ async def create( text_overlay: Text overlay can be used to brand a video or add a label in the form of text. animated_gif: Create an animated GIF from the video. additional_tracks: Add additional Audio / Subtitle tracks to Gumlet for transcoding and delivery along with video asset track. - generate_subtitles: Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes) + generate_subtitles: Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes) mp4_access: Creates `MP4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`** per_title_encoding: Gumlet analyzes each input video on a wide range of visual aspects. Based on the analysis, it chooses a unique set of transcoding options for processing the video. This ensures that the output video is of optimal size and best quality. **Default: `true`** process_low_resolution_input: Currently, the minimum supported frame size is `57600` (`240x240`) pixels for `HLS/DASH` and `21025` (`145x145`) pixels for `MP4` format. However, enabling this flag will allow Gumlet to simply put your video asset into the specified delivery format without transcoding and optimization. Enabling this flag will cause any kind of specified video transformation to be ignored if you input video asset frame size is lower than the minimum supported frame size for the specified format. **Default: `false`** audio_only: This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`** - enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs. - call_to_actions: CTA, is an explicit prompt within the video content encouraging viewers to take a particular action. + enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs. + call_to_actions: A CTA is an explicit prompt within the video content encouraging viewers to take a particular action. playlist_id: Add this asset to a playlist. folder: Add this asset to an existing folder by `folder_id`. workspace_id: Gumlet video workspace id. @@ -1160,19 +1160,19 @@ async def upload( timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> VideoAssetUploadResponse: """ - This endpoint creates a video asset allowing to upload of the video from the local file system and ingest media content into the Gumlet system for processing and delivery.Body Parameters are the same as the Create Asset Body Parameters except for the `input` parameter which this endpoint does not take.A successful response will be returned with `upload_url` field. You can make `PUT` request to that URL to upload video. To upload video using `upload_url` refer to [this](https://docs.gumlet.com/docs/direct-upload#2-use-the-url-to-upload-a-file). + This endpoint creates a video asset allowing upload of a video from the local file system and ingest media content into the Gumlet system for processing and delivery. Body parameters are the same as the Create Asset body parameters except for the `input` parameter, which this endpoint does not take. A successful response will be returned with `upload_url` field. You can make `PUT` request to that URL to upload video. To upload video using `upload_url` refer to [this](https://docs.gumlet.com/docs/direct-upload#2-use-the-url-to-upload-a-file). Args: collection_id: Gumlet video workspace id. profile_id: Provide `profile_id` of the previously created video profile. This parameter will override all the parameters (except `input` and `collection_id`) from the video profile. - format: Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and`MP4`. + format: Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`. tag: Specify a text string or identifier which can identify an asset or bunch of assets later. title: Specify a text string or identifier which can be used for filtering or searching the asset. description: Attach some textual data with the asset. This field is neither searchable nor filterable. metadata: Add your metadata you want to associate with this asset.
Example:
{ "internal_video_id" : "123Abc" } width: Resize video with the given width. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset width will be ignored. Applicable only when specified format is `MP4`. height: Resize video with the given height. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset height will be ignored. Applicable only when specified format is `MP4`. - resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Re-sized rendition will retain the input aspect ratio. + resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma-separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Resized rendition will retain the input aspect ratio. crop: This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video. pad: This transformation can be used to add padding to the video. trim: Trim transformation can be used to trim videos based on time duration. @@ -1180,13 +1180,13 @@ async def upload( text_overlay: Text overlay can be used to brand a video or add a label in the form of text. animated_gif: Create an animated GIF from the video. additional_tracks: Add additional Audio / Subtitle tracks to Gumlet for transcoding and delivery along with video asset track. - generate_subtitles: Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes) + generate_subtitles: Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes) mp4_access: Creates `MP4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`** per_title_encoding: Gumlet analyzes each input video on a wide range of visual aspects. Based on the analysis, it chooses a unique set of transcoding options for processing the video. This ensures that the output video is of optimal size and best quality. **Default: `true`** process_low_resolution_input: Currently, the minimum supported frame size is `57600` (`240x240`) pixels for `HLS/DASH` and `21025` (`145x145`) pixels for `MP4` format. However, enabling this flag will allow Gumlet to simply put your video asset into the specified delivery format without transcoding and optimization. Enabling this flag will cause any kind of specified video transformation to be ignored if you input video asset frame size is lower than the minimum supported frame size for the specified format. **Default: `false`** audio_only: This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`** - enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs. - call_to_actions: CTA, is an explicit prompt within the video content encouraging viewers to take a particular action. + enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs. + call_to_actions: A CTA is an explicit prompt within the video content encouraging viewers to take a particular action. playlist_id: Add this asset to a playlist. folder: Add this asset to an existing folder by `folder_id`. extra_headers: Send extra headers with the request. @@ -1372,8 +1372,8 @@ async def update( asset_id: Asset Id title: Specify a text string or identifier which can be used for filtering or searching the asset. description: Attach some textual data with the asset. This field is neither searchable nor filterable. - tag: Specify a text string or identifier which can identify an asset or bunch of assets later. You can pass multiple comma separated values. - call_to_actions: CTA, is an explicit prompt within the video content encouraging viewers to take a particular action. + tag: Specify a text string or identifier which can identify an asset or bunch of assets later. You can pass multiple comma-separated values. + call_to_actions: A CTA is an explicit prompt within the video content encouraging viewers to take a particular action. metadata: Set of key-value pairs that you can attach to this Asset. This can be useful for storing additional information.
Example:
{ "internal_video_id" : "123Abc" } remove_subtitles: Comma separated string of language codes. input: For replacing videos, pass this along with `asset_id` diff --git a/src/gumlet/resources/video_playlists.py b/src/gumlet/resources/video_playlists.py index c23f272..e137a86 100644 --- a/src/gumlet/resources/video_playlists.py +++ b/src/gumlet/resources/video_playlists.py @@ -392,8 +392,8 @@ def list_assets( playlist_id: ID of playlist in which you need to list assets. sort_by: Optional, if sort_by is set to asset_title it will sorted by title name. Otherwise order in which user added the assets in playlist. sort_order: -1 or 1 - page_number: Optional, Minimun 1 - page_size: Optional, Minimun 10 + page_number: Optional. Minimum: 1 + page_size: Optional. Minimum: 10 extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. @@ -884,8 +884,8 @@ async def list_assets( playlist_id: ID of playlist in which you need to list assets. sort_by: Optional, if sort_by is set to asset_title it will sorted by title name. Otherwise order in which user added the assets in playlist. sort_order: -1 or 1 - page_number: Optional, Minimun 1 - page_size: Optional, Minimun 10 + page_number: Optional. Minimum: 1 + page_size: Optional. Minimum: 10 extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. diff --git a/src/gumlet/resources/video_profiles.py b/src/gumlet/resources/video_profiles.py index 3743c80..8840f9c 100644 --- a/src/gumlet/resources/video_profiles.py +++ b/src/gumlet/resources/video_profiles.py @@ -72,19 +72,19 @@ def create( format: Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`. width: Resize video with the given width. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset width will be ignored. Only applicable when specified `format` is `MP4`. height: Resize video with the given height. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset height will be ignored. Only applicable when specified `format` is `MP4`. - resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p `. Re-sized rendition will retain the input aspect ratio. + resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma-separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p `. Resized rendition will retain the input aspect ratio. crop: This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video. pad: This transformation can be used to add padding to the video. trim: Trim transformation can be used to trim videos based on time duration. image_overlay: Image overlay can be used to brand a video or add a visual label in the form of an image. text_overlay: Text overlay can be used to brand a video or add a label in the form of text. animated_gif: Create an animated GIF from a video. - generate_subtitles: Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes). Remove this object if you do not want to generate AI subtitles. + generate_subtitles: Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes). Remove this object if you do not want to generate AI subtitles. mp4_access: Creates `mp4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`** per_title_encoding: Gumlet analyzes each input video on a wide range of visual aspects. Based on the analysis, it chooses a unique set of transcoding options for processing the video. This ensures that the output video is of optimal size and best quality. **Default: `true`** process_low_resolution_input: Currently, the minimum supported frame size is `57600` (`240x240`) pixels for `HLS/DASH` and `21025` (`145x145`) pixels for `MP4` format. However, enabling this flag will allow Gumlet to simply put your video asset into the specified delivery format without transcoding and optimization. Enabling this flag will cause any kind of specified video transformation to be ignored if you input video asset frame size is lower than the minimum supported frame size for the specified format. **Default: `false`** audio_only: This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case,This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`** - enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs. + enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. @@ -225,12 +225,12 @@ def update( image_overlay: Image overlay can be used to brand a video or add a visual label in the form of an image. text_overlay: Text overlay can be used to brand a video or add a label in the form of text. animated_gif: Create an animated GIF from a video. - generate_subtitles: Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes). You can remove this object if don't want to generate AI subtitles. + generate_subtitles: Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes). You can remove this object if you don't want to generate AI subtitles. mp4_access: Creates `mp4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`** per_title_encoding: Gumlet analyzes each input video on a wide range of visual aspects. Based on the analysis, it chooses a unique set of transcoding options for processing the video. This ensures that the output video is of optimal size and best quality. **Default: `true`** process_low_resolution_input: Currently, the minimum supported frame size is `57600` (`240x240`) pixels for `HLS/DASH` and `21025` (`145x145`) pixels for `MP4` format. However, enabling this flag will allow Gumlet to simply put your video asset into the specified delivery format without transcoding and optimization. Enabling this flag will cause any kind of specified video transformation to be ignored if you input video asset frame size is lower than the minimum supported frame size for the specified format. **Default: `false`** audio_only: This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case,This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`** - enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs. + enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs. vc: Video Codecs generate_chapters: Whether Gumlet should generate chapters. generate_description: Whether Gumlet should generate descriptions. @@ -414,19 +414,19 @@ async def create( format: Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`. width: Resize video with the given width. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset width will be ignored. Only applicable when specified `format` is `MP4`. height: Resize video with the given height. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset height will be ignored. Only applicable when specified `format` is `MP4`. - resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p `. Re-sized rendition will retain the input aspect ratio. + resolution: Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma-separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p `. Resized rendition will retain the input aspect ratio. crop: This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video. pad: This transformation can be used to add padding to the video. trim: Trim transformation can be used to trim videos based on time duration. image_overlay: Image overlay can be used to brand a video or add a visual label in the form of an image. text_overlay: Text overlay can be used to brand a video or add a label in the form of text. animated_gif: Create an animated GIF from a video. - generate_subtitles: Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes). Remove this object if you do not want to generate AI subtitles. + generate_subtitles: Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes). Remove this object if you do not want to generate AI subtitles. mp4_access: Creates `mp4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`** per_title_encoding: Gumlet analyzes each input video on a wide range of visual aspects. Based on the analysis, it chooses a unique set of transcoding options for processing the video. This ensures that the output video is of optimal size and best quality. **Default: `true`** process_low_resolution_input: Currently, the minimum supported frame size is `57600` (`240x240`) pixels for `HLS/DASH` and `21025` (`145x145`) pixels for `MP4` format. However, enabling this flag will allow Gumlet to simply put your video asset into the specified delivery format without transcoding and optimization. Enabling this flag will cause any kind of specified video transformation to be ignored if you input video asset frame size is lower than the minimum supported frame size for the specified format. **Default: `false`** audio_only: This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case,This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`** - enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs. + enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs. extra_headers: Send extra headers with the request. extra_query: Send extra query parameters with the request. extra_body: Send extra JSON properties with the request. @@ -567,12 +567,12 @@ async def update( image_overlay: Image overlay can be used to brand a video or add a visual label in the form of an image. text_overlay: Text overlay can be used to brand a video or add a label in the form of text. animated_gif: Create an animated GIF from a video. - generate_subtitles: Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes). You can remove this object if don't want to generate AI subtitles. + generate_subtitles: Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes). You can remove this object if you don't want to generate AI subtitles. mp4_access: Creates `mp4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`** per_title_encoding: Gumlet analyzes each input video on a wide range of visual aspects. Based on the analysis, it chooses a unique set of transcoding options for processing the video. This ensures that the output video is of optimal size and best quality. **Default: `true`** process_low_resolution_input: Currently, the minimum supported frame size is `57600` (`240x240`) pixels for `HLS/DASH` and `21025` (`145x145`) pixels for `MP4` format. However, enabling this flag will allow Gumlet to simply put your video asset into the specified delivery format without transcoding and optimization. Enabling this flag will cause any kind of specified video transformation to be ignored if you input video asset frame size is lower than the minimum supported frame size for the specified format. **Default: `false`** audio_only: This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case,This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`** - enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs. + enable_drm: Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs. vc: Video Codecs generate_chapters: Whether Gumlet should generate chapters. generate_description: Whether Gumlet should generate descriptions. diff --git a/src/gumlet/resources/video_usage_analytics.py b/src/gumlet/resources/video_usage_analytics.py index ef54cbb..f579aea 100644 --- a/src/gumlet/resources/video_usage_analytics.py +++ b/src/gumlet/resources/video_usage_analytics.py @@ -64,7 +64,7 @@ def retrieve( This endpoint gives usage analytics data of your videos. Ex - top assets, bandwidth consumption Args: - metrics: Define the metric you need the data for, currently we only support `bandwidth_consumption`, `asset_duration`, `storage_unit`, `top_assets`, `bandwidth_consumption_by_collection`, `errored_videos` and `widget_data` + metrics: Define the metric you need the data for. Currently we only support `bandwidth_consumption`, `asset_duration`, `storage_unit`, `top_assets`, `bandwidth_consumption_by_collection`, `errored_videos` and `widget_data` date_range: The timeframe to get the data for. Currently we only support a maximum of 60 days between `start_at` and `end_at`. filters: Body parameter. top_assets_count: Count of video assets that should be returned. Max assets count is 1000 per page. @@ -211,7 +211,7 @@ async def retrieve( This endpoint gives usage analytics data of your videos. Ex - top assets, bandwidth consumption Args: - metrics: Define the metric you need the data for, currently we only support `bandwidth_consumption`, `asset_duration`, `storage_unit`, `top_assets`, `bandwidth_consumption_by_collection`, `errored_videos` and `widget_data` + metrics: Define the metric you need the data for. Currently we only support `bandwidth_consumption`, `asset_duration`, `storage_unit`, `top_assets`, `bandwidth_consumption_by_collection`, `errored_videos` and `widget_data` date_range: The timeframe to get the data for. Currently we only support a maximum of 60 days between `start_at` and `end_at`. filters: Body parameter. top_assets_count: Count of video assets that should be returned. Max assets count is 1000 per page. diff --git a/src/gumlet/types/audio_upload_complete_params.py b/src/gumlet/types/audio_upload_complete_params.py index 3b8cc1b..1913b9a 100644 --- a/src/gumlet/types/audio_upload_complete_params.py +++ b/src/gumlet/types/audio_upload_complete_params.py @@ -14,7 +14,7 @@ class AudioUploadCompleteParams(TypedDict, total=False): class UploadResponse(TypedDict, total=False): language_code: str - """Language Code for uploaded audio file.""" + """Language code for uploaded audio file.""" uploaded: bool """Status of language uploaded audio file. (If status code was 200, You can mark true else false)""" diff --git a/src/gumlet/types/audio_upload_upload_params.py b/src/gumlet/types/audio_upload_upload_params.py index a283e29..c6b13f3 100644 --- a/src/gumlet/types/audio_upload_upload_params.py +++ b/src/gumlet/types/audio_upload_upload_params.py @@ -10,4 +10,4 @@ class AudioUploadUploadParams(TypedDict, total=False): language_codes: SequenceNotStr[str] - """List of language Code to upload audio file (use ISO 639-1 Language Codes)""" + """List of language codes to upload audio file (use ISO 639-1 Language Codes)""" diff --git a/src/gumlet/types/image_usage_analytic_retrieve_params.py b/src/gumlet/types/image_usage_analytic_retrieve_params.py index fb6abda..c7a212d 100644 --- a/src/gumlet/types/image_usage_analytic_retrieve_params.py +++ b/src/gumlet/types/image_usage_analytic_retrieve_params.py @@ -33,7 +33,7 @@ class ImageUsageAnalyticRetrieveParams(TypedDict, total=False): ] ] ] - """Define the metric you need the data for, currently we support "bandwidth_consumption", "requests_count","status_4xx","status_5xx","avg_response_time"\"""" + """Define the metric you need the data for. Currently we support `bandwidth_consumption`, `requests_count`, `status_4xx`, `status_5xx`, and `avg_response_time`.""" date_range: Required[DateRange] """The timeframe to get the data for. Currently we only support a maximum of 30 days between `start_at` and `end_at`.""" diff --git a/src/gumlet/types/live_stream_asset_create_params.py b/src/gumlet/types/live_stream_asset_create_params.py index 7ae3403..f0dd1c3 100644 --- a/src/gumlet/types/live_stream_asset_create_params.py +++ b/src/gumlet/types/live_stream_asset_create_params.py @@ -16,7 +16,7 @@ class LiveStreamAssetCreateParams(TypedDict, total=False): """Gumlet live video source/collection id.""" resolution: Required[str] - """Required resolutions in HLS delivery format for live stream. Can be an array of string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Re-sized rendition will retain the input aspect ratio.""" + """Required resolutions in HLS delivery format for live stream. Can be an array of string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Resized rendition will retain the input aspect ratio.""" title: str """Your live stream asset title""" diff --git a/src/gumlet/types/subtitle_upload_complete_params.py b/src/gumlet/types/subtitle_upload_complete_params.py index 96bea43..cf9cdb6 100644 --- a/src/gumlet/types/subtitle_upload_complete_params.py +++ b/src/gumlet/types/subtitle_upload_complete_params.py @@ -14,7 +14,7 @@ class SubtitleUploadCompleteParams(TypedDict, total=False): class UploadResponse(TypedDict, total=False): language_code: str - """Language Code for uploaded .srt or .vtt file.""" + """Language code for uploaded .srt or .vtt file.""" uploaded: bool """Status of language uploaded .srt or .vtt file. (If status code was 200, You can mark true else false)""" diff --git a/src/gumlet/types/subtitle_upload_upload_params.py b/src/gumlet/types/subtitle_upload_upload_params.py index 01d5bd3..e37fa45 100644 --- a/src/gumlet/types/subtitle_upload_upload_params.py +++ b/src/gumlet/types/subtitle_upload_upload_params.py @@ -10,4 +10,4 @@ class SubtitleUploadUploadParams(TypedDict, total=False): language_codes: SequenceNotStr[str] - """List of language Code to upload subtitle file (use ISO 639-1 Language Codes)""" + """List of language codes to upload subtitle file (use ISO 639-1 Language Codes)""" diff --git a/src/gumlet/types/video_analytic_chart_data_params.py b/src/gumlet/types/video_analytic_chart_data_params.py index 1053c9e..47da87d 100644 --- a/src/gumlet/types/video_analytic_chart_data_params.py +++ b/src/gumlet/types/video_analytic_chart_data_params.py @@ -32,7 +32,7 @@ class VideoAnalyticChartDataParams(TypedDict, total=False): """Data can be grouped by `daily`, `weekly` or `monthly`.""" chart_dimension: ChartDimension - """Metrics result Group by selected dimension, You can select upto 3 dimensions to get nested category result. result will follow selection orders.""" + """Group metrics by the selected dimension. You can select up to 3 dimensions for nested category results; results follow the selection order.""" class ChartDimensionGroupBy(TypedDict, total=False): diff --git a/src/gumlet/types/video_asset_create_params.py b/src/gumlet/types/video_asset_create_params.py index 567f98b..c7a687a 100644 --- a/src/gumlet/types/video_asset_create_params.py +++ b/src/gumlet/types/video_asset_create_params.py @@ -28,7 +28,7 @@ class VideoAssetCreateParams(TypedDict, total=False): """Provide `profile_id` of the previously created video profile. This parameter will override all the parameters (except `input` and `collection_id`) from the video profile.""" format: Required[Literal["ABR", "MP4"]] - """Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and`MP4`.""" + """Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`.""" tag: SequenceNotStr[str] """Specify a text string or identifier which can identify an asset or bunch of assets later.""" @@ -49,7 +49,7 @@ class VideoAssetCreateParams(TypedDict, total=False): """Resize video with the given height. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset height will be ignored. Applicable only when specified format is `MP4`.""" resolution: str - """Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Re-sized rendition will retain the input aspect ratio.""" + """Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma-separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Resized rendition will retain the input aspect ratio.""" crop: Crop """This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video.""" @@ -73,7 +73,7 @@ class VideoAssetCreateParams(TypedDict, total=False): """Add additional Audio / Subtitle tracks to Gumlet for transcoding and delivery along with video asset track.""" generate_subtitles: GenerateSubtitles - """Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes)""" + """Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes)""" mp4_access: bool """Creates `MP4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`**""" @@ -88,10 +88,10 @@ class VideoAssetCreateParams(TypedDict, total=False): """This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`**""" enable_drm: bool - """Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs.""" + """Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs.""" call_to_actions: Iterable[CallToAction] - """CTA, is an explicit prompt within the video content encouraging viewers to take a particular action.""" + """A CTA is an explicit prompt within the video content encouraging viewers to take a particular action.""" playlist_id: str """Add this asset to a playlist.""" @@ -166,13 +166,13 @@ class AnimatedGif(TypedDict, total=False): class TextOverlay(TypedDict, total=False): text: Required[str] - """Text to be overlayed on video.""" + """Text to be overlaid on video.""" horizontal_align: str - """This parameter specifies the horizontal alignment of the overlayed image and can be either `left` or `right`. **Default: `right`**""" + """This parameter specifies the horizontal alignment of the overlaid text and can be either `left` or `right`. **Default: `right`**""" vertical_align: str - """This parameter specifies the vertical alignment of the overlayed image and can be either `top` or `bottom`. **Default: `bottom`**""" + """This parameter specifies the vertical alignment of the overlaid text and can be either `top` or `bottom`. **Default: `bottom`**""" horizontal_margin: str """This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels relative to the video width. **Default: `0`**""" @@ -193,7 +193,7 @@ class TextOverlay(TypedDict, total=False): """Overlay text opacity can be specified with opacity parameter where value can be between `0` and `100` where `0` is considered completely transparent and `100` is considered completely opaque. **Default: `100`**""" box: bool - """This parameter allows rectangular drawing a box over the overlayed text. **Default: `false`**""" + """This parameter allows drawing a rectangular box over the overlaid text. **Default: `false`**""" box_color: str """Box color can be specified with this parameter. **Default: `white`**""" @@ -207,7 +207,7 @@ class TextOverlay(TypedDict, total=False): class ImageOverlay(TypedDict, total=False): url: Required[str] - """This is the required parameter for image overlay, it can be a URL to an image that needs to be overlayed.""" + """This is the required parameter for image overlay; it can be a URL to an image that needs to be overlaid.""" horizontal_margin: str """This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**""" @@ -216,16 +216,16 @@ class ImageOverlay(TypedDict, total=False): """This parameter defines the vertical coordinate value of the corner (determined by `vertical_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**""" horizontal_align: str - """This parameter specifies the horizontal alignment of the overlayed image and can be either `left` or `right`. **Default: `right`**""" + """This parameter specifies the horizontal alignment of the overlaid image and can be either `left` or `right`. **Default: `right`**""" vertical_align: str - """This parameter specifies the vertical alignment of the overlayed image and can be either `top` or `bottom`. **Default: `bottom`**""" + """This parameter specifies the vertical alignment of the overlaid image and can be either `top` or `bottom`. **Default: `bottom`**""" width: str - """Width of the overlayed image. **Default: `image width`**""" + """Width of the overlaid image. **Default: `image width`**""" height: str - """Height of the overlayed image. **Default: `image height`**""" + """Height of the overlaid image. **Default: `image height`**""" class Trim(TypedDict, total=False): diff --git a/src/gumlet/types/video_asset_retrieve_details_response.py b/src/gumlet/types/video_asset_retrieve_details_response.py index 3df0d58..c0517e1 100644 --- a/src/gumlet/types/video_asset_retrieve_details_response.py +++ b/src/gumlet/types/video_asset_retrieve_details_response.py @@ -246,10 +246,6 @@ class VideoAssetRetrieveDetailsResponse(BaseModel): tag: Optional[List[str]] = None - source_id: Optional[str] = None - - collection_id: Optional[str] = None - input: Optional[Input] = None output: Optional[Output] = None @@ -264,9 +260,6 @@ class VideoAssetRetrieveDetailsResponse(BaseModel): thumbnail_updated_at: Optional[int] = None """Thumbnail updated timestamp in milliseconds since epoch""" - collection_updated_at: int - """Collection updated timestamp in milliseconds since epoch""" - warning: Optional[List[Warning]] = None audio_only: Optional[bool] = FieldInfo(alias="audioOnly", default=None) @@ -278,3 +271,9 @@ class VideoAssetRetrieveDetailsResponse(BaseModel): """Access control""" access_controls: Optional[AccessControls] = None + + workspace_updated_at: int + """Collection updated timestamp in milliseconds since epoch""" + + workspace_id: Optional[str] = None + """Workspace ID""" diff --git a/src/gumlet/types/video_asset_update_params.py b/src/gumlet/types/video_asset_update_params.py index 3d8feaa..1fd2b0c 100644 --- a/src/gumlet/types/video_asset_update_params.py +++ b/src/gumlet/types/video_asset_update_params.py @@ -20,10 +20,10 @@ class VideoAssetUpdateParams(TypedDict, total=False): """Attach some textual data with the asset. This field is neither searchable nor filterable.""" tag: str - """Specify a text string or identifier which can identify an asset or bunch of assets later. You can pass multiple comma separated values.""" + """Specify a text string or identifier which can identify an asset or bunch of assets later. You can pass multiple comma-separated values.""" call_to_actions: Iterable[CallToAction] - """CTA, is an explicit prompt within the video content encouraging viewers to take a particular action.""" + """A CTA is an explicit prompt within the video content encouraging viewers to take a particular action.""" metadata: str """Set of key-value pairs that you can attach to this Asset. This can be useful for storing additional information.
Example:
{ "internal_video_id" : "123Abc" } """ diff --git a/src/gumlet/types/video_asset_upload_params.py b/src/gumlet/types/video_asset_upload_params.py index e3faedf..286c1b2 100644 --- a/src/gumlet/types/video_asset_upload_params.py +++ b/src/gumlet/types/video_asset_upload_params.py @@ -28,7 +28,7 @@ class VideoAssetUploadParams(TypedDict, total=False): """Provide `profile_id` of the previously created video profile. This parameter will override all the parameters (except `input` and `collection_id`) from the video profile.""" format: Literal["ABR", "MP4"] - """Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and`MP4`.""" + """Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`.""" tag: SequenceNotStr[str] """Specify a text string or identifier which can identify an asset or bunch of assets later.""" @@ -49,7 +49,7 @@ class VideoAssetUploadParams(TypedDict, total=False): """Resize video with the given height. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset height will be ignored. Applicable only when specified format is `MP4`.""" resolution: str - """Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Re-sized rendition will retain the input aspect ratio.""" + """Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma-separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Resized rendition will retain the input aspect ratio.""" crop: Crop """This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video.""" @@ -73,7 +73,7 @@ class VideoAssetUploadParams(TypedDict, total=False): """Add additional Audio / Subtitle tracks to Gumlet for transcoding and delivery along with video asset track.""" generate_subtitles: GenerateSubtitles - """Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes)""" + """Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes)""" mp4_access: bool """Creates `MP4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`**""" @@ -88,10 +88,10 @@ class VideoAssetUploadParams(TypedDict, total=False): """This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`**""" enable_drm: bool - """Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs.""" + """Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs.""" call_to_actions: Iterable[CallToAction] - """CTA, is an explicit prompt within the video content encouraging viewers to take a particular action.""" + """A CTA is an explicit prompt within the video content encouraging viewers to take a particular action.""" playlist_id: str """Add this asset to a playlist.""" @@ -163,13 +163,13 @@ class AnimatedGif(TypedDict, total=False): class TextOverlay(TypedDict, total=False): text: Required[str] - """Text to be overlayed on video.""" + """Text to be overlaid on video.""" horizontal_align: str - """This parameter specifies the horizontal alignment of the overlayed image and can be either `left` or `right`. **Default: `right`**""" + """This parameter specifies the horizontal alignment of the overlaid text and can be either `left` or `right`. **Default: `right`**""" vertical_align: str - """This parameter specifies the vertical alignment of the overlayed image and can be either `top` or `bottom`. **Default: `bottom`**""" + """This parameter specifies the vertical alignment of the overlaid text and can be either `top` or `bottom`. **Default: `bottom`**""" horizontal_margin: str """This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels relative to the video width. **Default: `0`**""" @@ -190,7 +190,7 @@ class TextOverlay(TypedDict, total=False): """Overlay text opacity can be specified with opacity parameter where value can be between `0` and `100` where `0` is considered completely transparent and `100` is considered completely opaque. **Default: `100`**""" box: bool - """This parameter allows rectangular drawing a box over the overlayed text. **Default: `false`**""" + """This parameter allows drawing a rectangular box over the overlaid text. **Default: `false`**""" box_color: str """Box color can be specified with this parameter. **Default: `white`**""" @@ -204,7 +204,7 @@ class TextOverlay(TypedDict, total=False): class ImageOverlay(TypedDict, total=False): url: Required[str] - """This is the required parameter for image overlay, it can be a URL to an image that needs to be overlayed.""" + """This is the required parameter for image overlay; it can be a URL to an image that needs to be overlaid.""" horizontal_margin: str """This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**""" @@ -213,16 +213,16 @@ class ImageOverlay(TypedDict, total=False): """This parameter defines the vertical coordinate value of the corner (determined by `vertical_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**""" horizontal_align: str - """This parameter specifies the horizontal alignment of the overlayed image and can be either `left` or `right`. **Default: `right`**""" + """This parameter specifies the horizontal alignment of the overlaid image and can be either `left` or `right`. **Default: `right`**""" vertical_align: str - """This parameter specifies the vertical alignment of the overlayed image and can be either `top` or `bottom`. **Default: `bottom`**""" + """This parameter specifies the vertical alignment of the overlaid image and can be either `top` or `bottom`. **Default: `bottom`**""" width: str - """Width of the overlayed image. **Default: `image width`**""" + """Width of the overlaid image. **Default: `image width`**""" height: str - """Height of the overlayed image. **Default: `image height`**""" + """Height of the overlaid image. **Default: `image height`**""" class Trim(TypedDict, total=False): diff --git a/src/gumlet/types/video_playlist_list_assets_params.py b/src/gumlet/types/video_playlist_list_assets_params.py index 3de983a..750ffad 100644 --- a/src/gumlet/types/video_playlist_list_assets_params.py +++ b/src/gumlet/types/video_playlist_list_assets_params.py @@ -15,7 +15,7 @@ class VideoPlaylistListAssetsParams(TypedDict, total=False): """-1 or 1""" page_number: int - """Optional, Minimun 1""" + """Optional. Minimum: 1""" page_size: str - """Optional, Minimun 10""" + """Optional. Minimum: 10""" diff --git a/src/gumlet/types/video_profile_create_params.py b/src/gumlet/types/video_profile_create_params.py index a8d876b..bf17c58 100644 --- a/src/gumlet/types/video_profile_create_params.py +++ b/src/gumlet/types/video_profile_create_params.py @@ -30,7 +30,7 @@ class VideoProfileCreateParams(TypedDict, total=False): """Resize video with the given height. Can be an absolute value in pixels or a percentage value with the `%` suffix. Specified values greater than the original asset height will be ignored. Only applicable when specified `format` is `MP4`.""" resolution: str - """Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p `. Re-sized rendition will retain the input aspect ratio.""" + """Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma-separated string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p `. Resized rendition will retain the input aspect ratio.""" crop: Crop """This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video.""" @@ -51,7 +51,7 @@ class VideoProfileCreateParams(TypedDict, total=False): """Create an animated GIF from a video.""" generate_subtitles: GenerateSubtitles - """Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes). Remove this object if you do not want to generate AI subtitles.""" + """Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes). Remove this object if you do not want to generate AI subtitles.""" mp4_access: bool """Creates `mp4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`**""" @@ -66,7 +66,7 @@ class VideoProfileCreateParams(TypedDict, total=False): """This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case,This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`**""" enable_drm: bool - """Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs.""" + """Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs.""" class GenerateSubtitles(TypedDict, total=False): @@ -96,13 +96,13 @@ class AnimatedGif(TypedDict, total=False): class TextOverlay(TypedDict, total=False): text: Required[str] - """Text to be overlayed on video.""" + """Text to be overlaid on video.""" horizontal_align: str - """This parameter specifies the horizontal alignment of the overlayed image and can be either `left` or `right`. **Default: `right`**""" + """This parameter specifies the horizontal alignment of the overlaid text and can be either `left` or `right`. **Default: `right`**""" vertical_align: str - """This parameter specifies the vertical alignment of the overlayed image and can be either `top` or `bottom`. **Default: `bottom`**""" + """This parameter specifies the vertical alignment of the overlaid text and can be either `top` or `bottom`. **Default: `bottom`**""" horizontal_margin: str """This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels relative to the video width. **Default: `0`**""" @@ -123,7 +123,7 @@ class TextOverlay(TypedDict, total=False): """Overlay text opacity can be specified with opacity parameter where value can be between `0` and `100` where `0` is considered completely transparent and `100` is considered completely opaque. **Default: `100`**""" box: bool - """This parameter allows rectangular drawing a box over the overlayed text. **Default: `false`**""" + """This parameter allows drawing a rectangular box over the overlaid text. **Default: `false`**""" box_color: str """Box color can be specified with this parameter. **Default: `white`**""" @@ -137,7 +137,7 @@ class TextOverlay(TypedDict, total=False): class ImageOverlay(TypedDict, total=False): url: Required[str] - """This is the required parameter for image overlay, it can be a URL to an image that needs to be overlayed.""" + """This is the required parameter for image overlay; it can be a URL to an image that needs to be overlaid.""" horizontal_margin: str """This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**""" @@ -146,16 +146,16 @@ class ImageOverlay(TypedDict, total=False): """This parameter defines the vertical coordinate value of the corner (determined by `vertical_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**""" horizontal_align: str - """This parameter specifies the horizontal alignment of the overlayed image and can be either `left` or `right`. **Default: `right`**""" + """This parameter specifies the horizontal alignment of the overlaid image and can be either `left` or `right`. **Default: `right`**""" vertical_align: str - """This parameter specifies the vertical alignment of the overlayed image and can be either `top` or `bottom`. **Default: `bottom`**""" + """This parameter specifies the vertical alignment of the overlaid image and can be either `top` or `bottom`. **Default: `bottom`**""" width: str - """Width of the overlayed image. **Default: `image width`**""" + """Width of the overlaid image. **Default: `image width`**""" height: str - """Height of the overlayed image. **Default: `image height`**""" + """Height of the overlaid image. **Default: `image height`**""" class Trim(TypedDict, total=False): diff --git a/src/gumlet/types/video_profile_update_params.py b/src/gumlet/types/video_profile_update_params.py index 2483e57..d310b92 100644 --- a/src/gumlet/types/video_profile_update_params.py +++ b/src/gumlet/types/video_profile_update_params.py @@ -57,7 +57,7 @@ class VideoProfileUpdateParams(TypedDict, total=False): """Create an animated GIF from a video.""" generate_subtitles: GenerateSubtitles - """Gumlet allows to generate subtitles from the audio stream (use ISO 639-1 Language Codes). You can remove this object if don't want to generate AI subtitles.""" + """Gumlet allows you to generate subtitles from the audio stream (use ISO 639-1 Language Codes). You can remove this object if you don't want to generate AI subtitles.""" mp4_access: bool """Creates `mp4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`**""" @@ -72,7 +72,7 @@ class VideoProfileUpdateParams(TypedDict, total=False): """This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case,This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. **Default: `false`**""" enable_drm: bool - """Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs.""" + """Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs.""" vc: SequenceNotStr[str] """Video Codecs""" @@ -111,13 +111,13 @@ class AnimatedGif(TypedDict, total=False): class TextOverlay(TypedDict, total=False): text: Required[str] - """Text to be overlayed on video.""" + """Text to be overlaid on video.""" horizontal_align: str - """This parameter specifies the horizontal alignment of the overlayed image and can be either `left` or `right`. **Default: `right`**""" + """This parameter specifies the horizontal alignment of the overlaid text and can be either `left` or `right`. **Default: `right`**""" vertical_align: str - """This parameter specifies the vertical alignment of the overlayed image and can be either `top` or `bottom`. **Default: `bottom`**""" + """This parameter specifies the vertical alignment of the overlaid text and can be either `top` or `bottom`. **Default: `bottom`**""" horizontal_margin: str """This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels relative to the video width. **Default: `0`**""" @@ -138,7 +138,7 @@ class TextOverlay(TypedDict, total=False): """Overlay text opacity can be specified with opacity parameter where value can be between `0` and `100` where `0` is considered completely transparent and `100` is considered completely opaque. **Default: `100`**""" box: bool - """This parameter allows rectangular drawing a box over the overlayed text. **Default: `false`**""" + """This parameter allows drawing a rectangular box over the overlaid text. **Default: `false`**""" box_color: str """Box color can be specified with this parameter. **Default: `white`**""" @@ -152,7 +152,7 @@ class TextOverlay(TypedDict, total=False): class ImageOverlay(TypedDict, total=False): url: Required[str] - """This is the required parameter for image overlay, it can be a URL to an image that needs to be overlayed.""" + """This is the required parameter for image overlay; it can be a URL to an image that needs to be overlaid.""" horizontal_margin: str """This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**""" @@ -161,16 +161,16 @@ class ImageOverlay(TypedDict, total=False): """This parameter defines the vertical coordinate value of the corner (determined by `vertical_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**""" horizontal_align: str - """This parameter specifies the horizontal alignment of the overlayed image and can be either `left` or `right`. **Default: `right`**""" + """This parameter specifies the horizontal alignment of the overlaid image and can be either `left` or `right`. **Default: `right`**""" vertical_align: str - """This parameter specifies the vertical alignment of the overlayed image and can be either `top` or `bottom`. **Default: `bottom`**""" + """This parameter specifies the vertical alignment of the overlaid image and can be either `top` or `bottom`. **Default: `bottom`**""" width: str - """Width of the overlayed image. **Default: `image width`**""" + """Width of the overlaid image. **Default: `image width`**""" height: str - """Height of the overlayed image. **Default: `image height`**""" + """Height of the overlaid image. **Default: `image height`**""" class Trim(TypedDict, total=False): diff --git a/src/gumlet/types/video_usage_analytic_retrieve_params.py b/src/gumlet/types/video_usage_analytic_retrieve_params.py index 903a2dd..15f007e 100644 --- a/src/gumlet/types/video_usage_analytic_retrieve_params.py +++ b/src/gumlet/types/video_usage_analytic_retrieve_params.py @@ -25,7 +25,7 @@ class VideoUsageAnalyticRetrieveParams(TypedDict, total=False): ] ] ] - """Define the metric you need the data for, currently we only support `bandwidth_consumption`, `asset_duration`, `storage_unit`, `top_assets`, `bandwidth_consumption_by_collection`, `errored_videos` and `widget_data`""" + """Define the metric you need the data for. Currently we only support `bandwidth_consumption`, `asset_duration`, `storage_unit`, `top_assets`, `bandwidth_consumption_by_collection`, `errored_videos` and `widget_data`""" date_range: Required[DateRange] """The timeframe to get the data for. Currently we only support a maximum of 60 days between `start_at` and `end_at`.""" diff --git a/src/gumlet/types/video_workspace_retrieve_response.py b/src/gumlet/types/video_workspace_retrieve_response.py index feccc72..45e5004 100644 --- a/src/gumlet/types/video_workspace_retrieve_response.py +++ b/src/gumlet/types/video_workspace_retrieve_response.py @@ -164,7 +164,7 @@ class PlayerConfig(BaseModel): """Enable / disable playback from last viewed position. `true` means the playback will resume from last position.""" cc_color: Optional[str] = None - """Closed captions / subtitle color.""" + """Closed captions / subtitle color.""" cc_bg_color: Optional[str] = None """Closed captions / subtitle background color."""