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

gcore/types/streaming/create_video_param.py

@@ -0,0 +1,214 @@
+# 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__ = ["CreateVideoParam"]
+
+
+class CreateVideoParam(TypedDict, total=False):
+    name: Required[str]
+    """Video name"""
+
+    auto_transcribe_audio_language: Literal["disable", "auto", "<language_code>"]
+    """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: Literal["disable", "default", "<language_codes,>"]
+    """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: int
+    """Custom field where you can specify user ID in your system"""
+
+    clip_duration_seconds: int
+    """
+    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: int
+    """
+    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: str
+    """
+    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
+    """Video details; not visible to the end-users"""
+
+    directory_id: int
+    """ID of the directory where the video should be uploaded. (beta)"""
+
+    origin_http_headers: str
+    """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: str
+    """
+    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: str
+    """
+    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: int
+    """
+    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: str
+    """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: int
+    """
+    Custom quality set ID for transcoding, if transcoding is required according to
+    your conditions. Look at GET /`quality_sets` method
+    """
+
+    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.
+    """
+
+    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.
+    """
+
+    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
+    """
+
+    source_bitrate_limit: bool
+    """
+    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/direct_upload_parameters.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["DirectUploadParameters"]
+
+
+class DirectUploadParameters(BaseModel):
+    token: Optional[str] = None
+    """Token"""
+
+    servers: Optional[List[object]] = None
+    """An array which contains information about servers you can upload a video to.
+
+    **Server;** type — object.
+
+    ---
+
+    Server has the following fields:
+
+    - **id;** type — integer
+       Server ID
+    - **hostname;** type — string
+       Server hostname
+    """
+
+    video: Optional[object] = None
+    """Contains information about the created video.
+
+    See the full description in the Get video request
+    """

gcore/types/streaming/directories_tree.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+from .directory_base import DirectoryBase
+
+__all__ = ["DirectoriesTree", "Tree"]
+
+
+class Tree(DirectoryBase):
+    descendants: Optional[List["DirectoriesTree"]] = None
+    """Array of subdirectories, if any."""
+
+
+class DirectoriesTree(BaseModel):
+    tree: Optional[List[Tree]] = None

gcore/types/streaming/directory_base.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["DirectoryBase"]
+
+
+class DirectoryBase(BaseModel):
+    id: Optional[int] = None
+    """ID of the directory"""
+
+    created_at: Optional[str] = None
+    """Time of creation. Datetime in ISO 8601 format."""
+
+    items_count: Optional[int] = None
+    """Number of objects in this directory.
+
+    Counting files and folders. The quantity is calculated only at one level (not
+    recursively in all subfolders).
+    """
+
+    name: Optional[str] = None
+    """Title of the directory"""
+
+    parent_id: Optional[int] = None
+    """ID of a parent directory. "null" if it's in the root."""
+
+    updated_at: Optional[str] = None
+    """Time of last update of the directory entity. Datetime in ISO 8601 format."""

gcore/types/streaming/directory_create_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__ = ["DirectoryCreateParams"]
+
+
+class DirectoryCreateParams(TypedDict, total=False):
+    name: Required[str]
+    """Title of the directory."""
+
+    parent_id: int
+    """ID of a parent directory. "null" if it's in the root."""

gcore/types/streaming/directory_get_response.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+
+from ..._models import BaseModel
+from .directory_base import DirectoryBase
+from .directory_item import DirectoryItem
+from .directory_video import DirectoryVideo
+
+__all__ = ["DirectoryGetResponse", "Directory"]
+
+
+class Directory(DirectoryBase):
+    items: Optional[List[Union[DirectoryVideo, DirectoryItem]]] = None
+    """Array of subdirectories, if any."""
+
+
+class DirectoryGetResponse(BaseModel):
+    directory: Optional[Directory] = None

gcore/types/streaming/directory_item.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .directory_base import DirectoryBase
+
+__all__ = ["DirectoryItem"]
+
+
+class DirectoryItem(DirectoryBase):
+    item_type: Optional[Literal["Directory"]] = None
+    """Type of the entity: directory, or video"""

gcore/types/streaming/directory_update_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["DirectoryUpdateParams"]
+
+
+class DirectoryUpdateParams(TypedDict, total=False):
+    name: str
+    """Title of the directory. Omit this if you don't want to change."""
+
+    parent_id: int
+    """ID of a parent directory.
+
+    "null" if it's in the root. Omit this if you don't want to change.
+    """

gcore/types/streaming/directory_video.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .video import Video
+
+__all__ = ["DirectoryVideo"]
+
+
+class DirectoryVideo(Video):
+    item_type: Optional[Literal["Video"]] = None
+    """Type of the entity: directory, or video"""

gcore/types/streaming/ffprobes.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["Ffprobes", "Data"]
+
+
+class Data(BaseModel):
+    avg_bitrate: float
+
+    max_fps: float
+
+    max_height: int
+
+    max_keyframe_interval: int
+
+    sum_frames: int
+
+    time: str
+
+
+class Ffprobes(BaseModel):
+    data: Optional[List[Data]] = None

gcore/types/streaming/max_stream_series.py

@@ -0,0 +1,21 @@
+# 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__ = ["MaxStreamSeries", "MaxStreamSeryItem", "MaxStreamSeryItemMetrics"]
+
+
+class MaxStreamSeryItemMetrics(BaseModel):
+    streams: List[int]
+
+
+class MaxStreamSeryItem(BaseModel):
+    client: int
+
+    metrics: MaxStreamSeryItemMetrics
+
+
+MaxStreamSeries: TypeAlias = List[MaxStreamSeryItem]

gcore/types/streaming/meet_series.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import TypeAlias
+
+from ..._models import BaseModel
+
+__all__ = ["MeetSeries", "MeetSeryItem", "MeetSeryItemMetrics"]
+
+
+class MeetSeryItemMetrics(BaseModel):
+    max_meet_usage: Optional[List[int]] = None
+
+    meet: Optional[List[List[int]]] = None
+
+
+class MeetSeryItem(BaseModel):
+    client: int
+
+    metrics: MeetSeryItemMetrics
+
+
+MeetSeries: TypeAlias = List[MeetSeryItem]

gcore/types/streaming/player.py

@@ -0,0 +1,114 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["Player"]
+
+
+class Player(BaseModel):
+    name: str
+    """Player name"""
+
+    id: Optional[int] = None
+    """Player ID"""
+
+    autoplay: Optional[bool] = None
+    """Enables video playback right after player load:
+
+    - **true** — video starts playing right after player loads
+    - **false** — video isn’t played automatically. A user must click play to start
+
+    Default is false
+    """
+
+    bg_color: Optional[str] = None
+    """Color of skin background in format #AAAAAA"""
+
+    client_id: Optional[int] = None
+    """Client ID"""
+
+    custom_css: Optional[str] = None
+    """Custom CSS to be added to player iframe"""
+
+    design: Optional[str] = None
+    """String to be rendered as JS parameters to player"""
+
+    disable_skin: Optional[bool] = None
+    """Enables/Disables player skin:
+
+    - **true** — player skin is disabled
+    - **false** — player skin is enabled
+
+    Default is false
+    """
+
+    fg_color: Optional[str] = None
+    """Color of skin foreground (elements) in format #AAAAAA"""
+
+    framework: Optional[str] = None
+    """Player framework type"""
+
+    hover_color: Optional[str] = None
+    """Color of foreground elements when mouse is over in format #AAAAAA"""
+
+    js_url: Optional[str] = None
+    """Player main JS file URL. Leave empty to use JS URL from the default player"""
+
+    logo: Optional[str] = None
+    """URL to logo image"""
+
+    logo_position: Optional[str] = None
+    """Logotype position.
+     Has four possible values:
+
+    - **tl** — top left
+    - **tr** — top right
+    - **bl** — bottom left
+    - **br** — bottom right
+
+    Default is null
+    """
+
+    mute: Optional[bool] = None
+    """Regulates the sound volume:
+
+    - **true** — video starts with volume off
+    - **false** — video starts with volume on
+
+    Default is false
+    """
+
+    save_options_to_cookies: Optional[bool] = None
+    """Enables/Disables saving volume and other options in cookies:
+
+    - **true** — user settings will be saved
+    - **false** — user settings will not be saved
+
+    Default is true
+    """
+
+    show_sharing: Optional[bool] = None
+    """Enables/Disables sharing button display:
+
+    - **true** — sharing button is displayed
+    - **false** — no sharing button is displayed
+
+    Default is true
+    """
+
+    skin_is_url: Optional[str] = None
+    """URL to custom skin JS file"""
+
+    speed_control: Optional[bool] = None
+    """Enables/Disables speed control button display:
+
+    - **true** — sharing button is displayed
+    - **false** — no sharing button is displayed
+
+    Default is false
+    """
+
+    text_color: Optional[str] = None
+    """Color of skin text elements in format #AAAAAA"""

gcore/types/streaming/player_create_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+from .player_param import PlayerParam
+
+__all__ = ["PlayerCreateParams"]
+
+
+class PlayerCreateParams(TypedDict, total=False):
+    player: PlayerParam
+    """Set of properties for displaying videos.
+
+    All parameters may be blank to inherit their values from default Streaming
+    player.
+    """

gcore/types/streaming/player_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__ = ["PlayerListParams"]
+
+
+class PlayerListParams(TypedDict, total=False):
+    page: int
+    """Query parameter. Use it to list the paginated content"""