Skip to content

Add protobufs for agent socket #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AHGIJMKLKKZNPJKQR merged 7 commits into from
Aug 14, 2025
Merged

Add protobufs for agent socket #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bad8c83
Add protobufs for agent socket
AHGIJMKLKKZNPJKQR Aug 14, 2025
6656292
Add RemoveTrack notification
AHGIJMKLKKZNPJKQR Aug 14, 2025
e12f8db
Update docs
AHGIJMKLKKZNPJKQR Aug 14, 2025
c76284b
Compile with 0.15.0
AHGIJMKLKKZNPJKQR Aug 14, 2025
23b0800
Add RemoveTrack to AgentRequest
AHGIJMKLKKZNPJKQR Aug 14, 2025
ac39485
Rename TrackConfig to CodecParameters
AHGIJMKLKKZNPJKQR Aug 14, 2025
6f40649
Rename field
AHGIJMKLKKZNPJKQR Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
274 changes: 230 additions & 44 deletions doc/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@

## Table of Contents

- [fishjam/agent_notifications.proto](#fishjam_agent_notifications-proto)
- [AgentRequest](#fishjam-AgentRequest)
- [AgentRequest.AddTrack](#fishjam-AgentRequest-AddTrack)
- [AgentRequest.AddTrack.CodecParameters](#fishjam-AgentRequest-AddTrack-CodecParameters)
- [AgentRequest.AuthRequest](#fishjam-AgentRequest-AuthRequest)
- [AgentRequest.RemoveTrack](#fishjam-AgentRequest-RemoveTrack)
- [AgentRequest.TrackData](#fishjam-AgentRequest-TrackData)
- [AgentResponse](#fishjam-AgentResponse)
- [AgentResponse.Authenticated](#fishjam-AgentResponse-Authenticated)
- [AgentResponse.TrackData](#fishjam-AgentResponse-TrackData)

- [fishjam/media_events/peer/peer.proto](#fishjam_media_events_peer_peer-proto)
- [MediaEvent](#fishjam-media_events-peer-MediaEvent)
- [MediaEvent.Connect](#fishjam-media_events-peer-MediaEvent-Connect)
Expand Down Expand Up @@ -84,21 +95,186 @@
- [ServerMessage.StreamDisconnected](#fishjam-ServerMessage-StreamDisconnected)
- [ServerMessage.SubscribeRequest](#fishjam-ServerMessage-SubscribeRequest)
- [ServerMessage.SubscribeResponse](#fishjam-ServerMessage-SubscribeResponse)
- [ServerMessage.Track](#fishjam-ServerMessage-Track)
- [ServerMessage.TrackAdded](#fishjam-ServerMessage-TrackAdded)
- [ServerMessage.TrackData](#fishjam-ServerMessage-TrackData)
- [ServerMessage.TrackMetadataUpdated](#fishjam-ServerMessage-TrackMetadataUpdated)
- [ServerMessage.TrackRemoved](#fishjam-ServerMessage-TrackRemoved)
- [ServerMessage.ViewerConnected](#fishjam-ServerMessage-ViewerConnected)
- [ServerMessage.ViewerDisconnected](#fishjam-ServerMessage-ViewerDisconnected)

- [ServerMessage.EventType](#fishjam-ServerMessage-EventType)
- [ServerMessage.TrackType](#fishjam-ServerMessage-TrackType)

- [fishjam/shared_notifications.proto](#fishjam_shared_notifications-proto)
- [Track](#fishjam-Track)

- [TrackEncoding](#fishjam-TrackEncoding)
- [TrackType](#fishjam-TrackType)

- [Scalar Value Types](#scalar-value-types)



<a name="fishjam_agent_notifications-proto"></a>
<p align="right"><a href="#top">Top</a></p>

## fishjam/agent_notifications.proto



<a name="fishjam-AgentRequest"></a>

### AgentRequest
Defines any type of message passed from agent peer to Fishjam


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| auth_request | [AgentRequest.AuthRequest](#fishjam-AgentRequest-AuthRequest) | | |
| add_track | [AgentRequest.AddTrack](#fishjam-AgentRequest-AddTrack) | | |
| remove_track | [AgentRequest.RemoveTrack](#fishjam-AgentRequest-RemoveTrack) | | |
| track_data | [AgentRequest.TrackData](#fishjam-AgentRequest-TrackData) | | |






<a name="fishjam-AgentRequest-AddTrack"></a>

### AgentRequest.AddTrack
Request to add a track of the specified type


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| track | [Track](#fishjam-Track) | | Specification of the track to be added |
| codec_params | [AgentRequest.AddTrack.CodecParameters](#fishjam-AgentRequest-AddTrack-CodecParameters) | | Parameters of the input data stream |






<a name="fishjam-AgentRequest-AddTrack-CodecParameters"></a>

### AgentRequest.AddTrack.CodecParameters



| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| encoding | [TrackEncoding](#fishjam-TrackEncoding) | | The format of the input stream, defaults to pcm16 |
| sample_rate | [uint32](#uint32) | | The sample rate of the input stream, may be omitted for opus |
| channels | [uint32](#uint32) | | The number of channels. 1 means mono, 2 means stereo |






<a name="fishjam-AgentRequest-AuthRequest"></a>

### AgentRequest.AuthRequest
Request sent by agent, to authenticate to Fishjam server


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| token | [string](#string) | | |
| room_id | [string](#string) | | |






<a name="fishjam-AgentRequest-RemoveTrack"></a>

### AgentRequest.RemoveTrack
Removes the given track


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| track_id | [string](#string) | | |






<a name="fishjam-AgentRequest-TrackData"></a>

### AgentRequest.TrackData
Notification containing a chunk of an agent&#39;s track&#39;s data stream


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| track_id | [string](#string) | | |
| data | [bytes](#bytes) | | |






<a name="fishjam-AgentResponse"></a>

### AgentResponse
Defines any type of message passed from Fishjam to agent peer


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| authenticated | [AgentResponse.Authenticated](#fishjam-AgentResponse-Authenticated) | | |
| track_data | [AgentResponse.TrackData](#fishjam-AgentResponse-TrackData) | | |






<a name="fishjam-AgentResponse-Authenticated"></a>

### AgentResponse.Authenticated
Response confirming successful authentication


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| peer_id | [string](#string) | | The Peer ID assigned to the connected Agent |






<a name="fishjam-AgentResponse-TrackData"></a>

### AgentResponse.TrackData
Notification containing a chunk of a track&#39;s data stream


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| peer_id | [string](#string) | | |
| track | [Track](#fishjam-Track) | | |
| data | [bytes](#bytes) | | |















<a name="fishjam_media_events_peer_peer-proto"></a>
<p align="right"><a href="#top">Top</a></p>

Expand Down Expand Up @@ -1004,7 +1180,6 @@ Defines any type of message passed between FJ and server peer
| stream_disconnected | [ServerMessage.StreamDisconnected](#fishjam-ServerMessage-StreamDisconnected) | | |
| viewer_connected | [ServerMessage.ViewerConnected](#fishjam-ServerMessage-ViewerConnected) | | |
| viewer_disconnected | [ServerMessage.ViewerDisconnected](#fishjam-ServerMessage-ViewerDisconnected) | | |
| track_data | [ServerMessage.TrackData](#fishjam-ServerMessage-TrackData) | | |



Expand Down Expand Up @@ -1301,23 +1476,6 @@ Response sent by FJ, confirming subscription for message type



<a name="fishjam-ServerMessage-Track"></a>

### ServerMessage.Track
Describes a media track


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [string](#string) | | |
| type | [ServerMessage.TrackType](#fishjam-ServerMessage-TrackType) | | |
| metadata | [string](#string) | | |






<a name="fishjam-ServerMessage-TrackAdded"></a>

### ServerMessage.TrackAdded
Expand All @@ -1329,25 +1487,7 @@ Notification sent when peer or component adds new track
| room_id | [string](#string) | | |
| peer_id | [string](#string) | | |
| component_id | [string](#string) | | |
| track | [ServerMessage.Track](#fishjam-ServerMessage-Track) | | |






<a name="fishjam-ServerMessage-TrackData"></a>

### ServerMessage.TrackData
Notification containing a chunk of a track&#39;s data stream


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| room_id | [string](#string) | | |
| peer_id | [string](#string) | | |
| track | [ServerMessage.Track](#fishjam-ServerMessage-Track) | | |
| data | [bytes](#bytes) | | |
| track | [Track](#fishjam-Track) | | |



Expand All @@ -1365,7 +1505,7 @@ Notification sent when metadata of a multimedia track is updated
| room_id | [string](#string) | | |
| peer_id | [string](#string) | | |
| component_id | [string](#string) | | |
| track | [ServerMessage.Track](#fishjam-ServerMessage-Track) | | |
| track | [Track](#fishjam-Track) | | |



Expand All @@ -1383,7 +1523,7 @@ Notification sent when a track is removed
| room_id | [string](#string) | | |
| peer_id | [string](#string) | | |
| component_id | [string](#string) | | |
| track | [ServerMessage.Track](#fishjam-ServerMessage-Track) | | |
| track | [Track](#fishjam-Track) | | |



Expand Down Expand Up @@ -1435,10 +1575,56 @@ Defines message groups for which peer can subscribe
| EVENT_TYPE_SERVER_NOTIFICATION | 1 | |










<a name="fishjam_shared_notifications-proto"></a>
<p align="right"><a href="#top">Top</a></p>

## fishjam/shared_notifications.proto



<a name="fishjam-Track"></a>

### Track
Describes a media track


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [string](#string) | | |
| type | [TrackType](#fishjam-TrackType) | | |
| metadata | [string](#string) | | |








<a name="fishjam-TrackEncoding"></a>

### TrackEncoding


| Name | Number | Description |
| ---- | ------ | ----------- |
| TRACK_ENCODING_UNSPECIFIED | 0 | |
| TRACK_ENCODING_PCM16 | 1 | |
| TRACK_ENCODING_OPUS | 2 | |



<a name="fishjam-ServerMessage-TrackType"></a>
<a name="fishjam-TrackType"></a>

### ServerMessage.TrackType
### TrackType
Defines types of tracks being published by peers and component

| Name | Number | Description |
Expand Down
Loading
Loading