feat: add url player.

Author: ankit-v2-3

videodb/_utils/_http_client.py

@@ -120,7 +120,7 @@ def _handle_request_error(self, e: requests.exceptions.RequestException) -> None
                 f"Invalid request: {str(e)}", e.response
             ) from None
 
-    @backoff.on_exception(backoff.expo, Exception, max_time=500)
+    @backoff.on_exception(backoff.expo, Exception, max_time=500, logger=None)
     def _get_output(self, url: str):
         """Get the output from an async request"""
         response_json = self.session.get(url).json()

videodb/_utils/video.py

@@ -0,0 +1,15 @@
+import webbrowser as web
+
+
+def play_url(url: str) -> bool:
+    opend = web.open(url)
+    if not opend:
+        try:
+            from IPython.display import IFrame
+
+            player_width = 800
+            player_height = 400
+            IFrame(url, player_width, player_height)
+        except ImportError:
+            return False
+    return True

videodb/search.py

@@ -1,6 +1,5 @@
-import webbrowser as web
-
 from abc import ABC, abstractmethod
+from videodb._utils.video import play_url
 from videodb._constants import (
     SearchType,
     ApiPath,
@@ -73,8 +72,8 @@ def compile(self) -> str:
                     for shot in self.shots
                 ],
             )
-            self.stream_url = compile_data.get("stream_link")
-            self.player_url = compile_data.get("player_link")
+            self.stream_url = compile_data.get("stream_url")
+            self.player_url = compile_data.get("player_url")
             return self.stream_url
 
         else:
@@ -87,7 +86,7 @@ def play(self) -> str:
         :rtype: str
         """
         self.compile()
-        web.open(self.player_url)
+        play_url(self.player_url)
         return self.player_url
 
 

videodb/shot.py

@@ -1,7 +1,8 @@
 """This module contains the shot class"""
 
-import webbrowser as web
+
 from typing import Optional
+from videodb._utils.video import play_url
 from videodb._constants import (
     ApiPath,
 )
@@ -66,8 +67,8 @@ def generate_stream(self) -> str:
                     "length": self.video_length,
                 },
             )
-            self.stream_url = stream_data.get("stream_link")
-            self.player_url = stream_data.get("player_link")
+            self.stream_url = stream_data.get("stream_url")
+            self.player_url = stream_data.get("player_url")
             return self.stream_url
 
     def play(self) -> str:
@@ -77,5 +78,5 @@ def play(self) -> str:
         :rtype: str
         """
         self.generate_stream()
-        web.open(self.player_url)
+        play_url(self.player_url)
         return self.player_url

videodb/video.py

@@ -1,4 +1,5 @@
-import webbrowser as web
+from typing import Optional
+from videodb._utils.video import play_url
 from videodb._constants import (
     ApiPath,
     SearchType,
@@ -7,19 +8,18 @@
 )
 from videodb.search import SearchFactory, SearchResult
 from videodb.shot import Shot
-from typing import Optional
 
 
 class Video:
     def __init__(self, _connection, id: str, collection_id: str, **kwargs) -> None:
         self._connection = _connection
         self.id = id
         self.collection_id = collection_id
-        self.stream_url = kwargs.get("stream_link", None)
-        self.player_url = kwargs.get("player_link", None)
+        self.stream_url = kwargs.get("stream_url", None)
+        self.player_url = kwargs.get("player_url", None)
         self.name = kwargs.get("name", None)
         self.description = kwargs.get("description", None)
-        self.thumbnail_url = kwargs.get("thumbnail", None)
+        self.thumbnail_url = kwargs.get("thumbnail_url", None)
         self.length = float(kwargs.get("length", 0.0))
         self.transcript = kwargs.get("transcript", None)
         self.transcript_text = kwargs.get("transcript_text", None)
@@ -84,8 +84,8 @@ def generate_stream(self, timeline: Optional[list[tuple[int, int]]] = None) -> s
                 "length": self.length,
             },
         )
-        self.stream_url = stream_data.get("stream_link")
-        self.player_url = stream_data.get("player_link")
+        self.stream_url = stream_data.get("stream_url")
+        self.player_url = stream_data.get("player_url")
         return self.stream_url
 
     def generate_thumbnail(self):
@@ -94,7 +94,7 @@ def generate_thumbnail(self):
         thumbnail_data = self._connection.get(
             path=f"{ApiPath.video}/{self.id}/{ApiPath.thumbnail}"
         )
-        self.thumbnail_url = thumbnail_data.get("thumbnail")
+        self.thumbnail_url = thumbnail_data.get("thumbnail_url")
         return self.thumbnail_url
 
     def _fetch_transcript(self, force: bool = False) -> None:
@@ -137,8 +137,8 @@ def add_subtitle(self) -> str:
                 "type": Workflows.add_subtitles,
             },
         )
-        self.stream_url = subtitle_data.get("stream_link")
-        self.player_url = subtitle_data.get("player_link")
+        self.stream_url = subtitle_data.get("stream_url")
+        self.player_url = subtitle_data.get("player_url")
         return self.stream_url
 
     def insert_video(self, video, timestamp: float) -> str:
@@ -178,16 +178,15 @@ def insert_video(self, video, timestamp: float) -> str:
                 for shot in all_shots
             ],
         )
-        self.stream_url = compile_data.get("stream_link")
-        self.player_url = compile_data.get("player_link")
+        self.stream_url = compile_data.get("stream_url")
+        self.player_url = compile_data.get("player_url")
         return self.stream_url
 
     def play(self) -> str:
-        """Generate a stream url for the shot and open it in the default browser
+        """Open the player url in the browser/iframe and return the stream url
 
         :return: The stream url
         :rtype: str
         """
-        self.generate_stream()
-        web.open(self.player_url)
+        play_url(self.player_url)
         return self.player_url