Add livestream notifications

README.md

@@ -7,6 +7,7 @@ For detailed protobuf definitions and usage, please refer to the [documentation]
 ## How to add this repo as a git submodule in your own repository
 
 Use the command below:
+
 ```command
 git submodule add https://github.com/fishjam-cloud/protos.git`
 ```
@@ -16,20 +17,22 @@ git submodule add https://github.com/fishjam-cloud/protos.git`
 Install [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) plugin.
 
 Use the command below:
+
 ```command
 find fishjam/ -name "*.proto" | sort | xargs protoc --doc_out=./doc --doc_opt=markdown,docs.md
 ```
 
 ## Lint and formatting
 
-The files can be formatted using `buf`. 
+The files can be formatted using `buf`.
 Check out [installation page](https://buf.build/docs/installation/) for `buf`.
 
 ```
 buf format -w
 ```
 
 and linted
+
 ```
 buf lint
 ```

doc/docs.md

@@ -81,12 +81,16 @@
     - [ServerMessage.RoomCrashed](#fishjam-ServerMessage-RoomCrashed)
     - [ServerMessage.RoomCreated](#fishjam-ServerMessage-RoomCreated)
     - [ServerMessage.RoomDeleted](#fishjam-ServerMessage-RoomDeleted)
+    - [ServerMessage.StreamConnected](#fishjam-ServerMessage-StreamConnected)
+    - [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.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)
@@ -997,6 +1001,10 @@ Defines any type of message passed between FJ and server peer
 | track_metadata_updated | [ServerMessage.TrackMetadataUpdated](#fishjam-ServerMessage-TrackMetadataUpdated) |  |  |
 | peer_added | [ServerMessage.PeerAdded](#fishjam-ServerMessage-PeerAdded) |  |  |
 | peer_deleted | [ServerMessage.PeerDeleted](#fishjam-ServerMessage-PeerDeleted) |  |  |
+| stream_connected | [ServerMessage.StreamConnected](#fishjam-ServerMessage-StreamConnected) |  |  |
+| stream_disconnected | [ServerMessage.StreamDisconnected](#fishjam-ServerMessage-StreamDisconnected) |  |  |
+| viewer_connected | [ServerMessage.ViewerConnected](#fishjam-ServerMessage-ViewerConnected) |  |  |
+| viewer_disconnected | [ServerMessage.ViewerConnected](#fishjam-ServerMessage-ViewerConnected) |  |  |
 
 
 
@@ -1248,6 +1256,36 @@ Notification sent when a room is deleted
 
 
 
+<a name="fishjam-ServerMessage-StreamConnected"></a>
+
+### ServerMessage.StreamConnected
+Notification sent when streamer successfully connects
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| stream_id | [string](#string) |  |  |
+
+
+
+
+
+
+<a name="fishjam-ServerMessage-StreamDisconnected"></a>
+
+### ServerMessage.StreamDisconnected
+Notification sent when streamer disconnects
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| stream_id | [string](#string) |  |  |
+
+
+
+
+
+
 <a name="fishjam-ServerMessage-SubscribeRequest"></a>
 
 ### ServerMessage.SubscribeRequest
@@ -1348,6 +1386,38 @@ Notification sent when a track is removed
 
 
 
+
+<a name="fishjam-ServerMessage-ViewerConnected"></a>
+
+### ServerMessage.ViewerConnected
+Notification sent when viewer successfully connects
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| stream_id | [string](#string) |  |  |
+| viewer_id | [string](#string) |  |  |
+
+
+
+
+
+
+<a name="fishjam-ServerMessage-ViewerDisconnected"></a>
+
+### ServerMessage.ViewerDisconnected
+Notification sent when viewer disconnects
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| stream_id | [string](#string) |  |  |
+| viewer_id | [string](#string) |  |  |
+
+
+
+
+
 
 
 

fishjam/server_notifications.proto

@@ -153,6 +153,28 @@ message ServerMessage {
     Track track = 4;
   }
 
+  // Notification sent when streamer successfully connects
+  message StreamConnected {
+    string stream_id = 1;
+  }
+
+  // Notification sent when streamer disconnects
+  message StreamDisconnected {
+    string stream_id = 1;
+  }
+
+  // Notification sent when viewer successfully connects
+  message ViewerConnected {
+    string stream_id = 1;
+    string viewer_id = 2;
+  }
+
+  // Notification sent when viewer disconnects
+  message ViewerDisconnected {
+    string stream_id = 1;
+    string viewer_id = 2;
+  }
+
   oneof content {
     RoomCrashed room_crashed = 1;
     PeerConnected peer_connected = 2;
@@ -175,5 +197,9 @@ message ServerMessage {
     TrackMetadataUpdated track_metadata_updated = 19;
     PeerAdded peer_added = 20;
     PeerDeleted peer_deleted = 21;
+    StreamConnected stream_connected = 22;
+    StreamDisconnected stream_disconnected = 23;
+    ViewerConnected viewer_connected = 24;
+    ViewerConnected viewer_disconnected = 25;
   }
 }

fishjam_protos/lib/fishjam/server_notifications.pb.ex

@@ -219,6 +219,40 @@ defmodule Fishjam.ServerMessage.TrackMetadataUpdated do
   field :track, 4, type: Fishjam.ServerMessage.Track
 end
 
+defmodule Fishjam.ServerMessage.StreamConnected do
+  @moduledoc false
+
+  use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3
+
+  field :stream_id, 1, type: :string, json_name: "streamId"
+end
+
+defmodule Fishjam.ServerMessage.StreamDisconnected do
+  @moduledoc false
+
+  use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3
+
+  field :stream_id, 1, type: :string, json_name: "streamId"
+end
+
+defmodule Fishjam.ServerMessage.ViewerConnected do
+  @moduledoc false
+
+  use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3
+
+  field :stream_id, 1, type: :string, json_name: "streamId"
+  field :viewer_id, 2, type: :string, json_name: "viewerId"
+end
+
+defmodule Fishjam.ServerMessage.ViewerDisconnected do
+  @moduledoc false
+
+  use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3
+
+  field :stream_id, 1, type: :string, json_name: "streamId"
+  field :viewer_id, 2, type: :string, json_name: "viewerId"
+end
+
 defmodule Fishjam.ServerMessage do
   @moduledoc false
 
@@ -325,4 +359,24 @@ defmodule Fishjam.ServerMessage do
     type: Fishjam.ServerMessage.PeerDeleted,
     json_name: "peerDeleted",
     oneof: 0
+
+  field :stream_connected, 22,
+    type: Fishjam.ServerMessage.StreamConnected,
+    json_name: "streamConnected",
+    oneof: 0
+
+  field :stream_disconnected, 23,
+    type: Fishjam.ServerMessage.StreamDisconnected,
+    json_name: "streamDisconnected",
+    oneof: 0
+
+  field :viewer_connected, 24,
+    type: Fishjam.ServerMessage.ViewerConnected,
+    json_name: "viewerConnected",
+    oneof: 0
+
+  field :viewer_disconnected, 25,
+    type: Fishjam.ServerMessage.ViewerConnected,
+    json_name: "viewerDisconnected",
+    oneof: 0
 end