gcore 0.10.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

gcore/types/streaming/ai_task_get_response.py

@@ -16,16 +16,12 @@ __all__ = [
     "AITaskGetResponseResultAIResultsTranscribeSubtitle",
     "AITaskGetResponseResultAIResultsContentmoderationSport",
     "AITaskGetResponseResultAIResultsContentmoderationSportFrame",
-    "AITaskGetResponseResultAIResultsContentmoderationWeapon",
-    "AITaskGetResponseResultAIResultsContentmoderationWeaponFrame",
     "AITaskGetResponseResultAIResultsContentmoderationNsfw",
     "AITaskGetResponseResultAIResultsContentmoderationNsfwFrame",
     "AITaskGetResponseResultAIResultsContentmoderationHardnudity",
     "AITaskGetResponseResultAIResultsContentmoderationHardnudityFrame",
     "AITaskGetResponseResultAIResultsContentmoderationSoftnudity",
     "AITaskGetResponseResultAIResultsContentmoderationSoftnudityFrame",
-    "AITaskGetResponseResultAIResultsContentmoderationCasm",
-    "AITaskGetResponseResultAIResultsContentmoderationCasmFrame",
     "AITaskGetResponseResultAIResultsFailure",
 ]
 
@@ -157,26 +153,6 @@ class AITaskGetResponseResultAIResultsContentmoderationSport(BaseModel):
     """A boolean value whether any sports were detected"""
 
 
-class AITaskGetResponseResultAIResultsContentmoderationWeaponFrame(BaseModel):
-    confidence: Optional[float] = None
-    """Percentage of probability of identifying the object"""
-
-    frame_number: Optional[int] = FieldInfo(alias="frame-number", default=None)
-    """Video frame number where object was found"""
-
-    label: Optional[str] = None
-    """Type of detected object"""
-
-
-class AITaskGetResponseResultAIResultsContentmoderationWeapon(BaseModel):
-    detection_results: Optional[List[Literal["gun", "heavy weapon", "knife"]]] = None
-
-    frames: Optional[List[AITaskGetResponseResultAIResultsContentmoderationWeaponFrame]] = None
-
-    weapon_detected: Optional[bool] = None
-    """A boolean value whether any weapon was detected"""
-
-
 class AITaskGetResponseResultAIResultsContentmoderationNsfwFrame(BaseModel):
     confidence: Optional[float] = None
     """Percentage of probability of identifying the object"""
@@ -271,26 +247,6 @@ class AITaskGetResponseResultAIResultsContentmoderationSoftnudity(BaseModel):
     """A boolean value whether any nudity and other body part was detected"""
 
 
-class AITaskGetResponseResultAIResultsContentmoderationCasmFrame(BaseModel):
-    confidence: Optional[float] = None
-    """Percentage of probability of identifying the object"""
-
-    frame_number: Optional[int] = FieldInfo(alias="frame-number", default=None)
-    """Video frame number where object was found"""
-
-    label: Optional[str] = None
-    """Type of detected object"""
-
-
-class AITaskGetResponseResultAIResultsContentmoderationCasm(BaseModel):
-    child_pornography_detected: Optional[bool] = None
-    """A boolean value whether child pornography was detected"""
-
-    detection_results: Optional[List[Literal["0-2", "3-9", "10-19"]]] = None
-
-    frames: Optional[List[AITaskGetResponseResultAIResultsContentmoderationCasmFrame]] = None
-
-
 class AITaskGetResponseResultAIResultsFailure(BaseModel):
     error: str
 
@@ -298,11 +254,9 @@ class AITaskGetResponseResultAIResultsFailure(BaseModel):
 AITaskGetResponseResult: TypeAlias = Union[
     AITaskGetResponseResultAIResultsTranscribe,
     AITaskGetResponseResultAIResultsContentmoderationSport,
-    AITaskGetResponseResultAIResultsContentmoderationWeapon,
     AITaskGetResponseResultAIResultsContentmoderationNsfw,
     AITaskGetResponseResultAIResultsContentmoderationHardnudity,
     AITaskGetResponseResultAIResultsContentmoderationSoftnudity,
-    AITaskGetResponseResultAIResultsContentmoderationCasm,
     AITaskGetResponseResultAIResultsFailure,
 ]
 

gcore/types/streaming/clip.py

@@ -38,7 +38,8 @@ class Clip(BaseModel):
     deleted from memory and is no longer available via the link. You need to create
     a new segment, or use `vod_required: true` attribute. If value is omitted, then
     expiration is counted as +3600 seconds (1 hour) to the end of the clip (i.e.
-    `unix timestamp = + + 3600`). Allowed range: 1m <= expiration <= 4h. Example:
+    `unix timestamp = <start> + <duration> + 3600`). Allowed range: 1m <= expiration
+    <= 4h. Example:
     `24.05.2024 14:00:00 (GMT) + 60 seconds of duration + 3600 seconds of expiration = 24.05.2024 15:01:00 (GMT) is Unix timestamp = 1716562860`
     """
 

gcore/types/streaming/create_video_param.py

@@ -25,16 +25,16 @@ class CreateVideoParam(TypedDict, total=False):
       attribute of API POST /streaming/ai/transcribe . Example:
 
     ```
-    `auto_transcribe_audio_language`: "auto"
-    `auto_transcribe_audio_language`: "ger"
+    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)
+      [GET /streaming/ai/tasks](/docs/api-reference/streaming/ai/get-list-of-ai-tasks)
     - 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).
+      [POST /streaming/videos/{`video_id`}/subtitles](/docs/api-reference/streaming/subtitles/add-subtitle).
     """
 
     auto_translate_subtitles_language: Literal["disable", "default", "<language_codes,>"]
@@ -53,8 +53,8 @@ class CreateVideoParam(TypedDict, total=False):
       subtitle will be generated for each language. Example:
 
     ```
-    `auto_translate_subtitles_language`: default
-    `auto_translate_subtitles_language`: eng,fre,ger
+    auto_translate_subtitles_language: default
+    auto_translate_subtitles_language: eng,fre,ger
     ```
 
     Please note that subtitle translation is done separately and after
@@ -95,7 +95,7 @@ class CreateVideoParam(TypedDict, total=False):
 
     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:
+    `Authorization: <auth-scheme> <authorization-parameters>` Examples:
 
     - "`origin_http_headers`": "Authorization: Basic ..."
     - "`origin_http_headers`": "Authorization: Bearer ..."
@@ -104,10 +104,11 @@ class CreateVideoParam(TypedDict, total=False):
 
     ```
     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"
+      "name": "IBC 2024 intro.mp4",
+      "origin_url": "https://www.googleapis.com/drive/v3/files/...?alt=media",
+      "origin_http_headers": "Authorization: Bearer ABC"
     }
     ```
     """
@@ -128,8 +129,8 @@ class CreateVideoParam(TypedDict, total=False):
     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:
+    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==`

gcore/types/streaming/max_stream_series.py

@@ -5,17 +5,17 @@ from typing_extensions import TypeAlias
 
 from ..._models import BaseModel
 
-__all__ = ["MaxStreamSeries", "MaxStreamSeryItem", "MaxStreamSeryItemMetrics"]
+__all__ = ["MaxStreamSeries", "MaxStreamSeriesItem", "MaxStreamSeriesItemMetrics"]
 
 
-class MaxStreamSeryItemMetrics(BaseModel):
+class MaxStreamSeriesItemMetrics(BaseModel):
     streams: List[int]
 
 
-class MaxStreamSeryItem(BaseModel):
+class MaxStreamSeriesItem(BaseModel):
     client: int
 
-    metrics: MaxStreamSeryItemMetrics
+    metrics: MaxStreamSeriesItemMetrics
 
 
-MaxStreamSeries: TypeAlias = List[MaxStreamSeryItem]
+MaxStreamSeries: TypeAlias = List[MaxStreamSeriesItem]

gcore/types/streaming/playlist.py

@@ -49,7 +49,7 @@ class Playlist(BaseModel):
 
     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 ``
+    `/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

gcore/types/streaming/playlist_create_params.py

@@ -49,7 +49,7 @@ class PlaylistCreateParams(TypedDict, total=False):
 
     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 ``
+    `/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

gcore/types/streaming/playlist_update_params.py

@@ -49,7 +49,7 @@ class PlaylistUpdateParams(TypedDict, total=False):
 
     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 ``
+    `/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

gcore/types/streaming/playlist_video.py

@@ -26,16 +26,16 @@ class PlaylistVideo(BaseModel):
       attribute of API POST /streaming/ai/transcribe . Example:
 
     ```
-    `auto_transcribe_audio_language`: "auto"
-    `auto_transcribe_audio_language`: "ger"
+    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)
+      [GET /streaming/ai/tasks](/docs/api-reference/streaming/ai/get-list-of-ai-tasks)
     - 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).
+      [POST /streaming/videos/{`video_id`}/subtitles](/docs/api-reference/streaming/subtitles/add-subtitle).
     """
 
     auto_translate_subtitles_language: Optional[Literal["disable", "default", "<language_codes,>"]] = None
@@ -54,8 +54,8 @@ class PlaylistVideo(BaseModel):
       subtitle will be generated for each language. Example:
 
     ```
-    `auto_translate_subtitles_language`: default
-    `auto_translate_subtitles_language`: eng,fre,ger
+    auto_translate_subtitles_language: default
+    auto_translate_subtitles_language: eng,fre,ger
     ```
 
     Please note that subtitle translation is done separately and after
@@ -96,7 +96,7 @@ class PlaylistVideo(BaseModel):
 
     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:
+    `Authorization: <auth-scheme> <authorization-parameters>` Examples:
 
     - "`origin_http_headers`": "Authorization: Basic ..."
     - "`origin_http_headers`": "Authorization: Bearer ..."
@@ -105,10 +105,11 @@ class PlaylistVideo(BaseModel):
 
     ```
     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"
+      "name": "IBC 2024 intro.mp4",
+      "origin_url": "https://www.googleapis.com/drive/v3/files/...?alt=media",
+      "origin_http_headers": "Authorization: Bearer ABC"
     }
     ```
     """
@@ -129,8 +130,8 @@ class PlaylistVideo(BaseModel):
     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:
+    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==`

gcore/types/streaming/storage_series.py

@@ -5,19 +5,19 @@ from typing_extensions import TypeAlias
 
 from ..._models import BaseModel
 
-__all__ = ["StorageSeries", "StorageSeryItem", "StorageSeryItemMetrics"]
+__all__ = ["StorageSeries", "StorageSeriesItem", "StorageSeriesItemMetrics"]
 
 
-class StorageSeryItemMetrics(BaseModel):
+class StorageSeriesItemMetrics(BaseModel):
     max_volume_usage: List[int]
 
     storage: List[List[int]]
 
 
-class StorageSeryItem(BaseModel):
+class StorageSeriesItem(BaseModel):
     client: int
 
-    metrics: StorageSeryItemMetrics
+    metrics: StorageSeriesItemMetrics
 
 
-StorageSeries: TypeAlias = List[StorageSeryItem]
+StorageSeries: TypeAlias = List[StorageSeriesItem]

gcore/types/streaming/stream.py

@@ -89,7 +89,7 @@ class Stream(BaseModel):
     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_entity_data = '{ "seq_id": "1234567890", "name": "John Doe", "iat": 1516239022 }'`
     """
 
     client_user_id: Optional[int] = None
@@ -168,7 +168,7 @@ class Stream(BaseModel):
     - and its possible to enable ±3 sec for LL-HLS, just ask our Support Team.
 
     It is also possible to use modifier-attributes, which are described in the
-    "`hls_mpegts_url`" field above. If you need to get MPEGTS (.ts) chunks, look at
+    "`hls_mpegts_url`" field above. If you need to get MPEG-TS (.ts) chunks, look at
     the attribute "`hls_mpegts_url`".
 
     Read more information in the article "How Low Latency streaming works" in the
@@ -184,13 +184,13 @@ class Stream(BaseModel):
     hls_mpegts_url: Optional[str] = None
     """HLS output for legacy devices.
 
-    URL for transcoded result of stream in HLS MPEGTS (.ts) format, with .m3u8 link.
-    Low Latency support: NO. Some legacy devices or software may require MPEGTS
-    (.ts) segments as a format for streaming, so we provide this options keeping
-    backward compatibility with any of your existing workflows. For other cases it's
-    better to use "`hls_cmaf_url`" instead. You can use this legacy HLSv6 format
-    based on MPEGTS segmenter in parallel with main HLS CMAF. Both formats are
-    sharing same segments size, manifest length (DVR), etc.
+    URL for transcoded result of stream in HLS MPEG-TS (.ts) format, with .m3u8
+    link. Low Latency support: NO. Some legacy devices or software may require
+    MPEG-TS (.ts) segments as a format for streaming, so we provide this options
+    keeping backward compatibility with any of your existing workflows. For other
+    cases it's better to use "`hls_cmaf_url`" instead. You can use this legacy HLSv6
+    format based on MPEG-TS segmenter in parallel with main HLS CMAF. Both formats
+    are sharing same segments size, manifest length (DVR), etc.
 
     It is also possible to use additional modifier-attributes:
 
@@ -202,8 +202,8 @@ class Stream(BaseModel):
       determine duration in seconds at the level of analyzing the logs of CDN
       requests and compare it with file size (so to use it in your analytics). Such
       modifier attributes are applied manually and added to the link obtained from
-      this field. I.e. `` ?`get_duration_sec`=true `` Example:
-      `https://demo.gvideo.io/mpegts/`2675_19146`/`master_mpegts`.m3u8?`get_duration_sec`=true`
+      this field. I.e. `<hls_url>?get_duration_sec=true` Example:
+      `https://demo.gvideo.io/mpegts/2675_19146/master_mpegts.m3u8?get_duration_sec=true`
 
     ```
     #EXTM3U
@@ -212,7 +212,7 @@ class Stream(BaseModel):
     ...
     #EXTINF:2.000000,
     #EXT-X-PROGRAM-DATE-TIME:2025-08-14T08:15:00
-    seg1.ts?`duration_sec`=2
+    seg1.ts?duration_sec=2
     ...
     ```
     """
@@ -239,28 +239,12 @@ class Stream(BaseModel):
     with limits. That's why you may need to use this HTML web player. Please, look
     Knowledge Base for details. Example of usage on a web page:
 
-    <iframe width="560" height="315" src="https://player.gvideo.co/streams/`2675_201693`" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
+    <iframe width="560" height="315" src="https://player.gvideo.co/streams/2675_201693" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
     """
 
     live: Optional[bool] = None
     """State of receiving and transcoding master stream from source by main server"""
 
-    low_latency_enabled: Optional[bool] = None
-    """
-    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: Optional[Literal["regular", "vr360", "vr180", "vr360tb"]] = None
     """
     Visualization mode for 360° streams, how the stream is rendered in our web
@@ -279,15 +263,19 @@ class Stream(BaseModel):
     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.
+      from external server.
     - 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.
+      from end-device to our Streaming Platform, i.e. from your encoder, mobile app
+      or OBS Studio.
     """
 
     push_url: Optional[str] = None
     """
     URL to PUSH master stream to our main server using RTMP and RTMPS protocols. To
     use RTMPS just manually change the protocol name from "rtmp://" to "rtmps://".
+    Use only 1 protocol of sending a master stream: eitheronly RTMP/S (`push_url`),
+    or only SRT (`push_url_srt`).
+
     If you see an error like "invalid SSL certificate" try the following:
 
     - Make sure the push URL is correct, and it contains "rtmps://".
@@ -295,20 +283,58 @@ class Stream(BaseModel):
       port 443 in the URL. Here’s an example:
       rtmps://vp-push.domain.com:443/in/stream?key.
     - If you're still having trouble, then your encoder may not support RTMPS.
-      Double-check the documentation for your encoder. For advanced customers only:
-      For your complexly distributed broadcast systems, it is also possible to
-      additionally output an array of multi-regional ingestion points for manual
-      selection from them. To activate this mode, contact your manager or the
-      Support Team to activate the "`multi_region_push_urls`" attibute. But if you
-      clearly don’t understand why you need this, then it’s best to use the default
-      single URL in the "`push_url`" attribute.
+      Double-check the documentation for your encoder.
+
+    Please note that 1 connection and 1 protocol can be used at a single moment in
+    time per unique stream key input. Trying to send 2+ connection requests into
+    `push_url` to once, or 2+ protocols at once will not lead to a result. For
+    example, transcoding process will fail if:
+
+    - you are pushing primary and backup RTMP to the same single `push_url`
+      simultaneously
+    - you are pushing RTMP to `push_url` and SRT to `push_url_srt` simultaneously
+
+    For advanced customers only: For your complexly distributed broadcast systems,
+    it is also possible to additionally output an array of multi-regional ingestion
+    points for manual selection from them. To activate this mode, contact your
+    manager or the Support Team to activate the "`multi_region_push_urls`" attibute.
+    But if you clearly don’t understand why you need this, then it’s best to use the
+    default single URL in the "`push_url`" attribute.
     """
 
     push_url_srt: Optional[str] = None
     """
     URL to PUSH master stream to our main server using SRT protocol. Use only 1
-    protocol of sending a master stream: either only SRT (`push_url_srt`), or only
-    RTMP (`push_url`).
+    protocol of sending a master stream: eitheronly RTMP/S (`push_url`), or only SRT
+    (`push_url_srt`).
+
+    **Setup SRT latency on your sender side** SRT is designed as a low-latency
+    transport protocol, but real networks are not always stable and in some cases
+    the end-to-end path from the venue to the ingest point can be long. For this
+    reason, it is important to configure the latency parameter carefully to match
+    the actual network conditions. Small latency values may lead to packet loss when
+    jitter or retransmissions occur, while very large values introduce unnecessary
+    end-to-end delay. \\**Incorrect or low default value is one of the most common
+    reasons for packet loss, frames loss, and bad picture.\\**
+
+    We therefore recommend setting latency manually rather than relying on the
+    default, to ensure the buffer is correctly sized for your environment. A
+    practical range is 400–2000 ms, with the exact value chosen based on RTT,
+    jitter, and expected packet loss. Be sure to check and test SRT settings on your
+    sender side. The default values do not take into account your specific scenarios
+    and do not work well. If necessary, ask us and we will help you.
+
+    Please note that 1 connection and 1 protocol can be used at a single moment in
+    time per unique stream key input. Trying to send 2+ connection requests into
+    `push_url_srt` to once, or 2+ protocols at once will not lead to a result. For
+    example, transcoding process will fail if:
+
+    - you are pushing primary and backup SRT to the same single `push_url_srt`
+      simultaneously
+    - you are pushing RTMP to `push_url` and SRT to `push_url_srt` simultaneously
+
+    See more information and best practices about SRT protocol in the Product
+    Documentation.
     """
 
     push_url_whip: Optional[str] = None
@@ -321,9 +347,9 @@ class Stream(BaseModel):
     receives video data. Signaling is a term to describe communication between
     WebRTC endpoints, needed to initiate and maintain a session. WHIP is an open
     specification for a simple signaling protocol for starting WebRTC sessions in an
-    outgoing direction, (i.e., streaming from your device). **WebRTC stream encoding
-    parameters** At least one video and audio track both must be present in the
-    stream:
+    outgoing direction, (i.e., streaming from your device). There is the primary
+    link only for WHIP, so no backup link. **WebRTC stream encoding parameters** At
+    least one video and audio track both must be present in the stream:
 
     - Video must be encoded with H.264.
     - Audio must be encoded with OPUS. Note. Specifically for WebRTC mode a method
@@ -339,8 +365,18 @@ class Stream(BaseModel):
       https://stackblitz.com/edit/stackblitz-starters-j2r9ar?file=index.html Also
       try to use the feature in UI of the Customer Portal. In the Streaming section
       inside the settings of a specific live stream, a new section "Quick start in
-      browser" has been added. More information in the Product Documentation on the
-      website.
+      browser" has been added.
+
+    Please note that 1 connection and 1 protocol can be used at a single moment in
+    time per unique stream key input. Trying to send 2+ connection requests into
+    `push_url_whip` to once, or 2+ protocols at once will not lead to a result. For
+    example, transcoding process will fail if:
+
+    - you are pushing primary and backup WHIP to the same single `push_url_whip`
+      simultaneously
+    - you are pushing WHIP to `push_url_whip` and RTMP to `push_url` simultaneously
+
+    More information in the Product Documentation on the website.
     """
 
     quality_set_id: Optional[int] = None
@@ -407,10 +443,11 @@ class Stream(BaseModel):
     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.
+    next one will be selected according to the same scheme. After 2 hours of
+    inactivity of your original stream, the system stops PULL requests and the
+    stream is deactivated (the "active" field switches 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.
     """
 
     video_height: Optional[float] = None

gcore/types/streaming/stream_create_clip_params.py

@@ -32,7 +32,8 @@ class StreamCreateClipParams(TypedDict, total=False):
     deleted from memory and is no longer available via the link. You need to create
     a new segment, or use `vod_required: true` attribute. If value is omitted, then
     expiration is counted as +3600 seconds (1 hour) to the end of the clip (i.e.
-    `unix timestamp = + + 3600`). Allowed range: 1m <= expiration <= 4h. Example:
+    `unix timestamp = <start> + <duration> + 3600`). Allowed range: 1m <= expiration
+    <= 4h. Example:
     `24.05.2024 14:00:00 (GMT) + 60 seconds of duration + 3600 seconds of expiration = 24.05.2024 15:01:00 (GMT) is Unix timestamp = 1716562860`
     """
 

gcore/types/streaming/stream_create_params.py

@@ -57,7 +57,7 @@ class StreamCreateParams(TypedDict, total=False):
     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_entity_data = '{ "seq_id": "1234567890", "name": "John Doe", "iat": 1516239022 }'`
     """
 
     client_user_id: int
@@ -94,22 +94,6 @@ class StreamCreateParams(TypedDict, total=False):
     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
@@ -128,9 +112,10 @@ class StreamCreateParams(TypedDict, total=False):
     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.
+      from external server.
     - 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.
+      from end-device to our Streaming Platform, i.e. from your encoder, mobile app
+      or OBS Studio.
     """
 
     quality_set_id: int
@@ -158,8 +143,9 @@ class StreamCreateParams(TypedDict, total=False):
     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.
+    next one will be selected according to the same scheme. After 2 hours of
+    inactivity of your original stream, the system stops PULL requests and the
+    stream is deactivated (the "active" field switches 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/stream_series.py

@@ -5,17 +5,17 @@ from typing_extensions import TypeAlias
 
 from ..._models import BaseModel
 
-__all__ = ["StreamSeries", "StreamSeryItem", "StreamSeryItemMetrics"]
+__all__ = ["StreamSeries", "StreamSeriesItem", "StreamSeriesItemMetrics"]
 
 
-class StreamSeryItemMetrics(BaseModel):
+class StreamSeriesItemMetrics(BaseModel):
     streams: List[int]
 
 
-class StreamSeryItem(BaseModel):
+class StreamSeriesItem(BaseModel):
     client: int
 
-    metrics: StreamSeryItemMetrics
+    metrics: StreamSeriesItemMetrics
 
 
-StreamSeries: TypeAlias = List[StreamSeryItem]
+StreamSeries: TypeAlias = List[StreamSeriesItem]