Changelog

v3.2.0 Latest

2026-05-15

Added

• Documentation Restructure: Reorganized into Web SDK, Android SDK, iOS SDK, and three API categories (Web Server / Media Server / Document Server), aligned with real showdoc interfaces.
• Get Recording Files API: Documented getRoomRecord for querying recordings by meeting ID or user, returning filepath, duration, and related fields.
• URL Join (Single-Parameter Token): Full H5 single-parameter join docs with Java / PHP AES-256 token generation examples and index.html?token= usage.

Improved

• Integration Methods: Method 1 now documents both client protocol launch (weiyi://https://domain/h5/index.html?...) and web multi-parameter join (https://domain/h5/#/login?...).
• UI SDK Integration: Method 2 updated to URL-based join; iframe embeds must include allow="geolocation; microphone; camera;display-capture".
• Web SDK Leave Room: Clarified that iframe scenarios must use postMessage("exit") to avoid Vue refs issues.

Fixed

• Removed outdated placeholder content for @weiyipro/ui-sdk / @weiyipro/core-sdk; docs now match the real JS SDK (conference, Wy.Base.LocalStream).
• Added missing URL join parameters: joinRole (presenter / speaker / chairman) and invisible.

---

v3.1.0

2026-03-20

Added

• Media Server RTMP Streaming: Documented startStreamingOut / stopStreamingOut for pushing Room audio/video streams to RTMP endpoints.
• Stream Mixing APIs: Added mixStream, removeMixStream, and updateRoomMixStream for adding/removing streams from mix and adjusting output resolution (e.g. 1280×720).
• Get Live Streams: Documented getLiveStream Web API returning cdnStreams and serverStreams pull URLs.

Improved

• Web SDK Publish Example: Added H.264 encoding parameters, publishConstraints bitrate config (e.g. 2500 kbps), and publication.stop() usage.
• Create Meeting Response: Expanded meetingcreate response fields including roomid, sig, push/pull/record paths.

Fixed

• Corrected createRoom mix resolution optional params; default output is 640×480.
• Added duration field (class duration in seconds) to getClassBeginTime response docs.

---

v3.0.0 Major Release

2026-01-10

Breaking Changes

• Documentation Overhaul: Replaced fictional Audio/Video / IM / Live npm package docs with real Web JS SDK + REST / JS API integration guides.
• SDK Overview: Platform split into Web / Android / iOS SDKs; system requirements trimmed to Windows, Android, iOS, and Web browsers (macOS / Linux removed).

Added

• Web JS SDK Docs: Device enumeration (enumerateDevices), media capture (getUserMedia), Room connection (createToken + conference.join), publish/subscribe, signaling, and streamadded event handling.
• Web Server APIs: Create / modify / delete meetings, bind documents, list meeting files, upload room background, member login records, and related REST endpoints.
• Document Server API: uploadfile with optional meeting auto-binding via serial.
• URL Join (Multi-Parameter): H5 link join with serial, userid, username, and related parameters.

Improved

• WebRTC deployment requirements: HTTPS mandatory; iframe embeds require microphone, camera, and display-capture permissions.
• Media server createRoom returns roomid for chaining into JS SDK join flow.

---

v2.8.0

2025-10-15

Added

• Member Login Records: getlogininfo API returning participant userid, entertime, leavetime, and related fields.
• Meeting Document Management: meetingbindfile for associating documents and getmeetingfile for listing meeting files.
• Room Background Image: uploadRoomPic for uploading room backgrounds, returning picPath.

Improved

• Error Code Reference: Expanded common Web API error codes (e.g. 4101 enterprise ID, 4110 password required, 5205 display name required).
• Subscribe Example: Web SDK conference.subscribe docs include subscription.stop() and stream ended event handling.

Fixed

• Documented Unicode encoding requirement for Chinese usernames in token JSON (Java chineseCharacterToUnicode).
• Added uploadfile constraint: when isopen=0, serial is required.