refactor: rename play_hls -> play_stream

Author: ankit-v2-3

.gitignore

@@ -15,3 +15,4 @@ dist/*
 venv/
 .vscode/*
 example.ipynb
+example.py

videodb/__init__.py

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

videodb/_utils/_video.py

@@ -3,10 +3,10 @@
 from videodb._constants import PLAYER_URL
 
 
-def play_hls(url: str):
-    """Play a hls stream url in the browser/ notebook
+def play_stream(url: str):
+    """Play a stream url in the browser/ notebook
 
-    :param str url: The url of the hls stream
+    :param str url: The url of the 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}"

videodb/search.py

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

videodb/shot.py

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

videodb/video.py

@@ -1,5 +1,5 @@
 from typing import Optional
-from videodb._utils._video import play_hls
+from videodb._utils._video import play_stream
 from videodb._constants import (
     ApiPath,
     SearchType,
@@ -182,4 +182,4 @@ def play(self) -> str:
         :return: The stream url
         :rtype: str
         """
-        return play_hls(self.stream_url)
+        return play_stream(self.stream_url)