Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 34 additions & 0 deletions doc/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@
- [ServerMessage.PeerDeleted](#fishjam-ServerMessage-PeerDeleted)
- [ServerMessage.PeerDisconnected](#fishjam-ServerMessage-PeerDisconnected)
- [ServerMessage.PeerMetadataUpdated](#fishjam-ServerMessage-PeerMetadataUpdated)
- [ServerMessage.RecordingStatusChanged](#fishjam-ServerMessage-RecordingStatusChanged)
- [ServerMessage.RoomCrashed](#fishjam-ServerMessage-RoomCrashed)
- [ServerMessage.RoomCreated](#fishjam-ServerMessage-RoomCreated)
- [ServerMessage.RoomDeleted](#fishjam-ServerMessage-RoomDeleted)
Expand All @@ -124,6 +125,7 @@

- [ServerMessage.EventType](#fishjam-ServerMessage-EventType)
- [ServerMessage.PeerType](#fishjam-ServerMessage-PeerType)
- [ServerMessage.RecordingStatusChanged.Status](#fishjam-ServerMessage-RecordingStatusChanged-Status)
- [ServerMessage.VadNotification.Status](#fishjam-ServerMessage-VadNotification-Status)

- [Scalar Value Types](#scalar-value-types)
Expand Down Expand Up @@ -1364,6 +1366,7 @@ Defines any type of message passed between FJ and server peer
| viewer_disconnected | [ServerMessage.ViewerDisconnected](#fishjam-ServerMessage-ViewerDisconnected) | | |
| streamer_connected | [ServerMessage.StreamerConnected](#fishjam-ServerMessage-StreamerConnected) | | |
| streamer_disconnected | [ServerMessage.StreamerDisconnected](#fishjam-ServerMessage-StreamerDisconnected) | | |
| recording_status_changed | [ServerMessage.RecordingStatusChanged](#fishjam-ServerMessage-RecordingStatusChanged) | | |
| notification_batch | [ServerMessage.NotificationBatch](#fishjam-ServerMessage-NotificationBatch) | | Batch |
| stream_connected | [ServerMessage.StreamConnected](#fishjam-ServerMessage-StreamConnected) | | **Deprecated.** |
| stream_disconnected | [ServerMessage.StreamDisconnected](#fishjam-ServerMessage-StreamDisconnected) | | **Deprecated.** |
Expand Down Expand Up @@ -1629,6 +1632,23 @@ Notification sent when peer updates its metadata



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

### ServerMessage.RecordingStatusChanged
Notification sent when a recording changes status


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| recording_id | [string](#string) | | |
| status | [ServerMessage.RecordingStatusChanged.Status](#fishjam-ServerMessage-RecordingStatusChanged-Status) | | |
| metadata | [string](#string) | | JSON-encoded, as set on recording creation |






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

### ServerMessage.RoomCrashed
Expand Down Expand Up @@ -1936,6 +1956,20 @@ Defines message groups for which peer can subscribe



<a name="fishjam-ServerMessage-RecordingStatusChanged-Status"></a>

### ServerMessage.RecordingStatusChanged.Status


| Name | Number | Description |
| ---- | ------ | ----------- |
| STATUS_UNSPECIFIED | 0 | |
| STATUS_FINISHED | 1 | |
| STATUS_AVAILABLE | 2 | |
| STATUS_FAILED | 3 | |



<a name="fishjam-ServerMessage-VadNotification-Status"></a>

### ServerMessage.VadNotification.Status
Expand Down
18 changes: 18 additions & 0 deletions fishjam/server_notifications.proto
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,20 @@ message ServerMessage {
string streamer_id = 2;
}

// Notification sent when a recording changes status
message RecordingStatusChanged {
enum Status {
STATUS_UNSPECIFIED = 0;
STATUS_FINISHED = 1;
STATUS_AVAILABLE = 2;
STATUS_FAILED = 3;
}

string recording_id = 1;
Status status = 2;
string metadata = 3; // JSON-encoded, as set on recording creation
}

// Carries multiple notifications in a single wire frame.
//
// Constraints (documented, not schema-enforced):
Expand Down Expand Up @@ -288,6 +302,10 @@ message ServerMessage {
StreamerConnected streamer_connected = 26;
StreamerDisconnected streamer_disconnected = 27;

// Recordings

RecordingStatusChanged recording_status_changed = 34;

// Batch
NotificationBatch notification_batch = 33;

Expand Down
33 changes: 33 additions & 0 deletions fishjam_protos/lib/fishjam/server_notifications.pb.ex
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,21 @@ defmodule Fishjam.ServerMessage.VadNotification.Status do
field :STATUS_SPEECH, 2
end

defmodule Fishjam.ServerMessage.RecordingStatusChanged.Status do
@moduledoc false

use Protobuf,
enum: true,
full_name: "fishjam.ServerMessage.RecordingStatusChanged.Status",
protoc_gen_elixir_version: "0.17.0",
syntax: :proto3

field :STATUS_UNSPECIFIED, 0
field :STATUS_FINISHED, 1
field :STATUS_AVAILABLE, 2
field :STATUS_FAILED, 3
end

defmodule Fishjam.ServerMessage.RoomCrashed do
@moduledoc false

Expand Down Expand Up @@ -443,6 +458,19 @@ defmodule Fishjam.ServerMessage.StreamerDisconnected do
field :streamer_id, 2, type: :string, json_name: "streamerId"
end

defmodule Fishjam.ServerMessage.RecordingStatusChanged do
@moduledoc false

use Protobuf,
full_name: "fishjam.ServerMessage.RecordingStatusChanged",
protoc_gen_elixir_version: "0.17.0",
syntax: :proto3

field :recording_id, 1, type: :string, json_name: "recordingId"
field :status, 2, type: Fishjam.ServerMessage.RecordingStatusChanged.Status, enum: true
field :metadata, 3, type: :string
end

defmodule Fishjam.ServerMessage.NotificationBatch do
@moduledoc false

Expand Down Expand Up @@ -583,6 +611,11 @@ defmodule Fishjam.ServerMessage do
json_name: "streamerDisconnected",
oneof: 0

field :recording_status_changed, 34,
type: Fishjam.ServerMessage.RecordingStatusChanged,
json_name: "recordingStatusChanged",
oneof: 0

field :notification_batch, 33,
type: Fishjam.ServerMessage.NotificationBatch,
json_name: "notificationBatch",
Expand Down
Loading