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

gcore/types/streaming/stream_start_recording_response.py

@@ -0,0 +1,76 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = [
+    "StreamStartRecordingResponse",
+    "Data",
+    "DataStream",
+    "DataStreamClient",
+    "Warning",
+    "WarningMeta",
+    "WarningSourceObject",
+]
+
+
+class DataStreamClient(BaseModel):
+    id: Optional[int] = None
+    """Client ID"""
+
+    storage_limit_mb: Optional[int] = None
+    """Current storage limit for client by megabytes"""
+
+    storage_usage_mb: Optional[float] = None
+    """Current storage usage for client by megabytes"""
+
+
+class DataStream(BaseModel):
+    id: Optional[int] = None
+    """Stream ID"""
+
+    client: Optional[DataStreamClient] = None
+
+
+class Data(BaseModel):
+    stream: Optional[DataStream] = None
+
+
+class WarningMeta(BaseModel):
+    storage_limit_mb: Optional[int] = None
+    """Current storage limit for client by megabytes"""
+
+    storage_usage_mb: Optional[float] = None
+    """Current storage usage for client by megabytes"""
+
+
+class WarningSourceObject(BaseModel):
+    id: Optional[int] = None
+    """Client ID"""
+
+    type: Optional[Literal["client"]] = None
+    """Object type (class)"""
+
+
+class Warning(BaseModel):
+    key: Optional[Literal["client_storage_almost_exceeded"]] = None
+    """current warning key"""
+
+    meta: Optional[WarningMeta] = None
+    """storage usage state for client"""
+
+    source_object: Optional[WarningSourceObject] = None
+    """Warning source object"""
+
+
+class StreamStartRecordingResponse(BaseModel):
+    data: Optional[Data] = None
+    """Stream data"""
+
+    errors: Optional[List[object]] = None
+    """List of errors received on attempt to start recording process"""
+
+    warnings: Optional[List[Warning]] = None
+    """List of warnings received on starting recording process"""

gcore/types/streaming/stream_update_params.py

@@ -0,0 +1,169 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["StreamUpdateParams", "Stream"]
+
+
+class StreamUpdateParams(TypedDict, total=False):
+    stream: Stream
+
+
+class Stream(TypedDict, total=False):
+    name: Required[str]
+    """
+    Stream name. Often used as a human-readable name for the stream, but can contain
+    any text you wish. The values are not unique and may be repeated. Examples:
+
+    - Conference in July
+    - Stream #10003
+    - Open-Air Camera #31 Backstage
+    - 480fd499-2de2-4988-bc1a-a4eebe9818ee
+    """
+
+    active: bool
+    """Stream switch between on and off.
+
+    This is not an indicator of the status "stream is receiving and it is LIVE", but
+    rather an on/off switch. When stream is switched off, there is no way to process
+    it: PULL is deactivated and PUSH will return an error.
+
+    - true – stream can be processed
+    - false – stream is off, and cannot be processed
+    """
+
+    auto_record: bool
+    """Enables autotomatic recording of the stream when it started.
+
+    So you don't need to call recording manually. Result of recording is
+    automatically added to video hosting. For details see the
+    /streams/`start_recording` method and in knowledge base Values:
+
+    - true – auto recording is enabled
+    - false – auto recording is disabled
+    """
+
+    broadcast_ids: Iterable[int]
+    """IDs of broadcasts which will include this stream"""
+
+    cdn_id: int
+    """
+    ID of custom CDN resource from which the content will be delivered (only if you
+    know what you do)
+    """
+
+    client_entity_data: str
+    """
+    Custom meta field designed to store your own extra information about a video
+    entity: video source, video id, parameters, etc. We do not use this field in any
+    way when processing the stream. You can store any data in any format (string,
+    json, etc), saved as a text string. Example:
+    `` client_entity_data = '{ "`seq_id`": "1234567890", "name": "John Doe", "iat": 1516239022 }' ``
+    """
+
+    client_user_id: int
+    """Custom meta field for storing the Identifier in your system.
+
+    We do not use this field in any way when processing the stream. Example:
+    `client_user_id = 1001`
+    """
+
+    dvr_duration: int
+    """DVR duration in seconds if DVR feature is enabled for the stream.
+
+    So this is duration of how far the user can rewind the live stream.
+    `dvr_duration` range is [30...14400]. Maximum value is 4 hours = 14400 seconds.
+    If you need more, ask the Support Team please.
+    """
+
+    dvr_enabled: bool
+    """Enables DVR for the stream:
+
+    - true – DVR is enabled
+    - false – DVR is disabled
+    """
+
+    hls_mpegts_endlist_tag: bool
+    """
+    Add `#EXT-X-ENDLIST` tag within .m3u8 playlist after the last segment of a live
+    stream when broadcast is ended.
+    """
+
+    html_overlay: bool
+    """
+    Switch on mode to insert and display real-time HTML overlay widgets on top of
+    live streams
+    """
+
+    low_latency_enabled: bool
+    """
+    Deprecated, always returns "true". The only exception is that the attribute can
+    only be used by clients that have previously used the old stream format. This
+    method is outdated since we've made it easier to manage streams. For your
+    convenience, you no longer need to set this parameter at the stage of creating a
+    stream. Now all streams are prepared in 2 formats simultaniously: Low Latency
+    and Legacy. You can get the desired output format in the attributes
+    "`dash_url`", "`hls_cmaf_url`", "`hls_mpegts_url`". Or use them all at once.
+
+    ---
+
+    Note: Links /streams/{id}/playlist.m3u8 are depricated too. Use value of the
+    "`hls_mpegts_url`" attribute instead.
+    """
+
+    projection: Literal["regular", "vr360", "vr180", "vr360tb"]
+    """
+    Visualization mode for 360° streams, how the stream is rendered in our web
+    player ONLY. If you would like to show video 360° in an external video player,
+    then use parameters of that video player. Modes:
+
+    - regular – regular “flat” stream
+    - vr360 – display stream in 360° mode
+    - vr180 – display stream in 180° mode
+    - vr360tb – display stream in 3D 360° mode Top-Bottom
+    """
+
+    pull: bool
+    """Indicates if stream is pulled from external server or not.
+
+    Has two possible values:
+
+    - true – stream is received by PULL method. Use this when need to get stream
+      from external server by srt, rtmp\\ss, hls, dash, etc protocols.
+    - false – stream is received by PUSH method. Use this when need to send stream
+      from end-device to our Streaming Platform, i.e. from mobile app or OBS Studio.
+    """
+
+    quality_set_id: int
+    """
+    Custom quality set ID for transcoding, if transcoding is required according to
+    your conditions. Look at GET /`quality_sets` method
+    """
+
+    record_type: Literal["origin", "transcoded"]
+    """Method of recording a stream.
+
+    Specifies the source from which the stream will be recorded: original or
+    transcoded. Types:
+
+    - "origin" – To record RMTP/SRT/etc original clean media source.
+    - "transcoded" – To record the output transcoded version of the stream,
+      including overlays, texts, logos, etc. additional media layers.
+    """
+
+    uri: str
+    """
+    When using PULL method, this is the URL to pull a stream from. You can specify
+    multiple addresses separated by a space (" "), so you can organize a backup
+    plan. In this case, the specified addresses will be selected one by one using
+    round robin scheduling. If the first address does not respond, then the next one
+    in the list will be automatically requested, returning to the first and so on in
+    a circle. Also, if the sucessfully working stream stops sending data, then the
+    next one will be selected according to the same scheme. After 24 hours of
+    inactivity of your streams we will stop PULL-ing, and will switch "active" field
+    to "false". Please, note that this field is for PULL only, so is not suitable
+    for PUSH. Look at fields "`push_url`" and "`push_url_srt`" from GET method.
+    """

gcore/types/streaming/streams/__init__.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .overlay import Overlay as Overlay
+from .overlay_create_params import OverlayCreateParams as OverlayCreateParams
+from .overlay_list_response import OverlayListResponse as OverlayListResponse
+from .overlay_update_params import OverlayUpdateParams as OverlayUpdateParams
+from .overlay_create_response import OverlayCreateResponse as OverlayCreateResponse
+from .overlay_update_multiple_params import OverlayUpdateMultipleParams as OverlayUpdateMultipleParams
+from .overlay_update_multiple_response import OverlayUpdateMultipleResponse as OverlayUpdateMultipleResponse

gcore/types/streaming/streams/overlay.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ...._models import BaseModel
+
+__all__ = ["Overlay"]
+
+
+class Overlay(BaseModel):
+    id: int
+    """ID of the overlay"""
+
+    created_at: str
+    """Datetime of creation in ISO 8601"""
+
+    stream_id: int
+    """ID of a stream to which it is attached"""
+
+    updated_at: str
+    """Datetime of last update in ISO 8601"""
+
+    url: str
+    """Valid http/https URL to an HTML page/widget"""
+
+    height: Optional[int] = None
+    """Height of the widget"""
+
+    stretch: Optional[bool] = None
+    """Switch of auto scaling the widget.
+
+    Must not be used as "true" simultaneously with the coordinate installation
+    method (w, h, x, y).
+    """
+
+    width: Optional[int] = None
+    """Width of the widget"""
+
+    x: Optional[int] = None
+    """Coordinate of left upper corner"""
+
+    y: Optional[int] = None
+    """Coordinate of left upper corner"""

gcore/types/streaming/streams/overlay_create_params.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Required, TypedDict
+
+__all__ = ["OverlayCreateParams", "Body"]
+
+
+class OverlayCreateParams(TypedDict, total=False):
+    body: Iterable[Body]
+
+
+class Body(TypedDict, total=False):
+    url: Required[str]
+    """Valid http/https URL to an HTML page/widget"""
+
+    height: int
+    """Height of the widget"""
+
+    stretch: bool
+    """Switch of auto scaling the widget.
+
+    Must not be used as "true" simultaneously with the coordinate installation
+    method (w, h, x, y).
+    """
+
+    width: int
+    """Width of the widget"""
+
+    x: int
+    """Coordinate of left upper corner"""
+
+    y: int
+    """Coordinate of left upper corner"""

gcore/types/streaming/streams/overlay_create_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .overlay import Overlay
+
+__all__ = ["OverlayCreateResponse"]
+
+OverlayCreateResponse: TypeAlias = List[Overlay]

gcore/types/streaming/streams/overlay_list_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .overlay import Overlay
+
+__all__ = ["OverlayListResponse"]
+
+OverlayListResponse: TypeAlias = List[Overlay]

gcore/types/streaming/streams/overlay_update_multiple_params.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Required, TypedDict
+
+__all__ = ["OverlayUpdateMultipleParams", "Body"]
+
+
+class OverlayUpdateMultipleParams(TypedDict, total=False):
+    body: Iterable[Body]
+
+
+class Body(TypedDict, total=False):
+    id: Required[int]
+    """ID of the overlay"""
+
+    height: int
+    """Height of the widget"""
+
+    stretch: bool
+    """Switch of auto scaling the widget.
+
+    Must not be used as "true" simultaneously with the coordinate installation
+    method (w, h, x, y).
+    """
+
+    url: str
+    """Valid http/https URL to an HTML page/widget"""
+
+    width: int
+    """Width of the widget"""
+
+    x: int
+    """Coordinate of left upper corner"""
+
+    y: int
+    """Coordinate of left upper corner"""

gcore/types/streaming/streams/overlay_update_multiple_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .overlay import Overlay
+
+__all__ = ["OverlayUpdateMultipleResponse"]
+
+OverlayUpdateMultipleResponse: TypeAlias = List[Overlay]

gcore/types/streaming/streams/overlay_update_params.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["OverlayUpdateParams"]
+
+
+class OverlayUpdateParams(TypedDict, total=False):
+    stream_id: Required[int]
+
+    height: int
+    """Height of the widget"""
+
+    stretch: bool
+    """Switch of auto scaling the widget.
+
+    Must not be used as "true" simultaneously with the coordinate installation
+    method (w, h, x, y).
+    """
+
+    url: str
+    """Valid http/https URL to an HTML page/widget"""
+
+    width: int
+    """Width of the widget"""
+
+    x: int
+    """Coordinate of left upper corner"""
+
+    y: int
+    """Coordinate of left upper corner"""

gcore/types/streaming/subtitle.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .subtitle_base import SubtitleBase
+
+__all__ = ["Subtitle"]
+
+
+class Subtitle(SubtitleBase):
+    id: Optional[int] = None
+    """ID of subtitle file"""

gcore/types/streaming/subtitle_base.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["SubtitleBase"]
+
+
+class SubtitleBase(BaseModel):
+    language: Optional[str] = None
+    """3-letter language code according to ISO-639-2 (bibliographic code)"""
+
+    name: Optional[str] = None
+    """Name of subtitle file"""
+
+    vtt: Optional[str] = None
+    """Full text of subtitles/captions, with escaped "\n" ("\r") symbol of new line"""

gcore/types/streaming/subtitle_base_param.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__ = ["SubtitleBaseParam"]
+
+
+class SubtitleBaseParam(TypedDict, total=False):
+    language: str
+    """3-letter language code according to ISO-639-2 (bibliographic code)"""
+
+    name: str
+    """Name of subtitle file"""
+
+    vtt: str
+    """Full text of subtitles/captions, with escaped "\n" ("\r") symbol of new line"""

gcore/types/streaming/unique_viewers.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["UniqueViewers", "Data"]
+
+
+class Data(BaseModel):
+    date: str
+
+    unique_ips: int
+
+    id: Optional[int] = None
+
+    browser: Optional[str] = None
+
+    country: Optional[str] = None
+
+    event: Optional[str] = None
+
+    host: Optional[str] = None
+
+    ip: Optional[str] = None
+
+    os: Optional[str] = None
+
+    platform: Optional[str] = None
+
+    type: Optional[str] = None
+
+
+class UniqueViewers(BaseModel):
+    data: Optional[List[Data]] = None

gcore/types/streaming/unique_viewers_cdn.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__ = ["UniqueViewersCdn", "Data"]
+
+
+class Data(BaseModel):
+    type: str
+
+    uniqs: int
+
+
+class UniqueViewersCdn(BaseModel):
+    data: Optional[List[Data]] = None