Partners Blog Contact Us

Articles in this section

Send and Receive Event API Messages Within VidyoClient Parameters

  • Updated
Follow

In Events

In Events are sent to the VidyoClient from the application. 

In Event Message Type String Parameters Description Notes
InEventLicense None Initiates licensing activation with VidyoPortal™  
InEventLogin
  • portalUri
  • userName
  • userPass
 Logs user in to VidyoPortal  
InEventLoginCancel None Cancels login of user to VidyoPortal  
InEventSignIn
  • serverAddress
  • serverPort
  • userName
  • portalAccessKey
  • portalAddress
  • portalVersion
  • vmIdentity
  • locationTag
  • vidyoProxy Address
  • vidyoProxyPort
  • emcpSecured
  • guestLogin
  • showDialpad
  • showStartmeeting

Creates a VidyoClient sign-in In Event object.

Event used to perform endpoint registration.		  
InEventSignoff None Ends the connection with VidyoManager  
EventPreview inEventMutepreview Mode ("None", "PIP", "Dock") Changes or acknowledges how own video is shown in video layout Message type string same as VIDYO_CLIENT_
OUT_EVENT_
PREVIEW
InEventCancel None Cancels entering a conference  
InEventLayout numPreferred

Creates a VidyoClient layout In Event object. Event used to change number of preferred partici-pants displayed in the video layout.

Preferred participants appear in larger tiles than and in different positions from participants that are not preferred. Participants are usually selected to be preferred based on whether they are in the loudest speaker history, according to speech energy. The current capability allows for either 0 or 1 preferred participant.		  
InEventLeave None Leaves a conference that was already entered  
InEventMuteAudioIn willMute Changes the mute state of audio input (capture/microphone) device  
InEventMuteAudioOut willMute Changes the mute state of audio output (playback/speaker) device  
InEventMuteVideo willMute Changes the privacy state of video (capture/ camera) device  
InEventParticipantsLimit maxNumParticipants Changes the max number of participants to display in video layout  
InEventShare
  • window
  • shareType
 Shares an application window or the system desktop during a conference  shareType indi-cates whether the content being shared is an application or a desktop/ display
InEventToggleShare None Toggles the displayed application window share  
InEventUnshare None Stops sharing an application window or the system desktop during a conference  
InEventGetWindowsExt requestId Gets a full list of windows in the system This Event is only currently implemented and returned under Windows
InEventAnswer None Answers an incoming call  
InEventDecline None Declines an incoming call  
InEventPrivateChat
  • uri
  • message
 Sends a private chat text to a specified remote participant  
InEventGroupChat message Sends a group chat text to all remote participants  
InEventSetDisplay
Name
  • uri
  • displayName
 Sets the display name of the specified remote participant  
InEventResetDisplayName uri Resets the display name of the remote participant to the default name  
InEventSetEchoCancellation enable Changes the state of acoustic echo cancellation enable (true, false)
InEventSetEchoDetection enable Enable or disables echo detection notifications enable (true, false)
InEventSetAGC enable Changes the state of audio AGC (Automatic Gain Control) enable (true, false
InEventSetOffline offline Controls the connection with the conference manager  
InEventSetFreezeImage freeze Freezes/unfreezes the image from the video capture freeze (true - freeze, false - unfreeze)
InEventControlCamera
  • uri
  • cameraCommand
  • commandId
  • commandData
  • preset
 Sends a camera control request over FECC (Far End Camera Control) for the participant with the specified URI cameraCommand ("PanRight", "PanLeft" "TiltUp", "TiltDown", "ZoomIn", "ZoomOut", "Position", "ViscaCommand", "ViscaResponse")
InEventSetSendBandwidthLimit
  • sendBandwidth
  • layers

Limits the outgoing bandwidth.

The passed in parameter object can store the following properties:

sendBandwidth (7 - 768Kbps, 1 - 1Mbps, 2 - 2Mbps, 3 - 3Mbps, 4 - 4Mbps, 6 - 6Mbps)

layers (1, 2, 3)		  
InEventPinParticipant
  • uri
  • pinMode
 Pins a participant in the conference to a layout pinMode ("None", "PinHigh", "PinLow")
InEventParticipantsLimit maxNumParticipants Sets the maximum number of viewable remote participants in video layout to specified value  
InEventStartPrecallTestSpeaker soundFileName

Starts testing selected speaker when not joined in a call or conference (pre-call speaker test).

The sound data given in VidyoClientInEventStartPrecallTestSpeaker will be played until requested to stop using interface VIDYO_CLIENT_IN_ EVENT_STOP_PRECALL_TEST_SPEAKER.		  
InEventStopPrecallTestSpeaker Empty structure Stops testing selected speaker when not joined in a call or conference (pre-call speaker test)  
InEventPrecallTestMicrophone action (object)

Controls selected microphone when not joined in a call or conference (pre-call microphone test).

This is used to start or stop microphone.

Action values can be (strings):

DeviceTest
Start

DeviceTest
Stop
InEventPrecallTestCamera action (object)

Tests self-view using selected camera when not joined in a call or conference (pre-call self-view).

This is used to start or stop self-view.

Action values can be (strings):

DeviceTest
Start

DeviceTest
Stop
InEventControl
ConferenceRoomSettings
  • requestId
  • roomType
  • roomSettingId
  • moderatorPin
 Controls the conference room settings  
InEventPlayDtmfTone tone (object) Sends or plays a DTMF tone to conference Range of allowed values 0~9, *, #, A, B, C, D. */
PrivateInEventStartMyMeeting   Joins your own meeting room  
PrivateInEventVcsoap
  • typeRequest
  • requestId
 Communicates with the VidyoPortal via the VCSOAP protocol  
PrivateInEventVcsoapGuestLink
  • portalUri
  • roomKey
  • guestName
  • pin
 Links the guest user via the VCSOAP protocol  
start   Starts the plugin Needs to be called on the proxyWrapper or vidyoclient, depending upon which browser is being used
stop   Stops the plugin Needs to be called on the proxyWrapper or vidyoclient, depending upon which browser is being used

 

Out Events

Out Events are sent from the VidyoClient to the application. 

Out Event Message Type String Parameters Description Notes
OutEventLicense
  • error
  • vmConnectionPath
  • outOfLicenses

result: ("Failure", "Success", "NotLicensed", "SeatLicense Expired", "WronPin","Conference Locked", "Room Disabled", "GeneralFault", "InvalidArgument Fault", "MemberNot Online", "Not OwnerOfRoom", "User NotFound", "Unexpected Subelement InMessage", "EndPointNotFound", "FailedPlaceDirectCall", "IpcJoinFailure", "AllLinesInUse")

fault: ("None", "InvalidArgument", "NotLicensed", "General", "ConferenceLocked", "LicenseExpired", "WrongPin")		 Reports the success or failure of licensing activation with VidyoPortal  
OutEventLinked error Reports the success or failure of linking of user via VidyoPortal  
OutEventLogicStarted None Signals the completion of VidyoClient startup  
OutEventLogin
  • error
  • portalUri
  • userName
 Reports the success or failure of login of user to VidyoPortal  
OutEventSignedIn None Signals the connection to VidyoManager with a user identity  
OutEventSignedOut
  • Cause
    • "UserSignedIn"
    • "UserSignedOut"
    • "ServerSignedOut"
  • error
 Signals the disconnection from VidyoManager with a user identity, or any failure to connect with such an identity in the first place  
OutEventSignIn
  • activeEid
  • guestLogin
  • showDialpad
  • showStartmeeting
  • signinType
    • "Internal"
    • "External"
    • "Application"
  • signinSecured
 Signals that sign-in to server has been initiated. Reports if the endpoint ID is activated or not  
OutEventSignOut None Signals that sign-out from server has been completed  
EventPreview None   Message type string same as VIDYO_
CLIENT_
IN_EVENT_
PREVIEW
OutEventAddShare URI Indicates the remote application window share has been added  
OutEventConference
Active		 None Signals that operation to join a conference is complete  
OutEventConference
Ended		 None Signals that operation to leave a conference is complete  
OutEventEnd
Processing		 None Indicates the completion or cancellation of certain operations relating to state of entering and leaving conferences. Also used to dismiss dialog box with progress bar for certain pending operations  
OutEventJoining
  • numProgressSteps
  • caption
 Displays the dialog box with progress bar for pending join operation  
OutEventJoinProgress None Advances the progress bar for pending join operation  
OutEventKeydown
  • key
  • count
 Indicates the beginning of a keypress on the video layout while in a conference  
OutEventKeyup
  • key
  • count
 Indicates the ending of a keypress on the video layout while in a conference  
OutEventMouseDown
  • button
  • count
  • xPos
  • yPos
  • shift
  • ctrl
  • alt
  • command
  • scrollDeltaX
  • scrollDeltaY
  • scrollDeltaZ
 Indicates the beginning of a click on a mouse input device on the video layout while in a conference  
OutEventMouseMove
  • button
  • count
  • xPos
  • yPos
  • shift
  • ctrl
  • alt
  • command
  • scrollDeltaX
  • scrollDeltaY
  • scrollDeltaZ
 Indicates the movement of a mouse input device, independent of click state, which would move the pointer on the video layout while in a conference  
OutEventMouseUp
  • button
  • count
  • xPos
  • yPos
  • shift
  • ctrl
  • alt
  • command
  • scrollDeltaX
  • scrollDeltaY
  • scrollDeltaZ
 Indicates the ending of a click on a mouse input device, on the video layout while in a conference  
OutEventMutedAudio
In
  • isMuted
  • errorCode
 Acknowledges the change of mute state of audio input (capture/ microphone) device  
OutEventMutedAudioOut
  • isMuted
  • errorCode
 Acknowledges the change of mute state of audio output (playback/ speaker) device  
OutEventMutedServerAudio
In
  • isMuted
  • errorCode
 Indicates the change of mute state of audio input (capture/ microphone) device due to server  
OutEventMutedServerVideo
  • isMuted
  • errorCode
 Indicates the change of privacy state of video (capture/camera) device due to server  
OutEventMutedVideo
  • isMuted
  • errorCode
 Acknowledges the change of privacy state of video (capture/camera) device  
OutEventRemoveShare URI Indicates the remote application window share removed  
OutEventPlugin
ConnectionFailure		 None

Detects whether a user tries to open a VidyoClient API for the VidyoWeb Extension browser tab while an existing one is already open.

Failure indicates that the plugin did not connect because it is already in use. On NPAPI, it is VIDYO_CLIENT_
PRIVATE_OUT_EVENT_PLUGIN_CONNECTION_FAILURE error code 270001.		  

OutEventPlugin
ConnectionSuccess

 None Detects whether a user tries to open a VidyoClient API for the VidyoWeb Extension browser tab while an one is already open. Success indicates that it is safe to move ahead with any messaging.  
OutEvenGetWindows
Ext		 None Finds special windows to share that are not listed by the regular API Windows environments only
OutEventIncomingCall
  • invitingUser
  • isDirectCall
 Displays the dialog box for an incoming call, allowing the user to accept or decline the call  
OutEventIncomingCallEnded   Dismisses the dialog box for an incoming call, as call has timed out or has been canceled  
OutEventPrivateChat
  • uri
  • displayName
  • message
 Sends the text message received as part of a private chat from a remote participant  
OutEventGroupChat
  • uri
  • displayName
  • message
 Sends the text message received as part of a group chat from a remote participant  
OutEventConference
InfoUpdate
  • event
  • eventStatus
 Reports the conference information  
OutEventCallState callState

Provides an update of the current call state.

callState ("Idle", "Ringing", "Calling", "Joining", "InConference", "Disconnecting")		  
OutEventRinging
  • numProgressSteps
  • caption
 Displays a dialog box with progress bar for pending ring operation  
OutEventRinging
Progress		 None Advances the progress bar for pending ring operation  
OutEventRinging
Ended		 None Dismisses the dialog box with progress bar for pending ring operation  
OutEventCalling
  • numProgressSteps
  • caption
 Displays the dialog box with progress bar for pending call operation  
OutEventCalling
Progress		 None Advances the progress bar for pending call operation  
OutEventCallingEnded None Dismisses the dialog box with progress bar for pending call operation  
OutEventRetrying
  • numProgressSteps
  • caption
 Displays the dialog box with progress bar for pending retry operation  
OutEventRetrying
Progress		 None Advances the progress bar for pending retry operation  
OutEventParticipant
Limit
  • bandwidthLimited
  • cpuLimited
 Imposes a limit on the number of remote participants that can be rendered  
OutEventEcho
Detected		 None Indicates that echo in the audio path has been detected  
OutEventFloating
Window		 windowId Indicates that a floating Share window has been created or destroyed  
OutEventFeccList
Updated		 numberParticipants Indicates the updated list of participants in the conference that have a controllable camera  
OutEventControl
Camera
  • uricameraCommand
  • commandId
  • commandData

Indicates that a camera control request over FECC has been received.

cameraCommand ("PanRight", "PanLeft", "TiltUp", "TiltDown", "ZoomIn", "ZoomOut", "Position", "ViscaCommand", "ViscaResponse")		  
OutEventFeccStatus
Update
  • statusCode
  • curFeccUri

Reports the status of remote participants whose cameras are being controlled.

statusCode ("UserLost", "UserInPrivacy")		  
OutEventMediaControl
  • mediaCommand
  • mediaType
  • mediaSource

Provides server-based media control command details against a media device type.

mediaCommand ("Mute", "Unmute", "Silence")

mediaType ("Video", "Application", "Audio", "Unknown")

mediaSource ("Local", "Remote", "Calling", "Unknown")		  
OutEventGuestLink
  • error
  • state

Reports the state of Guest login & joined-conference, possibly with an error.

state ("Init", "Logged", "Linked", "Joined")		  
OutEventPin
ParticipantDone
  • uri
  • pinMode
  • isSet
 Returns type of a VidyoClient pin participant done out event object. Event used to signal status on participant pin pinMode ("None", "PinHigh", "PinLow")
OutEventEndpoint
Status		 endPointStatus

Signals the status of connectivity with server.

endPointStatus ("Inactive", "Registered", "Active")		  
OutEventParticipants
Changed		 participantCount Signals that a participant has joined or left the current conference Will trigger VIDYO_
CLIENT_
REQUEST
_STATISTICS_ENABLE
OutEventUser
Message
  • messageType
  • messageCode
  • messageString
 Displays the notification message in dialog box  
OutEventDevice
Changed
  • deviceType
    • "AudioOut"
    • "AudioIn"
    • "Video"
    • "RingTone"
 Notifies change in the list of attached devices for specified kind of media device  
OutEventDeviceSelect None Signals the need to select a media device  
OutEventDevice
SelectionChanged
  • deviceType
    • "AudioOut"
    • "AudioIn"
    • "Video"
    • "RingTone"
  • changeType
    • "DeviceLost"
    • "DeviceSelection
      Changed"
  • prevDeviceName
  • newDeviceName
 Reports the newly selected media device when there is an automatic change in the selection  
OutEventControl
ConferenceRoom
Settings
  • requestId
  • roomSettingId
  • result
 Sends the response to control conference room settings event  
OutEventPrecallTest
Device
  • deviceType
  • action
  • result
 Reports the status of test device test using selected device when not joined in a call or conference  
PrivateOutEventLog message Sends logs to the application  
PrivateOutEventVcsoap
GuestLink
  • typeRequest
  • Error
  • httpStatusCode
  • requestId
  • guestID
  • isLocked
  • hasPin
  • vmaddress
  • proxyaddress
  • loctag
  • un
  • pak
  • portal
  • portalVersion
  • proxyType
  • reverseProxyAddress
  • clientExternalIPAddress
  • result
  • fault

Links guest user via the VCSOAP protocol.

requestId (should be unique for each request)

typeRequest (will always be set to "GuestLink")		  
PrivateOutEventLog message Sends logs to application  

 

Requests

Requests are made by the application to the VidyoClient. 

Request Message Type String Parameters Description
RequestSetLogLevelsAndCategories levelsAndCategories New setting for log levels and categories
RequestGetConfiguration  

requestConfiguration object:

  • Microphones
  • microphonePhyDeviceName
  • microphoneVoiceProcessing
    Support
  • numberMicrophones
  • currentMicrophone
  • speakers
  • speakerPhyDeviceName
  • numberSpeakers
  • currentSpeaker
  • cameras
  • numberCameras
  • currentCamera
  • enableFeccEndpoint
  • enableFeccController
  • vidyoProxies
  • numberVidyoProxies
  • currentVidyoProxy
  • userID
  • password
  • serverAddress
  • serverPort
  • vidyoProxyAddress
  • vidyoProxyPort
  • webProxyAddress
  • webProxyPort
  • webProxyUsername
  • webProxyPassword
  • webProxyIeAddress
  • webProxyIePort
  • portalAddress
  • ringtoneDeviceName
  • verifyCertPortalAcct
  • webProxyScriptUrl
  • webProxyIeScriptUrl
  • mediaLowPort
  • mediaHighPort
  • proxySettings
  • videoPreferences
  • enableLogging
  • enableAutoAnswer
  • enableForceProxy
  • enableLogWindow
  • enableEntryTone
  • enableEchoDetection
  • enableEchoCancellation
  • enableFullScreenVideo
  • showToolbarInFullScreenVideo
  • enableAudioAGC
  • enableAutoStart
  • enableShowConfParticipant
    Name
  • enableMuteMicrophoneOnJoin
  • enableHideCameraOnJoin
  • enableMuteSpeakerOnJoin
  • enableEulaAgreed
  • enableRendering
  • enableBackgrounding
  • enableFullDisplaySharing
  • selfViewLoopbackPolicy

Gets various configuration parameters.

 

videoPreferences ("BestQuality", "BestFramerate", "BestResolution", "LimitedBandwidth", "Advanced450p30",
"Advanced720p15",
"Advanced720p30",
“Advanced1080p30”) 
RequestGetCurrent
SessionDisplayInfo
  • sessionDisplayContext
  • sessionDisplayText
  

Gets information that could be displayed to the user, relating to the current conference state.

sessionDisplayContext ("Conf", "OutCall", "InCall", "Idle")

sessionDisplayText:

If client is in a conference, this is the text which could be displayed in a windowcaption to identify the conference to the user. Encoded as UTF-8.
RequestGetNumParticipants numParticipants Gets the number of participants in the current conference
RequestGetParticipants  
  • numberParticipants
  • name
 Gets the number of participants in the current conference and their names
RequestGetParticipant
NameAt
  • index
  • result
  • name

Retrieves the conference participant's name at a given index in the list of participants.

Index (index of conference participant whose name to be retrieved)

Result (Success (VIDYO_TRUE) or failure (VIDYO_FALSE)

Name is valid only when result is VIDYO_TRUE. If value of result is VIDYO_FALSE, it means there is no participant at the given location/index. 
RequestGetParticpant
StatisticsAt 		  
  • index
  • Result
  • uri
  • name
  • videoResolution
  • videoKBitsPerSecRecv
  • audioKBitsPerSecRecv
  • firs
  • nacks
  • videoFrameRate
  • videoDecodedFrameRate
  • videoDisplayedFrameRate

Retrieves the conference participant's statistics at a given index in the list of participants.

videoResolution (containing following properties): xPos, yPos, width, height 
RequestGetVolumeAudioIn requestVolumeAudio structure:
volume		 Gets volume of audio input (capture/microphone) device
RequesGetVolumeAudioOut

requestVolumeAudio structure:
volume

 Gets volume of audio output (playback/speaker) device
RequestGetWindows AndDesktops
  • numApplicationWindows
  • appWindowName
  • appWindowAppName
  • appWindowId
  • numSystemDesktops
  • sysDesktopName
  • sysDesktopId

Gets list of open application windows and list of available system desktops.

appWindowName - List of open application window names (UTF-8) (Localized) - MacOs only

appWindowAppName - List of open applica-tion window applica-tion names (UTF-8)*

appWindowId - List of open application window handles*

appWindowRect - List of open application window geometries - MacOs only

sysDesktopName - List of available system desktop names (UTF-8)

sysDesktopId - List of available system desktop handles

sysDesktopRect - List of available system desktop geometries - MacOs only

Note: *With VidyoWeb Extension plugin version 1.3.7 or later, on Windows OS 8 and later, only Desktops will be returned for this request. To re-enable application sharing on these OSs, refer to RequestEnableAppShare on page 21.
RequestGetWindow
Shares

requestWindowShares object has the following parameters:

  • requestType
  • remoteAppUri
  • remoteAppName
  • numApp
  • currApp
  • eventUri
  • newApp

Gets list of remote window shares.

requestType ("ListSharingWindows", "ChangeSharingWindow","ToggleSharingWindow", "StopSharingWindow")
RequestEnableAppShare isEnable

Calling this on Windows 8 and later will change the behavior of RequestGet
WindowsAndDesktops) so that it retrieves appli-cations as well as desktops (see RequestGet
WindowsAndDesktops on page 21). This needs to be called once per client session.

Note: If you choose to re-enable application sharing on Windows 8 and later, be aware of the potential consequences: users may inadvertently share applications into the conference that they do not intend to share.
RequestSetConfiguration
  • requestConfiguration object:
  • microphones
  • microphonePhyDeviceName
  • microphoneVoiceProcessing
    Support
  • numberMicrophones
  • currentMicrophone
  • speakers
  • speakerPhyDeviceName
  • numberSpeakers
  • currentSpeaker
  • cameras
  • numberCameras
  • currentCamera
  • enableFeccEndpoint
  • enableFeccController
  • vidyoProxies
  • numberVidyoProxies
  • currentVidyoProxy
  • userID
  • password
  • serverAddress
  • serverPort
  • vidyoProxyAddress
  • vidyoProxyPort
  • webProxyAddress
  • webProxyPort
  • webProxyUsername
  • webProxyPassword
  • webProxyIeAddress
  • webProxyIePort
  • portalAddress
  • ringtoneDeviceName
  • verifyCertPortalAcct
  • webProxyScriptUrl
  • webProxyIeScriptUrl
  • mediaLowPort
  • mediaHighPort
  • proxySettings
  • videoPreferences
  • enableLogging
  • enableAutoAnswer
  • enableForceProxy
  • enableLogWindow
  • enableEntryTone
  • enableEchoDetection
  • enableEchoCancellation
  • enableFullScreenVideo
  • showToolbarInFullScreenVideo
  • enableAudioAGC
  • enableAutoStart
  • enableShowConfParticipantName
  • enableMuteMicrophoneOnJoin
  • enableHideCameraOnJoin
  • enableMuteSpeakerOnJoin
  • enableEulaAgreed
  • enableRendering
  • enableBackgrounding
  • enableFullDisplaySharing
  • selfViewLoopbackPolicy
  • allowLetterBoxVideoScaling

Sets various configuration parameters.

videoPreferences ("BestQuality", "BestFramerate", "Best-Resolution", "LimitedBandwidth", "Advanced450p30",
"Advanced720p15",
"Advanced720p30"
“Advanced1080p30”)
RequestSetVolumeAudio
In

requestVolumeAudio structure:
volume

Sets volume of audio input (capture/microphone) device.

Use requests to control gain level of microphone device.

Range of allowed values 0~65535.

Pre-call only.
RequestSetVolumeAudioOut requestVolumeAudio structure:
volume

Sets volume of audio output (playback/speaker) device.

Range of allowed values 0~65535
RequestSetWindow
Shares

requestWindowShares structure has the following parameter:

  • requestType
  • remoteAppUri
  • remoteAppName
  • numApp
  • currApp
  • eventUri
  • newApp

Sets list of remote window shares.

requestType ("ListSharingWindows", "ChangeSharingWindow","ToggleSharingWindow", "StopSharingWindow") 
RequestGetEID EID Gets the endpoint's unique identifier
RequestGetConnectivity
Info
  • serverAddress
  • serverPort
  • serverSecured
  • vmIdentity
  • userName
  • portalAddress
  • portalVersion
  • locationTag
  • vidyoProxyAddress
  • vidyoProxyPort
  • guestLogin
  • clientExternalIPAddress
  • proxyType
  • reverseProxyAddress
  • reverseProxyPort
 Returns the currently used sign-in information and parameters
RequestGetSendMax
Kbps		 value Inquires maximum aggregate bandwidth of all types of media to send
RequestSetSendMax
Kbps		 value Changes maximum aggregate bandwidth of all types of media to send
RequestGetReceiveMax
Kbps		 value Inquires maximum aggregate bandwidth of all types of media to receive
RequestSetReceiveMax
Kbps		 value Changes maximum aggregate bandwidth of all types of media to receive
RequestGetPreviewMode
  • previewMode
  • primaryDisplay
 Inquires how own video is shown in video layout
RequestGetMutedAudioIn isMuted

Inquires mute state of audio input (capture/microphone) device.

isMuted (true, false)
RequestGetMutedAudio
Out		 isMuted

Inquires mute state of audio output (playback/speaker) device.

isMuted (true, false)
RequestGetMutedVideo isMuted

Inquires privacy state of video (capture/
camera) device.

isMuted (true, false)
RequestGetMutedServer
AudioIn		 isMuted

Inquires mute state of audio input (capture/
microphone) device, as controlled by server.

isMuted (true, false)
RequestGetMutedServer
Video		 isMuted

Inquires mute state of video (capture/
camera) device, as controlled by server.

isMuted (true, false)
RequestGetEcho
Recommendation
  • speakerIndex
  • micIndex
  • disableEcho

Checks whether both audio devices (mic and speaker) are on same device and whether the device is a recommended audio device.

If both audio devices are one single recommended device, echo cancellation is recommended to be kept disabled.

disableEcho (true - do not enable echo cancellation, false - enable)
RequestCheck
Recommended
  • deviceType
  • deviceIndex
  • isRecommended

Checks whether given audio devices (mic and speaker) are a recommended device.

deviceType ("AudioOut", "AudioIn", "Video", "RingTone")

isRecommended (true - recommended, false - unknown/not recommended)
RequestGetWebProxy
SettingsValid		 isValid

Checks validity of web proxy configurations.

isValid (true - valid, false - not valid)
RequestSetWebProxy
Credentials		 persistusernamepassword

Sets proxy credentials with possibility to persist data.

persist (true - persist, false - use ) VIDYO_TRUE if the values are to be saved in Configuration, VIDYO_FALSE if volatile
RequestGetCurrentUser
  • currentUserID
  • currentUserDisplay
 Returns current user ID
RequestGetParticipants
Limit
  • bandwidthLimitedcpuLimited
  • userLimited

Returns remote participants number limit for rendering due to bandwidth, CPU or user settings.

BandwidthLimit -Maximum number of viewable remote participants in video layout, due to current network bandwidth. Range of values 0~16.

cpuLimited- Maximum number of viewable remote participants in video layout, due to current CPU

utilization. Range of values 0~16.

userLimited -Maximum number of viewable remote participants in video layout. Range of values 0~16.
RequestGetInvitingUser invitingUser Gets display name of the inviting user in the case of incoming call
RequestGetCurrentSes
sionVidyoRouter		 routerAddress Gets VidyoRouter™ address while in the conference
RequestGetFeccList
  • uri
  • name
  • privacyMode
  • numberParticipants
  • feccParticipantIndex
 Gets the list of controllable far-end cameras available in conference call
RequestGetConference
Info
  • recording
  • webcasting
 Gets the list of general conference information reported by the VidyoRouter in conference call
RequestGetCallState callState Gets the current call state callState ("Idle", "Ringing", "Calling", "Joining", "InConference", "Disconnecting")
RequestGetBandwidth
Info
  • AvailSendBwVideo
  • AvailSendBwAudio
  • AvailSendBwApplication
  • AvailSendBwMax
  • ActualSendBwVideo
  • ActualSendBwAudio
  • ActualSendBwApplication
  • ActualSendBwMax
  • AvailRecvBwVideo
  • AvailRecvBwAudio
  • AvailRecvBwApplication
  • AvailRecvBwMax
  • ActualRecvBwVideo
  • ActualRecvBwAudio
  • ActualRecvBwApplication
  • ActualRecvBwMax

Inquires current conference bandwidth statistics.

The format of recived returned data are in units of kilobits per second.

Range of values 0~UNIT_MAX.
RequestGetVideoFrame
RateInfo
  • captureFrameRate
  • encodeFrameRate
  • sendFrameRate
 Inquires current conference video frame rate that is captured, encoded, and sent
RequestGetMediaInfo
  • numIFrames
  • numFirs
  • numNacks
  • mediaRTT
 Inquires current conference number of IFrames, FIRs, NACKs, and media-RTT relating to media sent to network
RequestGetRateShaper
Info
  • delayVideoPriorytyNormal
  • numPacketsVideoPriorytyNormal
  • numFramesVideoPriorytyNormal
  • numDroppedVideoPriorytyNormal
  • delayVideoPriorutyRetransmit
  • numPacketsVideoPrioruty
    Retransmit
  • numFramesVideoPrioruty
    Retransmit
  • numDroppedVideoPrioruty
    Retransmit
  • delayAppPriorityNormal
  • numFramesAppPriorityNormal
  • numDroppedAppPriorityNormal
  • delayAppPriorityRetransmit
  • numPacketsAppPriorityRetransmit
  • numFramesAppPriorityRetransmit
  • numDroppedAppPriorityRetransmit
 Inquires current conference statistics relating to rate shaper
RequestGetCurrentCpu
Utilization		 value Inquires current CPU utilization
RequestGetEndpoint
Status		 endPointStatus

Gets status of endpoint.

The endpoint status can be ("Inactive", "Registered", "Active").
RequestGetEncode
Resolution		 rect (Object)

Inquires current conference video resolution that is encoded.

The passed in parameter object can store the following

Properties: xPos:0,yPos:0,width:0,height:0
requestGetAudioEnergy
Info
  • rendererEnergy
  • capturerEnergy
 Gets audio energy level of audio devices
RequestActivateEID lacKey Activates installation license of an endpoint. Perform endpoint registration
RequestSetSharable
WindowWhiteList
  • numWindows
  • windowName 

Sets the list of application windows that are in white list of sharable window.

If an open application window whose name contain one of the white listed window name,that windows property (e.g. is visible, is transparent toolbar window etc) will not be verified and it will be included in the list if sharable window list when using API

#VIDYO_CLIENT_REQUEST_GET_WINDOWS_AND_DESKTOPS
RequestGetLicensed
Status		 isLicensed Gets the endpoint's installation license status
RequestGetLID LID Gets the endpoint's unique long identifier
RequestConnectVersion version Connects to a specific version of the VidyoClientForWeb
RequestGetVersion   Requests the version of the active VidyoClientForWeb
RequestSetCamera
Resolution
  • width
  • height

Sets the resolution of the conference.

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

Related articles

Comments

0 comments

Please sign in to leave a comment.