This article describes the new features, functionality, and resolved issues for each of the VidyoClient API releases beginning in 2020 (subsequent to the VidyoClient API 3.x releases).
- Binary Library
- JavaScript Library
2020 Releases
Binary Library
VidyoClient API: About Version 20.3.0
What's New in This Release
High Frame Rate Content Share
- If you've ever wanted to share a streaming video or other high frame rate content during a video call, now you can! With version 20.3.0, you can share content up to 30 FPS.
- High frame rate content share is supported for Windows®, macOS®, Android™, and iOS.
Waiting Room
- The Waiting Room feature prevents meeting participants from seeing or hearing each other until the room owner joins the meeting or the moderator selects a presenter.
- As soon as the room owner joins or the presenter is selected, the meeting begins and all the participants can see each other. In addition:
- If Group mode is enabled, all the participants’ microphones will be unmuted.
- If Presenter mode is enabled, all the participants’ microphones will remain muted.
Presenter Mode
- When Presenter mode is enabled:
- All the participants remain in Waiting Room mode until the moderator selects the presenter.
- The microphones of all the participants are muted, and they must use the Raise Hand button to request to be unmuted.
- The conference moderator sees the Raise Hand requests and can select who to unmute.
Call Moderation
- The moderator can control many aspects of the video meeting, such as:
- Invite new participants.
- Mute and unmute individual or all participants' microphones and cameras.
- Lock and unlock the room.
- Switch to Presenter mode.
- Start, stop, pause, and resume recording.
- Disconnect participants and end the call.
- If you are not the room owner, you must enter the moderator PIN to become the moderator.
Webcast Indication API
- A new API provides you with the ability to show a webcast indication when there is an ongoing webcast during a video call.
Resolved Issues
The following table lists the resolved issues in VidyoClient API version 20.3.0:
VidyoClient API Version 20.3.0 - Resolved Issues |
|
---|---|
Key | Summary |
IO-1995 |
An issue with the hideView API that caused it to hang and block the video has been resolved. |
IO-1994 |
onRemoteCameraFirstFrameReceived is no longer called multiple times for the same instance of the last callback. |
IO-1899 |
An issue that caused an unhandled exception in OnParticipantJoined has been resolved. |
IO-1888 |
libVidyoClient.dll is now digitally signed so customers can check the certificate signature at runtime and allow or reject it. |
IO-1860 |
As issue was fixed with LmiRoomMembershipInline to prevent it from causing crashes in iOS. |
IO-1859 |
VidyoClient no longer crashes in iOS when it gets interrupted while it is actively connecting. |
IO-1783 |
The VidyoClient build configuration file now correctly has the BUILD_TYPE as "release" rather than "debug" and the DEBUG type as "false". |
Known Issues
The following table lists the known issues in VidyoClient API version 20.3.0:
VidyoClient API Version 20.3.0 - Known Issues |
|
---|---|
Key | Summary |
IO-2384 |
In order to launch the CSharp Sample app, you must launch the app as an admin. |
IO-2334 |
At this time, VidyoClient cannot detect the hard-mute status of the microphone or camera for either a room or a remote participant. |
IO-2206 |
When a Presenter is selected during a call, the microphones of the other call participants do not get hard muted as they should. |
IO-1937 |
Depending on the capacity of the machine and the available resources at the time, the maximum frame rate when sharing an app may be less than the full 30 frames per second, such as 25 to 27 fps. |
VidyoClient API: About Version 20.2.0
What's New in This Release
Multiple Enhancements for Custom Layout
- Multiple enhancements have been added to the Custom Layout in order to provide a better user experience. These enhancements include APIs that the application can use to reduce the chance of getting black video tiles as well as to reduce the receive bandwidth usage.
- The VidyoConnector Sample has also been updated to include a new layout where all the tiles are equal-sized.
Disabling Video Under Prolonged Low Bandwidth Conditions
- If an individual user in a call experiences prolonged low network bandwidth, their video feed will automatically shut off. By doing so, their limited bandwidth can be used to transmit their audio.
- Whenever the VidyoClient API shuts off a video stream due to prolonged low bandwidth, it will notify the application.
- This feature is disabled by default. For information about how to enable it, contact Enghouse Vidyo as listed in the Contact Us article.
Automatically Reconnecting to Conferences
- Calls will now automatically attempt to reconnect if they were disconnected under conditions where Enghouse Vidyo determines a reconnection attempt may be successful.
- If this occurs, the affected users will be notified of the following:
- When a reconnection is being attempted.
- The number of attempts at reconnection.
- Whether the reconnection is successful or not.
- This feature is disabled by default. For information about how to enable it, contact Enghouse Vidyo as listed in the Contact Us article.
Support for Additional Processors
- We can now detect newer processors including the Intel Cannon Lake, Intel Ice Lake, and Apple A13, thereby enabling our customers to achieve top-level performance.
Disabling the Default Install License Behavior
- By default, an install license is consumed whenever a VidyoClient-based app is installed on a new machine. However, an Advanced option is now available that enables you to disable the default install license behavior.
- This feature is disabled by default. For information about how to enable it, contact Enghouse Vidyo as listed in the Contact Us article or by reaching out to your authorized Vidyo Reseller.
Pinning and Unpinning One Video Tile at a Time
- The ability to pin and unpin one video tile at a time on a composite layout has been added.
- Support for pinning multiple participant tiles is not yet available.
Number of Encoded Spatial Layers Added to Statistics
- For easier debugging, the statistics now identify the number of spatial layers received, decoded, or rendered by the receiving client.
New and Updated APIs
- VidyoConnectorSetPool API for guests
- The VidyoConnectorSetPool API can now be used for guest users. This API enables the application to determine which VidyoRouter in the network will be used for the call by the client.
- New API to lock orientation of mobile devices
- The new VidyoLocalCameraSetOrientation API enables the application to lock the orientation of the video rendering window.
Resolved Issues
The following table lists the resolved issues in VidyoClient API version 20.2.0:
VidyoClient API Version 20.2.0 - Resolved Issues |
|
---|---|
Key | Summary |
IO-1812 |
Enghouse Vidyo fixed a crash issue that was caused when moving a window on Windows 10. |
IO-1801 |
Enghouse Vidyo fixed an issue where white flickering could sometimes be seen in the background of some video tiles. |
IO-1738 |
Enghouse Vidyo fixed a black tile issue that occurred for some users in large calls when using a Custom Layout. |
IO-1729 |
A crash issue that occurred when using VirtualVideoSource and SetBoundsConstraints has been resolved. |
IO-1719 |
If a user attempts to connect to a locked room or specifies an invalid room PIN, only one callback (rather than two) is now triggered and the correct error messages are received. |
IO-1718 |
Enghouse Vidyo fixed an issue where the user's display name was not being updated properly if the user left and rejoined the call. |
IO-1713 |
Enghouse Vidyo fixed an issue where connecting to a call took longer for iOS users when compared to Android and Web users. |
IO-1699 |
Enghouse Vidyo fixed an issue where Japanese characters in device names and participant names appeared garbled when using the IE plugin. |
IO-1676 |
Enghouse Vidyo fixed an issue where the app got stuck when a local window share was started before joining a call. |
IO-1652 |
Enghouse Vidyo fixed an issue where DTMF signals were being played in a call if, for the previous call, the user had dialed out and entered the meeting ID using the dialpad. |
IO-1640 and IO-1634 |
Enghouse Vidyo fixed an intermittent crashing or freezing issue that occurred due to a deallocated "VCParticipant" object. |
IO-1630 and IO-877 |
Enghouse Vidyo fixed an issue where the app would crash if the user disabled Wi-Fi on their Android or iOS device when in the process of joining a call. |
IO-1552 | Enghouse Vidyo fixed an issue where raw frames were not working on C# and Java bindings. |
IO-1539 | When a crash occurs on the Android platform, the crash stack trace is now getting printed in the logs. |
IO-1535 | Enghouse Vidyo fixed an issue where a registered user on tenant A (who gets their privileges on tenant A) joins a call on tenant B, they erroneously get the same privileges on tenant B as on tenant A. |
IO-1116 | Enghouse Vidyo fixed a camera labeling issue so that the correct labels now appear for camera preview and content preview. |
JavaScript Library
VidyoClient for WebRTC JavaScript Library: About Limited Availability (LA) Version 20.1.7
What's New
- In this release, we've resolved issues and incorporated solutions to improve the usability, reliability, and performance of your custom-built applications using the VidyoClient for WebRTC JavaScript Library.
Resolved Issues
The following table lists the resolved issues in VidyoClient for WebRTC JavaScript Library version 20.1.7 LA:
VidyoClient for WebRTC JavaScript Library Version 20.1.7 LA - Resolved Issues | |
---|---|
Key | Summary |
IOWEBRTC-1632 | On Google Chrome, a participant's incoming audio no longer switches to the default speaker when another participant switches their microphone. |
IOWEBRTC-1601 | An issue has been fixed where only one video tile was displayed during a call even when there were multiple participants in the call. |
IOWEBRTC-1538 | When a Safari user on iOS 13.7 joins a call that already has a VidyoConnect participant, the Safari user no longer sees a black tile. |
Known Issues
There are no new known issues for this release.
VidyoClient for WebRTC JavaScript Library: About Limited Availability (LA) Version 20.1.6
What's New
- Resolved Issues
- In this release, we've resolved issues and incorporated solutions to improve the usability, reliability, and performance of your custom-built applications using the VidyoClient for WebRTC JavaScript Library.
Resolved Issues
The following table lists the resolved issues in VidyoClient for WebRTC JavaScript Library version 20.1.6 LA:
VidyoClient for WebRTC JavaScript Library Version 20.1.6 - Resolved Issues | |
---|---|
Key | Summary |
IOWEBRTC-1533 |
The stats object "codecIFrames", which works for Chrome and Safari only, no longer misses iFrame counts for the encoder and decoder. |
IOWEBRTC-1489 | Firefox now uses the VP9 codec by default. |
IOWEBRTC-1484, IOWEBRTC-1429, and IOWEBRTC-1170 |
An issue has been fixed where users occasionally stopped seeing the remote video from user after content was shared during a call. |
IOWEBRTC-1419 | An issue that caused Firefox users to occasionally drop from calls has been fixed. |
IOWEBRTC-1399 |
The video stream and shared content from Firefox users can now be seen by the other call participants. |
IOWEBRTC-1160 | When the uplink bandwidth is limited, the video encoder bitrate is lowered to provide enough bandwidth for audio. |
Known Issues
There are no new known issues for this release.
VidyoClient for WebRTC JavaScript Library: About Limited Availability (LA) Version 20.1.5
What's New
- Additional Statistics
- Add the QualityLimitationReason reason to encoder statistics to debug quality issues such as:
- Reduced media in the stream by the codec during encoding
- Frame rate or resolution issues
- Increase in compression factors
- Use the Browser Round-Trip Time (RTT) to determine the send and receive duration times when troubleshooting page load times, network latency issues, scalability, server response times, and other influencing factors.
- Add the QualityLimitationReason reason to encoder statistics to debug quality issues such as:
- Chat Character Limit
- The chat feature allows you to enter a maximum of 1024 characters; otherwise the message will not send.
- Resolved Issues
- In this release, various solutions are in place to improve the usability, reliability, and performance of your custom built applications when using the VidyoClient for WebRTC JavaScript Library.
Resolved Issues
The following table lists the resolved issues in VidyoClient for WebRTC JavaScript Library version 20.1.5 LA:
VidyoClient for WebRTC JavaScript Library Version 20.1.5 - Resolved Issues | |
---|---|
Key | Summary |
IOWEBRTC-1458 |
The output or speaker device selected in Settings displays correctly in the main beauty screen rather than the OS default speaker. |
IOWEBRTC-1457 |
If a display name contains an ampersand (&), <, or >, the audio tile will display the exact same name. For example, John& will display as "John&" on the audio tile instead of displaying only "&" without the name. |
IOWEBRTC-1456 |
An issue was fixed where sometimes Safari iOS participants would see buttons displayed that should not be available. For example, users should not see video controls displayed on an undocked share or see the play and pause buttons when joining a call. |
IOWEBRTC-1447 IOWEBRTC-1445 |
An audio issue was resolved where a participant joined a call with three other participants and no one could hear that participant unless dropping from the call and rejoining. |
IOWEBRTC-1432 |
A problem was remedied where a Safari user joined a call and only saw a black tile instead of a share that was already in progress by another user. |
IOWEBRTC-1416 |
An issue was resolved where a participant using Chrome 85 joined a call with three other participants and a black tile was observed. |
IOWEBRTC-1332 |
Chat messages are allowed a maximum of 1024 characters; otherwise the message will not be sent. |
Known Issues
There are no new known issues for this release.
VidyoClient for WebRTC JavaScript Library: About Limited Availability (LA) Version 20.1.4
Enghouse Vidyo corrected several issues in this release to improve the usability, reliability, and performance of your custom-built applications when using the VidyoClient for WebRTC JavaScript Library.
Resolved Issues
The following table lists the resolved issues in VidyoClient for WebRTC JavaScript Library version 20.1.4 LA:
VidyoClient for WebRTC JavaScript Library Version 20.1.4 - Resolved Issues | |
---|---|
Key | Summary |
IOWEBRTC-1430 |
When using the Apple Safari browser to join a conference via WebRTC, connections over secure TURN will now succeed without a certificate error. |
IOWEBRTC-1423 and IOWEBRTC-1408 |
Users who start sharing content before joining a call no longer get dropped from the call. |
IOWEBRTC-1412 |
Users who disconnect from a video call and then reconnect to a call using the same browser tab no longer experience audio issues. Starting with this release, after the call has ended, the browser tab stops using the microphone. |
Known Issues
There are no new known issues for this release.
VidyoClient for WebRTC JavaScript Library: About Limited Availability (LA) Version 20.1.3
Enghouse Vidyo corrected several issues in this release to improve the usability, reliability, and performance of your custom-built applications when using the VidyoClient for WebRTC JavaScript Library.
Resolved Issues
The following table lists the resolved issues in VidyoClient for WebRTC JavaScript Library version 20.1.3 LA:
VidyoClient for WebRTC JavaScript Library Version 20.1.3 - Resolved Issues | |
---|---|
Key | Summary |
IOWEBRTC-1418, IOWEBRTC-1372, IOWEBRTC-1371, and IOWEBRTC-1370 |
An issue was resolved affecting WebRTC users who had issues getting dropped within seconds of joining a call or after another user muted or unmuted their camera and microphone when using Google Chrome version 86. |
IOWEBRTC-1401 |
Enghouse Vidyo fixed an issue affecting Android WebRTC users who experienced black tiles during calls when using Google Chrome. |
IOWEBRTC-1384 |
An issue was resolved where VidyoGateway clients (SIP endpoints) are now detected properly as "gateway" types for participant.GetApplicationType(). |
IOWEBRTC-1380 |
The following identifiers for WebRTC's Statistics API are now available:
|
IOWEBRTC-1365 |
An issue was corrected where a browser console error, "Uncaught Error: Could not find participant with id..." displayed after a participant left a call. |
IOWEBRTC-1359 |
A bug was resolved where, when using Safari iOS, a black tile was observed if the user joined and rejoined the call several times. |
IOWEBRTC-1344 |
An issue was corrected where the audio energy bar on Chrome was frozen after the microphone was muted. |
IOWEBRTC-1322 |
An issue was fixed where a Safari iOS user joined a call and a black tile displayed (with a large "C" in the middle of the screen) when a participant using Google Chrome (version 86) muted the microphone and camera. |
IOWEBRTC-1174 |
An issue was corrected where on iOS, the microphone will be shown as in use after a call is disconnected even though the microphone is not in use. |
IOWEBRTC-1072 |
An issue was fixed where Safari iOS users could not successfully join calls over TURN. |
Known Issues
There are no new known issues for this release.
VidyoClient for WebRTC JavaScript Library: About Limited Availability (LA) Version 20.1.2
Enghouse Vidyo corrected an issue so that your custom-built applications using the VidyoClient for WebRTC JavaScript Library will work when using WebRTC with Google Chrome™ version 85. Previously, some users experienced issues on Google Chrome version 85 beta when connecting to calls, and may have received timeout errors.
Resolved Issues
The following table lists the resolved issues in VidyoClient for WebRTC JavaScript Library version 20.1.2 LA:
VidyoClient for WebRTC JavaScript Library Version 20.1.2 - Resolved Issues | |
---|---|
Key | Summary |
IOWEBRTC-1337 |
An issue was resolved affecting VidyoConnect for Native WebRTC users who got had issues disconnecting from calls when using Google Chrome version 85. |
IOWEBRTC-1297 |
Enghouse Vidyo fixed an issue affecting VidyoConnect for Native WebRTC users who had issues joining calls using Google Chrome version 85. |
IOWEBRTC-1276 |
An issue was resolved so that the VidyoClient updates the endpoint information correctly (for example: applicationName, applicationiOS). |
IOWEBRTC-1270 |
A bug was fixed where iPads are recognized as a tablet device rather than as a desktop device. |
IOWEBRTC-1269 |
The vidyoConnector.Destruct works as expected and no longer sends an error. |
IOWEBRTC-1264 |
Incompatible Safari 12 users are now prevented from joining a conference. |
IOWEBRTC-1217 |
A bug was resolved where, when using Safari iOS, an undocked share displayed video controls incorrectly. |
IOWEBRTC-1194 |
The aspect ratio will now remain the same even if the application changes video resolution. Previously, the layout changed and the self-view resized incorrectly during a call. |
Known Issues
There are no new known issues for this release.
VidyoClient for WebRTC JavaScript Library: About Limited Availability (LA) Version 20.1.0
What's New in This Release
Introducing the New VidyoClient for WebRTC JavaScript Library
- Enghouse Vidyo introduces the new VidyoClient for WebRTC JavaScript Library which is based on the latest generation VidyoClient Library rather than the legacy VidyoWorks SDK (version 3.x). We have dramatically improved it for ease of use, performance, and flexibility.
- If you are a Vidyo customer with an existing application built with the previous-generation VidyoWorks SDK, you can now migrate to our new VidyoClient for WebRTC JavaScript Library.
- Interested in migrating? COMING SOON! Please refer to the Migrating Your Application to the VidyoClient API article to learn more about the benefits, requirements, and instructions for migrating.
WebRTC Supported Browsers
- The VidyoClient for WebRTC JavaScript Library, along with the VidyoConnector reference app, now run on the JavaScript platform on the following supported WebRTC browsers:
- Google Chrome™ on Windows®, macOS® and Android™
- Safari® on iOS/iPad OS and macOS
- Supported Platforms
Platform OS Version Browsers Windows 10 and later Google Chrome 83 and later macOS 10.14 and later Google Chrome 83 and later
Safari 13.1.1 and lateriOS/iPad OS 13.6 and later Safari Android 8 and later Chrome 83 and later
Codec Support
- Enghouse Vidyo provides the following audio and video codec support in our desktop and mobile applications:
Codec Audio/Video Browser Support VP9 - SVC Video Google Chrome VP9 Video Google Chrome
VP8 Video Google Chrome and Safari OPUS Audio N/A
New WebRTC Features and Updates
- Content Share
- Participants can share and receive content by selecting the Content Share button in supported browsers (e.g., Chrome and Safari).
- Device Switching Support
- Users can easily switch between devices.
- Public Chat
- Support is available for in app public chat to send and receive in call messages via the VidyoConnectorAddMessageClass API.
- Transport-CC Support
- VidyoClient API's for WebRTC now natively support the transport-cc protocols which improves bandwidth estimation and congestion control in WebRTC.
- For more information on transport-cc, refer to the RTP Extensions for Transport-wide Congestion Control web page.
- PIN Protected Calls
- To enhance security during calls, there is an option to enable PIN access. Once set up, users are required to to enter a PIN prior to joining a call.
- For Epic Context Aware Linking (CAL) Integrations: The extDataType and extData parameters are available to support Epic CAL integrations.
- To enhance security during calls, there is an option to enable PIN access. Once set up, users are required to to enter a PIN prior to joining a call.
- Custom Layout Rendering Support
- When it comes to embedded video, different layouts are often required for varying types of applications as one size does not fit all. With this version, developers can easily customize the layout of the on-screen video by changing the location, size, and shape of the tiles.
New APIs
- VidyoConnector.GetConnectionProperties() API
- The VidyoConnector.GetConnectionProperties() API allows you to get the room display name.
- VidyoConnectorConnectToRoomAsGuest API
- This API allows a guest to join a conference call with a PIN.
- VidyoConnectorRegisterRecorderInCallEventListener API
- This API enables participants to know when they are being recorded during a video call.
- VidyoConnectorAddMessageClass API
- This API allows the application to white list special messages to forward to the application (default is none).
- APIs to Limit Bitrate on WebRTC
- The VidyoConnectorSendMaxBitRate API allows you to set the VidyoClient maximum send bitrate information from the joinWeb response from the VidyoPortal.
- The VidyoConnectorSetMaxSendBitrate API permits you to set the VidyoClient maximum set bitrate information.
- The SetMaxBitRate API was used in prior versions and only was limited to setting the max bit rate and in this version support was added to set the maximum send bitrate information.
- EnableDebug API
- This API allows you to enable additional log messages to diagnose issues.
IMPORTANT NOTE: You will need to add your CORS default domain per tenant of your web application to the VidyoPortal. Please contact the Vidyo Support Team via email or phone at the locations listed in the Contact Us article for instructions.
Known Issues (JavaScript Library)
The following table lists the all the known issues in the VidyoClient Library:
VidyoClient Version for WebRTC JavaScript Library (LA)- Known Issues) |
|
---|---|
Key | Summary |
IOWEBRTC-1451 |
Sometimes when joining a large meeting while using some of the devices listed below with a Safari browser, the Safari tab will reload instead of staying connected in the call.
|
IOWEBRTC-1211 |
When using iOS on Safari with WebRTC, some iPhones (e.g., X GSM and XS/XS Max) will hear a clicking sound transmitted. |
IOWEBRTC-1163 |
Some Android device users experienced a crash issue when using VidyoClient native WebRTC on Google Chrome. Workaround: Applications using the WebRTC library must update to Chrome version 83 or later. |
IOWEBRTC-1135 and IOWEBRTC-1134 | Audio issues occur when using Safari version 13.1 and earlier. Workaround: Use Safari version 13.2 or later or Safari Technology (TP) Preview version 107 or later. NOTE: Audio will be fixed in Safari TP, but AV synchronization issues may still occur. |
IOWEBRTC-1100 | During calls, the Chrome tab crashed after changing the microphone (mute/on off) with some Android devices. Workaround: Applications using the WebRTC library must update to Chrome version 83 or later. |
IOWEBRTC-1067 | Mobile share may not work on some Android devices that do not support VP8 video acceleration. |
IOWEBRTC-1060 | Sometimes audio will not work from participants using an iPhone with iOS version 13.5.1 and earlier in WebRTC. This issue occurs intermittently for iPhone and iPad users and refreshing the mobile browser does not remedy the issue. Workaround: This issue may resolve when using iOS version 13.6 and later. |
IOWEBRTC-1037 | The energy bar (e.g., battery indicator) does not work for some Android devices when using Chrome version 80 and later. |
Comments
0 comments
Please sign in to leave a comment.