gcore 0.13.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

gcore/types/streaming/create_video_param.py

@@ -12,7 +12,9 @@ class CreateVideoParam(TypedDict, total=False):
     """Video name"""
 
     auto_transcribe_audio_language: Literal["disable", "auto", "<language_code>"]
-    """Automatic creation of subtitles by transcribing the audio track. Values:
+    """Automatic creation of subtitles by transcribing the audio track.
+
+    Values:
 
     - disable – Do not transcribe.
     - auto – Automatically detects the activation of the option based on the
@@ -22,7 +24,9 @@ class CreateVideoParam(TypedDict, total=False):
       language spoken in the audio track, or when auto language detection fails.
       Language is set by 3-letter language code according to ISO-639-2
       (bibliographic code). List of languages is available in `audio_language`
-      attribute of API POST /streaming/ai/transcribe . Example:
+      attribute of API POST /streaming/ai/transcribe .
+
+    Example:
 
     ```
     auto_transcribe_audio_language: "auto"
@@ -41,16 +45,23 @@ class CreateVideoParam(TypedDict, total=False):
     """Automatic translation of auto-transcribed subtitles to the specified
     language(s).
 
-    Can be used both together with `auto_transcribe_audio_language` option only. Use
-    it when you want to make automatic subtitles in languages other than the
-    original language in audio. Values:
+    Can be used both together with `auto_transcribe_audio_language` option only.
+
+    Use it when you want to make automatic subtitles in languages other than the
+    original language in audio.
+
+    Values:
 
     - disable – Do not translate.
     - default – There are 3 default languages: eng,fre,ger
     - \\  – Explicit language to translate to, or list of languages separated by a
       comma. Look at list of available languages in description of AI ASR task
-      creation. If several languages are specified for translation, a separate
-      subtitle will be generated for each language. Example:
+      creation.
+
+    If several languages are specified for translation, a separate subtitle will be
+    generated for each language.
+
+    Example:
 
     ```
     auto_translate_subtitles_language: default
@@ -79,9 +90,10 @@ class CreateVideoParam(TypedDict, total=False):
     """
 
     custom_iframe_url: str
-    """
-    Deprecated. Custom URL of IFrame for video player to be used in share panel in
-    player. Auto generated IFrame URL provided by default
+    """Deprecated.
+
+    Custom URL of IFrame for video player to be used in share panel in player. Auto
+    generated IFrame URL provided by default
     """
 
     description: str
@@ -94,8 +106,11 @@ class CreateVideoParam(TypedDict, total=False):
     """Authorization HTTP request header.
 
     Will be used as credentials to authenticate a request to download a file
-    (specified in "`origin_url`" parameter) on an external server. Syntax:
-    `Authorization: <auth-scheme> <authorization-parameters>` Examples:
+    (specified in "`origin_url`" parameter) on an external server.
+
+    Syntax: `Authorization: <auth-scheme> <authorization-parameters>`
+
+    Examples:
 
     - "`origin_http_headers`": "Authorization: Basic ..."
     - "`origin_http_headers`": "Authorization: Bearer ..."
@@ -121,16 +136,21 @@ class CreateVideoParam(TypedDict, total=False):
     """
 
     poster: str
-    """
-    Poster is your own static image which can be displayed before the video starts.
+    """Poster is your own static image which can be displayed before the video starts.
+
     After uploading the video, the system will automatically create several
     screenshots (they will be stored in "screenshots" attribute) from which you can
     select an default screenshot. This "poster" field is for uploading your own
     image. Also use attribute "`screenshot_id`" to select poster as a default
-    screnshot. Attribute accepts single image as base64-encoded string
+    screnshot.
+
+    Attribute accepts single image as base64-encoded string
     [(RFC 2397 – The "data" URL scheme)](https://www.rfc-editor.org/rfc/rfc2397). In
-    format: `data:[<mediatype>];base64,<data>` MIME-types are image/jpeg,
-    image/webp, and image/png and file sizes up to 1Mb. Examples:
+    format: `data:[<mediatype>];base64,<data>`
+
+    MIME-types are image/jpeg, image/webp, and image/png and file sizes up to 1Mb.
+
+    Examples:
 
     - `data:image/jpeg;base64,/9j/4AA...qf/2Q==`
     - `data:image/png;base64,iVBORw0KGg...ggg==`
@@ -141,13 +161,16 @@ class CreateVideoParam(TypedDict, total=False):
     """
     Priority allows you to adjust the urgency of processing some videos before
     others in your account, if your algorithm requires it. For example, when there
-    are very urgent video and some regular ones that can wait in the queue. Value
-    range, integer [-10..10]. -10 is the lowest down-priority, 10 is the highest
-    up-priority. Default priority is 0.
+    are very urgent video and some regular ones that can wait in the queue.
+
+    Value range, integer [-10..10]. -10 is the lowest down-priority, 10 is the
+    highest up-priority. Default priority is 0.
     """
 
     projection: str
-    """Deprecated. Regulates the video format:
+    """Deprecated.
+
+    Regulates the video format:
 
     - **regular** — plays the video as usual
     - **vr360** — plays the video in 360 degree mode
@@ -166,28 +189,34 @@ class CreateVideoParam(TypedDict, total=False):
     remote_poster_url: str
     """
     Poster URL to download from external resource, instead of uploading via "poster"
-    attribute. It has the same restrictions as "poster" attribute.
+    attribute.
+
+    It has the same restrictions as "poster" attribute.
     """
 
     remove_poster: bool
     """Set it to true to remove poster"""
 
     screenshot_id: int
-    """
-    Default screenshot index. Specify an ID from the "screenshots" array, so that
-    the URL of the required screenshot appears in the "screenshot" attribute as the
-    default screenshot. By default 5 static screenshots will be taken from different
-    places in the video after transcoding. If the video is short, there may be fewer
-    screenshots. Counting from 0. A value of -1 sets the default screenshot to the
-    URL of your own image from the "poster" attribute. Look at "screenshot"
-    attribute in GET /videos/{`video_id`} for details.
+    """Default screenshot index.
+
+    Specify an ID from the "screenshots" array, so that the URL of the required
+    screenshot appears in the "screenshot" attribute as the default screenshot. By
+    default 5 static screenshots will be taken from different places in the video
+    after transcoding. If the video is short, there may be fewer screenshots.
+
+    Counting from 0. A value of -1 sets the default screenshot to the URL of your
+    own image from the "poster" attribute.
+
+    Look at "screenshot" attribute in GET /videos/{`video_id`} for details.
     """
 
     share_url: str
-    """
-    Deprecated. Custom URL or iframe displayed in the link field when a user clicks
-    on a sharing button in player. If empty, the link field and social network
-    sharing is disabled
+    """Deprecated.
+
+    Custom URL or iframe displayed in the link field when a user clicks on a sharing
+    button in player. If empty, the link field and social network sharing is
+    disabled
     """
 
     source_bitrate_limit: bool
@@ -200,16 +229,19 @@ class CreateVideoParam(TypedDict, total=False):
     By default `source_bitrate_limit: true` this option allows you to have the
     output bitrate not more than in the original video, thus to transcode video
     faster and to deliver it to end-viewers faster as well. At the same time, the
-    quality will be similar to the original. If for some reason you need more
-    byte-space in the output quality when encoding, you can set this option to
-    `source_bitrate_limit: false`. Then, when transcoding, the quality ceiling will
-    be raised from the bitrate of the original video to the maximum possible limit
-    specified in our the Product Documentation. For example, this may be needed
-    when:
+    quality will be similar to the original.
+
+    If for some reason you need more byte-space in the output quality when encoding,
+    you can set this option to `source_bitrate_limit: false`. Then, when
+    transcoding, the quality ceiling will be raised from the bitrate of the original
+    video to the maximum possible limit specified in our the Product Documentation.
+    For example, this may be needed when:
 
     - to improve the visual quality parameters using PSNR, SSIM, VMAF metrics,
     - to improve the picture quality on dynamic scenes,
-    - etc. The option is applied only at the video creation stage and cannot be
-      changed later. If you want to re-transcode the video using new value, then you
-      need to create and upload a new video only.
+    - etc.
+
+    The option is applied only at the video creation stage and cannot be changed
+    later. If you want to re-transcode the video using new value, then you need to
+    create and upload a new video only.
     """

gcore/types/streaming/playlist.py

@@ -64,9 +64,10 @@ class Playlist(BaseModel):
     """A URL to a built-in HTML video player with the video inside.
 
     It can be inserted into an iframe on your website and the video will
-    automatically play in all browsers. The player can be opened or shared via this
-    direct link. Also the video player can be integrated into your web pages using
-    the Iframe tag.
+    automatically play in all browsers.
+
+    The player can be opened or shared via this direct link. Also the video player
+    can be integrated into your web pages using the Iframe tag.
 
     Please see the details in `iframe_url` attribute of /videos/{id} method.
     """
@@ -97,6 +98,7 @@ class Playlist(BaseModel):
     video_ids: Optional[List[int]] = None
     """A list of VOD IDs included in the playlist.
 
-    Order of videos in a playlist reflects the order of IDs in the array. Maximum
-    video limit = 128.
+    Order of videos in a playlist reflects the order of IDs in the array.
+
+    Maximum video limit = 128.
     """

gcore/types/streaming/playlist_create_params.py

@@ -64,9 +64,10 @@ class PlaylistCreateParams(TypedDict, total=False):
     """A URL to a built-in HTML video player with the video inside.
 
     It can be inserted into an iframe on your website and the video will
-    automatically play in all browsers. The player can be opened or shared via this
-    direct link. Also the video player can be integrated into your web pages using
-    the Iframe tag.
+    automatically play in all browsers.
+
+    The player can be opened or shared via this direct link. Also the video player
+    can be integrated into your web pages using the Iframe tag.
 
     Please see the details in `iframe_url` attribute of /videos/{id} method.
     """
@@ -97,6 +98,7 @@ class PlaylistCreateParams(TypedDict, total=False):
     video_ids: Iterable[int]
     """A list of VOD IDs included in the playlist.
 
-    Order of videos in a playlist reflects the order of IDs in the array. Maximum
-    video limit = 128.
+    Order of videos in a playlist reflects the order of IDs in the array.
+
+    Maximum video limit = 128.
     """

gcore/types/streaming/playlist_update_params.py

@@ -64,9 +64,10 @@ class PlaylistUpdateParams(TypedDict, total=False):
     """A URL to a built-in HTML video player with the video inside.
 
     It can be inserted into an iframe on your website and the video will
-    automatically play in all browsers. The player can be opened or shared via this
-    direct link. Also the video player can be integrated into your web pages using
-    the Iframe tag.
+    automatically play in all browsers.
+
+    The player can be opened or shared via this direct link. Also the video player
+    can be integrated into your web pages using the Iframe tag.
 
     Please see the details in `iframe_url` attribute of /videos/{id} method.
     """
@@ -97,6 +98,7 @@ class PlaylistUpdateParams(TypedDict, total=False):
     video_ids: Iterable[int]
     """A list of VOD IDs included in the playlist.
 
-    Order of videos in a playlist reflects the order of IDs in the array. Maximum
-    video limit = 128.
+    Order of videos in a playlist reflects the order of IDs in the array.
+
+    Maximum video limit = 128.
     """

gcore/types/streaming/playlist_video.py

@@ -13,7 +13,9 @@ class PlaylistVideo(BaseModel):
     """Video name"""
 
     auto_transcribe_audio_language: Optional[Literal["disable", "auto", "<language_code>"]] = None
-    """Automatic creation of subtitles by transcribing the audio track. Values:
+    """Automatic creation of subtitles by transcribing the audio track.
+
+    Values:
 
     - disable – Do not transcribe.
     - auto – Automatically detects the activation of the option based on the
@@ -23,7 +25,9 @@ class PlaylistVideo(BaseModel):
       language spoken in the audio track, or when auto language detection fails.
       Language is set by 3-letter language code according to ISO-639-2
       (bibliographic code). List of languages is available in `audio_language`
-      attribute of API POST /streaming/ai/transcribe . Example:
+      attribute of API POST /streaming/ai/transcribe .
+
+    Example:
 
     ```
     auto_transcribe_audio_language: "auto"
@@ -42,16 +46,23 @@ class PlaylistVideo(BaseModel):
     """Automatic translation of auto-transcribed subtitles to the specified
     language(s).
 
-    Can be used both together with `auto_transcribe_audio_language` option only. Use
-    it when you want to make automatic subtitles in languages other than the
-    original language in audio. Values:
+    Can be used both together with `auto_transcribe_audio_language` option only.
+
+    Use it when you want to make automatic subtitles in languages other than the
+    original language in audio.
+
+    Values:
 
     - disable – Do not translate.
     - default – There are 3 default languages: eng,fre,ger
     - \\  – Explicit language to translate to, or list of languages separated by a
       comma. Look at list of available languages in description of AI ASR task
-      creation. If several languages are specified for translation, a separate
-      subtitle will be generated for each language. Example:
+      creation.
+
+    If several languages are specified for translation, a separate subtitle will be
+    generated for each language.
+
+    Example:
 
     ```
     auto_translate_subtitles_language: default
@@ -80,9 +91,10 @@ class PlaylistVideo(BaseModel):
     """
 
     custom_iframe_url: Optional[str] = None
-    """
-    Deprecated. Custom URL of IFrame for video player to be used in share panel in
-    player. Auto generated IFrame URL provided by default
+    """Deprecated.
+
+    Custom URL of IFrame for video player to be used in share panel in player. Auto
+    generated IFrame URL provided by default
     """
 
     description: Optional[str] = None
@@ -95,8 +107,11 @@ class PlaylistVideo(BaseModel):
     """Authorization HTTP request header.
 
     Will be used as credentials to authenticate a request to download a file
-    (specified in "`origin_url`" parameter) on an external server. Syntax:
-    `Authorization: <auth-scheme> <authorization-parameters>` Examples:
+    (specified in "`origin_url`" parameter) on an external server.
+
+    Syntax: `Authorization: <auth-scheme> <authorization-parameters>`
+
+    Examples:
 
     - "`origin_http_headers`": "Authorization: Basic ..."
     - "`origin_http_headers`": "Authorization: Bearer ..."
@@ -122,16 +137,21 @@ class PlaylistVideo(BaseModel):
     """
 
     poster: Optional[str] = None
-    """
-    Poster is your own static image which can be displayed before the video starts.
+    """Poster is your own static image which can be displayed before the video starts.
+
     After uploading the video, the system will automatically create several
     screenshots (they will be stored in "screenshots" attribute) from which you can
     select an default screenshot. This "poster" field is for uploading your own
     image. Also use attribute "`screenshot_id`" to select poster as a default
-    screnshot. Attribute accepts single image as base64-encoded string
+    screnshot.
+
+    Attribute accepts single image as base64-encoded string
     [(RFC 2397 – The "data" URL scheme)](https://www.rfc-editor.org/rfc/rfc2397). In
-    format: `data:[<mediatype>];base64,<data>` MIME-types are image/jpeg,
-    image/webp, and image/png and file sizes up to 1Mb. Examples:
+    format: `data:[<mediatype>];base64,<data>`
+
+    MIME-types are image/jpeg, image/webp, and image/png and file sizes up to 1Mb.
+
+    Examples:
 
     - `data:image/jpeg;base64,/9j/4AA...qf/2Q==`
     - `data:image/png;base64,iVBORw0KGg...ggg==`
@@ -142,13 +162,16 @@ class PlaylistVideo(BaseModel):
     """
     Priority allows you to adjust the urgency of processing some videos before
     others in your account, if your algorithm requires it. For example, when there
-    are very urgent video and some regular ones that can wait in the queue. Value
-    range, integer [-10..10]. -10 is the lowest down-priority, 10 is the highest
-    up-priority. Default priority is 0.
+    are very urgent video and some regular ones that can wait in the queue.
+
+    Value range, integer [-10..10]. -10 is the lowest down-priority, 10 is the
+    highest up-priority. Default priority is 0.
     """
 
     projection: Optional[str] = None
-    """Deprecated. Regulates the video format:
+    """Deprecated.
+
+    Regulates the video format:
 
     - **regular** — plays the video as usual
     - **vr360** — plays the video in 360 degree mode
@@ -167,28 +190,34 @@ class PlaylistVideo(BaseModel):
     remote_poster_url: Optional[str] = None
     """
     Poster URL to download from external resource, instead of uploading via "poster"
-    attribute. It has the same restrictions as "poster" attribute.
+    attribute.
+
+    It has the same restrictions as "poster" attribute.
     """
 
     remove_poster: Optional[bool] = None
     """Set it to true to remove poster"""
 
     screenshot_id: Optional[int] = None
-    """
-    Default screenshot index. Specify an ID from the "screenshots" array, so that
-    the URL of the required screenshot appears in the "screenshot" attribute as the
-    default screenshot. By default 5 static screenshots will be taken from different
-    places in the video after transcoding. If the video is short, there may be fewer
-    screenshots. Counting from 0. A value of -1 sets the default screenshot to the
-    URL of your own image from the "poster" attribute. Look at "screenshot"
-    attribute in GET /videos/{`video_id`} for details.
+    """Default screenshot index.
+
+    Specify an ID from the "screenshots" array, so that the URL of the required
+    screenshot appears in the "screenshot" attribute as the default screenshot. By
+    default 5 static screenshots will be taken from different places in the video
+    after transcoding. If the video is short, there may be fewer screenshots.
+
+    Counting from 0. A value of -1 sets the default screenshot to the URL of your
+    own image from the "poster" attribute.
+
+    Look at "screenshot" attribute in GET /videos/{`video_id`} for details.
     """
 
     share_url: Optional[str] = None
-    """
-    Deprecated. Custom URL or iframe displayed in the link field when a user clicks
-    on a sharing button in player. If empty, the link field and social network
-    sharing is disabled
+    """Deprecated.
+
+    Custom URL or iframe displayed in the link field when a user clicks on a sharing
+    button in player. If empty, the link field and social network sharing is
+    disabled
     """
 
     source_bitrate_limit: Optional[bool] = None
@@ -201,16 +230,19 @@ class PlaylistVideo(BaseModel):
     By default `source_bitrate_limit: true` this option allows you to have the
     output bitrate not more than in the original video, thus to transcode video
     faster and to deliver it to end-viewers faster as well. At the same time, the
-    quality will be similar to the original. If for some reason you need more
-    byte-space in the output quality when encoding, you can set this option to
-    `source_bitrate_limit: false`. Then, when transcoding, the quality ceiling will
-    be raised from the bitrate of the original video to the maximum possible limit
-    specified in our the Product Documentation. For example, this may be needed
-    when:
+    quality will be similar to the original.
+
+    If for some reason you need more byte-space in the output quality when encoding,
+    you can set this option to `source_bitrate_limit: false`. Then, when
+    transcoding, the quality ceiling will be raised from the bitrate of the original
+    video to the maximum possible limit specified in our the Product Documentation.
+    For example, this may be needed when:
 
     - to improve the visual quality parameters using PSNR, SSIM, VMAF metrics,
     - to improve the picture quality on dynamic scenes,
-    - etc. The option is applied only at the video creation stage and cannot be
-      changed later. If you want to re-transcode the video using new value, then you
-      need to create and upload a new video only.
+    - etc.
+
+    The option is applied only at the video creation stage and cannot be changed
+    later. If you want to re-transcode the video using new value, then you need to
+    create and upload a new video only.
     """

gcore/types/streaming/statistic_get_unique_viewers_cdn_params.py

@@ -17,10 +17,13 @@ class StatisticGetUniqueViewersCdnParams(TypedDict, total=False):
     id: str
     """Filter by entity's id.
 
-    Put ID of a Live stream, VOD or a playlist to be calculated. If the value is
-    omitted, then the calculation is done for all videos/streams of the specified
-    type. When using this "id" parameter, be sure to specify the "type" parameter
-    too. If you do not specify a type, the "id" will be ignored.
+    Put ID of a Live stream, VOD or a playlist to be calculated.
+
+    If the value is omitted, then the calculation is done for all videos/streams of
+    the specified type.
+
+    When using this "id" parameter, be sure to specify the "type" parameter too. If
+    you do not specify a type, the "id" will be ignored.
     """
 
     type: Literal["live", "vod", "playlist"]