Skip to main content

A Python client for Kurento Media Server

Project description

A python client for Kurento Media Streamer


  1. Setup
  2. Sample Usage
  3. Changelog


  1. Install Kurento
sudo docker run --name kms -d -p 8888:8888 kurento/kurento-media-server
  1. Install pyforkurento
pip install pyforkurento
  1. pyforkurento runs as an application server. You'll need to install relevant packages for the web or mobile client

For Node, Angular etc:

npm install kurento-utils

TODO: For vanilla Javascript:

[Optional] To use GStreamer filters:

sudo apt-get install libgstreamer1.0-0 gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-libav gstreamer1.0-doc gstreamer1.0-tools gstreamer1.0-x gstreamer1.0-alsa gstreamer1.0-gl gstreamer1.0-gtk3 gstreamer1.0-qt5 gstreamer1.0-pulseaudio

[Optional] To develop custom filters:

sudo apt-get update && sudo apt-get install --yes kurento-media-server-dev

If you get the error: Unable to locate package kurento-media-server-dev try:

  1. Paste this link ( to your browser
  2. Extract the downloaded folder to a location of choice
  3. cd into that folder then test using:
sh TestKMSFilter ../custom_kurento_module opencv_filter

This SDK is not yet 'prod-ready' and was inspired by this abandoned project


Before you start using pyforkurento and have a pretty good understanding of KMS, go through this refresher first

Read the complete documentation here:


This changelog loosely follows semantic versioning

0.1.7 5th Mar 2020


  • Streaming speeds by reducing player endpoint latency

0.1.6 18th Feb 2020


  • create_endpoint() to add_endpoint()

0.1.5 14th Feb 2020


  • Documentation significantly, and hosted on readthedocs

0.1.4 13th Feb 2020


  • Addition of event listeners to media elements

0.1.3 12th Feb 2020


  • Creation of media elements in a media pipeline


  • Class inheritance structure


  • ImageOverlayFilter

0.0.2 5th Feb 2020


  • Class method parameters error

0.0.2 5th Feb 2020


  • Import error

0.0.1 5th Feb 2020

  • Released a very basic version of the project under the name 'pyforkurento' with only the capability to:
    • Create:
      • Media Pipelines
      • Player Endpoints
      • WebRTC Endpoints
    • Subscribe to ICE candidates events on a WebRTC Endpoint

Project details

Download files

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

Files for pyforkurento, version 0.1.7
Filename, size File type Python version Upload date Hashes
Filename, size pyforkurento-0.1.7-py3-none-any.whl (14.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pyforkurento-0.1.7.tar.gz (11.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page