Skip to main content

LiveKit Python Client SDK for LiveKit

Project description

The LiveKit icon, the name of the repository and some sample code in the background.

pypi-v

📹🎙️🐍 Python Client SDK for LiveKit

The Livekit Python Client provides a convenient interface for integrating Livekit's real-time video and audio capabilities into your Python applications. With this library, developers can easily leverage Livekit's WebRTC functionalities, allowing them to focus on building their AI models or other application logic without worrying about the complexities of WebRTC.

Official LiveKit documentation: https://docs.livekit.io/

Installation

$ pip install livekit

Connecting to a room

async def main():
    room = livekit.Room()
    await room.connect(URL, TOKEN)
    logging.info("connected to room %s", room.name)

    @room.on("participant_connected")
    def on_participant_connected(participant: livekit.RemoteParticipant):
        logging.info(
            "participant connected: %s %s", participant.sid, participant.identity)

    video_stream = None
    @room.on("track_subscribed")
    def on_track_subscribed(track: livekit.Track, publication: livekit.RemoteTrackPublication, participant: livekit.RemoteParticipant):
        logging.info("track subscribed: %s", publication.sid)
        if track.kind == livekit.TrackKind.KIND_VIDEO:
            nonlocal video_stream
            video_stream = livekit.VideoStream(track)

            @video_stream.on("frame_received")
            def on_video_frame(frame: livekit.VideoFrame):
                # received a video frame from the track
                pass

    await room.run()

Examples

Getting help / Contributing

Please join us on Slack to get help from our devs / community members. We welcome your contributions(PRs) and details can be discussed there.


LiveKit Ecosystem
Client SDKsComponents · JavaScript · iOS/macOS · Android · Flutter · React Native · Rust · Python · Unity (web) · Unity (beta)
Server SDKsNode.js · Golang · Ruby · Java/Kotlin · PHP (community) · Python (community)
ServicesLivekit server · Egress · Ingress
ResourcesDocs · Example apps · Cloud · Self-hosting · CLI

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

livekit-0.2.2.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

livekit-0.2.2-py3-none-any.whl (37.4 kB view details)

Uploaded Python 3

File details

Details for the file livekit-0.2.2.tar.gz.

File metadata

  • Download URL: livekit-0.2.2.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for livekit-0.2.2.tar.gz
Algorithm Hash digest
SHA256 4e455d9f51616d459e03edaf36d3c135d96a01358ec09934ff2dbe347ff4ae6f
MD5 1714b41567bad2d435244cf1ea186a57
BLAKE2b-256 7b0047969ade1d23a5ecee25c44c9d6decbd53d19d8857bd5ab3fda84fe0902d

See more details on using hashes here.

File details

Details for the file livekit-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: livekit-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 37.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for livekit-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 98608459135bc7b059dbb6b9cccd1f2e6b9fdddb9d7d41d20220b161c2ae00f6
MD5 3d95e41671e354a771f47f74339bc8fa
BLAKE2b-256 bac7fce7cb3fbed6c41d426b3a53ce10ea967d1269384e057430b3a9a96d5757

See more details on using hashes here.

Supported by

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