gcore 0.13.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

gcore/resources/streaming/streams/overlays.py

@@ -6,7 +6,7 @@ from typing import Iterable
 
 import httpx
 
-from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+from ...._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
 from ...._utils import maybe_transform, async_maybe_transform
 from ...._compat import cached_property
 from ...._resource import SyncAPIResource, AsyncAPIResource
@@ -50,13 +50,13 @@ class OverlaysResource(SyncAPIResource):
         self,
         stream_id: int,
         *,
-        body: Iterable[overlay_create_params.Body] | NotGiven = NOT_GIVEN,
+        body: Iterable[overlay_create_params.Body] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> OverlayCreateResponse:
         """
         "Overlay" is a live HTML widget, which rendered and inserted over the live
@@ -65,6 +65,7 @@ class OverlaysResource(SyncAPIResource):
         There are can be more that 1 overlay over a stream, which are small or stretched
         over full frame. Overlays can have transparent areas. Frequency of update is 1
         FPS. Automatic size scaling for Adaptative Bitrate qualities is applied.
+
         ![HTML Overlays](https://demo-files.gvideo.io/apidocs/coffee_run_overlays.gif)
 
         How to activate and use in simple steps:
@@ -73,12 +74,16 @@ class OverlaysResource(SyncAPIResource):
         - Set “`html_overlay`” attribute to "true" for a stream
         - Set array of overlays
         - Start or restart your stream again
-        - Enjoy :-) For the first time an overlay should be enabled **before** start
-          pushing of a live stream. If you are pushing the stream already (stream is
-          alive and you are activating overlay for the first time), then overlay will
-          become active after restart pushing. Once you activate the overlay for the
-          stream for the first time, you can add, change, move, delete widgets on the
-          fly even during a live stream with no affection on a result stream.
+        - Enjoy :-)
+
+        For the first time an overlay should be enabled **before** start pushing of a
+        live stream. If you are pushing the stream already (stream is alive and you are
+        activating overlay for the first time), then overlay will become active after
+        restart pushing.
+
+        Once you activate the overlay for the stream for the first time, you can add,
+        change, move, delete widgets on the fly even during a live stream with no
+        affection on a result stream.
 
         Tech limits:
 
@@ -105,13 +110,16 @@ class OverlaysResource(SyncAPIResource):
           can be stopped automatically, and the ability to insert widgets itself is
           banned.
         - If feature is disabled, you will receive HTTP code: 422. Error text: Feature
-          disabled. Contact support to enable. Please, pay attention to the content of
-          HTML widges you use. If you don't trust them, then you shouldn't use them, as
-          their result will be displayed in live stream to all users. **Will there be a
-          widget in the recording?** Right now overlay widgets are sent to the end
-          viewer in the HLS/DASH streams, but are not recorded due to technical
-          limitations. We are working to ensure that widgets remain in the recordings as
-          well. Follow the news.
+          disabled. Contact support to enable.
+
+        Please, pay attention to the content of HTML widges you use. If you don't trust
+        them, then you shouldn't use them, as their result will be displayed in live
+        stream to all users.
+
+        **Will there be a widget in the recording?** Right now overlay widgets are sent
+        to the end viewer in the HLS/DASH streams, but are not recorded due to technical
+        limitations. We are working to ensure that widgets remain in the recordings as
+        well. Follow the news.
 
         Args:
           extra_headers: Send extra headers
@@ -123,7 +131,9 @@ class OverlaysResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._post(
-            f"/streaming/streams/{stream_id}/overlays",
+            f"/streaming/streams/{stream_id}/overlays"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays",
             body=maybe_transform(body, Iterable[overlay_create_params.Body]),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -136,18 +146,18 @@ class OverlaysResource(SyncAPIResource):
         overlay_id: int,
         *,
         stream_id: int,
-        height: int | NotGiven = NOT_GIVEN,
-        stretch: bool | NotGiven = NOT_GIVEN,
-        url: str | NotGiven = NOT_GIVEN,
-        width: int | NotGiven = NOT_GIVEN,
-        x: int | NotGiven = NOT_GIVEN,
-        y: int | NotGiven = NOT_GIVEN,
+        height: int | Omit = omit,
+        stretch: bool | Omit = omit,
+        url: str | Omit = omit,
+        width: int | Omit = omit,
+        x: int | Omit = omit,
+        y: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Overlay:
         """
         Updates overlay settings
@@ -175,7 +185,9 @@ class OverlaysResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._patch(
-            f"/streaming/streams/{stream_id}/overlays/{overlay_id}",
+            f"/streaming/streams/{stream_id}/overlays/{overlay_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays/{overlay_id}",
             body=maybe_transform(
                 {
                     "height": height,
@@ -202,7 +214,7 @@ class OverlaysResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> OverlayListResponse:
         """
         Returns a list of HTML overlay widgets which are attached to a stream
@@ -217,7 +229,9 @@ class OverlaysResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get(
-            f"/streaming/streams/{stream_id}/overlays",
+            f"/streaming/streams/{stream_id}/overlays"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -234,7 +248,7 @@ class OverlaysResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
         """
         Delete an overlay
@@ -250,7 +264,9 @@ class OverlaysResource(SyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._delete(
-            f"/streaming/streams/{stream_id}/overlays/{overlay_id}",
+            f"/streaming/streams/{stream_id}/overlays/{overlay_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays/{overlay_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -267,7 +283,7 @@ class OverlaysResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Overlay:
         """
         Get overlay details
@@ -282,7 +298,9 @@ class OverlaysResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get(
-            f"/streaming/streams/{stream_id}/overlays/{overlay_id}",
+            f"/streaming/streams/{stream_id}/overlays/{overlay_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays/{overlay_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -293,13 +311,13 @@ class OverlaysResource(SyncAPIResource):
         self,
         stream_id: int,
         *,
-        body: Iterable[overlay_update_multiple_params.Body] | NotGiven = NOT_GIVEN,
+        body: Iterable[overlay_update_multiple_params.Body] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> OverlayUpdateMultipleResponse:
         """
         Updates settings for set of overlays
@@ -314,7 +332,9 @@ class OverlaysResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._patch(
-            f"/streaming/streams/{stream_id}/overlays",
+            f"/streaming/streams/{stream_id}/overlays"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays",
             body=maybe_transform(body, Iterable[overlay_update_multiple_params.Body]),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -347,13 +367,13 @@ class AsyncOverlaysResource(AsyncAPIResource):
         self,
         stream_id: int,
         *,
-        body: Iterable[overlay_create_params.Body] | NotGiven = NOT_GIVEN,
+        body: Iterable[overlay_create_params.Body] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> OverlayCreateResponse:
         """
         "Overlay" is a live HTML widget, which rendered and inserted over the live
@@ -362,6 +382,7 @@ class AsyncOverlaysResource(AsyncAPIResource):
         There are can be more that 1 overlay over a stream, which are small or stretched
         over full frame. Overlays can have transparent areas. Frequency of update is 1
         FPS. Automatic size scaling for Adaptative Bitrate qualities is applied.
+
         ![HTML Overlays](https://demo-files.gvideo.io/apidocs/coffee_run_overlays.gif)
 
         How to activate and use in simple steps:
@@ -370,12 +391,16 @@ class AsyncOverlaysResource(AsyncAPIResource):
         - Set “`html_overlay`” attribute to "true" for a stream
         - Set array of overlays
         - Start or restart your stream again
-        - Enjoy :-) For the first time an overlay should be enabled **before** start
-          pushing of a live stream. If you are pushing the stream already (stream is
-          alive and you are activating overlay for the first time), then overlay will
-          become active after restart pushing. Once you activate the overlay for the
-          stream for the first time, you can add, change, move, delete widgets on the
-          fly even during a live stream with no affection on a result stream.
+        - Enjoy :-)
+
+        For the first time an overlay should be enabled **before** start pushing of a
+        live stream. If you are pushing the stream already (stream is alive and you are
+        activating overlay for the first time), then overlay will become active after
+        restart pushing.
+
+        Once you activate the overlay for the stream for the first time, you can add,
+        change, move, delete widgets on the fly even during a live stream with no
+        affection on a result stream.
 
         Tech limits:
 
@@ -402,13 +427,16 @@ class AsyncOverlaysResource(AsyncAPIResource):
           can be stopped automatically, and the ability to insert widgets itself is
           banned.
         - If feature is disabled, you will receive HTTP code: 422. Error text: Feature
-          disabled. Contact support to enable. Please, pay attention to the content of
-          HTML widges you use. If you don't trust them, then you shouldn't use them, as
-          their result will be displayed in live stream to all users. **Will there be a
-          widget in the recording?** Right now overlay widgets are sent to the end
-          viewer in the HLS/DASH streams, but are not recorded due to technical
-          limitations. We are working to ensure that widgets remain in the recordings as
-          well. Follow the news.
+          disabled. Contact support to enable.
+
+        Please, pay attention to the content of HTML widges you use. If you don't trust
+        them, then you shouldn't use them, as their result will be displayed in live
+        stream to all users.
+
+        **Will there be a widget in the recording?** Right now overlay widgets are sent
+        to the end viewer in the HLS/DASH streams, but are not recorded due to technical
+        limitations. We are working to ensure that widgets remain in the recordings as
+        well. Follow the news.
 
         Args:
           extra_headers: Send extra headers
@@ -420,7 +448,9 @@ class AsyncOverlaysResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._post(
-            f"/streaming/streams/{stream_id}/overlays",
+            f"/streaming/streams/{stream_id}/overlays"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays",
             body=await async_maybe_transform(body, Iterable[overlay_create_params.Body]),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -433,18 +463,18 @@ class AsyncOverlaysResource(AsyncAPIResource):
         overlay_id: int,
         *,
         stream_id: int,
-        height: int | NotGiven = NOT_GIVEN,
-        stretch: bool | NotGiven = NOT_GIVEN,
-        url: str | NotGiven = NOT_GIVEN,
-        width: int | NotGiven = NOT_GIVEN,
-        x: int | NotGiven = NOT_GIVEN,
-        y: int | NotGiven = NOT_GIVEN,
+        height: int | Omit = omit,
+        stretch: bool | Omit = omit,
+        url: str | Omit = omit,
+        width: int | Omit = omit,
+        x: int | Omit = omit,
+        y: int | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Overlay:
         """
         Updates overlay settings
@@ -472,7 +502,9 @@ class AsyncOverlaysResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._patch(
-            f"/streaming/streams/{stream_id}/overlays/{overlay_id}",
+            f"/streaming/streams/{stream_id}/overlays/{overlay_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays/{overlay_id}",
             body=await async_maybe_transform(
                 {
                     "height": height,
@@ -499,7 +531,7 @@ class AsyncOverlaysResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> OverlayListResponse:
         """
         Returns a list of HTML overlay widgets which are attached to a stream
@@ -514,7 +546,9 @@ class AsyncOverlaysResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._get(
-            f"/streaming/streams/{stream_id}/overlays",
+            f"/streaming/streams/{stream_id}/overlays"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -531,7 +565,7 @@ class AsyncOverlaysResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
         """
         Delete an overlay
@@ -547,7 +581,9 @@ class AsyncOverlaysResource(AsyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._delete(
-            f"/streaming/streams/{stream_id}/overlays/{overlay_id}",
+            f"/streaming/streams/{stream_id}/overlays/{overlay_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays/{overlay_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -564,7 +600,7 @@ class AsyncOverlaysResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Overlay:
         """
         Get overlay details
@@ -579,7 +615,9 @@ class AsyncOverlaysResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._get(
-            f"/streaming/streams/{stream_id}/overlays/{overlay_id}",
+            f"/streaming/streams/{stream_id}/overlays/{overlay_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays/{overlay_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -590,13 +628,13 @@ class AsyncOverlaysResource(AsyncAPIResource):
         self,
         stream_id: int,
         *,
-        body: Iterable[overlay_update_multiple_params.Body] | NotGiven = NOT_GIVEN,
+        body: Iterable[overlay_update_multiple_params.Body] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> OverlayUpdateMultipleResponse:
         """
         Updates settings for set of overlays
@@ -611,7 +649,9 @@ class AsyncOverlaysResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._patch(
-            f"/streaming/streams/{stream_id}/overlays",
+            f"/streaming/streams/{stream_id}/overlays"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//streaming/streams/{stream_id}/overlays",
             body=await async_maybe_transform(body, Iterable[overlay_update_multiple_params.Body]),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout