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

gcore/types/streaming/player_param.py

@@ -0,0 +1,114 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["PlayerParam"]
+
+
+class PlayerParam(TypedDict, total=False):
+    name: Required[str]
+    """Player name"""
+
+    id: int
+    """Player ID"""
+
+    autoplay: bool
+    """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: str
+    """Color of skin background in format #AAAAAA"""
+
+    client_id: int
+    """Client ID"""
+
+    custom_css: str
+    """Custom CSS to be added to player iframe"""
+
+    design: str
+    """String to be rendered as JS parameters to player"""
+
+    disable_skin: bool
+    """Enables/Disables player skin:
+
+    - **true** — player skin is disabled
+    - **false** — player skin is enabled
+
+    Default is false
+    """
+
+    fg_color: str
+    """Color of skin foreground (elements) in format #AAAAAA"""
+
+    framework: str
+    """Player framework type"""
+
+    hover_color: str
+    """Color of foreground elements when mouse is over in format #AAAAAA"""
+
+    js_url: str
+    """Player main JS file URL. Leave empty to use JS URL from the default player"""
+
+    logo: str
+    """URL to logo image"""
+
+    logo_position: str
+    """Logotype position.
+     Has four possible values:
+
+    - **tl** — top left
+    - **tr** — top right
+    - **bl** — bottom left
+    - **br** — bottom right
+
+    Default is null
+    """
+
+    mute: bool
+    """Regulates the sound volume:
+
+    - **true** — video starts with volume off
+    - **false** — video starts with volume on
+
+    Default is false
+    """
+
+    save_options_to_cookies: bool
+    """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: bool
+    """Enables/Disables sharing button display:
+
+    - **true** — sharing button is displayed
+    - **false** — no sharing button is displayed
+
+    Default is true
+    """
+
+    skin_is_url: str
+    """URL to custom skin JS file"""
+
+    speed_control: bool
+    """Enables/Disables speed control button display:
+
+    - **true** — sharing button is displayed
+    - **false** — no sharing button is displayed
+
+    Default is false
+    """
+
+    text_color: str
+    """Color of skin text elements in format #AAAAAA"""

gcore/types/streaming/player_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
+
+from .player_param import PlayerParam
+
+__all__ = ["PlayerUpdateParams"]
+
+
+class PlayerUpdateParams(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/playlist.py

@@ -0,0 +1,102 @@
+# 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__ = ["Playlist"]
+
+
+class Playlist(BaseModel):
+    active: Optional[bool] = None
+    """Enables/Disables playlist. Has two possible values:
+
+    - true – Playlist can be played.
+    - false – Playlist is disabled. No broadcast while it's desabled.
+    """
+
+    ad_id: Optional[int] = None
+    """The advertisement ID that will be inserted into the video"""
+
+    client_id: Optional[int] = None
+    """Current playlist client ID"""
+
+    client_user_id: Optional[int] = None
+    """Custom field where you can specify user ID in your system"""
+
+    countdown: Optional[bool] = None
+    """Enables countdown before playlist start with `playlist_type: live`"""
+
+    hls_cmaf_url: Optional[str] = None
+    """A URL to a master playlist HLS (master-cmaf.m3u8) with CMAF-based chunks.
+
+    Chunks are in fMP4 container.
+
+    It is possible to use the same suffix-options as described in the "`hls_url`"
+    attribute.
+
+    Caution. Solely master.m3u8 (and master[-options].m3u8) is officially documented
+    and intended for your use. Any additional internal manifests, sub-manifests,
+    parameters, chunk names, file extensions, and related components are internal
+    infrastructure entities. These may undergo modifications without prior notice,
+    in any manner or form. It is strongly advised not to store them in your database
+    or cache them on your end.
+    """
+
+    hls_url: Optional[str] = None
+    """A URL to a master playlist HLS (master.m3u8) with MPEG TS container.
+
+    This URL is a link to the main manifest. But you can also manually specify
+    suffix-options that will allow you to change the manifest to your request:
+    `` /playlists/{`client_id`}_{`playlist_id`}/master[-cmaf][-min-N][-max-N][-img][-(h264|hevc|av1)].m3u8 ``
+    Please see the details in `hls_url` attribute of /videos/{id} method.
+
+    Caution. Solely master.m3u8 (and master[-options].m3u8) is officially documented
+    and intended for your use. Any additional internal manifests, sub-manifests,
+    parameters, chunk names, file extensions, and related components are internal
+    infrastructure entities. These may undergo modifications without prior notice,
+    in any manner or form. It is strongly advised not to store them in your database
+    or cache them on your end.
+    """
+
+    iframe_url: Optional[str] = None
+    """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.
+
+    Please see the details in `iframe_url` attribute of /videos/{id} method.
+    """
+
+    loop: Optional[bool] = None
+    """Enables/Disables playlist loop"""
+
+    name: Optional[str] = None
+    """Playlist name"""
+
+    player_id: Optional[int] = None
+    """The player ID with which the video will be played"""
+
+    playlist_type: Optional[Literal["live", "vod"]] = None
+    """Determines whether the playlist:
+
+    - `live` - playlist for live-streaming
+    - `vod` - playlist is for video on demand access
+    """
+
+    start_time: Optional[str] = None
+    """Playlist start time.
+
+    Playlist won't be available before the specified time. Datetime in ISO 8601
+    format.
+    """
+
+    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.
+    """

gcore/types/streaming/playlist_create.py

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

gcore/types/streaming/playlist_create_params.py

@@ -0,0 +1,102 @@
+# 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, TypedDict
+
+__all__ = ["PlaylistCreateParams"]
+
+
+class PlaylistCreateParams(TypedDict, total=False):
+    active: bool
+    """Enables/Disables playlist. Has two possible values:
+
+    - true – Playlist can be played.
+    - false – Playlist is disabled. No broadcast while it's desabled.
+    """
+
+    ad_id: int
+    """The advertisement ID that will be inserted into the video"""
+
+    client_id: int
+    """Current playlist client ID"""
+
+    client_user_id: int
+    """Custom field where you can specify user ID in your system"""
+
+    countdown: bool
+    """Enables countdown before playlist start with `playlist_type: live`"""
+
+    hls_cmaf_url: str
+    """A URL to a master playlist HLS (master-cmaf.m3u8) with CMAF-based chunks.
+
+    Chunks are in fMP4 container.
+
+    It is possible to use the same suffix-options as described in the "`hls_url`"
+    attribute.
+
+    Caution. Solely master.m3u8 (and master[-options].m3u8) is officially documented
+    and intended for your use. Any additional internal manifests, sub-manifests,
+    parameters, chunk names, file extensions, and related components are internal
+    infrastructure entities. These may undergo modifications without prior notice,
+    in any manner or form. It is strongly advised not to store them in your database
+    or cache them on your end.
+    """
+
+    hls_url: str
+    """A URL to a master playlist HLS (master.m3u8) with MPEG TS container.
+
+    This URL is a link to the main manifest. But you can also manually specify
+    suffix-options that will allow you to change the manifest to your request:
+    `` /playlists/{`client_id`}_{`playlist_id`}/master[-cmaf][-min-N][-max-N][-img][-(h264|hevc|av1)].m3u8 ``
+    Please see the details in `hls_url` attribute of /videos/{id} method.
+
+    Caution. Solely master.m3u8 (and master[-options].m3u8) is officially documented
+    and intended for your use. Any additional internal manifests, sub-manifests,
+    parameters, chunk names, file extensions, and related components are internal
+    infrastructure entities. These may undergo modifications without prior notice,
+    in any manner or form. It is strongly advised not to store them in your database
+    or cache them on your end.
+    """
+
+    iframe_url: str
+    """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.
+
+    Please see the details in `iframe_url` attribute of /videos/{id} method.
+    """
+
+    loop: bool
+    """Enables/Disables playlist loop"""
+
+    name: str
+    """Playlist name"""
+
+    player_id: int
+    """The player ID with which the video will be played"""
+
+    playlist_type: Literal["live", "vod"]
+    """Determines whether the playlist:
+
+    - `live` - playlist for live-streaming
+    - `vod` - playlist is for video on demand access
+    """
+
+    start_time: str
+    """Playlist start time.
+
+    Playlist won't be available before the specified time. Datetime in ISO 8601
+    format.
+    """
+
+    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.
+    """

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

gcore/types/streaming/playlist_list_videos_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 .playlist_video import PlaylistVideo
+
+__all__ = ["PlaylistListVideosResponse"]
+
+PlaylistListVideosResponse: TypeAlias = List[PlaylistVideo]

gcore/types/streaming/playlist_update_params.py

@@ -0,0 +1,102 @@
+# 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, TypedDict
+
+__all__ = ["PlaylistUpdateParams"]
+
+
+class PlaylistUpdateParams(TypedDict, total=False):
+    active: bool
+    """Enables/Disables playlist. Has two possible values:
+
+    - true – Playlist can be played.
+    - false – Playlist is disabled. No broadcast while it's desabled.
+    """
+
+    ad_id: int
+    """The advertisement ID that will be inserted into the video"""
+
+    client_id: int
+    """Current playlist client ID"""
+
+    client_user_id: int
+    """Custom field where you can specify user ID in your system"""
+
+    countdown: bool
+    """Enables countdown before playlist start with `playlist_type: live`"""
+
+    hls_cmaf_url: str
+    """A URL to a master playlist HLS (master-cmaf.m3u8) with CMAF-based chunks.
+
+    Chunks are in fMP4 container.
+
+    It is possible to use the same suffix-options as described in the "`hls_url`"
+    attribute.
+
+    Caution. Solely master.m3u8 (and master[-options].m3u8) is officially documented
+    and intended for your use. Any additional internal manifests, sub-manifests,
+    parameters, chunk names, file extensions, and related components are internal
+    infrastructure entities. These may undergo modifications without prior notice,
+    in any manner or form. It is strongly advised not to store them in your database
+    or cache them on your end.
+    """
+
+    hls_url: str
+    """A URL to a master playlist HLS (master.m3u8) with MPEG TS container.
+
+    This URL is a link to the main manifest. But you can also manually specify
+    suffix-options that will allow you to change the manifest to your request:
+    `` /playlists/{`client_id`}_{`playlist_id`}/master[-cmaf][-min-N][-max-N][-img][-(h264|hevc|av1)].m3u8 ``
+    Please see the details in `hls_url` attribute of /videos/{id} method.
+
+    Caution. Solely master.m3u8 (and master[-options].m3u8) is officially documented
+    and intended for your use. Any additional internal manifests, sub-manifests,
+    parameters, chunk names, file extensions, and related components are internal
+    infrastructure entities. These may undergo modifications without prior notice,
+    in any manner or form. It is strongly advised not to store them in your database
+    or cache them on your end.
+    """
+
+    iframe_url: str
+    """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.
+
+    Please see the details in `iframe_url` attribute of /videos/{id} method.
+    """
+
+    loop: bool
+    """Enables/Disables playlist loop"""
+
+    name: str
+    """Playlist name"""
+
+    player_id: int
+    """The player ID with which the video will be played"""
+
+    playlist_type: Literal["live", "vod"]
+    """Determines whether the playlist:
+
+    - `live` - playlist for live-streaming
+    - `vod` - playlist is for video on demand access
+    """
+
+    start_time: str
+    """Playlist start time.
+
+    Playlist won't be available before the specified time. Datetime in ISO 8601
+    format.
+    """
+
+    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.
+    """