0.0.3

[MaxMansfield]

---

name: Pull Request
about: Submit changes to the RTMS SDK

Description

This PR integrates the latest RTMS C++ SDK (librtmsdk.0.20251026) and adds several enhancements including media parameter validation, session handling, event callbacks, and raw webhook support. Key updates include enhanced initialization with agent parameter support, complete session object with helper methods, onEventEx callback integration, comprehensive media parameter validations that enforce SDK constants, and advanced webhook handling with request/response access. The README has been updated with examples demonstrating the new features.

Related Issues

Integrates librtmsdk.0.20251026

Type of Change

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation update
• Refactoring (no functional changes)
• Performance improvement
• Tests (adding or improving tests)
• Build changes

Affected Components

• Core C++ implementation
• Node.js bindings
• Python bindings
• Go bindings
• Build system
• Documentation
• Examples
• Other (please specify)

Testing Performed

C++ Integration Testing:

• Verified metadata fields (user_name and user_id) are blank in core SDK through debug statements, confirming issue is in librtmsdk itself
• Tested all media data handlers (audio, video, transcript, deskshare) receive metadata correctly
• Verified session update callbacks with sessionId, streamId, meetingId, statTime methods
• Tested isActive() and isPaused() helper methods

Media Parameter Validation:

• Tested audio parameter validation with invalid values to ensure proper error messages
• Tested video parameter validation with invalid values
• Tested deskshare parameter validation
• Verified all SDK constants are enforced (AudioContentType, VideoContentType, etc.)
• Confirmed error messages are helpful and guide users to correct constant usage

Raw Webhook Support:

• Tested enhanced callback signature with req/res parameters
• Verified type guard correctly detects raw webhook callbacks

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published

Additional Context

SDK Version: librtmsdk.0.20251016

Note on Metadata Fields: The metadata.user_name and metadata.user_id fields are blank when receiving data from the SDK. This has been confirmed through debug statements to be an issue in the core librtmsdk library, not in our wrapper code.

Media Parameter Validation: The validation ensures that users must use SDK constant enumerations (e.g., rtms.AudioContentType.RAW_AUDIO) rather than raw integers, preventing type safety issues and providing better error messages.

Webhook Integration: The raw webhook callback provides full access to HTTP request and response objects for advanced use cases like Zoom's webhook validation challenge, custom authentication, and custom responses. Documentation in README demonstrates this capability.

Session Handling: Full session object now includes helper methods for checking active/paused states, making it easier for users to track session status.

Event Callbacks: Added onEventEx support for receiving extended event data from the SDK.