Livestream mode, improved client-side auth

Author: davidzhao

auth/grants.go

@@ -23,15 +23,29 @@ import (
 )
 
 type VideoGrant struct {
-	// actions on rooms
+	// ---- actions on rooms
+
+	// ability to create rooms, typically used only for CreateRoom API
 	RoomCreate bool `json:"roomCreate,omitempty"`
-	RoomList   bool `json:"roomList,omitempty"`
+	// ability to retrieve read-only information about rooms
+	RoomList bool `json:"roomList,omitempty"`
+	// ability to record any room
+	// this permission is too broad, and will be replaced by roomEgress, which is applied to a specific room
 	RoomRecord bool `json:"roomRecord,omitempty"`
+	// actions on ingresses
+	IngressAdmin bool `json:"ingressAdmin,omitempty"` // applies to all ingress
+
+	// ---- actions on a single room
 
-	// actions on a particular room
-	RoomAdmin bool   `json:"roomAdmin,omitempty"`
-	RoomJoin  bool   `json:"roomJoin,omitempty"`
-	Room      string `json:"room,omitempty"`
+	Room string `json:"room,omitempty"`
+	// can token holder perform admin operations on the room
+	RoomAdmin bool `json:"roomAdmin,omitempty"`
+	// can token holder join the room as a participant
+	RoomJoin bool `json:"roomJoin,omitempty"`
+	// can start egress sessions from the room
+	RoomEgress bool `json:"roomEgress,omitempty"`
+
+	// ---- activity allowed by a participant with roomJoin
 
 	// permissions within a room, if none of the permissions are set explicitly
 	// it will be granted with all publish and subscribe permissions
@@ -44,8 +58,7 @@ type VideoGrant struct {
 	// by default, a participant is not allowed to update its own metadata
 	CanUpdateOwnMetadata *bool `json:"canUpdateOwnMetadata,omitempty"`
 
-	// actions on ingresses
-	IngressAdmin bool `json:"ingressAdmin,omitempty"` // applies to all ingress
+	// ---- attributes on a participant
 
 	// participant is not visible to other participants
 	Hidden bool `json:"hidden,omitempty"`

bootstrap.sh

@@ -38,20 +38,7 @@ fi
 
 go mod download
 
-GO_VERSION=`go version | { read _ _ v _; echo ${v#go}; }`
-GO_TARGET_VERSION=1.17
-
-function version { echo "$@" | awk -F. '{ printf("%d%03d%03d%03d\n", $1,$2,$3,$4); }'; }
-
-if [ $(version $GO_VERSION) -ge $(version $GO_TARGET_VERSION) ];
-  then
-    go install github.com/twitchtv/twirp/[email protected]
-    go install google.golang.org/protobuf/cmd/[email protected]
-    go install google.golang.org/grpc/cmd/[email protected]
-    go install github.com/livekit/psrpc/[email protected]
-  else
-    go get -u github.com/twitchtv/twirp/[email protected]
-    go get -u google.golang.org/protobuf/cmd/[email protected]
-    go get -u google.golang.org/grpc/cmd/[email protected]
-    go get -u github.com/livekit/psrpc/[email protected]
-fi
+go install github.com/twitchtv/twirp/[email protected]
+go install google.golang.org/protobuf/cmd/[email protected]
+go install google.golang.org/grpc/cmd/[email protected]
+go install github.com/livekit/psrpc/[email protected]

livekit_models.proto

@@ -34,15 +34,31 @@ message Room {
   uint32 num_publishers = 11;
   bool active_recording = 10;
   PlayoutDelay playout_delay = 12;
+  AppMode app_mode = 13;
 
-  // NEXT-ID: 13
+  // NEXT-ID: 14
+}
+
+// AppMode configures the behavior and limits of the room
+enum AppMode {
+  // default mode, up to 3k users per room, everyone can be a publisher
+  // most applications should use this mode
+  AM_DEFAULT = 0;
+  // Interactive livestreams with support for large audiences
+  // limited to 25 publishers (with canPublish permissions) and unlimited viewers (with Cloud)
+  // some behavioral differences in livestream mode:
+  // - only admins will receive participant information from subscribers
+  // - default playout_delay is set to 150ms, you can override this by setting playout_delay in CreateRoom
+  AM_LIVESTREAM = 1;
 }
 
 message Codec {
   string mime = 1;
   string fmtp_line = 2;
 }
 
+// AudioCodec and VideoCodec are used by Ingress / Egress
+
 enum AudioCodec {
   DEFAULT_AC = 0;
   OPUS = 1;

livekit_room.proto

@@ -74,8 +74,15 @@ message CreateRoomRequest {
   string metadata = 5;
   // egress
   RoomEgress egress = 6;
-  // minimum playout delay of subscriber
+  // minimum playout delay when receiving remote media
+  // this is used to smooth out network jitters, and reduces freezes/stutters when a user's network experiences blips
   uint32 min_playout_delay = 7;
+
+  optional AppMode app_mode = 8;
+
+  repeated Codec enabled_codecs = 9;
+
+  // NEXT_ID: 10
 }
 
 message RoomEgress {