gcore 0.9.0__py3-none-any.whl → 0.11.0__py3-none-any.whl

gcore/resources/streaming/streams/streams.py

@@ -80,7 +80,6 @@ class StreamsResource(SyncAPIResource):
         dvr_enabled: bool | NotGiven = NOT_GIVEN,
         hls_mpegts_endlist_tag: bool | NotGiven = NOT_GIVEN,
         html_overlay: bool | NotGiven = NOT_GIVEN,
-        low_latency_enabled: bool | NotGiven = NOT_GIVEN,
         projection: Literal["regular", "vr360", "vr180", "vr360tb"] | NotGiven = NOT_GIVEN,
         pull: bool | NotGiven = NOT_GIVEN,
         quality_set_id: int | NotGiven = NOT_GIVEN,
@@ -113,7 +112,7 @@ class StreamsResource(SyncAPIResource):
         for video streams by utilizing Common Media Application Format (CMAF)
         technology. So you obtain latency from the traditional 30-50 seconds to ±4
         seconds only by default. If you need legacy non-low-latency HLS, then look at
-        HLS MPEGTS delivery below.
+        HLS MPEG-TS delivery below.
 
         You have access to additional functions such as:
 
@@ -162,7 +161,7 @@ class StreamsResource(SyncAPIResource):
               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: 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`
@@ -184,19 +183,6 @@ class StreamsResource(SyncAPIResource):
           html_overlay: Switch on mode to insert and display real-time HTML overlay widgets on top of
               live streams
 
-          low_latency_enabled: 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: 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:
@@ -210,9 +196,10 @@ class StreamsResource(SyncAPIResource):
               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: Custom quality set ID for transcoding, if transcoding is required according to
               your conditions. Look at GET /`quality_sets` method
@@ -230,10 +217,11 @@ class StreamsResource(SyncAPIResource):
               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.
 
           extra_headers: Send extra headers
 
@@ -258,7 +246,6 @@ class StreamsResource(SyncAPIResource):
                     "dvr_enabled": dvr_enabled,
                     "hls_mpegts_endlist_tag": hls_mpegts_endlist_tag,
                     "html_overlay": html_overlay,
-                    "low_latency_enabled": low_latency_enabled,
                     "projection": projection,
                     "pull": pull,
                     "quality_set_id": quality_set_id,
@@ -318,7 +305,7 @@ class StreamsResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncPageStreaming[Stream]:
-        """Returns a list of streams.
+        """Returns a list of streams
 
         Args:
           page: Query parameter.
@@ -379,8 +366,8 @@ class StreamsResource(SyncAPIResource):
         Perhaps, instead of deleting, you may use the stream deactivation:
 
         ```
-        PATCH /videos/{`stream_id`}
-        { "active": false }
+        PATCH / videos / {stream_id}
+        {"active": false}
         ```
 
         For details, see the Product Documentation.
@@ -462,7 +449,7 @@ class StreamsResource(SyncAPIResource):
         - HLS .m3u8,
         - MP4,
         - VOD in video hosting with a permanent link to watch video.
-          ![HTML Overlays](https://demo-files.gvideo.io/apidocs/`clip_recording_mp4_hls`.gif)
+          ![HTML Overlays](https://demo-files.gvideo.io/apidocs/clip_recording_mp4_hls.gif)
 
         **Clip lifetime:** Instant clips are a copy of the stream, created from a live
         stream. They are stored in memory for a limited time, after which the clip
@@ -516,7 +503,8 @@ class StreamsResource(SyncAPIResource):
               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`
 
           start: Starting point of the segment to cut. Unix timestamp in seconds, absolute value.
@@ -606,13 +594,13 @@ class StreamsResource(SyncAPIResource):
         renditions list in order to get exact bitrate/quality from the set. Example:
 
         - HLS 720p:
-          `` https://CID.domain.com/rec/`111_1000`/`rec_d7bsli54p8n4_qsid42_master`.m3u8 ``
+          `https://CID.domain.com/rec/111_1000/rec_d7bsli54p8n4_qsid42_master.m3u8`
         - HLS 720p:
-          `` https://CID.domain.com/rec/`111_1000`/`rec_d7bsli54p8n4_qsid42_media_1_360`.m3u8 ``
+          `https://CID.domain.com/rec/111_1000/rec_d7bsli54p8n4_qsid42_media_1_360.m3u8`
         - MP4 360p:
-          `` https://CID.domain.com/rec/`111_1000`/`rec_d7bsli54p8n4_qsid42_master`.mp4 ``
+          `https://CID.domain.com/rec/111_1000/rec_d7bsli54p8n4_qsid42_master.mp4`
         - MP4 360p:
-          `` https://CID.domain.com/rec/`111_1000`/`rec_d7bsli54p8n4_qsid42_media_1_360`.mp4 ``
+          `https://CID.domain.com/rec/111_1000/rec_d7bsli54p8n4_qsid42_media_1_360.mp4`
 
         Args:
           extra_headers: Send extra headers
@@ -775,7 +763,6 @@ class AsyncStreamsResource(AsyncAPIResource):
         dvr_enabled: bool | NotGiven = NOT_GIVEN,
         hls_mpegts_endlist_tag: bool | NotGiven = NOT_GIVEN,
         html_overlay: bool | NotGiven = NOT_GIVEN,
-        low_latency_enabled: bool | NotGiven = NOT_GIVEN,
         projection: Literal["regular", "vr360", "vr180", "vr360tb"] | NotGiven = NOT_GIVEN,
         pull: bool | NotGiven = NOT_GIVEN,
         quality_set_id: int | NotGiven = NOT_GIVEN,
@@ -808,7 +795,7 @@ class AsyncStreamsResource(AsyncAPIResource):
         for video streams by utilizing Common Media Application Format (CMAF)
         technology. So you obtain latency from the traditional 30-50 seconds to ±4
         seconds only by default. If you need legacy non-low-latency HLS, then look at
-        HLS MPEGTS delivery below.
+        HLS MPEG-TS delivery below.
 
         You have access to additional functions such as:
 
@@ -857,7 +844,7 @@ class AsyncStreamsResource(AsyncAPIResource):
               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: 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`
@@ -879,19 +866,6 @@ class AsyncStreamsResource(AsyncAPIResource):
           html_overlay: Switch on mode to insert and display real-time HTML overlay widgets on top of
               live streams
 
-          low_latency_enabled: 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: 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:
@@ -905,9 +879,10 @@ class AsyncStreamsResource(AsyncAPIResource):
               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: Custom quality set ID for transcoding, if transcoding is required according to
               your conditions. Look at GET /`quality_sets` method
@@ -925,10 +900,11 @@ class AsyncStreamsResource(AsyncAPIResource):
               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.
 
           extra_headers: Send extra headers
 
@@ -953,7 +929,6 @@ class AsyncStreamsResource(AsyncAPIResource):
                     "dvr_enabled": dvr_enabled,
                     "hls_mpegts_endlist_tag": hls_mpegts_endlist_tag,
                     "html_overlay": html_overlay,
-                    "low_latency_enabled": low_latency_enabled,
                     "projection": projection,
                     "pull": pull,
                     "quality_set_id": quality_set_id,
@@ -1013,7 +988,7 @@ class AsyncStreamsResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[Stream, AsyncPageStreaming[Stream]]:
-        """Returns a list of streams.
+        """Returns a list of streams
 
         Args:
           page: Query parameter.
@@ -1074,8 +1049,8 @@ class AsyncStreamsResource(AsyncAPIResource):
         Perhaps, instead of deleting, you may use the stream deactivation:
 
         ```
-        PATCH /videos/{`stream_id`}
-        { "active": false }
+        PATCH / videos / {stream_id}
+        {"active": false}
         ```
 
         For details, see the Product Documentation.
@@ -1157,7 +1132,7 @@ class AsyncStreamsResource(AsyncAPIResource):
         - HLS .m3u8,
         - MP4,
         - VOD in video hosting with a permanent link to watch video.
-          ![HTML Overlays](https://demo-files.gvideo.io/apidocs/`clip_recording_mp4_hls`.gif)
+          ![HTML Overlays](https://demo-files.gvideo.io/apidocs/clip_recording_mp4_hls.gif)
 
         **Clip lifetime:** Instant clips are a copy of the stream, created from a live
         stream. They are stored in memory for a limited time, after which the clip
@@ -1211,7 +1186,8 @@ class AsyncStreamsResource(AsyncAPIResource):
               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`
 
           start: Starting point of the segment to cut. Unix timestamp in seconds, absolute value.
@@ -1301,13 +1277,13 @@ class AsyncStreamsResource(AsyncAPIResource):
         renditions list in order to get exact bitrate/quality from the set. Example:
 
         - HLS 720p:
-          `` https://CID.domain.com/rec/`111_1000`/`rec_d7bsli54p8n4_qsid42_master`.m3u8 ``
+          `https://CID.domain.com/rec/111_1000/rec_d7bsli54p8n4_qsid42_master.m3u8`
         - HLS 720p:
-          `` https://CID.domain.com/rec/`111_1000`/`rec_d7bsli54p8n4_qsid42_media_1_360`.m3u8 ``
+          `https://CID.domain.com/rec/111_1000/rec_d7bsli54p8n4_qsid42_media_1_360.m3u8`
         - MP4 360p:
-          `` https://CID.domain.com/rec/`111_1000`/`rec_d7bsli54p8n4_qsid42_master`.mp4 ``
+          `https://CID.domain.com/rec/111_1000/rec_d7bsli54p8n4_qsid42_master.mp4`
         - MP4 360p:
-          `` https://CID.domain.com/rec/`111_1000`/`rec_d7bsli54p8n4_qsid42_media_1_360`.mp4 ``
+          `https://CID.domain.com/rec/111_1000/rec_d7bsli54p8n4_qsid42_media_1_360.mp4`
 
         Args:
           extra_headers: Send extra headers

gcore/resources/streaming/videos/subtitles.py

@@ -62,18 +62,18 @@ class SubtitlesResource(SyncAPIResource):
         formats:
 
         - SRT – SubRip Text is described on
-          [wikipedia.org](https://en.wikipedia.org/wiki/SubRip#`SubRip_file_format`).
-          Must start from integer for sequence number. Use calidators to check the
-          subtitles, like
+          [wikipedia.org](https://en.wikipedia.org/wiki/SubRip#SubRip_file_format). Must
+          start from integer for sequence number. Use calidators to check the subtitles,
+          like
           [srt-validator](https://taoning2014.github.io/srt-validator-website/index.html).
         - WebVTT – Web Video Text Tracks Format is described on
-          [developer.mozilla.org](https://developer.mozilla.org/en-US/docs/Web/API/`WebVTT_API`).
+          [developer.mozilla.org](https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API).
           Must start from "WEBVTT" header. Use validators to check the subtitles, like
           [W3C](https://w3c.github.io/webvtt.js/parser.html). Language is 3-letter
           language code according to ISO-639-2 (bibliographic code). Specify language
           you need, or just look at our list in the attribute "`audio_language`" of
           section
-          ["AI Transcribe"](https://api.gcore.com/docs/streaming/docs/api-reference/streaming/ai/create-ai-asr-task).
+          ["AI Speech Recognition"](/docs/api-reference/streaming/ai/create-ai-asr-task).
           You can add multiple subtitles in the same language, language uniqueness is
           not required. Size must be up to 5Mb.
 
@@ -84,18 +84,19 @@ class SubtitlesResource(SyncAPIResource):
         subtitles based on AI. Read more:
 
         - What is
-          ["AI Transcribe"](https://api.gcore.com/docs/streaming/docs/api-reference/streaming/ai/create-ai-asr-task).
-        - If the option is enabled via `auto_transcribe_audio_language: auto|`, then
-          immediately after successful transcoding, an AI task will be automatically
-          created for transcription.
+          ["AI Speech Recognition"](/docs/api-reference/streaming/ai/create-ai-asr-task).
+        - If the option is enabled via
+          `auto_transcribe_audio_language: auto|<language_code>`, then immediately after
+          successful transcoding, an AI task will be automatically created for
+          transcription.
         - If you need to translate subtitles from original language to any other, then
           AI-task of subtitles translation can be applied. Use
-          `auto_translate_subtitles_language: default|` parameter for that. Also you can
-          point several languages to translate to, then a separate subtitle will be
-          generated for each specified language. The created AI-task(s) will be
-          automatically executed, and result will also be automatically attached to this
-          video as subtitle(s). If AI is disabled in your account, you will receive code
-          422 in response.
+          `auto_translate_subtitles_language: default|<language_codes,>` parameter for
+          that. Also you can point several languages to translate to, then a separate
+          subtitle will be generated for each specified language. The created AI-task(s)
+          will be automatically executed, and result will also be automatically attached
+          to this video as subtitle(s). If AI is disabled in your account, you will
+          receive code 422 in response.
 
         **Where and how subtitles are displayed?** Subtitles are became available in the
         API response and in playback manifests. All added subtitles are automatically
@@ -320,18 +321,18 @@ class AsyncSubtitlesResource(AsyncAPIResource):
         formats:
 
         - SRT – SubRip Text is described on
-          [wikipedia.org](https://en.wikipedia.org/wiki/SubRip#`SubRip_file_format`).
-          Must start from integer for sequence number. Use calidators to check the
-          subtitles, like
+          [wikipedia.org](https://en.wikipedia.org/wiki/SubRip#SubRip_file_format). Must
+          start from integer for sequence number. Use calidators to check the subtitles,
+          like
           [srt-validator](https://taoning2014.github.io/srt-validator-website/index.html).
         - WebVTT – Web Video Text Tracks Format is described on
-          [developer.mozilla.org](https://developer.mozilla.org/en-US/docs/Web/API/`WebVTT_API`).
+          [developer.mozilla.org](https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API).
           Must start from "WEBVTT" header. Use validators to check the subtitles, like
           [W3C](https://w3c.github.io/webvtt.js/parser.html). Language is 3-letter
           language code according to ISO-639-2 (bibliographic code). Specify language
           you need, or just look at our list in the attribute "`audio_language`" of
           section
-          ["AI Transcribe"](https://api.gcore.com/docs/streaming/docs/api-reference/streaming/ai/create-ai-asr-task).
+          ["AI Speech Recognition"](/docs/api-reference/streaming/ai/create-ai-asr-task).
           You can add multiple subtitles in the same language, language uniqueness is
           not required. Size must be up to 5Mb.
 
@@ -342,18 +343,19 @@ class AsyncSubtitlesResource(AsyncAPIResource):
         subtitles based on AI. Read more:
 
         - What is
-          ["AI Transcribe"](https://api.gcore.com/docs/streaming/docs/api-reference/streaming/ai/create-ai-asr-task).
-        - If the option is enabled via `auto_transcribe_audio_language: auto|`, then
-          immediately after successful transcoding, an AI task will be automatically
-          created for transcription.
+          ["AI Speech Recognition"](/docs/api-reference/streaming/ai/create-ai-asr-task).
+        - If the option is enabled via
+          `auto_transcribe_audio_language: auto|<language_code>`, then immediately after
+          successful transcoding, an AI task will be automatically created for
+          transcription.
         - If you need to translate subtitles from original language to any other, then
           AI-task of subtitles translation can be applied. Use
-          `auto_translate_subtitles_language: default|` parameter for that. Also you can
-          point several languages to translate to, then a separate subtitle will be
-          generated for each specified language. The created AI-task(s) will be
-          automatically executed, and result will also be automatically attached to this
-          video as subtitle(s). If AI is disabled in your account, you will receive code
-          422 in response.
+          `auto_translate_subtitles_language: default|<language_codes,>` parameter for
+          that. Also you can point several languages to translate to, then a separate
+          subtitle will be generated for each specified language. The created AI-task(s)
+          will be automatically executed, and result will also be automatically attached
+          to this video as subtitle(s). If AI is disabled in your account, you will
+          receive code 422 in response.
 
         **Where and how subtitles are displayed?** Subtitles are became available in the
         API response and in playback manifests. All added subtitles are automatically