Partners Blog Contact Us

VidyoClient API 3.x: Releases

Follow

This article describes the new features, functionality, and resolved issues for each of the VidyoCient™ releases below. Additionally, this article includes information on platform and browser compatibility and known issues.

The VidyoClient API versions below are Generally Available for Windows®, Mac®, iOS, and Android.

The VidyoClient API is an interface for third-party applications to integrate with the VidyoClient library in order to build complete custom client applications. If you'd like more information or need additional assistance with any VidyoClient version, please contact us at apisupport@vidyo.com

 


VidyoClient API: About Version 3.5.23

What's New in This Release

  • Resolved Issues
    • In this release, Enghouse Vidyo addressed a crash issue for customers using iOS devices, and we've corrected the memory allocation issues.

Resolved Issues

The following table lists the resolved issues in VidyoClient version 3.5.23:  

VidyoClient Version 3.5.23 - Resolved Issues

Key Summary

VC-1723
and
VC-1719

Enghouse Vidyo reviewed and then ultimately disabled some LmiAsserts which will prevent unnecessary premature crashes that occurred sporadically when some iOS users attempted to join a Vidyo call using the VidyoClient iOS libraries on newer Apple iOS operating systems.  
VC-1706 Enghouse Vidyo fixed a few memory allocation issues that caused the application to crash after a number of calls.

 


VidyoClient API: About Version 3.5.21

What's New in This Release

  • Improved Audio with Android 10 Devices 
    • The LmiAudioCapturer.java file has been updated, thereby preventing low audio issues on Android 10 devices.
    • Low audio occurred on Android P and later devices because the VOICE_COMMUNICATION parameter incorrectly selected the earpiece microphone by default.
  • Solutions for Bluetooth/Wired Headsets That Did Not Connect Before or During a Call  
    • The LmiAudioPlaybackDevice.java file has been updated to modify the playback stream to be set to AudioManager.STREAM_MUSIC instead of AudioManager.STREAM_VOICE_CALL. This improves audio device switching before or during the call by taking into account circumstances related to the mobile device manufacturers.
    • Enghouse Vidyo does not recommend setting a speakerphone on by default using "AudioManager.setSpeakerphoneOn(true)" because this leads to headsets or Bluetooth devices not being detected on the system level. 
  • Resolved Issues
    • Enghouse Vidyo corrected several issues to improve performance and usability. 

Resolved Issues

The following table lists the resolved issues in VidyoClient version 3.5.21:  

VidyoClient Version 3.5.21 - Resolved Issues

Key Summary
VC-1714 The LmiAudioCapturer.java file has been updated, thereby preventing low audio issues on Android 10 devices. 
VC-1712 An issue on the iPhone® XR that caused the app to crash when a user pressed the End Call button has been resolved.
VC-1710

Enghouse Vidyo resolved an issue where Bluetooth/wired headsets did not connect properly before or during a call by updating the LmiAudioPlaybackDevice.java file to modify the playback stream to be set to AudioManager.STREAM_MUSIC instead of AudioManager.STREAM_VOICE_CALL.

Enghouse Vidyo does not recommend setting a speakerphone on by default using "AudioManager.setSpeakerphoneOn(true)" because this leads to headsets or Bluetooth devices not being detected on the system level.

VC-1709 Enghouse Vidyo resolved a crash that occurred on iOS which resulted in a stack trace which referenced LmiBitset. This should help alleviate most of the theoretical crashes involving this area; however, if any are still present (so far unreproducible), future stack traces should shed more light on them.
VC-1706 A memory allocation issue that caused the app to crash after a certain number of calls has been resolved. 
VC-1702 Improvements were made to ensure that when running the client library via proper recommended API flows, open handle counts remain within a steady range and do not present as handle leaks and resource leaks over time. Enghouse Vidyo still recommends that long-running applications should cycle from time to time via VidyoClientStart() and VidyoClientStop() calls, but they SHOULD NOT and need NOT be done per call.
VC-1687 An issue was fixed where the VidyoClient application crashed after leaving a conference when using an iOS 13.3 device when IPv6 was encountered in the list of addresses while the library was expecting IPv4 only. This crash stack was identified via references to LmiIceMediaStreamNat64ResolutionCompleted in the stack trace. 

 

 


VidyoClient API: About Version 3.5.20

What's New in This Release

This release resolved some issues to improve usability and performance, as well as introduced new APIs. The new APIs will allow you to modify the aspect ratio of the video and help you manage the composite send and receive bandwidth limits for video, data, and audio. For more information, please refer to the below bulleted sections and the Resolved Issues table. 

To download the package for this release and the VidyoClient API Reference Guide, go to the VidyoWorks API Downloads article and then click the 3.5.20 link in the Download Link column.   

  • New APIs to Modify the Aspect Ratio of Video
    • For customers with cameras that only support a 4:3 aspect ratio, use the new aspect ratio APIs to change your video screen settings.  
      • Set your aspect ratio to 4:3 to change to full screen video (limited high-definition display). 
      • Accept the system default of 16:9 to continue with widescreen video (the highest-definition video signals).
    • Use the SET/GET Configuration APIs to change the aspect ratio to the minimum camera supported size 4:3 (width:height):
      • VIDYO_CLIENT_REQUEST_SET_CONFIGURATION and VIDYO_CLIENT_REQUEST_GET_CONFIGURATION)  
      • If an incorrect value is set, the VidyoClient library will use the default value: 16:9. 
    • Set the aspect ratio of the rectangular partitions for width and height as follows:
      • (VidyoUnit)aspectRatioWidth = 16 or 4
      • (VidyoUnit)aspectRatioHeight = 9 or 3
    • Use the below referenced example, to change the aspect ratio to 4:3:

      VidyoClientRequestConfiguration config = {};

      VidyoClientSendRequest(VIDYO_CLIENT_REQUEST_GET_CONFIGURATION,

      &config, sizeof(VidyoClientRequestConfiguration));

      config.aspectRatioWidth = 4;

      config.aspectRatioHeight = 3;

      VidyoClientSendRequest(VIDYO_CLIENT_REQUEST_SET_CONFIGURATION,

      &config, sizeof(VidyoClientRequestConfiguration));

  • New Bandwidth APIs to Manage Video, Data, and Audio Limits
    • In this release, you can now set the full send or receive allowable bandwidth for video stream, data share, and audio with the following APIs and parameters. Previously, you could GET/SET SEND/RECEIVE bandwidth only for video stream. For example, the  VIDYO_CLIENT_REQUEST_GET_SEND_MAX_KBPS API controlled the send bandwidth only for the video stream and not for the audio or data share send bandwidth.  
      • Use the following parameters to SET/GET the maximum full bandwidths in KBPS units if using the SET/GET Configuration APIs:  
        VIDYO_CLIENT_REQUEST_SET_CONFIGURATION and VIDYO_CLIENT_REQUEST_GET_CONFIGURATION):
        • maxFullSendBandwidth
        • maxFullRecvBandwidth
      • Another alternative is to use the APIs below to perform the same operation outside of the SET/GET Configuration APIs.
        • VIDYO_CLIENT_REQUEST_SET_FULL_SEND_BANDWIDTH and
        • VIDYO_CLIENT_REQUEST_SET_FULL_RECV_BANDWIDTH
    • For more details about these APIs, access the VidyoClient API Reference Guide by going to the VidyoWorks API Downloads article and then clicking the 3.5.20 link in the Download Link column to access the VidyoClient API Reference Guide. 
       
  • Resolved Issues 
    • See the table below for more details. 

Resolved Issues

The following table lists the resolved issues in VidyoClient version 3.5.20:  

VidyoClient Version 3.5.20 - Resolved Issues

Key Summary
VC-1696 The SET/GET configuration APIs now allow users to set the aspect ratio to 16:9 or 4.3 eliminating cropped images with cameras using 640x480 resolution.
VC-1688 The number of warnings during the compile time of a VidyoClient sample app with iOS are now significantly reduced and the duplicate symbol warnings no longer display.  
VC-1637 An intermittent crash after calling 'VidyoClientStop()`no longer occurs. 

 


VidyoClient API: About Version 3.5.19

 

New Updated Software Package for VidyoClient iOS Customers

An updated VidyoClient iOS software package for version 3.5.19 is now available for VidyoClient iOS customers. With this new package, VidyoClient iOS customers will no longer need to link to the third-party zlib library when building their application. The previous version of this software package included an unnecessary dependency on the zlib library that was unintentionally added due to an upgrade of the libcurl and OpenSSL. We apologize for any inconvenience this has caused.

The updated software package is for VidyoClient iOS customers only. The software packages for VidyoClient Windows®, VidyoClient Mac®, and VidyoClient Android™ have not changed.

 

What's New in This Release

  • OpenSSL and Curl Libraries Updated
    • To improve the security and stability of VidyoClient version 3.5.19, the Open SLL was updated to version 1.1.1d and the Curl library was updated to version 7.66.0.
  • Resolved Issues 
    • Various issues were resolved to improve usability and performance.

Resolved Issues

The following table lists the resolved issues in VidyoClient version 3.5.19:  

VidyoClient Version 3.5.19 - Resolved Issues

Key Summary
VC-1672 Enghouse Vidyo updated OpenSSL to version 1.1.1d and the Curl library was updated to version 7.66.0. 
VC-1684 The VidyoClient library no longer crashes the application when rendering starts when using on MacOS Catalina and XCode version 11.2.1.

 


VidyoClient API: About Version 3.5.18

What's New in This Release 

  • New enableWebProxyDiscovering Parameter
    • A new Boolean parameter called enableWebProxyDiscovering (default value = true) has been added to the VidyoClientRequestConfiguration structure.
    • The new parameter allows the application to turn off the automatic discovery of web proxies in the event that a network has an improperly configured proxy and it is disrupting the ability to connect to Vidyo calls.
  • Resolved Issues 
    • MacOS Catalina users can now successfully share their screens and applications with remote participants rather than displaying a blank screen.
    • OUT events, such as OUT_EVENT_CONFERENCE_ENDED and OUT_EVENT_CONFERENCE_CLEARED, are now processed correctly after a call is disconnected.
    • An autoproxy issue which resulted in the IN_EVENT_ROOM_LINK API hanging was resolved by supplying a new parameter (called enableWebProxyDiscovering) to the VidyoClientRequestConfiguration structure that turns off autoproxy look-up when set to false.

Resolved Issues

The following table lists the resolved issues in VidyoClient version 3.5.18:  

VidyoClient Version 3.5.18 - Resolved Issues

Key Summary
VC-1670 Enghouse Vidyo fixed an issue so macOS Catalina users can share their screen and applicable applications with remote participants rather than a displaying a blank screen. 
VC-1669 An issue was fixed with the VIDYO_CLIENT_REQUEST_GET_WINDOWS_AND_DESKTOPS API (for sharable windows and apps) so that OUT events, including OUT_EVENT_CONFERENCE_ENDED and OUT_EVENT_CONFERENCE_CLEARED, now work correctly after disconnecting from calls. 
VC-1662 An autoproxy issue which resulted in the IN_EVENT_ROOM_LINK API hanging was resolved by supplying a new parameter (called enableWebProxyDiscovering) to the VidyoClientRequestConfiguration structure that turns off autoproxy look-up when set to false.

 


VidyoClient API: About Version 3.5.17

What's New in This Release 

  • Improved Connections with New Parameter
    • In this release, if you set the VidyoUint enableAutoRetryWithProxy parameter to true within the VidyoClientRequestConfiguration structure, calls will reconnect via proxy if the initial call fails to connect directly.
  • Resolved Issues
    • Enghouse Vidyo improved the the security, stability, usability, and performance of the application. Specifically, the VidyoClient security was improved by addressing vulnerabilities found via a third-party scanner tool.

Resolved Issues

The following table lists the resolved issues in VidyoClient version 3.5.17:

VidyoClient Version 3.5.17 - Resolved Issues

Key Summary
VC-1642 Enghouse Vidyo fixed an issue so now if "Rear" camera is turned on for Android VidyoMobile device users (during a prior conference) when joining the next conference, the video will send correctly and the application no longer crashes.
VC-1640 An issue was fixed so VidyoMobile Android device users (version 3.5.16) can log out and then successfully access the Enter Portal page.
VC-1636 Enghouse Vidyo fixed an issue so the iOS sample application connects and renders correctly and no longer modifies the autolayout engine from a background thread.
VC-1631 An issue was resolved for Verizon LTE users (on various operating systems) so they now can connect to calls from specific locations.  
VC-1621 Enghouse Vidyo corrected an intermittent issue where users had difficulty logging into the VidyoPortal. 
VC-1620 VidyoClient vulnerabilities were corrected in this version to improve the stability and performance of the application. 
VC-1596 Enghouse Vidyo investigated and resolved a VidyoEngage iOS application crashing issue that occurred when a third-party entered a call. 
VC-1577 An issue was corrected for some iOS application users who were experiencing an application crash at the end of the call. 
VC-1533 Enghouse Vidyo implemented code changes to improve the integrity and security of the application.  

 


VidyoClient API: About Version 3.5.16

What's New in This Release 

  • Resolved Issues
    • In this release of VidyoClient, Vidyo resolved an issue so that you can now hear the audio correctly whether participants join as guests to the same room or different rooms, or whether using built-in speakers or headsets. 

Resolved Issues

The following table lists the resolved issues in VidyoClient version 3.5.16:

VidyoClient Version 3.5.16 - Resolved Issues

Key Summary
VC-1632 Vidyo resolved an issue that could arise when playing the audio out while within the conference through any (built-in or headset) device.

 


  

VidyoClient API: About Version 3.5.15

What's New in This Release 

  • Resolved Issues
    • In this release of VidyoClient, we’ve updated our library to use isVideoStabilizationModeSupported instead of isVideoStabilizationSupported, which has been deprecated by Apple®.
    • VidyoMobile™ users can now successfully join conferences when "Background Action" is disabled in their VidyoMobile app.
    • When a VidyoWeb™ or VidyoDesktop™ user mutes the microphones of all the participants in a video call, the video from that user will remain visible to any mobile participants in the call.
    • VidyoClient now returns the correct VidyoProxy state.
    • On iOS, IP addresses are properly determined as iPV4 or iPV6, thus avoiding a runtime assertion failure.
    • A runtime hang that occurred after leaving a call has been resolved on the Windows platform by providing a proper timeout value. Now, any delays only result in a five-second maximum wait instead of a runtime hang.

Resolved Issues

The following table lists the resolved issues in VidyoClient version 3.5.15:

VidyoClient Version 3.5.15 - Resolved Issues

Key Summary
VC-1622 When a user disables "Background Action" on the VidyoMobile app, that user can now successfully join conferences and the "Operation failed. General Failure" message no longer appears.
VC-1619 When a VidyoWeb or VidyoDesktop user mutes the microphones of all the participants in a video call, the video from that user will continue to be visible to any mobile participants in that call.
VC-1614 VidyoClient now returns the correct VidyoProxy state (that is, the return value is not always "false").
VC-1591 A runtime hang that occurred after leaving a call has been resolved on the Windows platform by providing a proper timeout value. Now, any delays only result in a five-second maximum wait instead of a runtime hang.
VC-1588 On iOS, IP addresses are properly determined as iPV4 or iPV6, thus avoiding a runtime assertion failure.
VC-1492 The library has been updated, and therefore, the "WARNING: -[<AVCaptureDeviceFormat: 0x7001b190> isVideoStabilizationSupported] is deprecated. Please use -[AVCaptureDeviceFormat isVideoStabilizationModeSupported:]" message no longer appears.

  


 

VidyoClient API: About Version 3.5.14

What's In This Release

In VidyoClient version 3.5.14 release, we have resolved an issue which was causing unexpected crashes when using iOS 12 or later with VidyoClient 3.x applications (including VidyoMobile for iOS version 2.4.4, which is currently on the Apple® App Store).

For more information about this issue, please refer to the Important Notice for Customers Using VidyoClient Version 3.x or VidyoMobile for iOS with iOS 12 or Later article.

Resolved Issues

The following table lists the resolved issue in VidyoClient version 3.5.14:

VidyoClient Version 3.5.14 - Resolved Issue

Key Summary
VC-1604 An issue was resolved on iOS 12, when a VidyoClient-based application is connected to the conference and the device receives incoming cellular call, the application does not crash.

 

 


 

VidyoClient API: About Version 3.5.13

What's New in This Release

There are no new features for the VidyoClient API version 3.5.13 release; however we have resolved a number of issues for improved security, performance and stability. Please refer to the Resolved Issues table below.  

 

The tables above reflect Vidyo’s current test matrix. Other platforms and browsers may also work, although they are not officially supported.

Resolved Issues

The following table includes the resolved issues in VidyoClient API version 3.5.13:

VidyoClient API Version 3.5.13 - Resolved Issues

Key Summary
VC-1590 VidyoClient was updated with the latest cURL library to support a wide range of Internet protocols.
VC-1589 An issue was fixed so that the VidyoClient tiles no longer crash when changing the number of viewable "maximum" participants.
VC-1588 An assertion failed bug (e.g., (af == LMI_IPADDRESSFAMILY_IPV4 || af == LMI_IPADDRESSFAMILY_IPV6) was fixed for Mac OS Desktop.
VC-1581 The VIDYO_CLIENT_REQUEST_SET_LABEL is now working and allows you to modify the text label between conferences by sending VidyoClientPrivateRequestSetCallWindowAutoClean request after VIDYO_CLIENT_OUT_EVENT_LOGIC_STARTED is received.
VC-1580 The restrictions/values set when sending the VIDYO_CLIENT_IN_EVENT_PARTICIPANTS_LIMIT now work before joining a call for Samsung S8 (8.0.0) and iPhone 6 plus (11.2.2). For example "0" sets to self view shown in dock and "1" is one remote participant and self view are displayed, etc.
VC-1561 The OpenSSL library was updated to make the VidyoClient communications more secure.
VC-1485  Vidyo resolved an issue preventing the VidyoClientStop() call from randomly crashing the client.
VC-1349  All the bugs which caused the application to crash after launch are now fixed for VMAndrd, VMiOS, VidyoDesktop, and VidyoWeb. To eliminate warnings, Vidyo cleaned the VidyoClient xcode.
VC-1315  To improve and safeguard your security, Vidyo performed detailed analysis, memory leak detection, and updated the following libraries: Open SSL library and the cURL library.

 

 


 

VidyoClient API: About Version 3.5.12

What's New in This Release

There are no new features for the VidyoClient API version 3.5.12 release; however we have resolved a number of issues for improved performance and stability. Please refer to the Resolved Issues table below.  

Resolved Issues

The following table lists the resolved issues in VidyoClient API version 3.5.12:

VidyoClient API Version 3.5.12 - Resolved Issues

Key Summary
VC-1579 When a user rejoins a call after a lost connection with video media, the Statistics thread is now stopped correctly so the user can rejoin successfully.
VC-1576 The system no longer crashes at the end of a call when using an Android device.
VC-1573 When a call is made to VIDYO_CLIENT_IN_EVENT_PARTICIPANTS_LIMIT, the system no longer crashes when not in call for mobile devices.
VC-1565 When a user on a Mac starts to share a document, pops it out, and then maximizes it, the system no longer crashes.
VC-1564  The VIDYO_CLIENT_OUT_EVENT_INITIAL_VIDEO_FRAME_SENT was only sent for slabs and now is added for tiles and legacy devices. 
VC-1529 When muting and unmuting the participant, the VidyoClient library will now remove and add source respectively so that other clients can properly see the status.
VC-1504  The UI and layout code (UI Kit) now always get executed on the main thread, thereby preventing system crashes.
VC-1188  VidyoClient no longer crashes when sending VidyoClientStop after sending VIDYO_CLIENT_IN_EVENT_ROOM_LINK API followed by VIDYO_CLIENT_IN_EVENT_CANCEL
VC-1134  The application no longer crashes when using media control APIs (e.g. VIDYO_CLIENT_IN_EVENT_MUTE_AUDIO_IN) while leaving a conference (e.g. VIDYO_CLIENT_IN_EVENT_LEAVE).

 

 


 

Compatibility

The following table defines the compatibility between VidyoClient version 3.5.18 and OS platforms.

Operating System Compatible Platforms
Windows
  • Windows 7 32-bit and 64-bit
  • Windows 8 32-bit and 64-bit
  • Windows 8.1 32-bit and 64-bit
  • Windows 10 32-bit and 64-bit
Mac
  • Mac OS 10.6 – 10.15.x
iOS
  • iOS 8.4.1 and later
Android
  • Android 4.2.2 and later

 

The table above reflects Vidyo’s current test matrix. Other platforms and browsers may also work, although they are not officially supported.

 


 

Known Issues

The following table lists the known issues for all VidyoClient releases:

VidyoClient - Known Issues

Key Summary
VC-1615 The VIDYO_CLIENT_OUT_EVENT_INITIAL_VIDEO_FRAME_SENT out event is sent only one time per VidyoClient initialization and conference. For the second and subsequent conferences, this event won't be received.
VC-1611

When building a video stream solution with MacOS Mojave 10.14.x and Xcode 10, the stream may not show in the parent view.

Workaround: Provide NULL to force the library to render the stream in a separate dialog.

VC-1593 The energy level data from VIDYO_CLIENT_REQUEST_GET_AUDIO_ACTIVE_USERS does not get updated dynamically. Therefore, users should avoid acting on this data.

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.