Skip to main content

A Python library for streaming video over RTSP

Project description

Zephyr

Zephyr is a simple RTSP library to stream and receive video over RTSP.

Pre-requisites

  • Python 3.8 or higher
  • FFmpeg to encode and decode video
  • MediaMTX as RTSP server

Installation

The easiest way to install Zephyr is using pip:

$ pip install zephyr-rtsp

But you can also install Zephyr from source:

$ git clone https://github.com/bpradana/zephyr.git
$ cd zephyr
$ python setup.py install

Usage

Zephyr has 2 main classes, Stream and Client. Stream is used to stream video over RTSP, while Client is used to receive video from RTSP stream.

Stream

To stream video, you need to create a Stream object and call send with a frame. You can also call end to stop the stream.

import cv2
from zephyr import Stream

stream = Stream(
  url="rtsp://localhost:8554/test",
  resolution=(1280, 720),
  fps=30,
  bitrate="2M"
)

cap = cv2.VideoCapture(0)
while True:
  ret, frame = cap.read()
  stream.send(frame)

stream.end()
cap.release()

Client

To receive video, you need to create a Client object and call read to get the frame. You can also call release to stop receiving video.

import cv2
from zephyr import Client

client = Client(url="rtsp://localhost:8554/test")

while True:
  ret, frame = client.read()
  cv2.imshow('frame', frame)

  if cv2.waitKey(1) & 0xFF == ord("q"):
    client.release()
    break

License

Zephyr is licensed under the MIT License.

Credits

  • Zephyr uses FFmpeg to encode and decode video.
  • The name Zephyr is inspired by Zephyr a video streaming project by Octavia.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zephyr-rtsp-0.0.5.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

zephyr_rtsp-0.0.5-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file zephyr-rtsp-0.0.5.tar.gz.

File metadata

  • Download URL: zephyr-rtsp-0.0.5.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.13

File hashes

Hashes for zephyr-rtsp-0.0.5.tar.gz
Algorithm Hash digest
SHA256 65b90ce89e048f7ca0a83cc4196d0a6d78995ac5bdeb8240b88623b1d771f2d0
MD5 8d121d8da34172a294e129d3dd9a4e1c
BLAKE2b-256 48fa3213d320ccbe16cdb5abbee49a6ad7cd65fdc07b13695edadc48b510b26e

See more details on using hashes here.

File details

Details for the file zephyr_rtsp-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: zephyr_rtsp-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.13

File hashes

Hashes for zephyr_rtsp-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ad02576fc686e9084eb40761693b70a08a95dc486bb971c8715e84e5d0463c76
MD5 db773896252196719655b16ddec750ab
BLAKE2b-256 84db8c2a9f633d13cde4b5fd8f8784dd553e53f0521d2c9c4bfcec04cb80f548

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page