gcore 0.6.0__py3-none-any.whl → 0.8.0__py3-none-any.whl

gcore/types/streaming/playlist_video.py

@@ -0,0 +1,215 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["PlaylistVideo"]
+
+
+class PlaylistVideo(BaseModel):
+    name: str
+    """Video name"""
+
+    auto_transcribe_audio_language: Optional[Literal["disable", "auto", "<language_code>"]] = None
+    """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
+      settings in your account. If generation is activated, then automatic language
+      detection while transcribing.
+    - \\  – Transcribe from specific language. Can be used to specify the exact
+      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:
+
+    ```
+    `auto_transcribe_audio_language`: "auto"
+    `auto_transcribe_audio_language`: "ger"
+    ```
+
+    More details:
+
+    - List of AI tasks – API
+      [GET /streaming/ai/tasks](https://api.gcore.com/docs/streaming/docs/api-reference/streaming/ai/get-ai-task-result)
+    - Add subtitles to an exist video – API
+      [POST /streaming/videos/{`video_id`}/subtitles](https://api.gcore.com/docs/streaming/docs/api-reference/streaming/subtitles/add-subtitle).
+    """
+
+    auto_translate_subtitles_language: Optional[Literal["disable", "default", "<language_codes,>"]] = None
+    """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:
+
+    - 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:
+
+    ```
+    `auto_translate_subtitles_language`: default
+    `auto_translate_subtitles_language`: eng,fre,ger
+    ```
+
+    Please note that subtitle translation is done separately and after
+    transcription. Thus separate AI-tasks are created for translation.
+    """
+
+    client_user_id: Optional[int] = None
+    """Custom field where you can specify user ID in your system"""
+
+    clip_duration_seconds: Optional[int] = None
+    """
+    The length of the trimmed segment to transcode, instead of the entire length of
+    the video. Is only used in conjunction with specifying the start of a segment.
+    Transcoding duration is a number in seconds.
+    """
+
+    clip_start_seconds: Optional[int] = None
+    """
+    If you want to transcode only a trimmed segment of a video instead of entire
+    length if the video, then you can provide timecodes of starting point and
+    duration of a segment to process. Start encoding from is a number in seconds.
+    """
+
+    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
+    """
+
+    description: Optional[str] = None
+    """Video details; not visible to the end-users"""
+
+    directory_id: Optional[int] = None
+    """ID of the directory where the video should be uploaded. (beta)"""
+
+    origin_http_headers: Optional[str] = None
+    """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: ` Examples:
+
+    - "`origin_http_headers`": "Authorization: Basic ..."
+    - "`origin_http_headers`": "Authorization: Bearer ..."
+    - "`origin_http_headers`": "Authorization: APIKey ..." Example of usage when
+      downloading a file from Google Drive:
+
+    ```
+    POST https://api.gcore.com/streaming/videos
+    "video": {
+    "name": "IBC 2024 intro.mp4",
+    "`origin_url`": "https://www.googleapis.com/drive/v3/files/...?alt=media",
+    "`origin_http_headers`": "Authorization: Bearer ABC"
+    }
+    ```
+    """
+
+    origin_url: Optional[str] = None
+    """
+    URL to an original file which you want to copy from external storage. If
+    specified, system will download the file and will use it as video source for
+    transcoding.
+    """
+
+    poster: Optional[str] = None
+    """
+    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
+    [(RFC 2397 – The "data" URL scheme)](https://www.rfc-editor.org/rfc/rfc2397). In
+    format: `data:[];base64,` 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==`
+    - `data:image/webp;base64,UklGRt.../DgAAAAA`
+    """
+
+    priority: Optional[int] = None
+    """
+    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.
+    """
+
+    projection: Optional[str] = None
+    """Deprecated. Regulates the video format:
+
+    - **regular** — plays the video as usual
+    - **vr360** — plays the video in 360 degree mode
+    - **vr180** — plays the video in 180 degree mode
+    - **vr360tb** — plays the video in 3D 360 degree mode Top-Bottom.
+
+    Default is regular
+    """
+
+    quality_set_id: Optional[int] = None
+    """
+    Custom quality set ID for transcoding, if transcoding is required according to
+    your conditions. Look at GET /`quality_sets` method
+    """
+
+    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.
+    """
+
+    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.
+    """
+
+    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
+    """
+
+    source_bitrate_limit: Optional[bool] = None
+    """
+    The option allows you to set the video transcoding rule so that the output
+    bitrate in ABR ladder is not exceeding the bitrate of the original video.
+
+    This option is for advanced users only.
+
+    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:
+
+    - 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.
+    """

gcore/types/streaming/popular_videos.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["PopularVideos", "Data"]
+
+
+class Data(BaseModel):
+    id: str
+
+    views: int
+
+
+class PopularVideos(BaseModel):
+    data: Optional[List[Data]] = None

gcore/types/streaming/quality_set_set_default_params.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["QualitySetSetDefaultParams", "Live", "Vod"]
+
+
+class QualitySetSetDefaultParams(TypedDict, total=False):
+    live: Live
+
+    vod: Vod
+
+
+class Live(TypedDict, total=False):
+    id: int
+    """ID of the custom quality set, or "null" for the system default"""
+
+
+class Vod(TypedDict, total=False):
+    id: int
+    """ID of the custom quality set, or "null" for the system default"""

gcore/types/streaming/quality_sets.py

@@ -0,0 +1,57 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["QualitySets", "Live", "LiveQuality", "Vod", "VodQuality"]
+
+
+class LiveQuality(BaseModel):
+    id: Optional[int] = None
+    """ID of the quality"""
+
+    name: Optional[str] = None
+    """Name of the quality"""
+
+
+class Live(BaseModel):
+    id: Optional[int] = None
+    """ID of the custom quality set"""
+
+    default: Optional[bool] = None
+    """States if this preset is default for a client profile"""
+
+    name: Optional[str] = None
+    """Human readable name of the quality set"""
+
+    qualities: Optional[List[LiveQuality]] = None
+    """Array of associated qualities"""
+
+
+class VodQuality(BaseModel):
+    id: Optional[int] = None
+    """ID of the quality"""
+
+    name: Optional[str] = None
+    """Name of the quality"""
+
+
+class Vod(BaseModel):
+    id: Optional[int] = None
+    """ID of the custom quality set"""
+
+    default: Optional[bool] = None
+    """States if this preset is default for a client profile"""
+
+    name: Optional[str] = None
+    """Human readable name of the quality set"""
+
+    qualities: Optional[List[VodQuality]] = None
+    """Array of associated qualities"""
+
+
+class QualitySets(BaseModel):
+    live: Optional[List[Live]] = None
+
+    vod: Optional[List[Vod]] = None

gcore/types/streaming/restream.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["Restream"]
+
+
+class Restream(BaseModel):
+    active: Optional[bool] = None
+    """Enables/Disables restream. Has two possible values:
+
+    - **true** — restream is enabled and can be started
+    - **false** — restream is disabled.
+
+    Default is true
+    """
+
+    client_user_id: Optional[int] = None
+    """Custom field where you can specify user ID in your system"""
+
+    live: Optional[bool] = None
+    """Indicates that the stream is being published. Has two possible values:
+
+    - **true** — stream is being published
+    - **false** — stream isn't published
+    """
+
+    name: Optional[str] = None
+    """Restream name"""
+
+    stream_id: Optional[int] = None
+    """ID of the stream to restream"""
+
+    uri: Optional[str] = None
+    """A URL to push the stream to"""

gcore/types/streaming/restream_create_params.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["RestreamCreateParams", "Restream"]
+
+
+class RestreamCreateParams(TypedDict, total=False):
+    restream: Restream
+
+
+class Restream(TypedDict, total=False):
+    active: bool
+    """Enables/Disables restream. Has two possible values:
+
+    - **true** — restream is enabled and can be started
+    - **false** — restream is disabled.
+
+    Default is true
+    """
+
+    client_user_id: int
+    """Custom field where you can specify user ID in your system"""
+
+    live: bool
+    """Indicates that the stream is being published. Has two possible values:
+
+    - **true** — stream is being published
+    - **false** — stream isn't published
+    """
+
+    name: str
+    """Restream name"""
+
+    stream_id: int
+    """ID of the stream to restream"""
+
+    uri: str
+    """A URL to push the stream to"""

gcore/types/streaming/restream_list_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["RestreamListParams"]
+
+
+class RestreamListParams(TypedDict, total=False):
+    page: int
+    """Query parameter. Use it to list the paginated content"""

gcore/types/streaming/restream_update_params.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["RestreamUpdateParams", "Restream"]
+
+
+class RestreamUpdateParams(TypedDict, total=False):
+    restream: Restream
+
+
+class Restream(TypedDict, total=False):
+    active: bool
+    """Enables/Disables restream. Has two possible values:
+
+    - **true** — restream is enabled and can be started
+    - **false** — restream is disabled.
+
+    Default is true
+    """
+
+    client_user_id: int
+    """Custom field where you can specify user ID in your system"""
+
+    live: bool
+    """Indicates that the stream is being published. Has two possible values:
+
+    - **true** — stream is being published
+    - **false** — stream isn't published
+    """
+
+    name: str
+    """Restream name"""
+
+    stream_id: int
+    """ID of the stream to restream"""
+
+    uri: str
+    """A URL to push the stream to"""

gcore/types/streaming/statistic_get_ffprobes_params.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["StatisticGetFfprobesParams"]
+
+
+class StatisticGetFfprobesParams(TypedDict, total=False):
+    date_from: Required[str]
+    """Start of time frame. Format is ISO 8601."""
+
+    date_to: Required[str]
+    """End of time frame. Datetime in ISO 8601 format."""
+
+    stream_id: Required[str]
+    """Stream ID"""
+
+    interval: int
+
+    units: Literal["second", "minute", "hour", "day", "week", "month"]

gcore/types/streaming/statistic_get_live_unique_viewers_params.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetLiveUniqueViewersParams"]
+
+
+class StatisticGetLiveUniqueViewersParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """Start of time frame. Format is date time in ISO 8601"""
+
+    to: Required[str]
+    """End of time frame. Format is date time in ISO 8601"""
+
+    client_user_id: int
+    """Filter by "`client_user_id`" """
+
+    granularity: Literal["1m", "5m", "15m", "1h", "1d"]
+    """Specifies the time interval for grouping data"""
+
+    stream_id: int
+    """Filter by "`stream_id`" """

gcore/types/streaming/statistic_get_live_unique_viewers_response.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from ..._models import BaseModel
+
+__all__ = [
+    "StatisticGetLiveUniqueViewersResponse",
+    "StatisticGetLiveUniqueViewersResponseItem",
+    "StatisticGetLiveUniqueViewersResponseItemMetrics",
+]
+
+
+class StatisticGetLiveUniqueViewersResponseItemMetrics(BaseModel):
+    streams: List[int]
+
+
+class StatisticGetLiveUniqueViewersResponseItem(BaseModel):
+    client: int
+
+    metrics: StatisticGetLiveUniqueViewersResponseItemMetrics
+
+
+StatisticGetLiveUniqueViewersResponse: TypeAlias = List[StatisticGetLiveUniqueViewersResponseItem]

gcore/types/streaming/statistic_get_live_watch_time_cdn_params.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetLiveWatchTimeCdnParams"]
+
+
+class StatisticGetLiveWatchTimeCdnParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """Start of the time period for counting minutes of watching.
+
+    Format is date time in ISO 8601.
+    """
+
+    client_user_id: int
+    """Filter by field "`client_user_id`" """
+
+    granularity: Literal["1m", "5m", "15m", "1h", "1d", "1mo"]
+    """Data is grouped by the specified time interval"""
+
+    stream_id: int
+    """Filter by `stream_id`"""
+
+    to: str
+    """End of time frame.
+
+    Datetime in ISO 8601 format. If omitted, then the current time is taken
+    """

gcore/types/streaming/statistic_get_live_watch_time_total_cdn_params.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetLiveWatchTimeTotalCdnParams"]
+
+
+class StatisticGetLiveWatchTimeTotalCdnParams(TypedDict, total=False):
+    client_user_id: int
+    """Filter by field "`client_user_id`" """
+
+    from_: Annotated[str, PropertyInfo(alias="from")]
+    """Start of the time period for counting minutes of watching.
+
+    Format is date time in ISO 8601. If omitted, the earliest start time for viewing
+    is taken
+    """
+
+    stream_id: int
+    """Filter by `stream_id`"""
+
+    to: str
+    """End of time frame.
+
+    Datetime in ISO 8601 format. If missed, then the current time is taken
+    """

gcore/types/streaming/statistic_get_max_streams_series_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetMaxStreamsSeriesParams"]
+
+
+class StatisticGetMaxStreamsSeriesParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """Start of time frame. Datetime in ISO 8601 format."""
+
+    to: Required[str]
+    """End of time frame. Datetime in ISO 8601 format."""
+
+    granularity: Literal["1m", "5m", "15m", "1h", "1d"]
+    """specifies the time interval for grouping data"""

gcore/types/streaming/statistic_get_meet_series_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetMeetSeriesParams"]
+
+
+class StatisticGetMeetSeriesParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """Start of time frame. Datetime in ISO 8601 format."""
+
+    to: Required[str]
+    """End of time frame. Datetime in ISO 8601 format."""
+
+    granularity: Literal["1m", "5m", "15m", "1h", "1d"]
+    """specifies the time interval for grouping data"""

gcore/types/streaming/statistic_get_popular_videos_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["StatisticGetPopularVideosParams"]
+
+
+class StatisticGetPopularVideosParams(TypedDict, total=False):
+    date_from: Required[str]
+    """Start of time frame. Datetime in ISO 8601 format."""
+
+    date_to: Required[str]
+    """End of time frame. Datetime in ISO 8601 format."""

gcore/types/streaming/statistic_get_storage_series_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetStorageSeriesParams"]
+
+
+class StatisticGetStorageSeriesParams(TypedDict, total=False):
+    from_: Required[Annotated[str, PropertyInfo(alias="from")]]
+    """Start of time frame. Datetime in ISO 8601 format."""
+
+    to: Required[str]
+    """End of time frame. Datetime in ISO 8601 format."""
+
+    granularity: Literal["1m", "5m", "15m", "1h", "1d"]
+    """specifies the time interval for grouping data"""