Partners Blog Contact Us

Articles in this section

Migrating Your Application to the VidyoClient API

  • Updated
Follow

Overview

If you are a Vidyo customer with an existing application built with the previous-generation VidyoWorks SDK (also known as VidyoClient 3.x API), you can now migrate to the VidyoClient API (version 20.2.0 and later). 

This article includes the following sections and describes the benefits, migration requirements, and steps needed to update successfully to the latest VidyoClient API:

 

VidyoClient API Benefits

The VidyoClient API is based on the latest generation VidyoClient, which we have dramatically improved for ease of use, performance, and flexibility. Here are just a few of the benefits of using the VidyoClient API rather than the legacy VidyoWorks SDK (VidyoClient version 3.x):

  • Ongoing Updates and Support—The VidyoClient API is our cutting-edge API platform. Going forward, we will continue to offer performance improvements, new features, support for newer OS versions, and support for this platform. On the other hand, we are no longer developing new features and will only fix the most critical bugs for our previous-generation platform, VidyoWorks SDK (VidyoClient version 3.x). 
  • Cloud-Supported Infrastructure—You can run your custom applications on the global cloud platform managed by Vidyo. The Vidyo cloud infrastructure includes features such as WebRTC, geolocation, high availability, and scalability. With cloud infrastructure like this, you can spend your time as a developer innovating and designing rather than managing infrastructure issues and servers to support your apps.
  • On-Premises Supported Infrastructure—The VidyoClient API works on Vidyo’s traditional on-premises infrastructure as well as cloud. If you already have Vidyo infrastructure deployed or if you’re not yet ready to move to the cloud, you can still leverage the new VidyoClient API in your custom applications.
  • Consistent Cross-Platform APIs—The consistent behavior and structure of the VidyoClient API's cross-platform APIs allow developers to quickly and easily support multiple platforms (such as WebRTC, iOS, Android™, macOS®, and Windows®), resulting in faster time-to-market and reduced errors. Additionally, the VidyoClient APIs return very clear object states and allow developers to embed code without having to include a lot of boilerplate code.
  • High-DPI Screen Share—The VidyoClient API allows content sharing from devices that have high-DPI displays, whereas the previous-generation VidyoWorks platform (VidyoClient 3.x) did not support this feature. Device compatibility is important to Vidyo as retina and high-DPI displays continue to become more prevalent in computing devices.
  • Device Management Included—The VidyoClient API device management supports automatic detection of in-call devices for microphones, speakers, and cameras, and it allows selection of these devices with simple API calls. Conversely, the VidyoWorks platform uses a cumbersome process to detect and select devices for the application.
  • Improved Audio Pipeline—The VidyoClient API delivers enhanced high-performance, high-fidelity audio. It offers noise reduction and detection, echo cancellation, audio transmission over the network, and utilization of the Opus audio codec for superb audio quality.
  • Sample Applications—The Vidyo GitHub repository provides sample apps for developers to build their own apps for specific use cases.
  • Custom Layouts Made Easy—When it comes to embedded video, one size does not fit all; therefore, different layouts are often required for varying types of applications. With the VidyoClient API, developers can easily customize the layout of video on-screen within their own apps by changing the location, size, and shape of the tiles.

 

Getting Started With Migration

Vidyo has streamlined the VidyoClient APIs to reduce the complexity of performing the most common use cases. As a result, the VidyoClient APIs are easier to work with compared to the legacy VidyoWorks APIs (VidyoClient 3.x). This section provides step-by-step instructions and requirements to successfully migrate your applications. 

The VidyoClient APIs only support guest mode workflows. Please see Appendix A for a list of supported APIs and how they map to previous-generation APIs.

 

Migration Requirements

When using the VidyoClient APIs with on-premises infrastructure, you must upgrade these infrastructure components to the latest version:

Refer to the Vidyo Compatibility Matrix for On-Premises article for the most current versions of all of the Vidyo on-premises infrastructure components.

Migration Instructions

If you were previously using the SOAP-based VidyoWorks web services APIs, you may continue to utilize these APIs. With the interim approach, you are simply replacing the VidyoWorks client SDK with the updated VidyoClient API and using the associated APIs.   

To launch the reference application (and APIs) and create your first prototype:

  1. Navigate to the https://github.com/Vidyo GitHub page.
  2. Locate the specific repository for the target device platform you will be working with.
    The name will be vidyoplatform-connector-<platform name>.
  3. Follow the instructions on GitHub to clone or download the repository.
    This repository contains the application code for several platforms.
  4. Follow the instructions found in readme.md.
  5. To initiate a video chat session:
    • Launch two (or more) instances of the app.
    • Fill out the fields in the form: Portal, Display Name, Room Key, Room Pin (if applicable).
    • Click the green Join button to join the conference.

 

API Mapping

The table below provides the most common APIs used in the VidyoWorks client SDK (VidyoClient 3.x) and their equivalent APIs for the VidyoClient APIs. See Appendix A for a complete list.

Frequent Use Cases
Use Case  VidyoWorks (VidyoClient 3.x) VidyoClient API
Initialize and start library before starting with a use case. VidyoClientInitialize VidyoConnectorInitialize
Start or construct library objects. VidyoClientStart VidyoConnectorConstruct 

Get the list of cameras available on the machine and configure the library with the camera to be used for capturing video while in a call/conference.

Note: If the camera is not selected, the library will select the same camera selected in the operating system. 

 VIDYO_CLIENT_REQUEST_GET_CONFIGURATION -> cameras, cameraLabels

Register the following callback using VidyoConnectorRegisterLocalCameraEventListener

  • VidyoConnectorOnLocalCameraAdded
  • VidyoConnectorOnLocalCameraRemoved
  • VidyoConnectorOnLocalCameraSelected
  • VidyoConnectorOnLocalCameraUpdated
VidyoLocalCamera objects provided to the application have to be maintained by the application. VidyoLocalCameraGetName will provide the name of the device.

Get the list of microphones available on the machine and configure the library with the microphone to be used for capturing audio while in a call/conference.

Note: If the microphone is not selected, the library will select the same microphone selected in the operating system. 

VIDYO_CLIENT_REQUEST_GET_CONFIGURATION -> microphones, microphonePhyDeviceName

Register the following callback using VidyoConnectorRegisterLocalMicrophoneEventListener

  • VidyoConnectorOnLocalMicrophoneAdded
  • VidyoConnectorOnLocalMicrophoneRemoved
  • VidyoConnectorOnLocalMicrophoneSelected
  • VidyoConnectorOnLocalMicrophoneUpdated
VidyoLocalMicrophone objects provided to the application have to be maintained by the application. VidyoLocalMicrophoneGetName will provide the name of the device.

Get the list of speakers available on the machine and configure the library with the speaker to be used for capturing sound while in a call/conference.

Note: If the speaker is not selected, the library will select the same speaker selected in the operating system. 

 		 VIDYO_CLIENT_REQUEST_GET_CONFIGURATION -> speakers, speakerPhyDeviceName VidyoConnectorRegisterLocalSpeakerEventListener
Select a camera for use in the conference.  VIDYO_CLIENT_REQUEST_SET_CONFIGURATION -> currentCamera VidyoConnectorSelectLocalCameraSele
Select a microphone for use in the conference.  VIDYO_CLIENT_REQUEST_SET_CONFIGURATION -> currentMicrophone VidyoConnectorSelectLocalMicrophone
Select a speaker for use in the conference.  VIDYO_CLIENT_REQUEST_SET_CONFIGURATION -> currentSpeaker VidyoConnectorSelectLocalSpeaker
Join a conference room with an identified room link. VIDYO_CLIENT_IN_EVENT_ROOM_LINK

VidyoConnectorConnectToRoomAsGuest
Collect conference statistics while in a call/conference.      VIDYO_CLIENT_REQUEST_GET_BANDWIDTH_INFO VidyoConnectorGetStatsJson    
VIDYO_CLIENT_REQUEST_GET_PARTICIPANT_STATISTICS_AT
VIDYO_CLIENT_REQUEST_GET_PARTICIPANT_STATISTICS_LIST
VIDYO_CLIENT_REQUEST_GET_PARTICIPANT_STATISTICS_AT
VIDYO_CLIENT_REQUEST_GET_RATE_SHAPER_INFO
Determine the max configured remote participants tiles VIDYO_CLIENT_REQUEST_GET_PARTICIPANTS_LIMIT

Register callback using VidyoConnectorRegisterResourceManagerEventListener.

The callback registered for VidyoConnectorOnMaxRemoteSourcesChanged will provide the remote participant video rendering limit.

Switch the selected camera between the front and back cameras.

Note: Applicable only for mobile devices. 

 VIDYO_CLIENT_IN_EVENT_TOGGLE_CAMERA VidyoConnectorCycleCamera
Send a text message to all participants in the conference.  VIDYO_CLIENT_IN_EVENT_GROUP_CHAT

VidyoConnectorSendChatMessage
Receive a text message sent by another participant in the conference that was sent to everyone in the conference.  VIDYO_CLIENT_OUT_EVENT_GROUP_CHAT

Register callback using VidyoConnectorRegisterMessageEventListener.

The callback VidyoConnectorOnChatMessageReceived will provide the received chat message.
Mute the microphone.  VIDYO_CLIENT_IN_EVENT_MUTE_AUDIO_IN VidyoConnectorSetMicrophonePrivacy
Mute the speaker.  VIDYO_CLIENT_IN_EVENT_MUTE_AUDIO_OUT  VidyoConnectorSetSpeakerPrivacy 
Mute the camera.  VIDYO_CLIENT_IN_EVENT_MUTE_VIDEO  VidyoConnectorSetCameraPrivacy 
Get the list of open windows and connected screens that are available to share in the call/conference.  VIDYO_CLIENT_REQUEST_GET_WINDOWS_AND_DESKTOPS 

Register callback using VidyoConnectorRegisterLocalWindowShareEventListener.

The callback registered provides the local windows available for share and their states.

 

Register callback using VidyoConnectorRegisterLocalMonitorEventListener

Gets the display/screen or monitors connected and available for share and their states.
Share a window in a call/conference.  VIDYO_CLIENT_IN_EVENT_SHARE  VidyoConnectorSelectLocalWindowShare 
Share a screen in a call/conference.  VIDYO_CLIENT_IN_EVENT_SHARE  VidyoConnectorSelectLocalMonitor
Stop sharing a window in a call/conference.  VIDYO_CLIENT_IN_EVENT_UNSHARE   VidyoConnectorSelectLocalWindowShare(NULL)
Stop sharing a screen in a call/conference  VIDYO_CLIENT_IN_EVENT_UNSHARE  VidyoConnectorSelectLocalMonitor(NULL) 
Get the details of the content share started in the call/conference by a participant.  VIDYO_CLIENT_OUT_EVENT_ADD_SHARE

Register callback using VidyoConnectorRegisterRemoteWindowShareEventListener.

The callback registered for VidyoConnectorOnRemoteWindowShareAdded will provide the details.
Get the details of the content share ended in the call/conference by a participant.  VIDYO_CLIENT_OUT_EVENT_REMOVE_SHARE 

Register callback using VidyoConnectorRegisterRemoteWindowShareEventListener.

The callback registered for VidyoConnectorOnRemoteWindowShareRemoved will provide the details.
Show or hide the display of the participants name on their video tiles.  VIDYO_CLIENT_REQUEST_SET_CONFIGURATION -> enableShowConfParticipantName  VidyoConnectorShowViewLabel 
Let all participants know whether the local camera is allowed to be controlled by the remote participant.  VIDYO_CLIENT_REQUEST_SET_CONFIGURATION with enableFeccEndpoint enabled VidyoLocalCameraAllowRemoteCameraControl
Get the details of the controllable camera in the call/conference. VIDYO_CLIENT_OUT_EVENT_FECC_LIST_UPDATED & VIDYO_CLIENT_REQUEST_GET_FECC_LIST

Register callback VidyoConnectorOnRemoteCameraAdded and VidyoConnectorOnRemoteCameraRemoved in VidyoConnectorRegisterRemoteCameraEventListener.

The API VidyoRemoteCameraGetControlCapabilities on object VidyoRemoteCamera can provide whether the remote camera is controllable.
Control the camera of a participant that has a controllable camera (PTZ). VIDYO_CLIENT_IN_EVENT_CONTROL_CAMERA

VidyoRemoteCameraControlPTZ 

Send the application to the background.

Note: Applicable only for mobile devices.

 VIDYO_CLIENT_REQUEST_SET_BACKGROUND VidyoConnectorSetMode
Set the background of the participant tile (VidyoWorks); set the background of the rendering window (VidyoClient API).  VIDYO_CLIENT_IN_EVENT_SET_BACKGROUND_COLOR  VidyoConnectorSetViewBackgroundColor 
Disconnect the call/conference.  VIDYO_CLIENT_IN_EVENT_LEAVE VidyoConnectorDisconnect
Stop the library when finished using it for the use cases. The library can be started again later for the same or another use case without initializing again.  VidyoClientStop 

VidyoConnectorDisable

After calling this, the application must call VidyoConnectorDestruct. 
Un-initialize the library when finished using it for the use cases. This library has to be initialized again for using it later. VidyoClientUninitialize

VidyoConnectorUninitialize

Refer to the complete list of APIs in Appendix A: Complete VidyoWorks to VidyoClient API Map. 

 

Available Resources

To assist with the migration of your application, refer to the following resources: 

VidyoClient API Migration Resources
Resource Description  Link

VidyoClient API Reference

Complete API reference for the VidyoClient API.

 

https://vidyo.github.io/vidyoplatform.github.io/

VidyoClient Developer Guide

Overview guide showing how to use the VidyoClient API.

 

https://vidyo.github.io/vidyoplatform.github.io/

VidyoClient API Documentation

Documentation for VidyoClient API including SOAP API reference.

https://support.vidyocloud.com/hc/en-us/categories/115000272554

Vidyo Github

Sample applications demonstrating various ways to use the VidyoClient APIs.

https://github.com/vidyo 

StackOverflow

Community-driven discussions on how to use VidyoClient APIs. Check out the “Vidyo” tag for related posts.

https://stackoverflow.com/questions/tagged/vidyo 

Vidyo Help Center

Help center where you can get help from our support team.

https://support.vidyocloud.com 

 

Questions?

If you still have questions regarding migration from VidyoWorks to the VidyoClient API, please contact your Vidyo representative for assistance. You can also contact the Vidyo Developer Services team by emailing support@vidyo.com.

 

Appendix A: Complete VidyoWorks to VidyoClient API Map

 

Use Case

VidyoWorks (VidyoClient 3.x)

VidyoClient API

 Comments
IN EVENTS
Disconnect call/conference  VIDYO_CLIENT_IN_EVENT_LEAVE VidyoConnectorDisconnect  
  VIDYO_CLIENT_IN_EVENT_PREVIEW VidyoConnectorAssignViewToLocalCamera Relevant for composited layout only. 
Mute/unmute selected microphone  VIDYO_CLIENT_IN_EVENT_MUTE_AUDIO
_IN		 VidyoConnectorSetMicrophonePrivacy
(true/false) 		 
Mute/unmute selected speaker VIDYO_CLIENT_IN_EVENT_MUTE_AUDIO
_OUT 		VidyoConnectorSetSpeakerPrivacy
(true/false) 		 
Mute/unmute selected camera  VIDYO_CLIENT_IN_EVENT_MUTE_VIDEO

VidyoConnectorSetCameraPrivacy
(true/false)

 
Select an application window or entire monitor to share  VIDYO_CLIENT_IN_EVENT_SHARE

VidyoConnectorSelectLocalWindowShare

VidyoConnectorSelectLocalMonitor

  
Undo the selection of an application or entire monitor to share  VIDYO_CLIENT_IN_EVENT_UNSHARE

VidyoConnectorSelectLocalWindowShare
(NULL)

VidyoConnectorSelectLocalMonitor(NULL)

  
Send the specified video frame to the conference  VIDYO_CLIENT_IN_EVENT_SEND_FRAME VidyoVirtualVideoSourceOnFrame
Change the position and size of the window on which the video is rendered  VIDYO_CLIENT_IN_EVENT_RESIZE VidyoConnectorShowViewAt  
Limit the number of remote participants video being rendered in the layout VIDYO_CLIENT_IN_EVENT_
PARTICIPANTS_LIMIT 		VidyoConnectorConstruct(...,
remoteParticipants, ...) 		 
Change the background color of the rendering window  VIDYO_CLIENT_IN_EVENT_SET_BACK
GROUND_COLOR 		VidyoConnectorSetViewBackgroundColor  
Perform local or remote camera control  VIDYO_CLIENT_IN_EVENT_CONTROL_
CAMERA

VidyoRemoteCameraControlPTZ

VidyoLocalCameraControlPTZ

  
Limit the max send bitrate for all local sources together  VIDYO_CLIENT_IN_EVENT_SET_SEND_
BANDWIDTH

VidyoConnectorSetMaxSendBitRate

  
Select a specific network interface for video conferencing signaling and media  VIDYO_CLIENT_IN_EVENT_SET_
NETWORK_INTERFACE

VidyoConnectorSelectNetworkInterface
ForMedia

VidyoConnectorSelectNetworkInterface
ForSignaling

 
Join a room identified by a room link  VIDYO_CLIENT_IN_EVENT_ROOM_LINK VidyoConnectorConnectToRoomAsGuest  
Set the font file so that the display of the participant name is correct for different languages  VIDYO_CLIENT_IN_EVENT_SET_FONT
_FILE		 VidyoConnectorSetFontFileName  
Switch the selected camera between the front and back cameras on a mobile device  VIDYO_CLIENT_IN_EVENT_TOGGLE_
CAMERA 		VidyoConnectorCycleCamera  
Send a chat message to all participants in the conference/call. VIDYO_CLIENT_IN_EVENT_GROUP_CHAT VidyoConnectorSendChatMessage  
Send a chat message to a specified participant in the conference/call  VIDYO_CLIENT_IN_EVENT_PRIVATE_
CHAT		 VidyoConnectorSendPrivateChatMessage  
Start receiving raw video frame of a remote participant's camera  VIDYO_CLIENT_IN_EVENT_START_
WATCH_VIDEO_SOURCE 		VidyoConnectorRegisterRemoteCamera
FrameListener  		 
Stop receiving raw video frame of a remote participant's camera  VIDYO_CLIENT_IN_EVENT_STOP_
WATCH_VIDEO_SOURCE 		VidyoConnectorUnregisterRemoteCamera
FrameListener 		 
Start receiving raw video frame from the selected local camera  VIDYO_CLIENT_IN_EVENT_START_
WATCH_SELF_VIEW 		VidyoConnectorRegisterLocalCamera
FrameListener 		 
Stop receiving raw video frame from the selected local camera  VIDYO_CLIENT_IN_EVENT_STOP_
WATCH_SELF_VIEW 		VidyoConnectorUnregisterLocalCamera
FrameListener 		 
Assign remote video to a view and make it visible or hide it  VIDYO_CLIENT_IN_EVENT_SET_
RENDERER_VISIBLE

VidyoConnectorAssignViewTo*

VidyoConnectorHideView 		Applicable to custom layout only 
Start receiving audio from the local microphone or the remote microphone  VIDYO_CLIENT_IN_EVENT_START_
ACQUIRE_AUDIO

VidyoConnectorRegisterLocalMicrophone
FrameListener

VidyoConnectorRegisterRemoteMicrophone
FrameListener 		 
Stop receiving audio from the local microphone or the remote microphone  VIDYO_CLIENT_IN_EVENT_STOP_
ACQUIRE_AUDIO

VidyoConnectorUnregisterLocalMicrophone
FrameListener

VidyoConnectorUnregisterRemoteMicrophone
FrameListener 		 
OUT EVENTS
Report the addition, removal, or selection of local devices (microphone, speaker, or camera)   VIDYO_CLIENT_OUT_EVENT_DEVICE_
SELECTION_CHANGED  

VidyoConnectorRegisterLocalCameraEventListener

-OnLocalCameraAdded

-OnLocalCameraRemoved

- OnLocalCameraSelected

 

VidyoConnectorRegisterLocalMicrophone
EventListener

-OnLocalMicrophoneAdded

-OnLocalMicrophoneRemoved

- OnLocalMicrophoneSelected

 

VidyoConnectorRegisterLocalSpeakerEventListener

-OnLocalSpeakerAdded

-OnLocalSpeakerRemoved

- OnLocalSpeakerSelected

 

VidyoConnectorRegisterResourceManager
EventListener

-OnAvailableResourcesChanged   		 
  VIDYO_CLIENT_OUT_EVENT_
CONFERENCE_ACTIVE

VidyoConnectorConnectToRoomAsGuest

-OnSuccess   		 
  VIDYO_CLIENT_OUT_EVENT_
CONFERENCE_ENDED

VidyoConnectorConnectToRoomAsGuest

-OnDisconnected 		 
  VIDYO_CLIENT_OUT_EVENT_
PARTICIPANTS_CHANGED

VidyoConnectorRegisterParticipantEventListener

-OnParticipantJoined

-OnParticipantLeft 		 
Report the addition of a remote participant's camera, microphone, or speaker to the conference  VIDYO_CLIENT_OUT_EVENT_REMOTE
_SOURCE_ADDED

VidyoConnectorRegisterRemoteCamera
EventListener

-OnRemoteCameraAdded

VidyoConnectorRegisterRemoteMicrophone
EventListener

-OnRemoteMicrophoneAdded

VidyoConnectorRegisterRemoteSpeaker
EventListener

-OnRemoteSpeakerAdded

VidyoConnectorRegisterRemoteWindowShare
EventListener

-OnRemoteWindowShareAdded 		 
Report the removal of a remote participant's camera, microphone, or speaker to the conference VIDYO_CLIENT_OUT_EVENT_REMOTE
_SOURCE_REMOVED

VidyoConnectorRegisterRemoteCamera
EventListener

-OnRemoteCameraRemoved

VidyoConnectorRegisterRemoteMicrophone
EventListener

-OnRemoteMicrophoneRemoved

VidyoConnectorRegisterRemoteSpeaker
EventListener

-OnRemoteSpeakerRemoved

VidyoConnectorRegisterRemoteWindowShare
EventListener

-OnRemoteWindowShareRemoved 		 
Report the muted status of a local microphone to the application  VIDYO_CLIENT_OUT_EVENT_MUTED
_AUDIO_IN

VidyoConnectorRegisterLocalMicrophone
EventListener

-OnLocalMicrophoneStateUpdated 		 
Report the muted status of a local speaker to the application  VIDYO_CLIENT_OUT_EVENT_MUTED
_AUDIO_OUT

VidyoConnectorRegisterLocalSpeaker
EventListener

-OnLocalSpeakerStateUpdated

  
Report the muted status of a local camera to the application  VIDYO_CLIENT_OUT_EVENT_MUTED
_VIDEO

VidyoConnectorRegisterLocalCameraEventListener

-OnLocalCameraStateUpdated 		 
Report the muted status of a local microphone by the moderator to the application  VIDYO_CLIENT_OUT_EVENT_MUTED
_SERVER_AUDIO_IN 		Register callback VidyoConnectorOnModerationCommandReceived
in VidyoConnectorRegisterModerationCommand
EventListener 		 
Report the muted status of a local camera by the moderator to the application  VIDYO_CLIENT_OUT_EVENT_MUTED
_SERVER_VIDEO 		Register callback VidyoConnectorOnModerationCommandReceived
in VidyoConnectorRegisterModerationCommand
EventListener 		 
Report the addition of remote window share in conference VIDYO_CLIENT_OUT_EVENT_ADD_
SHARE

VidyoConnectorRegisterRemoteWindowShare
EventListener

-OnRemoteWindowShareAdded 		 
Report the removal of remote window share in conference  VIDYO_CLIENT_OUT_EVENT_REMOVE_
SHARE

VidyoConnectorRegisterRemoteWindowShare
EventListener

-OnRemoteWindowShareRemoved 		 
Report the removal/closed state of remote window share in conference  VIDYO_CLIENT_OUT_EVENT_SHARE_
CLOSED

VidyoConnectorRegisterRemoteWindowShare
EventListener

-OnRemoteWindowShareStateUpdated 		 
Report the success/failure result of a join request to a conference room identified by a room link  VIDYO_CLIENT_OUT_EVENT_ROOM_
LINK

VidyoConnectorConnectToRoomAsGuest

-OnSuccess

-OnFailure 		 
Report a changed list of the remote participants in a conference based on the loudness of their speech  VIDYO_CLIENT_OUT_EVENT_SELECTED
_PARTICIPANTS_CHANGED

VidyoConnectorRegisterParticipantEventListener

-OnDynamicParticipantChanged 		 
Report that group chat messages were received from a remote participant  VIDYO_CLIENT_OUT_EVENT_GROUP_
CHAT

Register callback using VidyoConnectorRegisterMessageEventListener

The callback VidyoConnectorOnChatMessageReceived will
provide the received chat message. VidyoChatMessageType will indicate whether the received chat is a group chat or private chat. 		 
Report that private chat messages were received from a remote participant  VIDYO_CLIENT_OUT_EVENT_PRIVATE
_CHAT

Register callback using VidyoConnectorRegisterMessageEventListener

The callback VidyoConnectorOnChatMessageReceived will
provide the received chat message. VidyoChatMessageType will indicate whether the received chat is a group chat or private chat. 		 
Report the audio frame received from a remote participant's microphone  VIDYO_CLIENT_OUT_EVENT_AUDIO_
FRAME_RECEIVED

VidyoConnectorRegisterRemoteMicrophone
EventListener

-OnRemoteMicrophoneFrame 		 
Report the video frame received from a remote participant's microphone  VIDYO_CLIENT_OUT_EVENT_VIDEO_
FRAME_RECEIVED

VidyoConnectorRegisterRemoteCamera
EventListener

-OnRemoteCameraFrame 		 
Report the video frame received from the local camera VIDYO_CLIENT_OUT_EVENT_SELF_
VIEW_VIDEO_FRAME_RECEIVED

VidyoConnectorRegisterLocalCamera
EventListener

-OnLocalCameraFrame 		 
Report changes in the list of active network interfaces the machine has VIDYO_CLIENT_OUT_EVENT_NETWORK
_INTERFACE_CHANGED

VidyoConnectorRegisterNetworkInterface
FrameListener

-OnNetworkInterfaceSelected 		 
Report log events to the listener VIDYO_CLIENT_OUT_EVENT_LOG

VidyoConnectorRegisterLogEventListener

-OnLog 		 
REQUESTS
Determine the list of cameras the machine has  VIDYO_CLIENT_REQUEST_GET_
CONFIGURATION -> cameras,
cameraLabels 		Refer to the details described for VIDYO_CLIENT_OUT_EVENT_DEVICE_
SELECTION_CHANGED. The application has to maintain the list of devices the machine has. 		 
Determine the list of microphones the machine has  VIDYO_CLIENT_REQUEST_GET_
CONFIGURATION -> microphones, microphonePhyDeviceName 		Refer to the details described for VIDYO_CLIENT_OUT_EVENT_DEVICE_
SELECTION_CHANGED. The application has to maintain the list of devices the machine has. 		 
Determine the list of speakers the machine has  VIDYO_CLIENT_REQUEST_GET_
CONFIGURATION -> speakers, speakerPhyDeviceName 		Refer to the details described for VIDYO_CLIENT_OUT_EVENT_DEVICE_
SELECTION_CHANGED. The application has to maintain the list of devices the machine has. 		 
Select a camera for use in the conference VIDYO_CLIENT_REQUEST_SET_
CONFIGURATION -> currentCamera 		VidyoConnectorSelectLocalCamera  
Select a microphone for use in the conference VIDYO_CLIENT_REQUEST_SET_
CONFIGURATION ->
currentMicrophone 		VidyoConnectorSelectLocalMicrophone  
Select a speaker for use in the conference VIDYO_CLIENT_REQUEST_SET_
CONFIGURATION -> currentSpeaker 		VidyoConnectorSelectLocalSpeaker  
Set the Web Proxy credentials if the connection of the VidyoPortal, VidyoManager, or VidyoRouter needs to go through a Web Proxy VIDYO_CLIENT_REQUEST_SET_
WEBPROXY_USERNAME_PASSWORD 		VidyoConnectorSetWebProxyAddress
Credentials 		 
Find the list of participants in the conference VIDYO_CLIENT_REQUEST_GET_
PARTICIPANTS

Register VidyoConnectorOnParticipantJoined
and VidyoConnectorOnParticipantLeft in VidyoConnectorRegisterParticipantEvent
Listener 

The VidyoParticipant objects have to be maintained by the application which has the details of each participant in the call. 		 
Find the current resolution being encoded VIDYO_CLIENT_REQUEST_GET_
VIDEO_ENCODE_RESOLUTION 		VidyoConnectorGetStatsJson  
Find the current media statistics

VIDYO_CLIENT_REQUEST_GET_
MEDIA_INFO

VidyoConnectorGetStatsJson  
Find the current rate shaper statistics VIDYO_CLIENT_REQUEST_GET_
RATE_SHAPER_INFO 		VidyoConnectorGetStatsJson  
Find the current CPU usage VIDYO_CLIENT_REQUEST_GET_
CURRENT_CPU_UTIL 		VidyoConnectorGetStatsJson  
Find the details of the participants video being displayed in the call and its statistics VIDYO_CLIENT_REQUEST_GET_
PARTICIPANT_INFO 		VidyoConnectorGetStatsJson  
Find the total number of participants in the call VIDYO_CLIENT_REQUEST_GET_
NUM_PARTICIPANTS 		VidyoConnectorGetStatsJson  
>Find the display name of a participant VIDYO_CLIENT_REQUEST_GET_
PARTICIPANT_NAME_AT

Register VidyoConnectorOnParticipantJoined and VidyoConnectorOnParticipantLeft in VidyoConnectorRegisterParticipantEventListener

The VidyoParticipant objects have to be maintained by the application which has the details of each participant in the call. 		 
Find the details of the participants video being displayed in the call and its statistics VIDYO_CLIENT_REQUEST_GET_
PARTICIPANT_STATISTICS_AT 		VidyoConnectorGetStatsJson  
Find the display name of participants in the conference VIDYO_CLIENT_REQUEST_GET_
PARTICIPANT_NAME_LIST

Register VidyoConnectorOnParticipantJoined and VidyoConnectorOnParticipantLeft in VidyoConnectorRegisterParticipantEventListener

The VidyoParticipant objects have to be maintained by the application which has the details of each participant in the call. 		 
Find the details of the participants video being displayed in the call and its statistics VIDYO_CLIENT_REQUEST_GET_
PARTICIPANT_STATISTICS_LIST 		VidyoConnectorGetStatsJson  
Find the details of the participants video being displayed in the call and its statistics VIDYO_CLIENT_REQUEST_GET_
PARTICIPANT_DETAILS_AT 		VidyoConnectorGetStatsJson  
Determine current audio energy level of microphone VIDYO_CLIENT_REQUEST_GET_
AUDIO_ENERGY_INFO

VidyoConnectorRegisterLocalMicrophone
EnergyListener

VidyoConnectorRegisterRemoteMicrophone
EnergyListener 		 
Change the log level for the different log categories VidyoClient has VIDYO_CLIENT_REQUEST_SET_
LOG_LEVELS_AND_CATEGORIES

VidyoConnectorConstruct(..., logFileFilter, ...)

Or

VidyoConnectorRegisterLogEventListener

Or

VidyoConnectorEnableDebug 		 
Find the list of shareable application windows and shareable monitors connected to the machine

VIDYO_CLIENT_REQUEST_GET_
SHARABLE_WINDOW_WHITE_LIST

VidyoConnectorRegisterLocalWindowShare
EventListener

-OnLocalWindowShareAdded

VidyoConnectorRegisterLocalMonitor
EventListener

-OnLocalMonitorAdded 		 
Share a window or monitor in the conference VIDYO_CLIENT_REQUEST_SET_
SHARABLE_WINDOW_WHITE_LIST

VidyoConnectorSelectLocalWindowShare

VidyoConnectorSelectLocalMonitorShare

  

Send the application to the background

Note: Applicable only for mobile devices

 VIDYO_CLIENT_REQUEST_SET_
BACKGROUND 		VidyoConnectorSetMode  
Find the current CPU usage VIDYO_CLIENT_REQUEST_GET_CPU
_USAGE 		VidyoConnectorGetStatsJson  
Was this article helpful?
1 out of 1 found this helpful

Related articles

Comments

0 comments

Please sign in to leave a comment.