index.rst•3.84 kB
VideoDB Python SDK
===================
The VideoDB Python SDK is a Python library for interacting with the [VideoDB](https://videodb.io)
Generate API keys at https://console.videodb.io
The Following are submodules of the VideoDB Python SDK:
-------------------------------------------------------
VideoDB python module metadata
-------------------------------------------------------
.. automodule:: videodb.__about__
:members:
:show-inheritance:
:undoc-members:
:special-members: __version__
Default Module videodb (`from videodb import class, func`)
----------------------------------------------------------
.. autofunction:: videodb.connect
.. autofunction:: videodb.play_stream
.. autoclass:: videodb.VideodbError
:members:
.. autoclass:: videodb.AuthenticationError
:members:
.. autoclass:: videodb.InvalidRequestError
:members:
.. autoclass:: videodb.SearchError
:members:
.. data:: videodb.VIDEO_DB_API
.. autoclass:: videodb.IndexType
:members:
:undoc-members:
.. autoclass:: videodb.MediaType
:members:
:undoc-members:
.. autoclass:: videodb.SearchType
:members:
:undoc-members:
.. autoclass:: videodb.SceneExtractionType
:members:
:undoc-members:
.. autoclass:: videodb.Segmenter
:members:
:undoc-members:
.. autoclass:: videodb.SubtitleAlignment
:members:
:undoc-members:
.. autoclass:: videodb.SubtitleBorderStyle
:members:
:undoc-members:
.. autoclass:: videodb.SubtitleStyle
:members:
.. autoclass:: videodb.TextStyle
:members:
Module : videodb.client (`from videodb.client import class, func`)
------------------------------------------------------------------
.. automodule:: videodb.client
:members:
:special-members: __init__
:show-inheritance:
:undoc-members:
Module : videodb.collection (`from videodb.collection import class, func`)
--------------------------------------------------------------------------
.. automodule:: videodb.collection
:members:
:special-members: __init__
:show-inheritance:
:undoc-members:
Module : videodb.video (`from videodb.video import class, func`)
------------------------------------------------------------------
.. automodule:: videodb.video
:members:
:show-inheritance:
:undoc-members:
Module : videodb.audio (`from videodb.audio import class, func`)
------------------------------------------------------------------
.. automodule:: videodb.audio
:members:
:show-inheritance:
:undoc-members:
Module : videodb.image (`from videodb.image import class, func`)
------------------------------------------------------------------
.. automodule:: videodb.image
:members:
:show-inheritance:
:undoc-members:
Module : videodb.timeline (`from videodb.timeline import class, func`)
----------------------------------------------------------------------
.. automodule:: videodb.timeline
:members:
:show-inheritance:
:undoc-members:
Module : videodb.asset (`from videodb.asset import class, func`)
------------------------------------------------------------------
.. automodule:: videodb.asset
:members:
:show-inheritance:
:undoc-members:
Module : videodb.scene (`from videodb.scene import class, func`)
------------------------------------------------------------------
.. automodule:: videodb.scene
:members:
:show-inheritance:
:undoc-members:
Module : videodb.search (`from videodb.search import class, func`)
------------------------------------------------------------------
.. autoclass:: videodb.search.SearchResult
:members:
:show-inheritance:
:undoc-members:
Module : videodb.shot (`from videodb.shot import class, func`)
------------------------------------------------------------------
.. automodule:: videodb.shot
:members:
:show-inheritance:
:undoc-members: