Metadata-Version: 2.1
Name: rtsp
Version: 1.1.8
Summary: RTSP client wrapper around gstreamer/opencv
Home-page: https://github.com/statueofmike/rtsp
Author: Michael Stewart
Author-email: statueofmike@gmail.com
License: MIT
Download-URL: https://github.com/statueofmike/rtsp/archive/1.1.8.tar.gz
Description: # RTSP Package
        
                    /((((((\\\\
            =======((((((((((\\\\\
                 ((           \\\\\\\
                 ( (*    _/      \\\\\\\
                   \    /  \      \\\\\\________________
                    |  |   |      </    __             ((\\\\
                    o_|   /        ____/ / _______       \ \\\\    \\\\\\\
                         |  ._    / __/ __(_-</ _ \       \ \\\\\\\\\\\\\\\\
                         | /     /_/  \__/___/ .__/       /    \\\\\\\     \\
                 .______/\/     /           /_/           /         \\\
                / __.____/    _/         ________(       /\
               / / / ________/`---------'         \     /  \_
              / /  \ \                             \   \ \_  \
             ( <    \ \                             >  /    \ \
              \/      \\_                          / /       > )
                       \_|                        / /       / /
                                                _//       _//
                                               /_|       /_|
        
        
        Convenience-wrapper around OpenCV-Python RTSP functions.
        
        ## Features
        
          * fetch a single image as Pillow Image
          * open RTSP stream and poll most recent frame as Pillow Image
          * preview stream in OpenCV
          * uniform interface for local web-cameras for rapid prototyping
            * integers will load a local USB or webcam starting with interface 0 via `OpenCV` e.g. `rtsp.Client(0)`
            * 'picam' uses a Raspberry Pi camera as source e.g. `rtsp.Client('picam')`
        
        ## Examples
        
        Use RTSP access credentials in your connection string e.g. `RTSP_URL = f"rtsp://{USERNAME}:{PASSWORD}@192.168.1.221:554/11"`
        
        One-off Retrieval
        
            import rtsp
            client = rtsp.Client(rtsp_server_uri = 'rtsp://...')
            client.read().show()
            client.close()
        
        Stream Preview
        
            import rtsp
            with rtsp.Client('rtsp://...') as client:
                client.preview()
        
        Continuous Retrieval
        
            import rtsp
        
            with rtsp.Client(rtsp_server_uri = 'rtsp://...') as client:
                _image = client.read()
        
                while True:
                    process_image(_image)
                    _image = client.read(raw=True)
        
        ## Roadmap:
        
        I don't plan to develop this module any further, as more complex applications are better suited to use OpenCV, Gstreamer, or ffmpeg directly.
        
        To do:
          * add better parsing for the RTSP resource URIs
        
Keywords: rtsp image stream
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Multimedia :: Video :: Capture
Classifier: Topic :: System :: Networking
Requires-Python: >=3.5
Description-Content-Type: text/markdown
