feat: add play_hls utility

Author: ankit-v2-3

videodb/__init__.py

@@ -4,6 +4,7 @@
 import logging
 
 from typing import Optional
+from videodb._utils.video import play_hls
 from videodb._constants import VIDEO_DB_API
 from videodb.client import Connection
 from videodb.exceptions import (
@@ -23,6 +24,7 @@
     "AuthenticationError",
     "InvalidRequestError",
     "SearchError",
+    "play_hls",
 ]
 
 

videodb/_constants.py

@@ -2,6 +2,7 @@
 
 
 VIDEO_DB_API: str = "https://api.videodb.io"
+PLAYER_URL: str = "https://console.videodb.io/player"
 
 
 class SearchType:

videodb/_utils/video.py

@@ -1,15 +1,23 @@
 import webbrowser as web
 
+from videodb._constants import PLAYER_URL
 
-def play_url(url: str) -> bool:
-    opend = web.open(url)
+
+def play_hls(url: str):
+    """Play a hls stream url in the browser/ notebook
+
+    :param str url: The url of the hls stream
+    :return: The player url if the stream is opened in the browser or the iframe if the stream is opened in the notebook
+    """
+    player = f"{PLAYER_URL}?url={url}"
+    opend = web.open(player)
     if not opend:
         try:
             from IPython.display import IFrame
 
             player_width = 800
             player_height = 400
-            IFrame(url, player_width, player_height)
+            return IFrame(player, player_width, player_height)
         except ImportError:
-            return False
-    return True
+            return player
+    return player

videodb/search.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from videodb._utils.video import play_url
+from videodb._utils.video import play_hls
 from videodb._constants import (
     SearchType,
     ApiPath,
@@ -86,8 +86,7 @@ def play(self) -> str:
         :rtype: str
         """
         self.compile()
-        play_url(self.player_url)
-        return self.player_url
+        return play_hls(self.stream_url)
 
 
 class Search(ABC):

videodb/shot.py

@@ -2,7 +2,7 @@
 
 
 from typing import Optional
-from videodb._utils.video import play_url
+from videodb._utils.video import play_hls
 from videodb._constants import (
     ApiPath,
 )
@@ -78,5 +78,4 @@ def play(self) -> str:
         :rtype: str
         """
         self.generate_stream()
-        play_url(self.player_url)
-        return self.player_url
+        return play_hls(self.stream_url)

videodb/video.py

@@ -1,5 +1,5 @@
 from typing import Optional
-from videodb._utils.video import play_url
+from videodb._utils.video import play_hls
 from videodb._constants import (
     ApiPath,
     SearchType,
@@ -84,9 +84,7 @@ def generate_stream(self, timeline: Optional[list[tuple[int, int]]] = None) -> s
                 "length": self.length,
             },
         )
-        self.stream_url = stream_data.get("stream_url")
-        self.player_url = stream_data.get("player_url")
-        return self.stream_url
+        return stream_data.get("stream_url", None)
 
     def generate_thumbnail(self):
         if self.thumbnail_url:
@@ -137,9 +135,7 @@ def add_subtitle(self) -> str:
                 "type": Workflows.add_subtitles,
             },
         )
-        self.stream_url = subtitle_data.get("stream_url")
-        self.player_url = subtitle_data.get("player_url")
-        return self.stream_url
+        return subtitle_data.get("stream_url", None)
 
     def insert_video(self, video, timestamp: float) -> str:
         """Insert a video into another video
@@ -178,15 +174,12 @@ def insert_video(self, video, timestamp: float) -> str:
                 for shot in all_shots
             ],
         )
-        self.stream_url = compile_data.get("stream_url")
-        self.player_url = compile_data.get("player_url")
-        return self.stream_url
+        return compile_data.get("stream_url", None)
 
     def play(self) -> str:
         """Open the player url in the browser/iframe and return the stream url
 
         :return: The stream url
         :rtype: str
         """
-        play_url(self.player_url)
-        return self.player_url
+        return play_hls(self.player_url)