Merge pull request #89 from zoom/dev

v1.0.2

Author: MaxMansfield

.github/docs-template/index.html

@@ -385,7 +385,7 @@ <h3>JavaScript & TypeScript</h3>
                     <p>Complete API reference for Node.js and TypeScript developers with comprehensive examples, type definitions, and integration guides for real-time media processing.</p>
                 </a>
 
-                <a href="./python/" class="docs-card" role="button" aria-label="Python Documentation">
+                <a href="./py/" class="docs-card" role="button" aria-label="Python Documentation">
                     <div class="card-icon">🐍</div>
                     <h3>Python</h3>
                     <p>Python bindings documentation featuring usage examples, API reference, and detailed implementation guides for seamless integration with your Python applications.</p>

CMakeLists.txt

@@ -7,6 +7,13 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 cmake_policy(SET CMP0091 NEW)
 
+# ===== Debug options =====
+option(RTMS_DEBUG "Enable RTMS debug logging for C SDK callbacks" OFF)
+if(RTMS_DEBUG)
+  add_compile_definitions(RTMS_DEBUG)
+  message(STATUS "RTMS debug logging enabled")
+endif()
+
 # ===== Platform detection =====
 if(APPLE)
   set(RTMS_PLATFORM "darwin")

README.md

@@ -4,7 +4,7 @@ Bindings for real-time audio, video, and transcript streams from Zoom Meetings
 
 [![npm](https://img.shields.io/npm/v/@zoom/rtms)](https://www.npmjs.com/package/@zoom/rtms)
 [![PyPI](https://img.shields.io/pypi/v/rtms)](https://pypi.org/project/rtms/)
-[![docs](https://img.shields.io/badge/docs-online-blue)](https://zoom.github.io/rtms/js/)
+[![docs](https://img.shields.io/badge/docs-online-blue)](https://zoom.github.io/rtms/)
 
 ## Supported Products
 
@@ -80,10 +80,7 @@ The RTMS SDK requires Python 3.10 or higher.
 # Check your Python version
 python3 --version
 
-# Install from TestPyPI (Current)
-pip install -i https://test.pypi.org/simple/ rtms
-
-# Install from PyPI (Coming Soon)
+# Install from PyPI
 pip install rtms
 ```
 
@@ -432,7 +429,7 @@ source .venv/bin/activate  # On Windows: .venv\Scripts\activate
 pip install python-dotenv
 
 # Install RTMS SDK
-pip install -i https://test.pypi.org/simple/ rtms
+pip install rtms
 ```
 
 Create a `.env` file:

Taskfile.yml

@@ -3,6 +3,7 @@ version: '3'
 # Global variables
 vars:
   BUILD_TYPE: '{{.BUILD_TYPE | default "Release"}}'
+  RTMS_DEBUG: '{{.RTMS_DEBUG | default "OFF"}}'
   NODE_VERSION: "22"
   PYTHON_VERSION: "3.13"
   CMAKE_VERSION: "3.25"
@@ -39,7 +40,7 @@ tasks:
   build:js:
     desc: "Build Node.js bindings (local platform)"
     cmds:
-      - npx cmake-js compile --CDCMAKE_BUILD_TYPE={{.BUILD_TYPE}}
+      - npx cmake-js compile --CDCMAKE_BUILD_TYPE={{.BUILD_TYPE}} --CDRTMS_DEBUG={{.RTMS_DEBUG}}
     sources:
       - src/**/*.cpp
       - src/**/*.h
@@ -53,7 +54,7 @@ tasks:
   build:js:linux:
     desc: "Build Node.js bindings for Linux (via Docker)"
     cmds:
-      - docker compose run --rm build task build:js BUILD_TYPE={{.BUILD_TYPE}}
+      - docker compose run --rm build task build:js BUILD_TYPE={{.BUILD_TYPE}} RTMS_DEBUG={{.RTMS_DEBUG}}
 
   build:js:darwin:
     desc: "Build Node.js bindings for macOS"
@@ -284,7 +285,7 @@ tasks:
   manual:js:linux:
     desc: "Run interactive Node.js manual test in Linux Docker"
     cmds:
-      - docker compose run --rm -it --service-ports test-js sh -c "task build:js && NODE_ENV=test node --trace-deprecation --force-node-api-uncaught-exceptions-policy=true --env-file=.env test.js"
+      - docker compose run --rm -it --service-ports test-js sh -c "task build:js RTMS_DEBUG={{.RTMS_DEBUG}} && NODE_ENV=test node --trace-deprecation --force-node-api-uncaught-exceptions-policy=true --env-file=.env test.js"
 
   manual:py:linux:
     desc: "Run interactive Python manual test in Linux Docker"
@@ -311,7 +312,10 @@ tasks:
     desc: "Generate Python API documentation"
     cmds:
       - mkdir -p docs
-      - pdoc3 -o docs/py/ --force --html rtms
+      - pdoc3 -o docs/ --force --html rtms
+      # pdoc3 creates docs/rtms/, rename to docs/py/ for clean URL
+      - rm -rf docs/py
+      - mv docs/rtms docs/py
     sources:
       - src/**/*.py
       - src/**/*.pyi

examples/videosdk.md

@@ -14,6 +14,7 @@ The API is identical to Meetings. See the [Meetings Node.js Quick Start](meeting
 
 Key differences:
 - Webhook event: `session.rtms_started` (Video SDK uses session events)
+- Webhook payload contains `session_id` instead of `meeting_uuid`
 - Join parameters come from Video SDK webhook payload
 
 ```javascript
@@ -32,6 +33,8 @@ rtms.onWebhookEvent(({event, payload}) => {
         console.log(`Video SDK video: ${metadata.width}x${metadata.height}`);
     });
 
+    // Video SDK payload contains session_id (not meeting_uuid)
+    // The SDK accepts both - just pass the payload directly
     client.join(payload);
 });
 ```
@@ -42,6 +45,7 @@ The API is identical to Meetings. See the [Meetings Python Quick Start](meetings
 
 Key differences:
 - Webhook event: `session.rtms_started` (Video SDK uses session events)
+- Webhook payload contains `session_id` instead of `meeting_uuid`
 
 ```python
 import rtms
@@ -53,7 +57,8 @@ def handle_webhook(payload):
     if payload.get('event') == 'session.rtms_started':
         rtms_payload = payload.get('payload', {})
         client.join(
-            meeting_uuid=rtms_payload.get('meeting_uuid'),
+            # Video SDK uses session_id instead of meeting_uuid
+            session_id=rtms_payload.get('session_id'),
             rtms_stream_id=rtms_payload.get('rtms_stream_id'),
             server_urls=rtms_payload.get('server_urls')
         )

index.ts

@@ -947,6 +947,7 @@ class Client extends nativeRtms.Client {
 
     const {
       meeting_uuid,
+      session_id,
       rtms_stream_id,
       server_urls,
       signature: providedSignature,
@@ -956,34 +957,40 @@ class Client extends nativeRtms.Client {
       pollInterval = 0
     } = options;
 
+    // Use meeting_uuid for Meeting SDK events, session_id for Video SDK events
+    const instance_id = meeting_uuid || session_id;
+
     this.pollRate = pollInterval;
 
-    Logger.info('client', `Joining meeting: ${meeting_uuid}`, {
+    Logger.info('client', `Joining ${meeting_uuid ? 'meeting' : 'session'}: ${instance_id}`, {
       streamId: rtms_stream_id,
       serverUrls: server_urls,
       timeout: providedTimeout,
       pollInterval
     });
-    
+
+    if (!instance_id) {
+      throw new Error('Either meeting_uuid or session_id must be provided');
+    }
 
     const finalSignature = providedSignature || generateSignature({
       client,
       secret,
-      uuid: meeting_uuid,
+      uuid: instance_id,
       streamId: rtms_stream_id
     });
 
     try {
-      ret = super.join(meeting_uuid, rtms_stream_id, finalSignature, server_urls, providedTimeout);
-      
+      ret = super.join(instance_id, rtms_stream_id, finalSignature, server_urls, providedTimeout);
+
       if (ret) {
-        Logger.info('client', `Successfully joined meeting: ${meeting_uuid}`);
+        Logger.info('client', `Successfully joined: ${instance_id}`);
       } else {
-        Logger.error('client', `Failed to join meeting: ${meeting_uuid}`);
+        Logger.error('client', `Failed to join: ${instance_id}`);
       }
     } catch (error) {
       const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-      Logger.error('client', `Error joining meeting: ${errorMessage}`, { meeting_uuid });
+      Logger.error('client', `Error joining: ${errorMessage}`, { instance_id });
       throw error;
     }