Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fishjam-dev/python-server-sdk

Python server SDK for Fishjam
https://github.com/fishjam-dev/python-server-sdk

fishjam membrane-framework python video webrtc

Last synced: 3 months ago
JSON representation

Python server SDK for Fishjam

Awesome Lists containing this project

README 

        
# Fishjam Python Server SDK



[![CircleCI](https://dl.circleci.com/status-badge/img/gh/fishjam-dev/python-server-sdk/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/fishjam-dev/python-server-sdk/tree/main)



Python server SDK for the [Fishjam Media Server](https://github.com/fishjam-dev/fishjam).



Read the docs [here](https://fishjam-dev.github.io/python-server-sdk)



## Installation



```

pip install fishjam-server-sdk

```



## Usage



The SDK exports two main classes for interacting with Fishjam server:

`RoomApi` and `Notifier`.



`RoomApi` wraps http REST api calls, while `Notifier` is responsible for receiving real-time updates from the server.



#### RoomApi



Create a `RoomApi` instance, providing the fishjam server address and api token



```python

from fishjam import RoomApi



room_api = RoomApi(server_address="localhost:5002", server_api_token="development")

```



You can use it to interact with Fishjam, manage rooms, peers and components



```python

# Create a room

fishjam_address, room = room_api.create_room(video_codec="h264", webhook_url="http://localhost:5000/webhook")

# '127.0.0.1:5002', Room(components=[], config=RoomConfig(max_peers=None, video_codec=, webhook_url='http://localhost:5000/webhook'), id='1d905478-ccfc-44d6-a6e7-8ccb1b38d955', peers=[])



# Add peer to the room

from fishjam import PeerOptionsWebRTC



peer_token, peer_webrtc = room_api.add_peer(room.id, options=PeerOptionsWebRTC())

# 'M8TUGhj-L11KpyG-2zBPIo', Peer(id='b1232c7e-c969-4450-acdf-ea24f3cdd7f6', status=, type='webrtc')



# Add component to the room

from fishjam import ComponentOptionsHLS



component_hls = room_api.add_component(room.id, options=ComponentOptionsHLS())

# ComponentHLS(id='5f062447-a9f7-45ed-8d1b-511f77dc78ae', properties=ComponentPropertiesHLS(low_latency=False, persistent=False, playable=False, subscribe_mode=, target_window_duration=None), type='hls')

```



All methods in `RoomApi` may raise one of the exceptions deriving from `fishjam.errors.HTTPError`. They are defined in `fishjam.errors`.



#### Notifier



Notifier allows for receiving real-time updates from the Fishjam Server.



You can read more about notifications in the [Fishjam Docs](https://fishjam-dev.github.io/fishjam-docs/next/getting_started/notifications).



Create `Notifier` instance

```python

from fishjam import Notifier



notifier = Notifier(server_address='localhost:5002', server_api_token='development')

```



Then define handlers for incoming messages

```python

@notifier.on_server_notification

def handle_notification(server_notification):

    print(f'Received a notification: {server_notification}')



@notifier.on_metrics

def handle_metrics(metrics_report):

    print(f'Received WebRTC metrics: {metrics_report}')

```



After that you can start the notifier

```python

async def test_notifier():

    notifier_task = asyncio.create_task(notifier.connect())



    # Wait for notifier to be ready to receive messages

    await notifier.wait_ready()



    # Create a room to trigger a server notification

    room_api = RoomApi()

    room_api.create_room()



    await notifier_task



asyncio.run(test_notifier())



# Received a notification: ServerMessageRoomCreated(room_id='69a3fd1a-6a4d-47bc-ae54-0c72b0d05e29')

# Received WebRTC metrics: ServerMessageMetricsReport(metrics='{}')

```



#### Cluster of Fishjams



The cluster of fishjams has got embedded load balancer, which means that a new room will be created on fishjam with the least usage. At the moment to modify this specific room you must communicate with the fishjam on which this room was created.



```python

room_api = RoomApi(server_address='localhost:5002')



# Create a room to trigger a server notification with h264 as a codec,

# that allow to use HLS.

address, room = room_api.create_room(video_codec="h264")



# Create new room api with returned fishjam address as a room could be

# created on a different fishjam instance

# (if you communicate with a cluster of fishjams)

new_room_api = RoomApi(server_address=address)



# Add HLS component with manual subscribe mode, we use here `new_room_api` as we are sure that this API refers to the fishjam on which this room was created.

_hls_component = new_room_api.add_component(

    room.id,

    ComponentOptionsHLS(subscribe_mode=ComponentOptionsHLSSubscribeMode.MANUAL),

)

```



## Testing



You can test the SDK by running

```console

poetry run ci_test

```



In local development you can use

```console

poetry run local_test

```



## Format & Lint

You can format code by running

```console

poetry run format

```



You can check linter by running

```console

poetry run lint

```



## Copyright and License



Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)



[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)



Licensed under the [Apache License, Version 2.0](LICENSE)