Skip to content

Add room type to Authenticated message #17

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 5 commits into from
Mar 6, 2025
Merged

Add room type to Authenticated message #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
80cd169
Add room type to Authenticated message
AHGIJMKLKKZNPJKQR Mar 5, 2025
f5b77ec
Update deps and fix linting
AHGIJMKLKKZNPJKQR Mar 5, 2025
3398689
Actually commit changes
AHGIJMKLKKZNPJKQR Mar 5, 2025
65f5eba
Regenerate docs
AHGIJMKLKKZNPJKQR Mar 5, 2025
6dcbc65
Add explicit ROOM_TYPE_FULL_FEATURE option
AHGIJMKLKKZNPJKQR Mar 6, 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
24 changes: 22 additions & 2 deletions doc/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@
- [PeerMessage.MediaEvent](#fishjam-PeerMessage-MediaEvent)
- [PeerMessage.RTCStatsReport](#fishjam-PeerMessage-RTCStatsReport)

- [PeerMessage.RoomType](#fishjam-PeerMessage-RoomType)

- [fishjam/server_notifications.proto](#fishjam_server_notifications-proto)
- [ServerMessage](#fishjam-ServerMessage)
- [ServerMessage.AuthRequest](#fishjam-ServerMessage-AuthRequest)
Expand Down Expand Up @@ -876,7 +878,12 @@ Request sent by peer, to authenticate to FJ server
<a name="fishjam-PeerMessage-Authenticated"></a>

### PeerMessage.Authenticated
Response sent by FJ, confirming successfull authentication
Response sent by FJ, confirming successful authentication


| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| room_type | [PeerMessage.RoomType](#fishjam-PeerMessage-RoomType) | | |



Expand Down Expand Up @@ -915,6 +922,19 @@ https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport#the_statistic_ty




<a name="fishjam-PeerMessage-RoomType"></a>

### PeerMessage.RoomType
Defines types of rooms peers may connect to

| Name | Number | Description |
| ---- | ------ | ----------- |
| ROOM_TYPE_UNSPECIFIED | 0 | |
| ROOM_TYPE_FULL_FEATURE | 1 | |
| ROOM_TYPE_AUDIO_ONLY | 2 | |





Expand Down Expand Up @@ -949,7 +969,7 @@ Defines any type of message passed between FJ and server peer
| subscribe_response | [ServerMessage.SubscribeResponse](#fishjam-ServerMessage-SubscribeResponse) | | |
| room_created | [ServerMessage.RoomCreated](#fishjam-ServerMessage-RoomCreated) | | |
| room_deleted | [ServerMessage.RoomDeleted](#fishjam-ServerMessage-RoomDeleted) | | |
| metrics_report | [ServerMessage.MetricsReport](#fishjam-ServerMessage-MetricsReport) | | |
| metrics_report | [ServerMessage.MetricsReport](#fishjam-ServerMessage-MetricsReport) | | **Deprecated.** |
| hls_playable | [ServerMessage.HlsPlayable](#fishjam-ServerMessage-HlsPlayable) | | |
| hls_uploaded | [ServerMessage.HlsUploaded](#fishjam-ServerMessage-HlsUploaded) | | |
| hls_upload_crashed | [ServerMessage.HlsUploadCrashed](#fishjam-ServerMessage-HlsUploadCrashed) | | |
Expand Down
13 changes: 11 additions & 2 deletions fishjam/peer_notifications.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,17 @@ import "fishjam/media_events/server/server.proto";

// Defines any type of message sent between FJ and a peer
message PeerMessage {
// Response sent by FJ, confirming successfull authentication
message Authenticated {}
// Defines types of rooms peers may connect to
enum RoomType {
ROOM_TYPE_UNSPECIFIED = 0;
ROOM_TYPE_FULL_FEATURE = 1;
ROOM_TYPE_AUDIO_ONLY = 2;
}

// Response sent by FJ, confirming successful authentication
message Authenticated {
RoomType room_type = 1;
}

// Request sent by peer, to authenticate to FJ server
message AuthRequest {
Expand Down
30 changes: 15 additions & 15 deletions fishjam_protos/lib/fishjam/media_events/peer/peer.pb.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defmodule Fishjam.MediaEvents.Peer.MediaEvent.VariantBitrate do
@moduledoc false

use Protobuf, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :variant, 1, type: Fishjam.MediaEvents.Variant, enum: true
field :bitrate, 2, type: :int32
Expand All @@ -10,29 +10,29 @@ end
defmodule Fishjam.MediaEvents.Peer.MediaEvent.Connect do
@moduledoc false

use Protobuf, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :metadata_json, 1, type: :string, json_name: "metadataJson"
end

defmodule Fishjam.MediaEvents.Peer.MediaEvent.Disconnect do
@moduledoc false

use Protobuf, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3
end

defmodule Fishjam.MediaEvents.Peer.MediaEvent.UpdateEndpointMetadata do
@moduledoc false

use Protobuf, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :metadata_json, 1, type: :string, json_name: "metadataJson"
end

defmodule Fishjam.MediaEvents.Peer.MediaEvent.UpdateTrackMetadata do
@moduledoc false

use Protobuf, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :track_id, 1, type: :string, json_name: "trackId"
field :metadata_json, 2, type: :string, json_name: "metadataJson"
Expand All @@ -41,13 +41,13 @@ end
defmodule Fishjam.MediaEvents.Peer.MediaEvent.RenegotiateTracks do
@moduledoc false

use Protobuf, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3
end

defmodule Fishjam.MediaEvents.Peer.MediaEvent.SdpOffer.TrackIdToMetadataJsonEntry do
@moduledoc false

use Protobuf, map: true, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, map: true, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :key, 1, type: :string
field :value, 2, type: :string
Expand All @@ -56,7 +56,7 @@ end
defmodule Fishjam.MediaEvents.Peer.MediaEvent.SdpOffer.TrackIdToBitratesEntry do
@moduledoc false

use Protobuf, map: true, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, map: true, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :key, 1, type: :string
field :value, 2, type: Fishjam.MediaEvents.Peer.MediaEvent.TrackBitrates
Expand All @@ -65,7 +65,7 @@ end
defmodule Fishjam.MediaEvents.Peer.MediaEvent.SdpOffer.MidToTrackIdEntry do
@moduledoc false

use Protobuf, map: true, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, map: true, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :key, 1, type: :string
field :value, 2, type: :string
Expand All @@ -74,7 +74,7 @@ end
defmodule Fishjam.MediaEvents.Peer.MediaEvent.SdpOffer do
@moduledoc false

use Protobuf, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :sdp, 1, type: :string

Expand All @@ -100,7 +100,7 @@ end
defmodule Fishjam.MediaEvents.Peer.MediaEvent.TrackBitrates do
@moduledoc false

use Protobuf, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :track_id, 1, type: :string, json_name: "trackId"

Expand All @@ -113,7 +113,7 @@ end
defmodule Fishjam.MediaEvents.Peer.MediaEvent.DisableTrackVariant do
@moduledoc false

use Protobuf, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :track_id, 1, type: :string, json_name: "trackId"
field :variant, 2, type: Fishjam.MediaEvents.Variant, enum: true
Expand All @@ -122,7 +122,7 @@ end
defmodule Fishjam.MediaEvents.Peer.MediaEvent.EnableTrackVariant do
@moduledoc false

use Protobuf, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :track_id, 1, type: :string, json_name: "trackId"
field :variant, 2, type: Fishjam.MediaEvents.Variant, enum: true
Expand All @@ -131,7 +131,7 @@ end
defmodule Fishjam.MediaEvents.Peer.MediaEvent.SetTargetTrackVariant do
@moduledoc false

use Protobuf, syntax: :proto3, protoc_gen_elixir_version: "0.13.0"
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

field :track_id, 1, type: :string, json_name: "trackId"
field :variant, 2, type: Fishjam.MediaEvents.Variant, enum: true
Expand All @@ -140,7 +140,7 @@ end
defmodule Fishjam.MediaEvents.Peer.MediaEvent do
@moduledoc false

use Protobuf, protoc_gen_elixir_version: "0.14.0", syntax: :proto3
use Protobuf, protoc_gen_elixir_version: "0.14.1", syntax: :proto3

oneof :content, 0

Expand Down
Loading