address mr comments

Author: stephen-derosa

user_timestamped_video/README.md

@@ -17,6 +17,14 @@ LIVEKIT_URL=ws://localhost:7880 LIVEKIT_TOKEN=<producer-token> ./UserTimestamped
 LIVEKIT_URL=ws://localhost:7880 LIVEKIT_TOKEN=<consumer-token> ./UserTimestampedVideoConsumer
 ```
 
+Requirements:
+
+- LiveKit C++ SDK `v0.3.4` or newer. This example uses
+  `VideoFrameMetadata` and `setOnVideoFrameEventCallback`, which are not
+  available in older SDK releases.
+- To pin the SDK version when configuring the examples, pass
+  `-DLIVEKIT_SDK_VERSION=0.3.4` to CMake.
+
 Flags:
 
 - Producer default: sends user timestamps

user_timestamped_video/consumer/main.cpp

@@ -49,6 +49,8 @@ constexpr const char *kTrackName = "timestamped-camera";
 
 std::atomic<bool> g_running{true};
 
+enum class ParseResult { Ok, Help, Error };
+
 void handleSignal(int) { g_running.store(false); }
 
 std::string getenvOrEmpty(const char *name) {
@@ -74,15 +76,15 @@ void printUsage(const char *program) {
             << " [--with-user-timestamp|--without-user-timestamp]\n";
 }
 
-bool parseArgs(int argc, char *argv[], std::string &url, std::string &token,
-               bool &read_user_timestamp) {
+ParseResult parseArgs(int argc, char *argv[], std::string &url,
+                      std::string &token, bool &read_user_timestamp) {
   read_user_timestamp = true;
   std::vector<std::string> positional;
 
   for (int i = 1; i < argc; ++i) {
     const std::string arg = argv[i];
     if (arg == "-h" || arg == "--help") {
-      return false;
+      return ParseResult::Help;
     }
     if (arg == "--without-user-timestamp") {
       read_user_timestamp = false;
@@ -104,7 +106,7 @@ bool parseArgs(int argc, char *argv[], std::string &url, std::string &token,
     token = positional[1];
   }
 
-  return !(url.empty() || token.empty());
+  return (url.empty() || token.empty()) ? ParseResult::Error : ParseResult::Ok;
 }
 
 class UserTimestampedVideoConsumerDelegate : public RoomDelegate {
@@ -203,9 +205,11 @@ int main(int argc, char *argv[]) {
   std::string token;
   bool read_user_timestamp = true;
 
-  if (!parseArgs(argc, argv, url, token, read_user_timestamp)) {
+  const ParseResult parse_result =
+      parseArgs(argc, argv, url, token, read_user_timestamp);
+  if (parse_result != ParseResult::Ok) {
     printUsage(argv[0]);
-    return 1;
+    return parse_result == ParseResult::Help ? 0 : 1;
   }
 
   std::signal(SIGINT, handleSignal);

user_timestamped_video/producer/main.cpp

@@ -51,6 +51,8 @@ constexpr int kFrameIntervalMs = 200;
 
 std::atomic<bool> g_running{true};
 
+enum class ParseResult { Ok, Help, Error };
+
 void handleSignal(int) { g_running.store(false); }
 
 std::string getenvOrEmpty(const char *name) {
@@ -89,15 +91,15 @@ void printUsage(const char *program) {
             << " [--with-user-timestamp|--without-user-timestamp]\n";
 }
 
-bool parseArgs(int argc, char *argv[], std::string &url, std::string &token,
-               bool &send_user_timestamp) {
+ParseResult parseArgs(int argc, char *argv[], std::string &url,
+                      std::string &token, bool &send_user_timestamp) {
   send_user_timestamp = true;
   std::vector<std::string> positional;
 
   for (int i = 1; i < argc; ++i) {
     const std::string arg = argv[i];
     if (arg == "-h" || arg == "--help") {
-      return false;
+      return ParseResult::Help;
     }
     if (arg == "--without-user-timestamp") {
       send_user_timestamp = false;
@@ -119,7 +121,7 @@ bool parseArgs(int argc, char *argv[], std::string &url, std::string &token,
     token = positional[1];
   }
 
-  return !(url.empty() || token.empty());
+  return (url.empty() || token.empty()) ? ParseResult::Error : ParseResult::Ok;
 }
 
 } // namespace
@@ -129,9 +131,11 @@ int main(int argc, char *argv[]) {
   std::string token;
   bool send_user_timestamp = true;
 
-  if (!parseArgs(argc, argv, url, token, send_user_timestamp)) {
+  const ParseResult parse_result =
+      parseArgs(argc, argv, url, token, send_user_timestamp);
+  if (parse_result != ParseResult::Ok) {
     printUsage(argv[0]);
-    return 1;
+    return parse_result == ParseResult::Help ? 0 : 1;
   }
 
   std::signal(SIGINT, handleSignal);