Skip to content

Commit 7fcea68

Browse files
committed
updated docstrings
1 parent 3984302 commit 7fcea68

2 files changed

Lines changed: 12 additions & 10 deletions

File tree

versioned_docs/version-0.23.0/api/server-python/fishjam.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ Allows for receiving WebSocket messages from Fishjam.
195195
```python
196196
def __init__(fishjam_id: str, management_token: str)
197197
```
198-
Create FishjamNotifier instance, providing the fishjam id and management token.
198+
Create a FishjamNotifier instance with an ID and management token.
199199

200200
### on_server_notification
201201
```python
@@ -204,14 +204,13 @@ def on_server_notification(
204204
handler: Union[Callable[[Union[ServerMessageRoomCreated, ServerMessageRoomDeleted, ServerMessageRoomCrashed, ServerMessagePeerAdded, ServerMessagePeerDeleted, ServerMessagePeerConnected, ServerMessagePeerDisconnected, ServerMessagePeerMetadataUpdated, ServerMessagePeerCrashed, ServerMessageStreamConnected, ServerMessageStreamDisconnected, ServerMessageViewerConnected, ServerMessageViewerDisconnected, ServerMessageTrackAdded, ServerMessageTrackRemoved, ServerMessageTrackMetadataUpdated]], NoneType], Callable[[Union[ServerMessageRoomCreated, ServerMessageRoomDeleted, ServerMessageRoomCrashed, ServerMessagePeerAdded, ServerMessagePeerDeleted, ServerMessagePeerConnected, ServerMessagePeerDisconnected, ServerMessagePeerMetadataUpdated, ServerMessagePeerCrashed, ServerMessageStreamConnected, ServerMessageStreamDisconnected, ServerMessageViewerConnected, ServerMessageViewerDisconnected, ServerMessageTrackAdded, ServerMessageTrackRemoved, ServerMessageTrackMetadataUpdated]], Coroutine[Any, Any, None]]]
205205
)
206206
```
207-
Decorator used for defining handler for Fishjam Notifications
207+
Decorator used for defining handler for Fishjam Notifications.
208208

209209
### connect
210210
```python
211211
def connect(self)
212212
```
213-
A coroutine which connects FishjamNotifier to Fishjam and listens for
214-
all incoming messages from the Fishjam.
213+
Connects to Fishjam and listens for all incoming messages.
215214

216215
It runs until the connection isn't closed.
217216

@@ -237,6 +236,7 @@ def receive_binary(
237236
) -> Union[ServerMessageRoomCreated, ServerMessageRoomDeleted, ServerMessageRoomCrashed, ServerMessagePeerAdded, ServerMessagePeerDeleted, ServerMessagePeerConnected, ServerMessagePeerDisconnected, ServerMessagePeerMetadataUpdated, ServerMessagePeerCrashed, ServerMessageStreamConnected, ServerMessageStreamDisconnected, ServerMessageViewerConnected, ServerMessageViewerDisconnected, ServerMessageTrackAdded, ServerMessageTrackRemoved, ServerMessageTrackMetadataUpdated, NoneType]
238237
```
239238
Transform received protobuf notification to adequate notification instance.
239+
240240
The available notifications are listed in `fishjam.events` module.
241241

242242
---

versioned_docs/version-0.23.0/api/server-python/fishjam/agent.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ custom_edit_url: null
1313
class Agent:
1414
```
1515
Allows for connecting to a Fishjam room as an agent peer.
16+
1617
Provides callbacks for receiving audio.
1718

1819
### __init__
@@ -52,7 +53,7 @@ defined with :func:`on_track_data`.
5253
```python
5354
class AgentError(Exception):
5455
```
55-
Base exception class for all agent exceptions
56+
Base exception class for all agent exceptions.
5657

5758
---
5859
## AgentSession
@@ -82,8 +83,7 @@ def receive(
8283
self
8384
) -> AsyncIterator[AgentResponseTrackData]
8485
```
85-
Returns an infinite async iterator over the incoming messages from Fishjam to
86-
the agent.
86+
Returns an infinite async iterator over incoming messages from Fishjam.
8787

8888
### add_track
8989
```python
@@ -99,14 +99,15 @@ over the added track.
9999
def disconnect(self)
100100
```
101101
Ends the agent session by closing the websocket connection.
102+
102103
Useful when you don't use the context manager to obtain the session.
103104

104105
---
105106
## AgentAuthError
106107
```python
107108
class AgentAuthError(fishjam.agent.errors.AgentError):
108109
```
109-
Agent failed to authenticate properly
110+
Agent failed to authenticate properly.
110111

111112
### __init__
112113
```python
@@ -133,8 +134,9 @@ IncomingTrackData = <class 'AgentResponseTrackData'>
133134
```python
134135
class OutgoingTrack:
135136
```
136-
Represents an outgoing track of an agent connected to Fishjam,
137-
created by :func:`Agent.add_track`.
137+
Represents an outgoing track of an agent connected to Fishjam.
138+
139+
This is created by :func:`Agent.add_track`.
138140

139141
### __init__
140142
```python

0 commit comments

Comments
 (0)