Table of Contents:
(c) 2006-2016 Vidyo Inc.,
433 Hackensack Avenue,
Hackensack, NJ 07601.
All rights reserved.
The information contained herein is proprietary to Vidyo, Inc. and shall not be reproduced, copied
(in whole or in part), adapted, modified, disseminated, transmitted, transcribed, stored in a retrieval system,
or translated into any language in any form by any means without the express written consent of Vidyo, Inc.
***** CONFIDENTIAL *****
[PRIVATE] Indicates an interface is private. Private interfaces are subject to change or may be entirely removed without notice. Use of such interfaces is not recommended.
[EXPERIMENTAL] Indicates an interface is experimental. Experimental interfaces represent work in progress and therefore may be incomplete and may be subject to change (both in terms of interface definition and the semantics the interface controls) or even removed entirely in subsequent releases. Use of experimental interfaces should be carefully weighed by the application writer.
[DEPRECATED] Indicates an interface has been deprecated. Deprecated interfaces are subject to removal in subsequent releases. Use of deprecated interfaces in new code is not recommended. Existing uses of deprecated interfaces should be removed as soon as possible.
[REPLACED BY interface ] Indicates an interface has been superseded by interface .
SYMBOLIC Indicates that the constant is a compile-time symbolic replacement of the constants value. Such constants can be used as global initializers, but can not have their address taken. Non-symbolic constant can not be used as global initializers, but can have their address taken.
REFERENCE COUNTED Indicates that objects of the type are reference counted. Calling ConstructCopy or Assign has reference semantics.
VidyoCalendarCreateResult | Indicates the result code for the creation of the calendar instance . |
VidyoCalendarManager |
This type will be used to retrieve and manage the creation of the various calendar service types. General concepts: - Presents a set of API's that allow for the creation of a calendar service. - The types of calendar services offered will depend on the implementations that are built and packaged against these API's as plugins - The type of calendar service types defined may change as new implementations are added. - The service type will dicate how an application will construct the servce through this calendar service manager API => A set of connection properties will be passed into the create service methods based on the service type. - The service manager will pass back a constructed calendar service type, which can then be used to connect to the service with and manage meeting setups and receive events for that service. Note that the availability of a service may come and go based on local applications or network events. |
VidyoCalendarManagerFeedback | Interface for registering callbacks that notify an application about events on the VidyoCalendarManager object. Multiple feedbacks can be registered on the same VidyoCalendarManager. |
VidyoCalendarServiceStatus | Indicates the result code for the creation of the calendar instance . |
VidyoFormField | Attributes related to an HTML form input field. |
VidyoFormFieldOption | Option properties for an HTML drop down select input field. |
VidyoFormFieldTextWrapMode | This enum is used to represent the wrapping modes defined for a textarea HTML form input field. |
VidyoFormFieldType | This enum contains type values that releate directly to HTML form input fields. |
VidyoCalendar |
Represents an instance of a calendar service. General concepts: - Each instance is identifiable through the combination of the service type and the id Lifecycle of an calendar service instance: - Create/construct an instance of the service through the VidyoCalendarManager based on a VidyoCalendarManagerDefaultServices - Constructor will take a vector of connection parameters, the content of which will also be dictated by the VidyoCalendarManagerDefaultServices - Recieve the constructed instance back through the VidyoCalendarManager callback method VidyoCalendarManagerFeedbackCreateServiceResult. - Connect the service to it's resource using the VidyoCalendarConnect method - Receive the connect result through the calendar service callback for that service through VidyoCalendarFeedbackConnectResult - Upon successful connection result, the user will be able to create, update, read and delete meetings from the service as well as receive reminder events |
VidyoCalendarFeedback | Interface for registering callbacks that notify an application about events on the VidyoCalendar object. Multiple feedbacks can be registerd on the same VidyoCalendar. |
VidyoCalendarManagerDefaultServices | Calendar service ID's. |
VidyoCalendarServiceCode | This type indicates the result of an attempt to log in to some service. |
VidyoCalendarState | Types of services available to reference for calendar specific data and events. |
VidyoMeetingSearchResult | This type indicates the result of a search for a meeting(s). |
VidyoConnector | The videoconferencing API that handles all aspects of the media (audio/video) connection. |
VidyoGateway | A wrapper for Vidyo gateways. |
VidyoConnectorInitialize | Initialize the VidyoConnector API. |
VidyoConnectorUninitialize | Uninitialize the VidyoConnector API. |
VidyoDevice | A wrapper class for Local and Remote devices. |
VidyoLocalCamera | This object represents a camera on the local endpoint. |
VidyoLocalMicrophone | This object represents a microphone on the local endpoint. |
VidyoLocalMonitor | This object represents a monitor on the local endpoint. |
VidyoLocalRenderer | |
VidyoLocalSpeaker | This object represents a speaker on the local endpoint. |
VidyoLocalWindowShare | This object represents a window share on the local endpoint. |
VidyoRemoteCamera | This object represents a camera which belongs to the remote participant. |
VidyoRemoteMicrophone | This object represents a microphone which belongs to the remote participant. |
VidyoRemoteRenderer | |
VidyoRemoteSpeaker | |
VidyoRemoteWindowShare | This object represents a window share which belongs to the remote participant. |
VidyoVideoCapability | Represents the capability of a Video Source. |
VidyoVirtualDeviceManager | |
VidyoVirtualShareManager |
VidyoCall | Establishes and manages a point-to-point call. |
VidyoChatMessage | Contains the text message and additional information about who sent it and when. |
VidyoContact | Stores contact information and presence status. |
VidyoContactInfo | Stores contact information returned from search. |
VidyoEndpoint | |
VidyoLogRecord | A record of one logged event. |
VidyoLogger | |
VidyoMediaFormat | Represents the media format. |
VidyoParticipant | This object represents a participant in the room or call. |
VidyoRoom | Establishes and manages a conference room. See VidyoRoomType for sescription of room types. |
VidyoRoomInfo | descriptive details of a room. |
VidyoUser |
VidyoClientGetBuildTag | |
VidyoClientGetVersion | |
VidyoClientInitialize | |
VidyoClientUninitialize |
VidyoMeeting | Represents a meeting and all the related attributes. |
VidyoMeetingActionResult | This type indicates the result of an attempt to create a meeting. |
VidyoMeetingType | Type of meeting. |
VidyoBandwidthSummaryStats | Staticstics for an endpoint rate shaper. |
VidyoEndpointStats | Statistics for an endpoint. |
VidyoLocalMicrophoneStats | Staticstics for a local microphone. |
VidyoLocalRendererStats | Statistics for a local renderer. |
VidyoLocalRendererStreamStats | Statistics for a local renderer. |
VidyoLocalSpeakerStats | Staticstics for a local speaker. |
VidyoLocalSpeakerStreamStats | Staticstics for a local speaker. |
VidyoLocalVideoSourceStats | Statistics for a local video source. |
VidyoMediaConnectionTransportInfo | Information about media connection transport. |
VidyoNetworkInterfaceStats | Staticstics for a network interface. |
VidyoParticipantGenerationStats | Staticstics for a participnat generation, ordered list of dynamic participants. |
VidyoParticipantStats | Staticstics for a room. |
VidyoRateShaperStats | Staticstics for an endpoint rate shaper. |
VidyoRemoteMicrophoneStats | Staticstics for a remote microphone. |
VidyoRemoteRendererStreamStats | Statistics for a remote renderer. |
VidyoRemoteSpeakerStreamStats | Staticstics for a remote speaker. |
VidyoRemoteVideoSourceStats | Statistics for a remote video source. |
VidyoRoomStats | Staticstics for a room. |
VidyoUserStats | Statistics for an user. |
CalendarManager | The CalendarServices package encapsulates all APIs related to calendar specific actions and items (i.e. a meeting, attendees, etc). |
CalendarSchedule | Contains a schedule of meetings that the client wishes to operate against. Note that there is a separate, but different calendar package defined in under the Lmi related objects called Calendar. |
Connector | Package that encapsulates all the APIs required to build a simple videoconferencing application. |
Device | The VidyoDevice package. |
Endpoint | The VidyoClient package encapsulates all APIs required to build a vidyo conferencing application. |
Meeting | Represents a meeting or appointment. The meeting may have information in it to identify it as a Vidyo specific meeting. |
Participant | The VidyoParticipant package. |
Stats | Statistics for VidyoClient |
VidyoMeetingAttendee | Stores information for a meeting attendee. |
VidyoNetworkInterface | Stores network interface information. |
VIDYO_ATTENDEEPARTICIPATIONROLE_Chair | |
VIDYO_ATTENDEEPARTICIPATIONROLE_Required | |
VIDYO_ATTENDEEPARTICIPATIONROLE_Optional | |
VIDYO_ATTENDEEPARTICIPATIONROLE_Informational | Maps to NON-PARTICIPANT role in RFC type |
VIDYO_ATTENDEEPARTICIPATIONSTATUS_NeedsAction | |
VIDYO_ATTENDEEPARTICIPATIONSTATUS_Organized | |
VIDYO_ATTENDEEPARTICIPATIONSTATUS_Accepted | |
VIDYO_ATTENDEEPARTICIPATIONSTATUS_Declined | |
VIDYO_ATTENDEEPARTICIPATIONSTATUS_Tentative | |
VIDYO_ATTENDEEPARTICIPATIONSTATUS_Delegated | |
VIDYO_ATTENDEEPARTICIPATIONSTATUS_None | Response not required |
VIDYO_ATTENDEEPARTICIPATIONSTATUS_Completed | |
VIDYO_ATTENDEEPARTICIPATIONSTATUS_InProcess |
availableBandwidth | LmiUint | Available bandwidth. |
targetEncoderBitRate | LmiUint | Target encoder bitrate. |
actualEncoderBitRate | LmiUint | Actual encoder bitrate. |
retransmitBitRate | LmiUint | Bitrate used for retransmission. |
totalTransmitBitRate | LmiUint | Total transmit bitrate. |
leakyBucketDelay | LmiUint | Leaky bucket delay. |
serviceType | LmiString | Types of calendar services supported through this interface. |
serviceState | VidyoCalendarState | Enumeration for the states that a calendar service can transition through. |
id | LmiString | Uniquely identifies the calendar service instance. |
VidyoCalendarConnProps | Properties for connecting to a calendar service. |
VidyoCalendarConnectParamType | This type indicates the connection parameter types that would be required for connecting to a specific calendar service. |
VidyoCalendarConnect |
Initiates a connection of the calendar service to its resource for data. This can include both a local resource or a server based one. Triggers callback(s): VidyoCalendarFeedbackConnectResult |
VidyoCalendarConstructCopy | Constructs an VidyoCalendar object as a copy of another. |
VidyoCalendarCreateMeeting |
Creates a calendar meeting Triggers callback(s): VidyoCalendarFeedbackMeetingCreated |
VidyoCalendarDestruct | Destructs an VidyoCalendar object. |
VidyoCalendarGetConnectFields | Retrieves the connection fields needed to connect to a service, based on the service type. |
VidyoCalendarGetId | Retreives the unique string Id that identifies the instance of the calendar. |
VidyoCalendarGetMeetingsByDay |
Get a list of meetings by day. Triggers callback(s): VidyoCalendarFeedbackGetMeetingsResult |
VidyoCalendarGetMeetingsByMonth |
Get a list of meetings by month. Triggers callback(s): VidyoCalendarFeedbackGetMeetingsResult |
VidyoCalendarGetMeetingsByWeek |
Get a list of meetings by week. Triggers callback(s): VidyoCalendarFeedbackGetMeetingsResult |
VidyoCalendarGetServiceState | Retreives the user data pointer that was previousely set by Calendaring VidyoCalendarSetUserData. |
VidyoCalendarGetServiceType | Retreives the service type for the calendar. |
VidyoCalendarRemoveMeeting |
Removes a meeting from the calendar Triggers callback(s): VidyoCalendarFeedbackMeetingRemoved |
VidyoCalendarSearchMeetings |
Search a calendar for meetings based on a search string and a begin - end date. Triggers callback(s): VidyoCalendarFeedbackGetMeetingsResult NOTE - TODO: Should we also limit search range for dates? |
VidyoCalendarSetRoomIdMatchString | Sets the regular expression string that will be used to identify Vidyo room URLs or key information, during a meeting search or retrieval. |
VidyoCalendarUpdateMeeting |
Updates a calendar meeting Triggers callback(s): VidyoCalendarFeedbackMeetingUpdated |
TODO - VidyoCalendar myVidyoCalendar; VidyoCalendarFeedback myVidyoCalendarFeedback; LmiAllocator* alloc;
connPropType | VidyoCalendarConnectParamType | |
connPropValue | LmiString |
VIDYO_CALENDARCONNECTPARAMTYPE_Unknown | Undefined type. |
VIDYO_CALENDARCONNECTPARAMTYPE_UserId | Parameter type that specifies a user ID string. |
VIDYO_CALENDARCONNECTPARAMTYPE_PasswordToken | Parameter type that specifies a password or token string. |
VIDYO_CALENDARCONNECTPARAMTYPE_Mailbox | Parameter type that specifies a mailbox name string. |
VIDYO_CALENDARCONNECTPARAMTYPE_ServerAddress | Parameter type that specifies a server address string. |
VIDYO_CALENDARCREATERESULT_Ok | Service was created successfully. |
VIDYO_CALENDARCREATERESULT_InvalidConnParams | Set of connection parameters passed in were either missing or contained invalid values. |
VIDYO_CALENDARCREATERESULT_InvalidType | Invalid or unsupported calendar type was indicated. (Auto discovery will indicate whether the service is available on the platform) |
VidyoCalendarFeedbackConnectResult |
Triggered when service is connected. Triggered through method(s): VidyoCalendarConnect |
VidyoCalendarFeedbackDisconnected |
Callback that is triggered when service is disconnected.
Triggered when service is connected. Triggered through event(s): user will be notified through this method when the connection to the calendar service becomes unavailable. |
VidyoCalendarFeedbackGetMeetingsResult |
Triggered from a meeting search request. Triggered through method(s): - VidyoCalendarGetMeetingsByMonth - VidyoCalendarGetMeetingsByWeek |
VidyoCalendarFeedbackMeetingCreated |
Triggered when a meeting is created by the local user. Triggered through method(s): VidyoCalendarCreateMeeting |
VidyoCalendarFeedbackMeetingCreatedByService |
Triggered when a meeting is created through the receipt of an invite by a remote user. Triggered by an event for creating a meeting that originated from the calendar service |
VidyoCalendarFeedbackMeetingEventNotification |
Triggered when a meeting event occurs. Triggered through event(s): user will be notified through this method when the start time for a scheduled meeting occurs. |
VidyoCalendarFeedbackMeetingRemoved |
Triggered when a meeting is removed from the calendar schedule. Triggered through method(s): VidyoCalendarRemoveMeeting. The value of the VidyoMeetingActionResult will indicate if any errors occured trying to remove the meeting. |
VidyoCalendarFeedbackMeetingRemovedByService |
Triggered when a meeting is removed from the calendar schedule. Triggered through method(s): VidyoCalendarRemoveMeeting or remotely from a meeting removal by the originator. The value of the VidyoMeetingActionResult will indicate how the meeting was removed. |
VidyoCalendarFeedbackMeetingUpdated |
Triggered when a meeting is updated. Triggered from the method VidyoCalendarUpdateMeeting |
VidyoCalendarFeedbackMeetingUpdatedByService |
Triggered when a meeting is updated. Triggered from an event originating through the calendar service |
VidyoCalendarFeedbackConstruct | Construct the calendar feedback instance. |
VidyoCalendarFeedbackConstructCopy | Constructs a VidyoCalendarFeedback object as a copy of another. |
VidyoCalendarFeedbackDestruct | Destructs an VidyoCalendarFeedback object. |
VidyoCalendarManagerConstruct | Constructor for Vidyo Calendar Service Manager |
VidyoCalendarManagerCreateCalendarInstance | Creates a VidyoCalendar which is returned through VidyoCalendarManagerFeedbackCalendarCreated. Will be identifiable through the service ID and calendarName. |
VidyoCalendarManagerDeleteCalendarInstance | Destructs the for VidyoCalendar calendar instance passed in. |
VidyoCalendarManagerDestruct | Destructor for Vidyo Calendar Service Manager |
VidyoCalendarManagerGetCalendarSvcString | Retrieves the list of calendar types that the given calendar manager is configured to operate against. |
VidyoCalendarManagerGetCalendarTypes | Retrieves the list of calendar types that the given calendar manager is configured to operate against. |
VidyoCalendarManagerInitialize | Prepares the environment for accessing the underlying calendar services |
VidyoCalendarManagerSetCalendarTypes | Specifies a specific list of calendar types that the given calendar manager will be allowed to operate against. |
VidyoCalendarManagerUninitialize | Cleans up all resources related to calendar processing. MUST be performed before destructing the VidyoCalendarManager |
TODO - VidyoCalendar myVidyoCalendar; VidyoCalendarFeedback myVidyoCalendarFeedback; LmiAllocator* alloc;
VIDYO_CALENDARMANAGERDEFAULTSERVICES_External | ID used to indicate an externally supplied calendar implementation. |
VIDYO_CALENDARMANAGERDEFAULTSERVICES_Default | Vidyo based service (Future). |
VIDYO_CALENDARMANAGERDEFAULTSERVICES_Outlook2010 | Outlook 2010 client. |
VIDYO_CALENDARMANAGERDEFAULTSERVICES_Outlook2013 | Outlook 2013 client . |
VIDYO_CALENDARMANAGERDEFAULTSERVICES_Google | Google calendar . |
VidyoCalendarManagerFeedbackCalendarCreated | Returns the created VidyoCalendar that was initiated through VidyoCalendarManagerCreateCalendarInstance. |
VidyoCalendarManagerFeedbackServiceDiscovery |
Triggered through the construction of calendar manager. Returns the results from discovering the avialability for the supported calendar services. Triggered through method(s): VidyoCalendarManagerConstruct |
VidyoCalendarManagerFeedbackUninitialized |
Triggered through the construction of calendar manager. Returns the results from discovering the avialability for the supported calendar services. Triggered through method(s): VidyoCalendarManagerConstruct |
VidyoCalendarManagerFeedbackConstruct |
VIDYO_CALENDARSERVICECODE_Ok | The user logged in successfully. |
VIDYO_CALENDARSERVICECODE_NoService | |
VIDYO_CALENDARSERVICECODE_ConnectionFailed | The destination could not be reached. |
VIDYO_CALENDARSERVICECODE_ConnectionLost | The transport connection was lost prior to completing the login procedure. |
VIDYO_CALENDARSERVICECODE_ConnectionTimeout | The signaling connection timed out prior to completing the login procedure. |
VIDYO_CALENDARSERVICECODE_InvalidCredentials | The credentials (combination of both userID and password) are not known to the service. |
VIDYO_CALENDARSERVICECODE_InvalidCalendarId | Could not find the calendar instance for the given name. |
VIDYO_CALENDARSERVICECODE_GeneralError | The login failed for some other miscellaneous error. |
VIDYO_CALENDARSERVICESTATUS_Init | The initial state of the library for a service - ready to be located and loaded. |
VIDYO_CALENDARSERVICESTATUS_Loaded | Library was loaded and the API function required for registering the interface was found. |
VIDYO_CALENDARSERVICESTATUS_LoadError | Error occurred while trying to load the library. |
VIDYO_CALENDARSERVICESTATUS_Available | A connection attempt for the service was successful. API calls are ready for use. |
VIDYO_CALENDARSERVICESTATUS_DllNotFound | Vidyo DLL or static library for specified calendar service could not be found in the installation directory. |
VIDYO_CALENDARSERVICESTATUS_ApiProcError | Unable to retrieve the API function from the Vidyo DLL or static library for specified calendar service. |
VIDYO_CALENDARSERVICESTATUS_PluginSvcNotInstalled | Calendar service was loaded, but the 3rd party service it was referencing was not started or was not installed. |
VIDYO_CALENDARSERVICESTATUS_PluginSvcNotActive | Calendar service was loaded, and the local 3rd party service is available but not connected to it's resources for event notifications. |
VIDYO_CALENDARSERVICESTATUS_PluginSvcAuthRequired | Calendar service was loaded, and the local 3rd party service is available but user is not logged in. |
VIDYO_CALENDARSERVICESTATUS_Unloaded | Calendar service has been uninitialized with all internal resources freed. |
VIDYO_CALENDARSTATE_Unavailable | Indicates that the service is not available in the environmemt due to either an unreachable server, or by lack of an installed product. |
VIDYO_CALENDARSTATE_Initialized | Verified that the service is available to attempt a connection against. |
VIDYO_CALENDARSTATE_Connecting | |
VIDYO_CALENDARSTATE_Connected | |
VIDYO_CALENDARSTATE_Disconnecting | |
VIDYO_CALENDARSTATE_Disconnected |
id | LmiString | Unique ID of the VidyoCall. |
VidyoCallEndReason | Reasons why a VidyoCall is ending. |
VidyoCallInitiatedResult | Result of an attempt to enter a VidyoCall. |
VidyoCallOnEnded | Callback that is triggered when VidyoCall has ended. |
VidyoCallOnInitiated | Callback that is triggered when initiating a VidyoCall. |
VidyoCallOnMessageAcknowledged | Callback that is triggered when a VidyoChatMessage is delivered to the VidyoCall on the server. |
VidyoCallOnMessageRead | Callback that is triggered when a message that was acknowledged by the server was read by the other VidyoParticipant in the room. |
VidyoCallOnMessageReceived | Callback that is triggered when a new text message arrives. |
VidyoCallOnMessageTypingIndication | Callback that is triggered when typing state of a remote VidyoParticipant changes. |
VidyoCallOnSetSubject | Callback that is triggered when the subject of the VidyoCall has changed. |
VidyoCallAccept | Accepts an incoming VidyoCall that was notified by the VidyoUserOnCallCreatedByInvite callback. |
VidyoCallConstructCopy | Constructs the VidyoCall object as a copy of another. |
VidyoCallDestruct | Destructs the VidyoCall object. |
VidyoCallGetId | Gets the unique ID of the VidyoCall |
VidyoCallGetParticipants | Gets the LmiVector of VidyoParticipant objects in the VidyoCall. |
VidyoCallGetRemoteRenderers | Gets the LmiVector of VidyoRemoteRenderer objects in the VidyoCall. |
VidyoCallGetRemoteSpeakers | Gets the LmiVector of VidyoRemoteSpeaker objects in the VidyoCall. |
VidyoCallGetSubject | Gets the current subject of the VidyoCall. |
VidyoCallGetUser | |
VidyoCallHangUp | Hangs up an in-progress VidyoCall. |
VidyoCallInitiate | Initiates a VidyoCall. |
VidyoCallRegisterMessageEventListener | Registers to get notified about message events. |
VidyoCallRegisterSubjectEventListener | Registers to get notified about subject events. |
VidyoCallReject | Rejects an incoming VidyoCall that was notified by the VidyoUserFeedbackCallCreatedByInvite callback. |
VidyoCallSendMessage | Sends a message to the remote user in the VidyoCall. |
VidyoCallSetSubject | Sets a new subject on the VidyoCall. |
VIDYO_CALLENDREASON_Ended | Call was terminated locally. |
VIDYO_CALLENDREASON_ConnectionFailed | Local entity could not establish a signaling connection to its peer. |
VIDYO_CALLENDREASON_ConnectionLost | Signaling connection was lost between the local entity and its peer. |
VIDYO_CALLENDREASON_ParticipantBusy | Remote peer is busy and cannot accept the call. |
VIDYO_CALLENDREASON_ParticipantRejected | Remote peer rejected the call. |
VIDYO_CALLENDREASON_ParticipantEnded | Local entity had a call and the remote peer ended it. |
VIDYO_CALLENDREASON_MiscError | Miscellaneous error occurred. |
VIDYO_CALLINITIATEDRESULT_OK | Call entered successfully. |
VIDYO_CALLINITIATEDRESULT_Cancelled | Enter request was cancelled. |
VIDYO_CALLINITIATEDRESULT_NoResponse | Server did not respond in a reasonable amount of time to the request to enter the room. |
VIDYO_CALLINITIATEDRESULT_UnknownParticipant | Call specified by the user does not exist. |
VIDYO_CALLINITIATEDRESULT_MiscLocalError | Server is rejecting the request to enter due to some miscellaneous problem with the request. |
VIDYO_CALLINITIATEDRESULT_MiscRemoteError | Server is rejecting the request to enter due to some miscellaneous problem of its own. |
userId | LmiString | Unique ID of a VidyoParticipant who sent the message or NULL depending on the VidyoChatMessageSenderType. |
senderType | VidyoChatMessageSenderType | The type of the sender. |
id | LmiInt64 | Unique ID of the VidyoChatMessage. |
body | LmiString | The body of the VidyoChatMessage. |
type | VidyoChatMessageType | The type of VidyoChatMessage. |
timestamp | LmiTime | The time when the message was created. |
VidyoChatMessageSenderType | Type of the VidyoChatMessage sender. |
VidyoChatMessageType | Type of a message. This type will depend on the content of the message or where it originated. |
VidyoChatMessageTypingIndication | Typing indicator of VidyoParticipant state in the VidyoRoom. |
VIDYO_CHATMESSAGESENDERTYPE_User | VidyoChatMessage is from a VidyoUser represented by VidyoParticipant in VidyoRoom/VidyoCall. |
VIDYO_CHATMESSAGESENDERTYPE_Room | VidyoChatMessage is from a VidyoRoom. |
VIDYO_CHATMESSAGESENDERTYPE_System | VidyoChatMessage is from the system. |
VIDYO_CHATMESSAGESENDERTYPE_None | Sender type is not set. |
VIDYO_CHATMESSAGETYPE_Chat | Text chat message from another VidyoParticipant. |
VIDYO_CHATMESSAGETYPE_MediaStart | Media was enabled in the room. This indicates that someone enabled their camera/microphone/etc and would like to escalate the VidyoRoom to audio/video. |
VIDYO_CHATMESSAGETYPE_MediaStop | Media was disabled in the room. This indicates that there are no more audio/video in the VidyoRoom. |
VIDYO_CHATMESSAGETYPINGINDICATION_Active | Active and responsive. |
VIDYO_CHATMESSAGETYPINGINDICATION_Composing | Composing a text message. |
VIDYO_CHATMESSAGETYPINGINDICATION_Gone | Closed the chat window. |
VIDYO_CHATMESSAGETYPINGINDICATION_Inactive | Inactive for reasons such as the chat is out of focus. |
VIDYO_CHATMESSAGETYPINGINDICATION_Paused | Paused composing a message. |
VIDYO_CHATMESSAGETYPINGINDICATION_None | Not set. |
VidyoConnectorDisconnectReason | Reasons why an established connection was disconnected. |
VidyoConnectorFailReason | Reasons why a connection attempt failed. |
VidyoConnectorMode | Operating modes of a VidyoConnector object. |
VidyoConnectorState | States of a connection, mostly representing the progress of a connection attempt. |
VidyoConnectorViewStyle | Styles of the composite renderer, which apply to its layout and behaviour. |
VidyoConnectorOnAvailableResourcesChanged | Callback that is triggered each time the available local resources change. |
VidyoConnectorOnChatMessageReceived | Callback that is triggered each time a chat message is received from one of the other participants. |
VidyoConnectorOnDisconnected | Callback that is triggered when an established connection is disconnected. |
VidyoConnectorOnDynamicParticipantChanged | Callback that is triggered each time the order of dyanmic participants has changed, based on active speech detection. |
VidyoConnectorOnFailure | Callback that is triggered when the connection attempt has failed. |
VidyoConnectorOnLocalCameraAdded | Callback that is triggered each time a local camera becomes available to a VidyoConnector. |
VidyoConnectorOnLocalCameraRemoved | Callback that is triggered each time a local camera is no longer available to a VidyoConnector. |
VidyoConnectorOnLocalCameraSelected | Callback that is triggered each time there is a change in which local camera is selected for use. |
VidyoConnectorOnLocalCameraStateUpdated | Callback that is triggered each time there is a change in the state of the camera such as being suspended or disabled. |
VidyoConnectorOnLocalMicrophoneAdded | Callback that is triggered each time a local microphone becomes available to a VidyoConnector. |
VidyoConnectorOnLocalMicrophoneRemoved | Callback that is triggered each time a local microphone is no longer available to a VidyoConnector. |
VidyoConnectorOnLocalMicrophoneSelected | Callback that is triggered each time there is a change in which local microphone is selected for use. |
VidyoConnectorOnLocalMicrophoneStateUpdated | Callback that is triggered each time there is a change in the state of the microphone such as being suspended or disabled. |
VidyoConnectorOnLocalMonitorAdded | Callback that is triggered each time a local monitor becomes available to a VidyoConnector. |
VidyoConnectorOnLocalMonitorRemoved | Callback that is triggered each time a local monitor is no longer available to a VidyoConnector. |
VidyoConnectorOnLocalMonitorSelected | Callback that is triggered each time there is a change in which local monitor is selected for sharing. |
VidyoConnectorOnLocalMonitorStateUpdated | Callback that is triggered each time there is a change in the state of the monitor such as being suspended or disabled. |
VidyoConnectorOnLocalSpeakerAdded | Callback that is triggered each time a local speaker becomes available to a VidyoConnector. |
VidyoConnectorOnLocalSpeakerRemoved | Callback that is triggered each time a local speaker is no longer available to a VidyoConnector. |
VidyoConnectorOnLocalSpeakerSelected | Callback that is triggered each time there is a change in which local speaker is selected for use. |
VidyoConnectorOnLocalSpeakerStateUpdated | Callback that is triggered each time there is a change in the state of the speaker such as being suspended or disabled. |
VidyoConnectorOnLocalWindowShareAdded | Callback that is triggered each time a local window becomes available for a VidyoConnector to share in a conference. |
VidyoConnectorOnLocalWindowShareRemoved | Callback that is triggered each time a local window is no longer available for a VidyoConnector to share in a conference. |
VidyoConnectorOnLocalWindowShareSelected | Callback that is triggered each time there is a change in which local window is selected for sharing. |
VidyoConnectorOnLocalWindowShareStateUpdated | Callback that is triggered each time there is a change in the state of the window such as being suspended or disabled. |
VidyoConnectorOnLog | Callback that is triggered for every log record. |
VidyoConnectorOnLoudestParticipantChanged | Callback that is triggered each time one of the other participants becomes the loudest, based on active speech detection. |
VidyoConnectorOnMaxRemoteSourcesChanged | Callback that is triggered each time the local client's maximum decoding capability changes. |
VidyoConnectorOnNetworkInterfaceAdded | Callback that is triggered each time a network interface is available to a VidyoConnector. |
VidyoConnectorOnNetworkInterfaceRemoved | Callback that is triggered each time a network interface is no longer available to a VidyoConnector. |
VidyoConnectorOnNetworkInterfaceSelected | Callback that is triggered each time there is a change in which network interface is selected for use. |
VidyoConnectorOnNetworkInterfaceStateUpdated | Callback that is triggered each time there is a change in the state of the network interface such as being up or down. |
VidyoConnectorOnParticipantJoined | Callback that is triggered each time another participant joins a conference. |
VidyoConnectorOnParticipantLeft | Callback that is triggered each time an existing participant leaves a conference. |
VidyoConnectorOnRemoteCameraAdded | Callback that is triggered each time one of the other participants adds a remote camera into a conference. |
VidyoConnectorOnRemoteCameraRemoved | Callback that is triggered each time one of the other participants removes a remote camera from a conference. |
VidyoConnectorOnRemoteCameraStateUpdated | Callback that is triggered each time one of the other participants remote camera changes state in a conference. |
VidyoConnectorOnRemoteMicrophoneAdded | Callback that is triggered each time one of the other participants adds a remote microphone into a conference. |
VidyoConnectorOnRemoteMicrophoneRemoved | Callback that is triggered each time one of the other participants removes a remote microphone from a conference. |
VidyoConnectorOnRemoteMicrophoneStateUpdated | Callback that is triggered each time one of the other participants remote microphone changes state in a conference. |
VidyoConnectorOnRemoteWindowShareAdded | Callback that is triggered each time one of the other participants adds, or shares, a remote window into a conference. |
VidyoConnectorOnRemoteWindowShareRemoved | Callback that is triggered each time one of the other participants removes a remote window from a conference, or stops sharing it. |
VidyoConnectorOnRemoteWindowShareStateUpdated | Callback that is triggered each time one of the other participants remote window changes state in a conference. |
VidyoConnectorOnSuccess | Callback that is triggered when the connection is sucessfully established. |
VidyoConnectorOnWebProxyCredentialsRequest | Callback that is triggered when Web Proxy Server requires password. |
VidyoConnectorRecorderInCall | Callback that is triggered each time a recorder joins or leaves the call. |
VidyoConnectorAssign | Assigns one VidyoConnector object the value of another. |
VidyoConnectorAssignViewToLocalCamera | Assigns the view in which to show the preview from a local camera. |
VidyoConnectorAssignViewToRemoteCamera | Assigns the view in which to show the remote camera of one of the other participants. |
VidyoConnectorAssignViewToRemoteWindowShare | Shows a participant in a view. |
VidyoConnectorConnect | Connects to a live conference with the specified resourceId. |
VidyoConnectorConstruct | Constructs the VidyoConnector. |
VidyoConnectorConstructCopy | Constructs an VidyoConnector object as a copy of another. |
VidyoConnectorCycleCamera | Cycles camera selection to the next available camera. |
VidyoConnectorCycleMicrophone | Cycles microphone selection to the next available microphone. |
VidyoConnectorCycleSpeaker | Cycles speaker selection to the next available speaker. |
VidyoConnectorDestruct | Destructs an VidyoConnector object. |
VidyoConnectorDisable | Disables connector object, releases all devices as precursor to destruct. |
VidyoConnectorDisableDebug | |
VidyoConnectorDisconnect | Disconnects a live conference. |
VidyoConnectorEnableDebug | Enabled debug mode which will start debug logging and enable statistics. |
VidyoConnectorGetState | Retrieves the state of the VidyoConnector. |
VidyoConnectorGetStatsJson | Retrieves VidyoConnector statistics in JSON format. |
VidyoConnectorGetVersion | Retrieves version of the VidyoConnector library. |
VidyoConnectorHideView | Hides a view which is used for custom layout of sources. |
VidyoConnectorRegisterLocalCameraEventListener | Registers to get notified about local camera events. |
VidyoConnectorRegisterLocalMicrophoneEventListener | Registers to get notified about local microphone events. |
VidyoConnectorRegisterLocalMonitorEventListener | Registers to get notified about local monitor events. |
VidyoConnectorRegisterLocalSpeakerEventListener | Registers to get notified about local speaker events. |
VidyoConnectorRegisterLocalWindowShareEventListener | Registers to get notified about local shareable-window events. |
VidyoConnectorRegisterLogEventListener | Registers to get notified about log events. |
VidyoConnectorRegisterMessageEventListener | Registers to get notified about message events. |
VidyoConnectorRegisterNetworkInterfaceEventListener | Registers to get notified about network interface events. |
VidyoConnectorRegisterParticipantEventListener | Registers to get notified about participant events. |
VidyoConnectorRegisterRecoderInCallEventListener | Registers to get notified when a recorder joins or leaves the call. |
VidyoConnectorRegisterRemoteCameraEventListener | Registers to get notified about remote camera events. |
VidyoConnectorRegisterRemoteMicrophoneEventListener | Registers to get notified about remote microphone events. |
VidyoConnectorRegisterRemoteWindowShareEventListener | Registers to get notified about remote shreable-window events. |
VidyoConnectorRegisterResourceManagerEventListener | Registers to get notified about resource-management events. |
VidyoConnectorRegisterWebProxyEventListener | Registers to get notified about web proxy events. |
VidyoConnectorSelectDefaultCamera | Resets the camera selection to pick the Default camera. |
VidyoConnectorSelectDefaultMicrophone | Resets the microphone selection to pick the Default microphone. |
VidyoConnectorSelectDefaultNetworkInterfaceForMedia | Selects the default "any" network interface to be used for Media. |
VidyoConnectorSelectDefaultNetworkInterfaceForSignaling | Selects the default "any" network interface to be used for Signaling. |
VidyoConnectorSelectDefaultSpeaker | Resets the speaker selection to pick the Default speaker. |
VidyoConnectorSelectLocalCamera | Selects the local camera to use. |
VidyoConnectorSelectLocalMicrophone | Selects the local microphone to use. |
VidyoConnectorSelectLocalMonitor | Selects the local monitor to share in a conference. |
VidyoConnectorSelectLocalSpeaker | Selects the local speaker to use. |
VidyoConnectorSelectLocalWindowShare | Selects the local window to share in a conference. |
VidyoConnectorSelectNetworkInterfaceForMedia | Selects the network interface to be used for Media. |
VidyoConnectorSelectNetworkInterfaceForSignaling | Selects the network interface to be used for Signaling. |
VidyoConnectorSendChatMessage | Sends a message to all the other participants. |
VidyoConnectorSetCameraPrivacy | Sets the flag to show/hide the local camera. |
VidyoConnectorSetLocation | Sets the geographic location of the endpoint using the VidyoConnector. |
VidyoConnectorSetMicrophonePrivacy | Sets the flag to mute/unmute the microphone. |
VidyoConnectorSetMode | Sets the operating mode of the VidyoConnector. |
VidyoConnectorSetPreview [REPLACED BY VidyoConnectorShowPreview] | Sets the flag to show/hide the local camera preview. |
VidyoConnectorSetSpeakerPrivacy | Sets the flag to mute/unmute the speaker. |
VidyoConnectorSetViewAnimationSpeed | Sets the speed of transition animation for windows moving around inside the view. |
VidyoConnectorSetViewBackgroundColor | Set the background color of the view. |
VidyoConnectorSetWebProxyAddressCredentials | Sets web proxy server address and credentials. |
VidyoConnectorShowAudioMeters | Shows or hides the audio meters in the view. |
VidyoConnectorShowPreview | Sets the flag to show/hide the local camera preview. |
VidyoConnectorShowViewAt | Sets the position of the view every time it's changed on the screen. |
VidyoConnectorShowViewLabel | Shows or hides the label on the view which displays the participant name or preview. |
VidyoConnectorUnregisterLocalCameraEventListener | Unregisters local camera event notifications. |
VidyoConnectorUnregisterLocalMicrophoneEventListener | Unregisters local microphone event notifications. |
VidyoConnectorUnregisterLocalMonitorEventListener | Unregisters local monitor event notifications. |
VidyoConnectorUnregisterLocalSpeakerEventListener | Unregisters local speaker event notifications. |
VidyoConnectorUnregisterLocalWindowShareEventListener | Unregisters local window share event notifications. |
VidyoConnectorUnregisterLogEventListener | Unregisters log event notifications. |
VidyoConnectorUnregisterMessageEventListener | Unregisters message event notifications. |
VidyoConnectorUnregisterNetworkInterfaceEventListener | Unregisters network interface event notifications. |
VidyoConnectorUnregisterParticipantEventListener | Unregisters participant event notifications. |
VidyoConnectorUnregisterRecoderInCallEventListener | Unregisters recorder in call event notifications. |
VidyoConnectorUnregisterRemoteCameraEventListener | Unregisters remote camera event notifications. |
VidyoConnectorUnregisterRemoteMicrophoneEventListener | Unregisters remote microphone event notifications. |
VidyoConnectorUnregisterRemoteWindowShareEventListener | Unregisters remote window share event notifications. |
VidyoConnectorUnregisterResourceManagerEventListener | Unregisters resource manager event notifications. |
VidyoConnectorUnregisterWebProxyEventListener | Unregisters web proxy event notifications. |
VIDYO_CONNECTORDISCONNECTREASON_Disconnected | The user disconnected gracefully. |
VIDYO_CONNECTORDISCONNECTREASON_ConnectionLost | The transport connection was lost. |
VIDYO_CONNECTORDISCONNECTREASON_ConnectionTimeout | The signaling connection timed-out. |
VIDYO_CONNECTORDISCONNECTREASON_NoResponse | The service did not respond in a reasonable amount of time to a request by the user. |
VIDYO_CONNECTORDISCONNECTREASON_Terminated | The service closed the connection or otherwise terminated the login session. |
VIDYO_CONNECTORDISCONNECTREASON_MiscLocalError | A miscellaneous problem occurred with this client library. |
VIDYO_CONNECTORDISCONNECTREASON_MiscRemoteError | A miscellaneous problem occurred with the conferencing service. |
VIDYO_CONNECTORDISCONNECTREASON_MiscError | The connection was closed for some other miscellaneous reason. |
VIDYO_CONNECTORFAILREASON_ConnectionFailed | The destination could not be reached. |
VIDYO_CONNECTORFAILREASON_ConnectionLost | The transport connection was lost prior to completing the login procedure. |
VIDYO_CONNECTORFAILREASON_ConnectionTimeout | The signaling connection timed-out prior to completing the login procedure. |
VIDYO_CONNECTORFAILREASON_NoResponse | The service was successfully contacted, but the service ignored the user's request to log in or it did not answer in a reasonable amount of time. |
VIDYO_CONNECTORFAILREASON_Terminated | The service was successfully contacted, but the service closed the connection or it refused to continue processing the login request. |
VIDYO_CONNECTORFAILREASON_InvalidToken | The token that was provided is unknown to the service or unauthorized to log in. |
VIDYO_CONNECTORFAILREASON_UnableToCreateResource | The server was unable to create the resource. |
VIDYO_CONNECTORFAILREASON_NoResponseFromResource | The server did not respond in a reasonable amount of time to the request to connect to the resource. |
VIDYO_CONNECTORFAILREASON_InvalidResourceId | The resource ID was invalid. |
VIDYO_CONNECTORFAILREASON_ResourceFull | The resource is at full capacity, and it cannot accept additional members. |
VIDYO_CONNECTORFAILREASON_NotMember | The resource allows only certain users to enter, and the current user is not one of them. |
VIDYO_CONNECTORFAILREASON_Banned | The user has been banned from entering the resource. |
VIDYO_CONNECTORFAILREASON_MediaNotEnabled | The client could not enable media. |
VIDYO_CONNECTORFAILREASON_MediaFailed | An established media connection failed. |
VIDYO_CONNECTORFAILREASON_MiscLocalError | The server rejected the user's request to enter the resource, due to a miscellaneous problem with the request. |
VIDYO_CONNECTORFAILREASON_MiscRemoteError | The server rejected the user's request to enter the resource, due to a miscellaneous problem of its own. |
VIDYO_CONNECTORFAILREASON_MiscError | The login failed for some other miscellaneous reason. |
VIDYO_CONNECTORMODE_Default | The default operating mode. |
VIDYO_CONNECTORMODE_Foreground | Runs in the foreground. |
VIDYO_CONNECTORMODE_Background | Runs in the background. |
VIDYO_CONNECTORSTATE_Idle | Not ready to connect, no devices. |
VIDYO_CONNECTORSTATE_Ready | Ready to connect. |
VIDYO_CONNECTORSTATE_EstablishingConnection | Establishing a connection to the server. |
VIDYO_CONNECTORSTATE_FindingResource | Finding a resource. |
VIDYO_CONNECTORSTATE_ConnectingToResource | Connecting to a resource. |
VIDYO_CONNECTORSTATE_EnablingMedia | Enabling media. |
VIDYO_CONNECTORSTATE_Connected | Sucessfully connected. |
VIDYO_CONNECTORVIEWSTYLE_Default | The default style. |
VIDYO_CONNECTORVIEWSTYLE_Tiles | Participants are shown in sizes that best reflect their order of importance. |
VidyoConsoleLoggerGetBase |
id | LmiString | |
name | LmiString | |
handle | LmiString | |
nickname | LmiString | |
emails | LmiVector(VidyoContactProperty) | |
telephones | LmiVector(VidyoContactProperty) | |
groups | LmiVector(LmiString) | |
presenceState | VidyoContactPresenceState | |
presenceStatus | LmiString | |
publicationState | VidyoContactSubscriptionState | |
subscriptionState | VidyoContactSubscriptionState | |
photo | LmiString | |
timestamp | LmiTime |
VidyoContactPresenceState | Presence status codes. |
VidyoContactProperty | Contact Property that has value and metadata for fields. |
VidyoContactSubscriptionState | Describes the relationship between a contact publishing its contact information and a contact subscribing to that information. |
id | LmiString | |
name | LmiString | |
handle | LmiString | |
nickname | LmiString | |
emails | LmiVector(VidyoContactInfoProperty) | |
telephones | LmiVector(VidyoContactInfoProperty) | |
groups | LmiVector(LmiString) | |
photo | LmiString | |
timestamp | LmiTime |
VidyoContactInfoProperty | Contact Property that has value and metadata for fields. |
value | LmiString | |
types | LmiVector(LmiString) |
VIDYO_CONTACTPRESENCESTATE_Unavailable | Unavailable |
VIDYO_CONTACTPRESENCESTATE_DoNotDisturb | Do not disturb |
VIDYO_CONTACTPRESENCESTATE_ExtendedAway | Extended away |
VIDYO_CONTACTPRESENCESTATE_Away | Away |
VIDYO_CONTACTPRESENCESTATE_Available | Available |
VIDYO_CONTACTPRESENCESTATE_InterestedInChat | Interested in chat |
value | LmiString | |
types | LmiVector(LmiString) |
VIDYO_CONTACTSUBSCRIPTIONSTATE_Unavailable | The subscriber's state is unknown. |
VIDYO_CONTACTSUBSCRIPTIONSTATE_NotSubscribed | The subscriber is not currently subscribed to the publisher's information. No action is pending on the subscription state. |
VIDYO_CONTACTSUBSCRIPTIONSTATE_Preapproved | The subscriber has not subscribed to the publisher's information, however, the publisher has already granted permission to the subscriber. |
VIDYO_CONTACTSUBSCRIPTIONSTATE_AwaitingApproval | The subscriber has subscribed to the publisher's information and is waiting for the publisher to grant permission for the subscription. |
VIDYO_CONTACTSUBSCRIPTIONSTATE_Subscribed | The subscriber is currently subscribed to the publisher's information. |
id | LmiString | Unique ID of the device. |
name | LmiString | Name of the device. |
type | VidyoDeviceType | Type of the device. |
VidyoDeviceAudioSignalType | Sets the type of the auido signal which determines how it is processed such as noise suppression, echo cancellation etc. |
VidyoDeviceState | Operational state of a device. |
VidyoDeviceType | Device type. |
VidyoDeviceAssign | Assigns one VidyoDevice object the value of another. |
VidyoDeviceConstructCopy | Constructs an VidyoDevice object as a copy of another. |
VidyoDeviceDerivedEqual | Compare the values of two derived devices for equality. |
VidyoDeviceDestruct | Destruct an instance of VidyoDevice. This may block until there are no more threads running. |
VidyoDeviceGetId | Gets the device id. |
VidyoDeviceGetName | Gets the device name. |
VidyoDeviceGetType | Gets the device type. |
VIDYO_DEVICEAUDIOSIGNALTYPE_Voice | Default type which will do echo cancellation, noise suppresstion etc. |
VIDYO_DEVICEAUDIOSIGNALTYPE_Unprocessed | Does not alter audio singal by having all the audio processing disabled. |
VIDYO_DEVICESTATE_Added | The device was added to the system. |
VIDYO_DEVICESTATE_Removed | The device was removed from the system. |
VIDYO_DEVICESTATE_Started | The device started successfully. |
VIDYO_DEVICESTATE_Stopped | The device stopped. |
VIDYO_DEVICESTATE_Suspended | The device was suspended and the frames can no longer be captured. |
VIDYO_DEVICESTATE_Unsuspended | The device was unsuspended. |
VIDYO_DEVICESTATE_Paused | The device was paused (muted) and no media will be sent. |
VIDYO_DEVICESTATE_Resumed | The device was resumed (unmuted) and media will be sent. |
VIDYO_DEVICESTATE_Controllable | The device PTZ is controllable. |
VIDYO_DEVICESTATE_NotControllable | The device PTZ is not controllable. |
VIDYO_DEVICESTATE_DefaultChanged | The device default device has changed. |
VIDYO_DEVICESTATE_ConfigureSuccess | The device configured successfully. |
VIDYO_DEVICESTATE_ConfigureError | The device configuring failed. |
VIDYO_DEVICESTATE_Error | The device failed. |
VIDYO_DEVICETYPE_LocalCamera | local camera device. |
VIDYO_DEVICETYPE_LocalMicrophone | local microphone device. |
VIDYO_DEVICETYPE_LocalMonitor | local screen device. |
VIDYO_DEVICETYPE_LocalWindowShare | local application window device. |
VIDYO_DEVICETYPE_LocalSpeaker | local speaker device. |
VIDYO_DEVICETYPE_LocalRenderer | local renderer device. |
VIDYO_DEVICETYPE_RemoteCamera | remote camera device. |
VIDYO_DEVICETYPE_RemoteMicrophone | remote microphone device. |
VIDYO_DEVICETYPE_RemoteWindowShare | remote application window device. |
VIDYO_DEVICETYPE_RemoteSpeaker | remote speaker device. |
VIDYO_DEVICETYPE_RemoteRenderer | remote renderer device. |
VidyoEndpointLogCompressionResult | Result of file log compression. |
VidyoEndpointMediaState | |
VidyoEndpointMode | Operating modes of the VidyoEndpoint. |
VidyoEndpointTone |
VidyoEndpointOnLocalCameraAdded | Callback that is triggered each time a local camera becomes available to a VidyoEndpoint. |
VidyoEndpointOnLocalCameraRemoved | Callback that is triggered each time a local camera is no longer available to a VidyoEndpoint. |
VidyoEndpointOnLocalCameraSelected | Callback that is triggered each time there is a change in which local camera is selected for use. |
VidyoEndpointOnLocalCameraStateUpdated | Callback that is triggered each time there is a change in the state of the camera such as being suspended or disabled. |
VidyoEndpointOnLocalMicrophoneAdded | Callback that is triggered each time a local microphone becomes available to a VidyoEndpoint. |
VidyoEndpointOnLocalMicrophoneRemoved | Callback that is triggered each time a local microphone is no longer available to a VidyoEndpoint. |
VidyoEndpointOnLocalMicrophoneSelected | Callback that is triggered each time there is a change in which local microphone is selected for use. |
VidyoEndpointOnLocalMicrophoneStateUpdated | Callback that is triggered each time there is a change in the state of the microphone such as being suspended or disabled. |
VidyoEndpointOnLocalMonitorAdded | Callback that is triggered each time a local monitor becomes available to a VidyoEndpoint. |
VidyoEndpointOnLocalMonitorRemoved | Callback that is triggered each time a local monitor is no longer available to a VidyoEndpoint. |
VidyoEndpointOnLocalMonitorSelected | Callback that is triggered each time there is a change in which local monitor is selected for sharing. |
VidyoEndpointOnLocalMonitorStateUpdated | Callback that is triggered each time there is a change in the state of the monitor such as being suspended or disabled. |
VidyoEndpointOnLocalRendererAdded | |
VidyoEndpointOnLocalRendererRemoved | |
VidyoEndpointOnLocalRendererSelected | |
VidyoEndpointOnLocalRendererStateUpdated | |
VidyoEndpointOnLocalSpeakerAdded | Callback that is triggered each time a local speaker becomes available to a VidyoEndpoint. |
VidyoEndpointOnLocalSpeakerRemoved | Callback that is triggered each time a local speaker is no longer available to a VidyoEndpoint. |
VidyoEndpointOnLocalSpeakerSelected | Callback that is triggered each time there is a change in which local speaker is selected for use. |
VidyoEndpointOnLocalSpeakerStateUpdated | Callback that is triggered each time there is a change in the state of the speaker such as being suspended or disabled. |
VidyoEndpointOnLocalWindowShareAdded | Callback that is triggered each time a local window becomes available for a VidyoEndpoint to share in a conference. |
VidyoEndpointOnLocalWindowShareRemoved | Callback that is triggered each time a local window is no longer available for a VidyoEndpoint to share in a conference. |
VidyoEndpointOnLocalWindowShareSelected | Callback that is triggered each time there is a change in which local window is selected for sharing. |
VidyoEndpointOnLocalWindowShareStateUpdated | Callback that is triggered each time there is a change in the state of the window such as being suspended or disabled. |
VidyoEndpointOnLog | Callback that is triggered for every log record. |
VidyoEndpointOnLogCompressionComplete | Callback that is triggered when the file log compression completes. |
VidyoEndpointOnNetworkInterfaceAdded | Callback that is triggered each time a network interface is available to a VidyoEndpoint. |
VidyoEndpointOnNetworkInterfaceRemoved | Callback that is triggered each time a network interface is no longer available to a VidyoEndpoint. |
VidyoEndpointOnNetworkInterfaceSelected | Callback that is triggered each time there is a change in which network interface is selected for use. |
VidyoEndpointOnNetworkInterfaceStateUpdated | Callback that is triggered each time there is a change in the state of the network interface such as being up or down. |
VidyoEndpointOnRemoteCameraAdded | |
VidyoEndpointOnRemoteCameraRemoved | |
VidyoEndpointOnRemoteCameraStateUpdated | |
VidyoEndpointOnRemoteMicrophoneAdded | |
VidyoEndpointOnRemoteMicrophoneRemoved | |
VidyoEndpointOnRemoteMicrophoneStateUpdated | |
VidyoEndpointOnRemoteRendererAdded | |
VidyoEndpointOnRemoteRendererRemoved | |
VidyoEndpointOnRemoteSpeakerAdded | |
VidyoEndpointOnRemoteSpeakerRemoved | |
VidyoEndpointOnRemoteWindowShareAdded | |
VidyoEndpointOnRemoteWindowShareRemoved | |
VidyoEndpointOnRemoteWindowShareStateUpdated |
VIDYO_ENDPOINTLOGCOMPRESSIONRESULT_Success | File Compressed successfully. |
VIDYO_ENDPOINTLOGCOMPRESSIONRESULT_MiscError | The compression failed some miscellaneous reason. |
VIDYO_ENDPOINTMEDIASTATE_Idle | |
VIDYO_ENDPOINTMEDIASTATE_GreenRoom | |
VIDYO_ENDPOINTMEDIASTATE_Live |
VIDYO_ENDPOINTMODE_Default | The default operating mode. |
VIDYO_ENDPOINTMODE_Foreground | Runs in the foreground. |
VIDYO_ENDPOINTMODE_Background | Runs in the background. |
id | LmiString | Room ID. |
timeStamp | LmiString | Gregorian Timestamp when the stats were measured. |
applicationTag | LmiString | Tag set by the application. |
libraryVersion | LmiString | Version of the library. |
buildTag | LmiString | Tag from the build system. |
osName | LmiString | Name of the operating system. |
osVersion | LmiString | Version of the operating system. |
processorBrand | LmiString | CPU brand. |
processorModel | LmiString | CPU Model. |
processorSpeed | LmiUint | CPU frequency, in MHz. |
processorPhysicalCores | LmiUint | Number of physical cores in the CPU (ignoring hyperthreading). |
processorLogicalCores | LmiUint | Number of logical cores in the CPU (including hyperthreading). |
networkInterfaceStats | LmiVector(VidyoNetworkInterfaceStats) | Network interfaces on the endpoint. |
userStats | LmiVector(VidyoUserStats) | Vector of stats of users. |
localCameraStats | LmiVector(VidyoLocalVideoSourceStats) | Vector of stats of cameras. |
localMicrophoneStats | LmiVector(VidyoLocalMicrophoneStats) | Vector of stats of microphones. |
localSpeakerStats | LmiVector(VidyoLocalSpeakerStats) | Vector of stats of speakers. |
localRendererStats | LmiVector(VidyoLocalRendererStats) | Vector of stats of renderers. |
localWindowShareStats | LmiVector(VidyoLocalVideoSourceStats) | Vector of stats of window shares. |
localMonitorStats | LmiVector(VidyoLocalVideoSourceStats) | Vector of stats of monitors. |
VIDYO_ENDPOINTTONE_Join | |
VIDYO_ENDPOINTTONE_Leave | |
VIDYO_ENDPOINTTONE_MsgRecv | |
VIDYO_ENDPOINTTONE_MsgSend | |
VIDYO_ENDPOINTTONE_Ring | |
VIDYO_ENDPOINTTONE_Max |
type | VidyoFormFieldType | Type that corresponds to the HTML form input fields that can be used to display and collect user data |
name | LmiString | Label used to uniquely identify the input field for this element |
value | LmiString | Default value to display in the input field if this struct is returned to the application, or a collected user input if this structure is passed back as a method argument |
size | LmiUint | Number of characters for the value |
maxlength | LmiUint | Maximum number of characters allowed for the input field |
rows | LmiUint | For a textarea input field, the number of rows the field should show |
cols | LmiUint | For a textarea input field, the number of columns the field should show |
multiple | LmiBool | For a select drop-down input field, whether multiple selections are allowed |
wrap | VidyoFormFieldTextWrapMode | For a textarea input field, how linebreaks should be handled |
options | LmiVector(VidyoFormFieldOption) | For a select drop-down input field, a list of the options and their selection status |
value | LmiString | String value representing the option text label |
selected | LmiBool | Indicates whether the option was selected or not |
VIDYO_FORMFIELDTEXTWRAPMODE_Off | No wrapping |
VIDYO_FORMFIELDTEXTWRAPMODE_Virtual | Shows linebreaks, but sends text as entered |
VIDYO_FORMFIELDTEXTWRAPMODE_Physical | Inserts linebreaks as needed and sends text with them. |
VIDYO_FORMFIELDTYPE_Text | HTML form field type for a text input. |
VIDYO_FORMFIELDTYPE_TextArea | HTML form field type for a textarea input. |
VIDYO_FORMFIELDTYPE_Password | HTML form field type for a password input. |
VIDYO_FORMFIELDTYPE_Checkbox | HTML form field type for a checkbox input. |
VIDYO_FORMFIELDTYPE_Radio | HTML form field type for a radio input. |
VIDYO_FORMFIELDTYPE_Select | HTML form field type for a dropdown select input. |
VidyoGatewayDisconnectReason | Reasons why an established connection was disconnected. |
VidyoGatewayFailReason | Reasons why a connection attempt failed. |
VidyoGatewayState | States of the VidyoGateway. |
VidyoGatewayOnDisconnected | Callback that is triggered when an established connection is disconnected. |
VidyoGatewayOnFailure | Callback that is triggered when the connection establishemnt failed. |
VidyoGatewayOnSuccess | Callback that is triggered when the connection is sucessfully established. |
VidyoGatewayAssign | Assigns one VidyoGateway object the value of another. |
VidyoGatewayConnect | Connects to a gateway to a live conference with the specified resourceId. |
VidyoGatewayConstructCopy | Constructs an VidyoGateway object as a copy of another. |
VidyoGatewayDestruct | Destruct an instance of VidyoGateway. This may block until there are no more threads running. |
VidyoGatewayDisconnect | Disconnects a live gateway call. |
VidyoGatewayInitialize | Initialize the VidyoGateway library. |
VidyoGatewayUninitialize | Uninitialize the VidyoGateway library. |
VIDYO_GATEWAYDISCONNECTREASON_Disconnected | The user disconnected gracefully. |
VIDYO_GATEWAYDISCONNECTREASON_ConnectionLost | The transport connection was lost. |
VIDYO_GATEWAYDISCONNECTREASON_ConnectionTimeout | The signaling connection timed-out. |
VIDYO_GATEWAYDISCONNECTREASON_NoResponse | The service did not respond in a reasonable amount of time to a request by the user. |
VIDYO_GATEWAYDISCONNECTREASON_Terminated | The service closed the connection or otherwise terminated the login session. |
VIDYO_GATEWAYDISCONNECTREASON_MiscLocalError | A miscellaneous problem occurred with this client library. |
VIDYO_GATEWAYDISCONNECTREASON_MiscRemoteError | A miscellaneous problem occurred with the conferencing service. |
VIDYO_GATEWAYDISCONNECTREASON_MiscError | The connection was closed for some other miscellaneous reason. |
VIDYO_GATEWAYFAILREASON_ConnectionFailed | The destination could not be reached. |
VIDYO_GATEWAYFAILREASON_ConnectionLost | The transport connection was lost prior to completing the login procedure. |
VIDYO_GATEWAYFAILREASON_ConnectionTimeout | The signaling connection timed-out prior to completing the login procedure. |
VIDYO_GATEWAYFAILREASON_NoResponse | The service was successfully contacted, but the service ignored the user's request to log in or it did not answer in a reasonable amount of time. |
VIDYO_GATEWAYFAILREASON_Terminated | The service was successfully contacted, but the service closed the connection or it refused to continue processing the login request. |
VIDYO_GATEWAYFAILREASON_InvalidToken | The token that was provided is unknown to the service or unauthorized to log in. |
VIDYO_GATEWAYFAILREASON_UnableToCreateResource | The server was unable to create the resource. |
VIDYO_GATEWAYFAILREASON_NoResponseFromResource | The server did not respond in a reasonable amount of time to the request to connect to the resource. |
VIDYO_GATEWAYFAILREASON_InvalidResourceId | The resource ID was invalid. |
VIDYO_GATEWAYFAILREASON_ResourceFull | The resource is at full capacity, and it cannot accept additional members. |
VIDYO_GATEWAYFAILREASON_NotMember | The resource allows only certain users to enter, and the current user is not one of them. |
VIDYO_GATEWAYFAILREASON_Banned | The user has been banned from entering the resource. |
VIDYO_GATEWAYFAILREASON_MediaNotEnabled | The client could not enable media. |
VIDYO_GATEWAYFAILREASON_MediaFailed | An established media connection failed. |
VIDYO_GATEWAYFAILREASON_MiscLocalError | The server rejected the user's request to enter the resource, due to a miscellaneous problem with the request. |
VIDYO_GATEWAYFAILREASON_MiscRemoteError | The server rejected the user's request to enter the resource, due to a miscellaneous problem of its own. |
VIDYO_GATEWAYFAILREASON_MiscError | The login failed for some other miscellaneous reason. |
VIDYO_GATEWAYSTATE_Idle | Ready to connect. |
VIDYO_GATEWAYSTATE_EstablishingConnection | Establishing a connection to the server. |
VIDYO_GATEWAYSTATE_FindingResource | Finding a resource. |
VIDYO_GATEWAYSTATE_ConnectingToResource | Connecting to a resource. |
VIDYO_GATEWAYSTATE_EnablingMedia | Enabling media. |
VIDYO_GATEWAYSTATE_Connected | Sucessfully connected. |
participant | VidyoParticipant | |
newIndex | LmiInt | |
oldIndex | LmiInt |
id | LmiString | Unique ID. |
name | LmiString | Name. |
VidyoLocalCameraPosition | Position of the camera. |
VIDYO_LOCALCAMERAPOSITION_Unknown | Position is unknown. |
VIDYO_LOCALCAMERAPOSITION_Front | Facing towards the screen. |
VIDYO_LOCALCAMERAPOSITION_Back | Facing away from the screen. |
id | LmiString | Unique ID. |
name | LmiString | Name. |
name | LmiString | Name. |
id | LmiString | Id. |
sampleRateSet | LmiUint | Sample rate setting. |
sampleRateMeasured | LmiUint | Measured sample rate. |
bitsPerSample | LmiUint | Bits per sample. |
numberOfChannels | LmiUint | Number of channels. |
format | VidyoMediaFormat | Format. |
aecEchoCoupling | LmiUint | AEC echo coupling. |
agcAverageGain | LmiUint | AGC average gain. |
noiseSuppressionSnr | LmiUint | Noise suppression SNR. |
localSpeakerStreams | LmiVector(VidyoLocalSpeakerStreamStats) | Vector of stats of local speaker streams. |
remoteSpeakerStreams | LmiVector(VidyoRemoteSpeakerStreamStats) | Vector of stats of remote speaker streams. |
id | LmiString | Unique ID. |
name | LmiString | Name. |
VidyoLocalMonitorState | State of the monitor. |
VidyoLocalMonitorOnPreviewDataUriComplete |
VidyoLocalMonitorAddToLocalRenderer | |
VidyoLocalMonitorAddToRemoteRenderer | |
VidyoLocalMonitorClearConstraints | |
VidyoLocalMonitorConstructCopy | Constructs an VidyoLocalMonitor object as a copy of another. |
VidyoLocalMonitorDestruct | Destructs an VidyoLocalMonitor object. |
VidyoLocalMonitorGetId | Gets the unique ID of the monitor. |
VidyoLocalMonitorGetName | Gets the name of the monitor. |
VidyoLocalMonitorGetPreviewFrameDataUri | |
VidyoLocalMonitorGetPreviewFrameDataUriAsync | |
VidyoLocalMonitorPrecludeWindow | |
VidyoLocalMonitorRemoveFromLocalRenderer | |
VidyoLocalMonitorRemoveFromRemoteRenderer | |
VidyoLocalMonitorSetBoundsConstraints | |
VidyoLocalMonitorSetCaptureInterval | |
VidyoLocalMonitorSetDiscrerteConstraints |
VIDYO_LOCALMONITORSTATE_Ok | The monitor is visible and has been fully captured. |
VIDYO_LOCALMONITORSTATE_NotVisible | The monitor exists but is not "visible". |
VIDYO_LOCALMONITORSTATE_MiscError | Miscellaneous error has occured trying to capture the frame. |
id | LmiString | |
name | LmiString |
VidyoLocalRendererViewStyle | Styles of the composite renderer, which apply to its layout and behaviour. |
VidyoLocalRendererConstructCopy | Constructs an VidyoLocalRenderer object as a copy of another. |
VidyoLocalRendererDestruct | Destructs an VidyoLocalRenderer object. |
VidyoLocalRendererGetId | |
VidyoLocalRendererGetName | |
VidyoLocalRendererIsPaused | |
VidyoLocalRendererPause | |
VidyoLocalRendererResume | |
VidyoLocalRendererSetMaxStreams | Sets the maximum number of streams that can be displayed in the renderer. |
VidyoLocalRendererSetPosition |
name | LmiString | Name. |
id | LmiString | Id. |
width | LmiSizeT | Width. |
height | LmiSizeT | Height. |
frameIntervalSet | LmiTime | Frame interval setting. |
frameIntervalMeasured | LmiTime | Frame interval measured by the renderer. |
totalFrames | LmiUint | Total frames rendered. |
totalPixels | LmiUint | Total pixels rendered. |
format | VidyoMediaFormat | Format. |
name | LmiString | Name. |
id | LmiString | Id. |
width | LmiSizeT | Width. |
height | LmiSizeT | Height. |
bufferSize | LmiUint | Size of video buffer. |
bufferDropped | LmiUint | Dropped frames from video buffer. |
VIDYO_LOCALRENDERERVIEWSTYLE_Default | The default style. |
VIDYO_LOCALRENDERERVIEWSTYLE_Tiles | Participants are shown in sizes that best reflect their order of importance. |
id | LmiString | Unique ID. |
name | LmiString | Name. |
VidyoLocalSpeakerConstructCopy | Constructs an VidyoLocalSpeaker object as a copy of another. |
VidyoLocalSpeakerDestruct | Destructs an VidyoLocalSpeaker object. |
VidyoLocalSpeakerGetId | Gets the unique ID of the speaker. |
VidyoLocalSpeakerGetName | Gets the name of the speaker. |
VidyoLocalSpeakerGetVolume | |
VidyoLocalSpeakerIsPaused | |
VidyoLocalSpeakerPause | |
VidyoLocalSpeakerPlayTone | |
VidyoLocalSpeakerResume | |
VidyoLocalSpeakerSetVolume | |
VidyoLocalSpeakerStopSound |
name | LmiString | Name. |
id | LmiString | Id. |
sampleRateSet | LmiUint | Sample rate setting. |
sampleRateMeasured | LmiUint | Sample rate measured. |
bitsPerSample | LmiUint | Bits per sample. |
numberOfChannels | LmiUint | Number of channels. |
format | VidyoMediaFormat | Audio format. |
name | LmiString | Name. |
sampleRate | LmiUint | Sample rate. |
bitsPerSample | LmiUint | Bits per sample. |
numberOfChannels | LmiUint | Number of channels. |
format | VidyoMediaFormat | Audio format. |
delay | LmiTime | Audio delay in the stream jitter buffer. |
lowestThreshold | LmiTime | Lowest threshold of stream jitter buffer under which the stream will be agressively padded to get into the proper range. |
lowThreshold | LmiTime | Low threshold of stream jitter buffer under which the stream will be gently padded to get into the proper range. |
highThreshold | LmiTime | High threshold of stream jitter buffer over which the stream will be gently pared down to get into the proper range. |
highestThreshold | LmiTime | Highest threshold of stream jitter buffer over which the stream will be agressively pared down to get into the proper range. |
maxThreshold | LmiTime | Maximum threshold of stream jitter buffer over which the stream will be agressively pared down by dropping non-speech frames to get into the proper range. |
played | LmiTime | Ammount of audio played by the stream. |
underrun | LmiTime | Ammount of time stream was in the empty but active state. |
overrun | LmiTime | Ammount of time stream was over the maxThreshold. |
lastPlayed | LmiTime | Last time audio was played from the stream. |
lastEnergy | LmiInt | Last energy in dBFS of the stream. |
name | LmiString | Name. |
id | LmiString | Id. |
width | LmiSizeT | Width. |
height | LmiSizeT | Height. |
frameIntervalSet | LmiTime | Frame interval setting. |
frameIntervalMeasured | LmiTime | Frame interval measured between last 2 frames. |
totalFrames | LmiUint | Total frames. |
format | VidyoMediaFormat | Format. |
localRendererStreams | LmiVector(VidyoLocalRendererStreamStats) | Vector of stats of local renderer streams. |
remoteRendererStreams | LmiVector(VidyoRemoteRendererStreamStats) | Vector of stats of remote renderer streams. |
id | LmiString | Unique ID. |
name | LmiString | Name of the window share. |
applicationName | LmiString | Name of the application which owns the window. |
VidyoLocalWindowShareState | State of the window share. |
VidyoLocalWindowShareOnApplicationIconDataUriComplete | |
VidyoLocalWindowShareOnPreviewDataUriComplete |
VIDYO_LOCALWINDOWSHARESTATE_Ok | The window is visible and has been fully captured. |
VIDYO_LOCALWINDOWSHARESTATE_NotVisible | The window exists but is not "visible". |
VIDYO_LOCALWINDOWSHARESTATE_Minimized | The window is minimized and "visible" but its content may not be accessible. |
VIDYO_LOCALWINDOWSHARESTATE_Closed | The window is closed and is no longer accessible. |
VIDYO_LOCALWINDOWSHARESTATE_MiscError | Miscellaneous error has occured trying to capture the frame. |
VIDYO_LOGLEVEL_FATAL | The event being logged describes a fatal error. In all likelihood system execution will not be able to continue. |
VIDYO_LOGLEVEL_ERROR | The event being logged describes a continuable error. The system should be able to continue, but human intervention or diagnosis may be necessary. |
VIDYO_LOGLEVEL_WARNING | The event being logged describes a warning. Something has occurred which may require attention or action, but which is not actually erroneous. |
VIDYO_LOGLEVEL_INFO | The event being logged describes information which may be useful or informative to a user of the system. No problems are being reported. |
VIDYO_LOGLEVEL_DEBUG | The event being logged describes information which may be useful to a developer to understand the code. The information is not expected to be useful to users of the system. |
VIDYO_LOGLEVEL_SENT | The event being logged describes data that has been transmitted by the system. |
VIDYO_LOGLEVEL_RECEIVED | The event being logged describes data that has been received by the system. |
VIDYO_LOGLEVEL_ENTER | The event being logged describes the system entering a function. |
VIDYO_LOGLEVEL_LEAVE | The event being logged describes the system leaving from a function. |
VIDYO_LOGLEVEL_INVALID | A value that does not represent a valid log level. This value is returned by LmiLogGetLevelByName and LmiLogGetLevelByIndex on invalid input. |
level | VidyoLogLevel | |
categoryName | LmiSizeT | |
name | const char* | |
file | const char * | |
line | LmiInt | |
functionName | const char * | |
message | const char * | |
threadName | const char * | |
eventTime | LmiTime |
VidyoLogLevel | An identifier for the level, or type, of a logged event. This indicates the degree of significance of the event. |
VidyoCachedLogger | |
VidyoConsoleLogger | |
VidyoFeedbackLogger | |
VidyoFileLogger | |
VidyoHttpLogger | |
VidyoLoggerCategory |
connectionId | LmiUint | Connection ID. |
componentType | LmiString | Transport component type. |
connectionType | LmiString | Transport connection type. |
internalLocalAddr | LmiString | Internal local address. |
internalRemoteAddr | LmiString | Internal remote address. |
externalLocalAddr | LmiString | External local address. |
externalRemoteAddr | LmiString | External remote address. |
interfaceName | LmiString | Interface name. |
interfaceType | LmiString | Interface type. |
addressType | LmiString | Address type. |
transportPlugIn | LmiString | Transport plugin. |
VIDYO_MEDIAFORMAT_IN16 | |
VIDYO_MEDIAFORMAT_FL32 | |
VIDYO_MEDIAFORMAT_NULL | |
VIDYO_MEDIAFORMAT_WPCM | |
VIDYO_MEDIAFORMAT_I420 | |
VIDYO_MEDIAFORMAT_YU12 | |
VIDYO_MEDIAFORMAT_YUYV | |
VIDYO_MEDIAFORMAT_YUY2 | |
VIDYO_MEDIAFORMAT_yuvs | |
VIDYO_MEDIAFORMAT_2vuy | |
VIDYO_MEDIAFORMAT_UYVY | |
VIDYO_MEDIAFORMAT_HDYC | |
VIDYO_MEDIAFORMAT_yuv2 | |
VIDYO_MEDIAFORMAT_yuvu | |
VIDYO_MEDIAFORMAT_NV12 | |
VIDYO_MEDIAFORMAT_NV21 | |
VIDYO_MEDIAFORMAT_24BG | |
VIDYO_MEDIAFORMAT_raw | |
VIDYO_MEDIAFORMAT_BGRA | |
VIDYO_MEDIAFORMAT_RGBA | |
VIDYO_MEDIAFORMAT_ARGB | |
VIDYO_MEDIAFORMAT_BYR1 | |
VIDYO_MEDIAFORMAT_BYR2 | |
VIDYO_MEDIAFORMAT_JPEG | |
VIDYO_MEDIAFORMAT_MJPG | |
VIDYO_MEDIAFORMAT_dmb1 | |
VIDYO_MEDIAFORMAT_dvsd | |
VIDYO_MEDIAFORMAT_dvhd | |
VIDYO_MEDIAFORMAT_dvsl | |
VIDYO_MEDIAFORMAT_dv25 | |
VIDYO_MEDIAFORMAT_dv50 | |
VIDYO_MEDIAFORMAT_dvh1 | |
VIDYO_MEDIAFORMAT_dv | |
VIDYO_MEDIAFORMAT_M420 | |
VIDYO_MEDIAFORMAT_420f | |
VIDYO_MEDIAFORMAT_420v | |
VIDYO_MEDIAFORMAT_Y8 |
id | LmiString | Unique id that identifies a conference meeting at the service which the meeting is created through. |
type | VidyoMeetingType | Type of meeting. See definition of VidyoMeetingType for possible values |
startDateTime | LmiString | Date and time that the meeting is scheduled for |
endDateTime | LmiString | Date and time that the meeting is scheduled for |
subject | LmiString | Subject for the meeting. |
location | LmiString | Subject for the meeting. |
ownerName | LmiString | Owner name for the meeting. |
ownerEmail | LmiString | Email for owner the meeting. |
vidyoMeetingRoomId | LmiString | Contains key information (URL, Room JID, etc) for the Vidyo room that the meeting is being held in if the meeting type is VIDYO_MEETINGTYPE_Vidyo. Otherwise it contains an empty string. |
body | LmiString | Body contents for the meeting. |
VidyoMeetingFeedback | Interface for registering callbacks that notify an application about events on the VidyoMeeting object. Multiple feedbacks can be registered on the same VidyoMeeting. |
VidyoMeetingAddAttendee |
Adds an attendee to the meeting Triggers callback(s): VidyoMeetingFeedbackAttendeeAdded |
VidyoMeetingConstructCopy | Constructs an VidyoMeeting object as a copy of another. |
VidyoMeetingDestruct | Destructs an VidyoMeeting object. |
VidyoMeetingGetAttendees |
Retrieve all attendees for the meeting |
VidyoMeetingGetAttendeesByRole |
Retrieve all attendees for the meeting |
VidyoMeetingGetBody | Retrieve up to 2K bytes of body data from a Vidyo meeting |
VidyoMeetingGetEndDateTime | |
VidyoMeetingGetId | |
VidyoMeetingGetLocation | |
VidyoMeetingGetOwnerEmail | |
VidyoMeetingGetOwnerName | |
VidyoMeetingGetStartDateTime | |
VidyoMeetingGetSubject | |
VidyoMeetingGetType | |
VidyoMeetingGetVidyoMeetingRoomId | |
VidyoMeetingRemoveAttendee |
Removes an attendee from the meeting Triggers callback(s): VidyoMeetingFeedbackAttendeeRemoved |
VidyoMeetingRespondToInvite |
Respond to a meeting invite |
VidyoMeetingRetrieveBody | To retrieve entire body from a Vidyo meeting |
VIDYO_MEETINGACTIONRESULT_OK | The meeting was created successfully. |
VIDYO_MEETINGACTIONRESULT_NoResponse | The calendar resource did not respond in a reasonable amount of time for the intended action. |
VIDYO_MEETINGACTIONRESULT_Unauthorized | The user is not allowed to create a meeting. |
VIDYO_MEETINGACTIONRESULT_RemovedByLocalUser | Meeting was removedby the local user. |
VIDYO_MEETINGACTIONRESULT_RemovedByRemoteUser | Meeting was removed by the remote user.. |
VIDYO_MEETINGACTIONRESULT_MiscLocalError | The server is rejecting the request to perform an action on the meeting due to some miscellaneous problem with the request. |
VIDYO_MEETINGACTIONRESULT_MiscRemoteError | The server is rejecting the request to perform an action on the meeting due to some miscellaneous problem of its own. |
name | LmiString | Attendee name as held by the underlying calendar service |
LmiString | Email for attendee. | |
role | VidyoAttendeeParticipationRole | Role for the attendee as defined by the roleparam specified in RFC 5545 |
status | VidyoAttendeeParticipationStatus | Participation status of the attendee for the meeting as specified by the STATUS property name specified in RFC 5545 |
VidyoAttendeeParticipationRole |
This indicates the role of the local user in a meeting. Maps directly to participation roles defined in IETF RFC 5545. |
VidyoAttendeeParticipationStatus |
This indicates the role of the local user in a meeting. Maps directly to participation statuses defined in IETF RFC 5545. |
VidyoMeetingFeedbackMeetingAttendeeAdded |
Indicates that an attendee was added to the meeting. Triggered by: VidyoMeetingAddAttendee or from addition by a remote user |
VidyoMeetingFeedbackMeetingAttendeeRemoved |
Indicates that an attendee was removed from the meeting. Triggered by: VidyoMeetingRemoveAttendee or from addition by a remote user |
VidyoMeetingFeedbackConstruct | |
VidyoMeetingFeedbackDestruct | Destructs an VidyoMeetingFeedback object. |
VIDYO_MEETINGSEARCHRESULT_OK | The search operation was successful. |
VIDYO_MEETINGSEARCHRESULT_NoRecords | No records found for the search. |
VIDYO_MEETINGSEARCHRESULT_NoResponse | The search result failed due to request timeout. |
VIDYO_MEETINGSEARCHRESULT_MiscLocalError | The search result failed due to some miscellaneous local problem. |
VIDYO_MEETINGSEARCHRESULT_MiscRemoteError | The search result failed due to some miscellaneous remote problem. |
VIDYO_MEETINGTYPE_Vidyo | A meeting containing Vidyo specific invite information. |
VIDYO_MEETINGTYPE_Standard | Standard meeting - not Vidyo specific. |
name | LmiString | The name of the interface. |
type | VidyoNetworkInterfaceType | The type of the interface. |
address | LmiString | The address of the interface. |
state | VidyoNetworkInterfaceState | The state of the interface. |
family | VidyoNetworkInterfaceFamily | The family of the interface. |
VidyoNetworkInterfaceFamily | The family of a network interface. |
VidyoNetworkInterfaceState | The state of a network interface. |
VidyoNetworkInterfaceTransportType | The trasport type used over the network interface. |
VidyoNetworkInterfaceType | The connection type of a network interface. |
VidyoNetworkInterfaceConstructCopy | Constructs an VidyoNetworkInterface object as a copy of an existing object. |
VidyoNetworkInterfaceDestruct | Destructs an VidyoNetworkInterface object. |
VidyoNetworkInterfaceGetAddress | Gets the address of the network interface. |
VidyoNetworkInterfaceGetFamily | Gets the family of the network interface. |
VidyoNetworkInterfaceGetName | Gets the name of the network interface. |
VidyoNetworkInterfaceGetState | Gets the state of the network interface. |
VidyoNetworkInterfaceGetType | Gets the type of the network interface. |
VIDYO_NETWORKINTERFACEFAMILY_Unspecified | The interface state is unknown. |
VIDYO_NETWORKINTERFACEFAMILY_IPV4 | The interface IPV4. |
VIDYO_NETWORKINTERFACEFAMILY_IPV6 | The interface is IPV6. |
VIDYO_NETWORKINTERFACESTATE_Unknown | The interface state is unknown. |
VIDYO_NETWORKINTERFACESTATE_Up | The interface is up. |
VIDYO_NETWORKINTERFACESTATE_Down | The interface is down. |
name | LmiString | Interface name. |
type | LmiString | Interface type such as wifi or wired. |
isUp | LmiBool | State of the interface. |
VIDYO_NETWORKINTERFACETRANSPORTTYPE_Signaling | The interface is used for signaling. |
VIDYO_NETWORKINTERFACETRANSPORTTYPE_Media | The interface is used fro Media. |
VIDYO_NETWORKINTERFACETRANSPORTTYPE_Data | The interface is used fro Data. |
VIDYO_NETWORKINTERFACETYPE_Wired | A wired interface. |
VIDYO_NETWORKINTERFACETYPE_WiFi | A Wi-Fi (802.11) interface. |
VIDYO_NETWORKINTERFACETYPE_Wwan | A WWAN (cellular data) interface. |
VIDYO_NETWORKINTERFACETYPE_Loopback | A loopback interface. |
VIDYO_NETWORKINTERFACETYPE_Tunneled | A tunneled interface. |
VIDYO_NETWORKINTERFACETYPE_Other | Some other type of interface, not one of the above. |
VIDYO_NETWORKINTERFACETYPE_NotApplicable | Network interface type is not applicable in this context. |
name | LmiString | Display name of the participant. |
id | LmiString | ID that is unique to the room or call only. |
userId | LmiString | ID that is globally unique such as user@domain. |
VidyoParticipantConstructCopy | Constructs an VidyoParticipant object as a copy of another. |
VidyoParticipantDestruct | Destructs an VidyoParticipant object. |
VidyoParticipantGetContact | |
VidyoParticipantGetId | Gets the ID that is unique to the room or call only. |
VidyoParticipantGetName | Gets the display name of the participant. |
VidyoParticipantGetUserId | Gets the ID that is globally unique such as user@domain. |
VidyoParticipantIsHidden | Gets the hidden state of the participant. |
VidyoParticipantIsLocal | |
VidyoParticipantIsRecording | Gets the recording state of the participant. |
VidyoParticipantIsSelectable | Gets the selectable state of the participant. |
name | LmiString | Participant name. |
id | LmiString | Participant id. |
cameraName | LmiString | Camera name. |
cameraId | LmiString | Camera id. |
width | LmiSizeT | Width. |
height | LmiSizeT | Height. |
frameInterval | LmiTime | Frame interval setting. |
pixelRate | LmiUint64 | Pixel rate to ask for. |
enabled | LmiBool | State of the generation. |
name | LmiString | Current CPU usage. |
id | LmiString | Participant ID. |
userId | LmiString | ID assosicated with the VidyoUser of that participant. |
remoteCameraStats | LmiVector(VidyoRemoteVideoSourceStats) | Vector of stats of cameras. |
remoteMicrophoneStats | LmiVector(VidyoRemoteMicrophoneStats) | Vector of stats of microphones. |
remoteWindowShareStats | LmiVector(VidyoRemoteVideoSourceStats) | Vector of stats of speakers. |
delayNormal | LmiUint | Normal delay. |
packetsNormal | LmiUint | Normal packets. |
dropNormal | LmiUint | Dropped normal. |
delayRetransmit | LmiUint | Retransmit delay. |
packetsRetransmit | LmiUint | Retransmitted packets. |
id | LmiString | Unique ID. |
name | LmiString | Name. |
VidyoRemoteCameraMode | |
VidyoRemoteCameraPosition | Position of the camera. |
VidyoRemoteCameraAddToLocalRenderer | |
VidyoRemoteCameraConstructCopy | Constructs an VidyoRemoteCamera object as a copy of another. |
VidyoRemoteCameraControlPTZ | Send the PTZ Nudge commands to the remote camera. |
VidyoRemoteCameraDestruct | Destructs an VidyoRemoteCamera object. |
VidyoRemoteCameraGetId | Gets the unique ID of the camera. |
VidyoRemoteCameraGetLocalRenderingStreamId | |
VidyoRemoteCameraGetName | Gets the name of the camera. |
VidyoRemoteCameraGetPosition | Gets the position of the camera. |
VidyoRemoteCameraIsControllable | Checks if the remote camera is controllable. |
VidyoRemoteCameraRemoveFromLocalRenderer | |
VidyoRemoteCameraSetPositionInLocalRenderer | |
VidyoRemoteCameraShowCameraControl | Shows camera control when rendering remote camera. |
VIDYO_REMOTECAMERAMODE_Dynamic | |
VIDYO_REMOTECAMERAMODE_Static |
VIDYO_REMOTECAMERAPOSITION_Unknown | Position is unknown. |
VIDYO_REMOTECAMERAPOSITION_Front | Facing towards the screen. |
VIDYO_REMOTECAMERAPOSITION_Back | Facing away from the screen. |
id | LmiString | Unique ID. |
name | LmiString | Name. |
signalType | VidyoDeviceAudioSignalType | Signal Type. |
VidyoRemoteMicrophoneMode |
VidyoRemoteMicrophoneAddToLocalSpeaker | |
VidyoRemoteMicrophoneConstructCopy | Constructs an VidyoRemoteMicrophone object as a copy of another. |
VidyoRemoteMicrophoneDestruct | Destructs an VidyoRemoteMicrophone object. |
VidyoRemoteMicrophoneGetId | Gets the unique ID of the microphone. |
VidyoRemoteMicrophoneGetName | Gets the name of the microphone. |
VidyoRemoteMicrophoneGetSignalType | Gets signal type of the microphone, which affects how the audio is processed. |
VidyoRemoteMicrophoneRemoveFromLocalSpeaker |
VIDYO_REMOTEMICROPHONEMODE_Dynamic | |
VIDYO_REMOTEMICROPHONEMODE_Static |
name | LmiString | Name. |
id | LmiString | Id. |
sampleRateSet | LmiUint | Sample rate setting. |
sampleRateMeasured | LmiUint | Measured sample rate. |
bitsPerSample | LmiUint | Bits per sample. |
numberOfChannels | LmiUint | Number of channels. |
codecName | LmiString | Codec name. |
codecQualitySetting | LmiUint | Codec quality setting. |
codecDtx | LmiUint | Codec DTX. |
receiveNetworkBitRate | LmiSizeT | Bandwidth of receive network. |
receiveNetworkJitter | LmiUint | Jitter in receive network. |
receiveNetworkDroppedPackets | LmiUint | Dropped packets in receive network. |
receiveNetworkDelay | LmiTime | Delay in receive netowrk. |
localSpeakerStreams | LmiVector(VidyoLocalSpeakerStreamStats) | Vector of stats of local speaker streams. |
id | LmiString | |
name | LmiString |
VidyoRemoteRendererConstructCopy | Constructs an VidyoRemoteRenderer object as a copy of another. |
VidyoRemoteRendererDestruct | Destructs an VidyoRemoteRenderer object. |
VidyoRemoteRendererGetId | |
VidyoRemoteRendererGetName |
name | LmiString | Name. |
width | LmiSizeT | Width determined by the operating point. |
height | LmiSizeT | Height determined by the operating point. |
fps | LmiUint | Frame rate determined by the operating point. |
fpsInput | LmiUint | Frame rate at encoder input. |
fpsSent | LmiUint | Frame rate at the encoder output. |
framesDropped | LmiSizeT | Number of frames dropped due to overconstraint or resizing errors. |
lastWidth | LmiSizeT | Width of the last frame received from the capturing device. |
lastHeight | LmiSizeT | Height of the last frame received from the capturing device. |
codecName | LmiString | Codec name. |
codecIFrames | LmiUint | Codec I frames. |
codecFir | LmiUint | Codec FIR. |
codecNacks | LmiUint | Codec nacks. |
codecLayers | LmiUint | Codec layers. |
sendNetworkBitRate | LmiUint | Send bitrate. |
sendNetworkRtt | LmiTime | Round trip time of send network. |
VidyoRemoteSpeakerConstructCopy | Constructs an VidyoRemoteSpeaker object as a copy of another. |
VidyoRemoteSpeakerDestruct | Destructs an VidyoRemoteSpeaker object. |
VidyoRemoteSpeakerGetId | |
VidyoRemoteSpeakerGetName |
name | LmiString | Name. |
sampleRate | LmiUint | Sample rate. |
bitsPerSample | LmiUint | Bits per sample. |
numberOfChannels | LmiUint | Number of channels. |
codecName | LmiString | Codec name. |
codecQualitySetting | LmiUint | Codec quality setting. |
codecDtx | LmiUint | Codec DTX. |
sendNetworkBitRate | LmiUint | Send bitrate. |
sendNetworkRtt | LmiTime | Round trip time of send network. |
name | LmiString | Name. |
id | LmiString | Id. |
width | LmiSizeT | Width. |
height | LmiSizeT | Height. |
showState | LmiString | State of how the source is received from the server (on/off/auto). |
maxStreamWidth | LmiUint | Width. |
maxStreamHeight | LmiSizeT | Width. |
maxStreamFrameRate | LmiSizeT | Width. |
showWidth | LmiSizeT | Width. |
showHeight | LmiSizeT | Width. |
showFrameRate | LmiUint | Width. |
showPixelRate | LmiUint | Width. |
fpsDecoderInput | LmiSizeT | Frame rate at decoder input. |
fpsDecoded | LmiSizeT | Frame rate of decoder output. |
fpsRendered | LmiSizeT | Frame rate of renderer. |
codecName | LmiString | Codec name. |
codecIFrames | LmiSizeT | Codec I frames. |
codecFir | LmiSizeT | Codec FIR. |
codecNacks | LmiSizeT | Codec nacks. |
codecLayers | LmiSizeT | Codec layers. |
receiveNetworkPacketsLost | LmiSizeT | Number of lost packets. |
receiveNetworkPacketsConcealed | LmiSizeT | Number of packets concealed. |
receiveNetworkPacketsReordered | LmiSizeT | Number of packets reordered. |
receiveNetworkBitRate | LmiSizeT | Source bitrate. |
receiveNetworkRecoveredWithFec | LmiSizeT | Number of packets recovered with FEC. |
localRendererStreams | LmiVector(VidyoLocalRendererStreamStats) | Vector of stats of local renderer streams. |
id | LmiString | Unique ID. |
name | LmiString | Name. |
VidyoRemoteWindowShareAddToLocalRenderer | |
VidyoRemoteWindowShareConstructCopy | Constructs an VidyoRemoteWindowShare object as a copy of another. |
VidyoRemoteWindowShareDestruct | Destructs an VidyoRemoteWindowShare object. |
VidyoRemoteWindowShareGetId | Gets the unique ID of the window share. |
VidyoRemoteWindowShareGetName | Gets the name of the window share. |
VidyoRemoteWindowShareRemoveFromLocalRenderer | |
VidyoRemoteWindowShareSetPositionInLocalRenderer |
id | LmiString | Unique ID that identifies a VidyoRoom at the server. |
type | VidyoRoomType | Type of VidyoRoom such as topic or Conversation. |
VidyoGenerationDiff | Represents a remote participant whose selected ranking in a conference has changed. When the selected participant list changes, a set of these objects can be used to represent the differences between the old list and the new list. Each object can indicate a new participant in the list, a participant that is no longer in the list, or a participant that has changed rank within the list. |
VidyoRoomDeleteResult | This type indicates the result of delete room. |
VidyoRoomEnterResult | Result of an attempt to enter a VidyoRoom. |
VidyoRoomExitReason | Reason why a user is no longer a participant of a VidyoRoom. |
VidyoRoomGetPropertiesResult | This type indicates the result of get room properties. |
VidyoRoomMediaDisableReason | This type indicates the reason why media support is now disabled on a room. |
VidyoRoomMediaFailReason | This type indicates the reason why an attempt to enable media on a room failed. |
VidyoRoomProfileControlMode | Describes the profile control mode. |
VidyoRoomProperties | Properties of a room. |
VidyoRoomSearchResult | Result of get room history. |
VidyoRoomSetFavoriteResult | This type indicates the result of set favorite room. |
VidyoRoomSetPropertiesResult | This type indicates the result of set room properties. |
VidyoRoomState | |
VidyoRoomType | This indicates the type of the room. |
VidyoRoomOnAvailableResourcesChanged | Callback that is triggered when the available resources such as CPU and bandwidth change when media is enabled. |
VidyoRoomOnDeleteResult | Callback that is triggered when server acknowleges a VidyoRoom has been deleted on the server. |
VidyoRoomOnDynamicParticipantChanged | This callback is invoked to report that the list of dynamically selected participants in a conference has changed. |
VidyoRoomOnEntered | Callback that is triggered when entering the VidyoRoom as a result of VidyoRoomEnter() or VidyoRoomAcceptIncoming() request. |
VidyoRoomOnExited | Callback that is triggered when the VidyoUser exited the VidyoRoom or as a result of VidyoRoomLeave() request. |
VidyoRoomOnGetHistoryResults | Callback that is triggered as a result of VidyoRoomGetHistory() call. |
VidyoRoomOnGetRoomPropertiesResult | Callback that is triggered when VidyoRoomGetRoomProperties() request completes. |
VidyoRoomOnLoudestParticipantChanged | This callback is invoked to report that an audio-only participant has gain or lost loudest speaker status. |
VidyoRoomOnMaxRemoteSourcesChanged | Callback that is triggered when maximum decoding capability changes when media is enabled. |
VidyoRoomOnMediaDisabled | Callback that is triggered when media has been disbled after a successfully enabling it with VidyoRoomEnableMedia(). |
VidyoRoomOnMediaEnabled | Callback that is triggered when media was enabled as a result of VidyoRoomEnableMedia() request. |
VidyoRoomOnMediaFailed | Callback that is triggered when media enabling failed as a result of VidyoRoomEnableMedia() request. |
VidyoRoomOnMediaRouteAcquired | Callback that is triggered when media route is discovered as a result of VidyoRoomAcquireMediaRoute() request. |
VidyoRoomOnMessageAcknowledged | Callback that is triggered when a VidyoChatMessage is delivered to the VidyoRoom on the server. |
VidyoRoomOnMessageRead | Callback that is triggered when a message that was acknowledged by the server was read by the other VidyoParticipant in the room. |
VidyoRoomOnMessageReceived | Callback that is triggered for every VidyoChatMessage that was sent to the VidyoRoom by every other VidyoParticipant after the VidyoRoomOnEntered returned successfully. |
VidyoRoomOnMessageSearchResults | Callback that is triggered as a result of VidyoRoomSearch() call. |
VidyoRoomOnMessageTypingIndication | Callback that is triggered when typing state of a remote VidyoParticipant changes. |
VidyoRoomOnParticipantJoined | Callback that is triggered when VidyoParticipant is entering or has been in the room when VidyoUser Entered. |
VidyoRoomOnParticipantLeft | Callback that is triggered when VidyoParticipant is leaving or is being removed when this VidyoUser Exited. |
VidyoRoomOnRoomPropertiesChanged | Callback that is triggered when VidyoRoomProperties is changed on the server side. |
VidyoRoomOnSetFavoriteResult | Callback that is triggered when server acknowleges a VidyoRoom's favorite status for current logged-in user has changed. |
VidyoRoomOnSetRoomPropertiesResult | Callback that is triggered when VidyoRoomSetProperties request completes. |
VidyoRoomOnSetSubject | Callback that is triggered when the subject of the VidyoRoom has changed. |
VidyoRoomRecorderInCall | Callback that is triggered when the call is recorded or when call recording stops. |
VIDYO_ROOMDELETERESULT_OK | The delete room operation was successful. |
VIDYO_ROOMDELETERESULT_NoResponse | The server did not respond in a reasonable amount of time to the request to delete room. |
VIDYO_ROOMDELETERESULT_Unauthorized | The user did not have permission to delete room. |
VIDYO_ROOMDELETERESULT_OutOfResources | The server cannot delete rooms at the current time because it is out of some resource. |
VIDYO_ROOMDELETERESULT_MiscError | Some other error occurred. |
VIDYO_ROOMENTERRESULT_OK | Room entered successfully. |
VIDYO_ROOMENTERRESULT_Cancelled | Enter request was cancelled. |
VIDYO_ROOMENTERRESULT_NoResponse | Server did not respond in a reasonable amount of time to the request to enter the room. |
VIDYO_ROOMENTERRESULT_InvalidPassword | User did not provide a password when one was required, or provided an invalid password. |
VIDYO_ROOMENTERRESULT_UnknownRoom | Room specified by the user does not exist. |
VIDYO_ROOMENTERRESULT_RoomFull | Room is at full capacity and cannot accept additional members. |
VIDYO_ROOMENTERRESULT_NotMember | Room allows only certain users to enter, and the user is not one of them. |
VIDYO_ROOMENTERRESULT_Banned | User has been banned from entering the room. |
VIDYO_ROOMENTERRESULT_MiscLocalError | Server is rejecting the request to enter due to some miscellaneous problem with the request. |
VIDYO_ROOMENTERRESULT_MiscRemoteError | Server is rejecting the request to enter due to some miscellaneous problem of its own. |
VIDYO_ROOMEXITREASON_Left | Leave was invoked, and this action completed successfully. |
VIDYO_ROOMEXITREASON_ConnectionLost | Connectivity was lost and signaling messages can no longer be sent or received. |
VIDYO_ROOMEXITREASON_SessionConnectionLost | Session connectivity was lost. |
VIDYO_ROOMEXITREASON_MembershipConnectionLost | Membership connectivity was lost. |
VIDYO_ROOMEXITREASON_NoResponse | A signaling request was sent, but no response was received within the allotted amount of time. |
VIDYO_ROOMEXITREASON_ProtocolViolation | A signaling message was received that could not be understood or otherwise violated the rules of the protocol in use. |
VIDYO_ROOMEXITREASON_Booted | User was kicked out of the room. This could be the result of an administrator's action. |
VIDYO_ROOMEXITREASON_ShuttingDown | Room or the entire conferencing service is going offline. All users are being removed from the room. |
VIDYO_ROOMEXITREASON_MiscLocalError | Some miscellaneous problem occurred with this application. |
VIDYO_ROOMEXITREASON_MiscRemoteError | Some miscellaneous problem occurred with the conferencing service. |
VIDYO_ROOMGETPROPERTIESRESULT_OK | The get properties operation was successful. |
VIDYO_ROOMGETPROPERTIESRESULT_NoResponse | The server did not respond in a reasonable amount of time to the request to get room properties. |
VIDYO_ROOMGETPROPERTIESRESULT_Unauthorized | The user did not have permission to get room properties. |
VIDYO_ROOMGETPROPERTIESRESULT_MiscLocalError | The server is rejecting the request to get room properties due to some miscellaneous problem with the request. |
VIDYO_ROOMGETPROPERTIESRESULT_MiscRemoteError | The server is rejecting the request to get room properties due to some miscellaneous problem of its own. |
id | LmiString | |
name | LmiString | |
description | LmiString | |
language | LmiString | |
type | VidyoRoomType | |
IsPublic | LmiBool | |
IsFavorite | LmiBool | |
numUsers | LmiInt | Total number of users of the room. |
ownerList | LmiVector(LmiString) | List of owners of the room. |
userList | LmiVector(LmiString) | few people ever joined the room. |
messageList | LmiVector(VidyoChatMessage) | few messages send in the room. |
creationTime | LmiTime | Creation time of the room. |
VIDYO_ROOMMEDIADISABLEREASON_Disabled | Media support was disabled gracefully (after calling VidyoRoomEnableMedia). |
VIDYO_ROOMMEDIADISABLEREASON_SignalingConnectionLost | Signaling connectivity to the conference server was lost. |
VIDYO_ROOMMEDIADISABLEREASON_MediaConnectionLost | Media connectivity to the conference server was lost. |
VIDYO_ROOMMEDIADISABLEREASON_Booted | The server is ousting this member from the conference. This could be the result of an administrator's action. |
VIDYO_ROOMMEDIADISABLEREASON_SessionTerminated | The session that was carrying the conferencing protocol has been terminated. |
VIDYO_ROOMMEDIADISABLEREASON_ServerShuttingDown | The conference server is shutting down. All members of all conferences are being booted. |
VIDYO_ROOMMEDIADISABLEREASON_ConferenceDestroyed | The conference is being destroyed. All members of the conference are being booted. |
VIDYO_ROOMMEDIADISABLEREASON_MiscLocalError | Some miscellaneous problem occurred with this application. |
VIDYO_ROOMMEDIADISABLEREASON_MiscRemoteError | Some miscellaneous problem occurred with the conferencing service. |
VIDYO_ROOMMEDIAFAILREASON_Cancelled | Media support was disabled (by calling VidyoRoomDisableMedia) before an attempt to enable it completed. |
VIDYO_ROOMMEDIAFAILREASON_NoConference | There was an error determining which conference to join. |
VIDYO_ROOMMEDIAFAILREASON_SignalingConnectionLost | Signaling Connection lost on current transport. |
VIDYO_ROOMMEDIAFAILREASON_MediaConnectionLost | Media Connection lost on current transport. |
VIDYO_ROOMMEDIAFAILREASON_MiscLocalError | Some miscellaneous problem occurred with this application. |
VIDYO_ROOMMEDIAFAILREASON_MiscRemoteError | Some miscellaneous problem occurred with the conferencing service. |
userId | LmiString | |
microphone | VidyoRoomProfileControlMode | |
camera | VidyoRoomProfileControlMode | |
windowShare | VidyoRoomProfileControlMode | |
chat | VidyoRoomProfileControlMode |
VIDYO_ROOMPROFILECONTROLMODE_AlwaysOn | Profile is always ON. |
VIDYO_ROOMPROFILECONTROLMODE_AlwaysOff | Profile is always OFF. |
VIDYO_ROOMPROFILECONTROLMODE_Default | Profile will take the default behavior. |
name | LmiString | |
description | LmiString | |
language | LmiString | |
owners | LmiVector(LmiString) | An owner of the room. This is the highest clearance. This type of user typically has unlimited privileges in the room. |
administrators | LmiVector(LmiString) | An administrator in the room. |
moderators | LmiVector(LmiString) | A member of the room with moderator privileges. A moderator will typically have privileges such as muting users or kicking them out of the room. |
members | LmiVector(LmiString) | A member of the room. |
outcasts | LmiVector(LmiString) | The user has been banned from the room. |
isPublic | LmiBool | The room Public. This room will show up in searches. |
isMembersOnly | LmiBool | The room is for members only. A user cannot join unless they have a member or better clearance. |
isModerated | LmiBool | This room is moderated. |
isLoggingEnabled | LmiBool | The room is being logges and is on the record. |
isPasswordProtected | LmiBool | The room requres a password to join. |
hasPassword | LmiBool | if hasPassword is LMI_TRUE, password filed should be examined. If password field is empty, it means to clear the password, otherwise, it means set the room with this new password. |
password | LmiString | The password to join this room. |
maxParticipants | LmiUint | Maxumum number of concurrent participants. |
schedule | VidyoRoomSchedule | A schedule for a room in iCalendar format. |
defaultProfile | VidyoRoomParticipantProfile | Default profile for all participants. |
participantProfiles | LmiVector(VidyoRoomParticipantProfile) | Profile for specific participants. |
creationTime | LmiTime | Creation time of the room. |
VidyoRoomParticipantProfile | Participant's profile describing the source restrictions and the chat restriction. |
VidyoRoomSchedule | Room schedule describes the scheduling of a room. This is modeled based off iCalendar. Please refer to the iCalendar specification (RFC 2445) for more details. |
eventId | LmiString | |
startTime | LmiString | |
endTime | LmiString | |
duration | LmiString | |
frequency | LmiString | |
interval | LmiString | |
count | LmiString | |
until | LmiString | |
byDay | LmiString | |
byMonthDay | LmiString | |
byMonth | LmiString | |
byYearDay | LmiString | |
byWeekNum | LmiString | |
bySetPos | LmiString | |
weekStartDay | LmiString |
VIDYO_ROOMSEARCHFIELD_Owner | owner of the rom. |
VIDYO_ROOMSEARCHFIELD_Admin | administrator of the room. |
VIDYO_ROOMSEARCHFIELD_Moderator | moderator of the room. |
VIDYO_ROOMSEARCHFIELD_Member | member of the room. |
VIDYO_ROOMSEARCHFIELD_User | user of the room. |
VIDYO_ROOMSEARCHFIELD_Name | name of the room. |
VIDYO_ROOMSEARCHFIELD_Subject | subject of the room. |
VIDYO_ROOMSEARCHFIELD_Type | type of the room. |
VIDYO_ROOMSEARCHFIELD_Public | visibility of the room; value of "true" indicates public room. |
VIDYO_ROOMSEARCHFIELD_NonMembers | number of members in the room includes owners, admins, moderators and members. |
VIDYO_ROOMSEARCHFIELDRELATION_AND | apply logical AND between the fields. |
VIDYO_ROOMSEARCHFIELDRELATION_OR | apply logical OR between the fields. |
VIDYO_ROOMSEARCHRESULT_OK | Get room history operation was successful. |
VIDYO_ROOMSEARCHRESULT_NoRecords | Server did not return any records. |
VIDYO_ROOMSEARCHRESULT_NoResponse | Server did not respond in a reasonable amount of time to the get room history request. |
VIDYO_ROOMSEARCHRESULT_Unauthorized | User did not have the permission to get room history. |
VIDYO_ROOMSEARCHRESULT_MiscLocalError | Server is rejecting the request to get room history due to some miscellaneous problem with the request. |
VIDYO_ROOMSEARCHRESULT_MiscRemoteError | Server is rejecting the request to get room history due to some miscellaneous problem of its own. |
VIDYO_ROOMSETFAVORITERESULT_OK | The set operation was successful. |
VIDYO_ROOMSETFAVORITERESULT_NoResponse | The server did not respond in a reasonable amount of time to the request to set. |
VIDYO_ROOMSETFAVORITERESULT_Conflict | There was a conflict in set. |
VIDYO_ROOMSETFAVORITERESULT_Unauthorized | The user did not have permission to set. |
VIDYO_ROOMSETFAVORITERESULT_NotAcceptable | The properties set on the room are not acceptable. |
VIDYO_ROOMSETFAVORITERESULT_NotAllowed | The operation being performed on the room using set properties is not allowed. |
VIDYO_ROOMSETFAVORITERESULT_MiscLocalError | The server is rejecting the request to set due to some miscellaneous problem with the request. |
VIDYO_ROOMSETFAVORITERESULT_MiscRemoteError | The server isrejecting the request to set room properties due to some miscellaneous problem of its own. |
VIDYO_ROOMSETPROPERTIESRESULT_OK | The set properties operation was successful. |
VIDYO_ROOMSETPROPERTIESRESULT_NoResponse | The server did not respond in a reasonable amount of time to the request to set room properties. |
VIDYO_ROOMSETPROPERTIESRESULT_Conflict | There was a conflict in setting room properties. |
VIDYO_ROOMSETPROPERTIESRESULT_Unauthorized | The user did not have permission to get room properties. |
VIDYO_ROOMSETPROPERTIESRESULT_NotAcceptable | The properties set on the room are not acceptable. |
VIDYO_ROOMSETPROPERTIESRESULT_NotAllowed | The operation being performed on the room using set properties is not allowed. |
VIDYO_ROOMSETPROPERTIESRESULT_MiscLocalError | The server is rejecting the request to set room properties due to some miscellaneous problem with the request. |
VIDYO_ROOMSETPROPERTIESRESULT_MiscRemoteError | The server is rejecting the request to set room properties due to some miscellaneous problem of its own. |
VIDYO_ROOMSTATE_Creating | |
VIDYO_ROOMSTATE_Created | |
VIDYO_ROOMSTATE_Entering | |
VIDYO_ROOMSTATE_Entered | |
VIDYO_ROOMSTATE_MediaRouteAcquiring | |
VIDYO_ROOMSTATE_MediaRouteAcquired | |
VIDYO_ROOMSTATE_MediaEnabling | |
VIDYO_ROOMSTATE_MediaEnabled | |
VIDYO_ROOMSTATE_MediaDisabling | |
VIDYO_ROOMSTATE_MediaDisabled | |
VIDYO_ROOMSTATE_Exiting | |
VIDYO_ROOMSTATE_Exited |
id | LmiString | Room ID. |
cpuUsage | LmiUint | Current CPU usage. |
maxEncodePixelRate | LmiUint64 | Max encode pixel rate. |
currentCpuEncodePixelRate | LmiUint64 | Current CPU encode pixel rate. |
currentBandwidthEncodePixelRate | LmiUint64 | Current Bandwidth encode pixel rate. |
maxDecodePixelRate | LmiUint64 | Max decode pixel rate. |
currentCpuDecodePixelRate | LmiUint64 | Current CPU decode pixel rate. |
currentBandwidthDecodePixelRate | LmiUint64 | Current Bandwidth decode pixel rate. |
sendBitRateTotal | LmiUint64 | Available ABA send bandwidth. |
sendBitRateAvailable | LmiUint64 | Actual ABA send bandwidth. |
receiveBitRateTotal | LmiUint64 | Available ABA receive bandwidth. |
receiveBitRateAvailable | LmiUint64 | Actual ABA receive bandwidth. |
maxVideoSources | LmiUint | Maximum video sources allowed based on the minimum of configured and constrained by resource manager. |
staticSources | LmiUint | Current ammount of static sources shown. |
bandwidthAudio | VidyoBandwidthSummaryStats | Bandwidth summary statistics of audio content. |
bandwidthVideo | VidyoBandwidthSummaryStats | Bandwidth summary statistics of video content. |
bandwidthApp | VidyoBandwidthSummaryStats | Bandwidth summary statistics of application content. |
rateShaperAudio | VidyoRateShaperStats | Rate shaper statistics of audio content. |
rateShaperVideo | VidyoRateShaperStats | Rate shaper statistics of video content. |
rateShaperApp | VidyoRateShaperStats | Rate shaper statistics of application content. |
participantStats | LmiVector(VidyoParticipantStats) | Vector of stats of participants. |
participantGenerationStats | LmiVector(VidyoParticipantGenerationStats) | Ordered list of generations (selected participants). |
reflectorId | LmiString | ID of the refector to which the media conneciton is established. |
conferenceId | LmiString | ID conference on the reflector associated with this VidyoRoom. |
transportInformation | LmiVector(VidyoMediaConnectionTransportInfo) | Vector of media transport information. |
VIDYO_ROOMTYPE_Unknown | This indicates that room type is unknown. |
VIDYO_ROOMTYPE_Conversation | This room is for private chat between users speicfied in the VidyoUserGetConversationRoom method. It is auto-created and the access is permanently limited to the list of users specified so that no other participants can be invited outside of the original user list. If the list of users needs to be modified, another CONVERSATION room must be created with the new list. |
VIDYO_ROOMTYPE_Topic | This room is created using the VidyoUserCreateTopicRoom method for topic discussions. The user creating the room will usually become the owner and can moderate/invite other users. The access and properties of this room can be modified by privileged users and others can join/leave this room based on those properties such as guest access or member only. |
VIDYO_ROOMTYPE_Scheduled | This indicates that room is of type scheduled. |
begin | LmiTime | The first time interval of the range. |
end | LmiTime | The last time interval of the range. |
VidyoRoomSearchField | This type specify the room property to search. |
VidyoRoomSearchFieldRelation | This type specify the relation between room property fields that apply in the search, AND operator gets evaluated before OR. |
VidyoUserCallCreateResult | This type indicates the result of an attempt to create call. |
VidyoUserConnectionStatusChangedReason | This type indicates the reason for a change in connection status . |
VidyoUserGetContactResult | This type indicates the result of getting a contact vCard. |
VidyoUserLoginResult | This type indicates the result of an attempt to log in to some service. |
VidyoUserLogoutReason | This type indicates the reason that a user that was once logged in is no longer logged in. |
VidyoUserRoomCreateResult | This type indicates the result of an attempt to create room. |
VidyoUserSearchField | This type specify the user details to search. |
VidyoUserSearchResult | This type indicates the result of a search for user or room. |
VidyoUserState | |
VidyoUserTokenType | An enumeration of authentication key types. |
VidyoUserOnCallCreated | |
VidyoUserOnCallCreatedByInvite | |
VidyoUserOnConnectionStatusChanged | |
VidyoUserOnFavoriteRoomResults | |
VidyoUserOnGetContactResult | |
VidyoUserOnGetLicenseKey | Requests the license key that was presumably stored when received via VidyoUserLicenseReceivedCallback |
VidyoUserOnLicenseReceived | Informs about new license received by VidyoUser |
VidyoUserOnLoggedOut | |
VidyoUserOnLoginComplete | |
VidyoUserOnRecentRoomResults | |
VidyoUserOnRemoveRosterContact | |
VidyoUserOnRoomCreated | |
VidyoUserOnRoomCreatedByInvite | |
VidyoUserOnRoomSearchResults | |
VidyoUserOnTokenReceived | |
VidyoUserOnUpdateRosterContact | |
VidyoUserOnUpdateSelf | |
VidyoUserOnUserSearchResults | |
VidyoUserOnWebProxyCredentialsRequest |
VIDYO_USERCALLCREATERESULT_OK | The call created successfully. |
VIDYO_USERCALLCREATERESULT_NoResponse | The server did not respond in a reasonable amount of time to the request to create the call. |
VIDYO_USERCALLCREATERESULT_NotAllowed | The user is not allowed to create call. |
VIDYO_USERCALLCREATERESULT_MiscLocalError | The server is rejecting the request to create the call due to some miscellaneous problem with the request. |
VIDYO_USERCALLCREATERESULT_MiscRemoteError | The server is rejecting the request to create the call due to some miscellaneous problem of its own. |
VIDYO_USERCONNECTIONSTATUSCHANGEDREASON_OK | Connected to the server |
VIDYO_USERCONNECTIONSTATUSCHANGEDREASON_LostContactWithServer | Lost contact with the server |
VIDYO_USERCONNECTIONSTATUSCHANGEDREASON_NoCommunicationWithServer | No communication with the server |
VIDYO_USERCONNECTIONSTATUSCHANGEDREASON_NoValidNetworkInterfaces | The user has no valid network interfaces available. |
VIDYO_USERCONNECTIONSTATUSCHANGEDREASON_NetworkInterfaceChanged | The user's network interfaces have changed. |
VIDYO_USERCONNECTIONSTATUSCHANGEDREASON_MiscNetworkError | Misc network error |
VIDYO_USERCONNECTIONSTATUSCHANGEDREASON_ConnectionError | Error on connecting to backend. |
VIDYO_USERGETCONTACTRESULT_OK | The request was successful. |
VIDYO_USERGETCONTACTRESULT_NoResponse | The server did not respond in a reasonable amount of time. |
VIDYO_USERGETCONTACTRESULT_Unauthorized | The user is not allowed to get contacts. |
VIDYO_USERGETCONTACTRESULT_MiscLocalError | The server is rejecting the request due to some miscellaneous problem with the request. |
VIDYO_USERGETCONTACTRESULT_MiscRemoteError | The server is rejecting the request due to some miscellaneous problem of its own. |
VIDYO_USERLOGINRESULT_OK | The user logged in successfully. |
VIDYO_USERLOGINRESULT_ConnectionFailed | The destination could not be reached. |
VIDYO_USERLOGINRESULT_ConnectionLost | The transport connection was lost prior to completing the login procedure. |
VIDYO_USERLOGINRESULT_ConnectionTimeout | The signaling connection timed out prior to completing the login procedure. |
VIDYO_USERLOGINRESULT_NoResponse | The service was successfully contacted, but the service ignored the user's request to log in, or did not answer in a reasonable amount of time. |
VIDYO_USERLOGINRESULT_Terminated | The service was successfully contacted, but the service closed the connection or refused to continue processing the login request. |
VIDYO_USERLOGINRESULT_InvalidUser | The user ID that was provided is unknown to the service or unauthorized to log in. |
VIDYO_USERLOGINRESULT_InvalidPassword | The password that was provided is incorrect. |
VIDYO_USERLOGINRESULT_MiscAuthError | The login failed for some other authentication error. |
VIDYO_USERLOGINRESULT_Cancelled | The user cancelled the login request before it completed. |
VIDYO_USERLOGINRESULT_MiscError | The login failed for some other miscellaneous error. |
VIDYO_USERLOGINRESULT_WebProxyAuthenticationRequired | The login failed as the web proxy address required authentication. |
VIDYO_USERLOGOUTREASON_LoggedOut | The user logged out gracefully. |
VIDYO_USERLOGOUTREASON_ConnectionLost | The transport connection was lost. |
VIDYO_USERLOGOUTREASON_ConnectionTimeout | The signaling connection timed out. |
VIDYO_USERLOGOUTREASON_NoResponse | The service did not respond in a reasonable amount of time to a request by the user. |
VIDYO_USERLOGOUTREASON_Terminated | The service closed the connection or otherwise terminated the login session. |
VIDYO_USERLOGOUTREASON_MiscError | The login session was closed for some other miscellaneous reason. |
VIDYO_USERROOMCREATERESULT_OK | The room entered successfully. |
VIDYO_USERROOMCREATERESULT_NoResponse | The server did not respond in a reasonable amount of time to the request to enter the room. |
VIDYO_USERROOMCREATERESULT_NotFound | The server did not find the room. |
VIDYO_USERROOMCREATERESULT_Unauthorized | The user is not allowed to create rooms. |
VIDYO_USERROOMCREATERESULT_MiscLocalError | The server is rejecting the request to enter due to some miscellaneous problem with the request. |
VIDYO_USERROOMCREATERESULT_MiscRemoteError | The server is rejecting the request to enter due to some miscellaneous problem of its own. |
VIDYO_USERROOMCREATERESULT_DuplicateName | The room with this name already exists. |
VIDYO_USERSEARCHFIELD_UID | id of the user. |
VIDYO_USERSEARCHFIELD_EMAIL | mail of the user. |
VIDYO_USERSEARCHFIELD_NAME | display name of the user. |
VIDYO_USERSEARCHFIELD_TELNO | telephone number of user. |
VIDYO_USERSEARCHRESULT_OK | The search operation was successful. |
VIDYO_USERSEARCHRESULT_NoRecords | No records found for the search. |
VIDYO_USERSEARCHRESULT_NoResponse | The search result failed due to request timeout. |
VIDYO_USERSEARCHRESULT_MiscLocalError | The search result failed due to some miscellaneous local problem. |
VIDYO_USERSEARCHRESULT_MiscRemoteError | The search result failed due to some miscellaneous remote problem. |
VIDYO_USERSTATE_Idle | |
VIDYO_USERSTATE_LoggingIn | |
VIDYO_USERSTATE_LoggedIn | |
VIDYO_USERSTATE_Reconnecting |
id | LmiString | User ID. |
serviceType | LmiString | Login service type. |
host | LmiString | Login host. |
port | LmiUint | Login Port. |
roomStats | LmiVector(VidyoRoomStats) | Vector of stats of rooms. |
VIDYO_USERTOKENTYPE_RefreshToken | The associated key is a refresh token. |
VIDYO_USERTOKENTYPE_AccessToken | The associated key is an access token. |
width | LmiSizeT | |
height | LmiSizeT | |
ranges | LmiVector(VidyoVideoFrameIntervalRange) |
VidyoVideoFrameIntervalRange | Represents frame interval range and media formats supported by that range. |
range | VidyoTimeRange | |
step | LmiTime | |
formats | LmiVector(VidyoMediaFormat) |
VidyoTimeRange | A time range class used to represent a range of time intervals. |
VidyoVirtualShareManagerConstructCopy | Constructs an VidyoVirtualShareManager object as a copy of another. |
VidyoVirtualShareManagerDestruct | Destructs an VidyoVirtualShareManager object. |
VidyoVirtualShareManagerLocalMonitorEvent | |
VidyoVirtualShareManagerLocalWindowShareEvent | |
VidyoVirtualShareManagerMediaFailedEvent |
f | Pointer to the VidyoCalendarFeedback object. |
c | Pointer to the VidyoCalendar that triggered the callback. |
result | Indication on whether the connection attempt was successful or not. |
f | Pointer to the VidyoCalendarFeedback object. |
c | Pointer to the VidyoCalendar that triggered the callback. |
result | Reason for the disconnect. |
f | Pointer to the VidyoCalendarFeedback object. |
c | Pointer to the VidyoCalendar that the callback was triggered against. |
searchResult | Indicates the reason code for the results. |
meetings | A vector of meeting objects based on the results of the triggering method. |
f | Pointer to the VidyoCalendarFeedback object. |
c | Pointer to the VidyoCalendar that triggered the callback. |
m | Pointer to the meeting that was created. |
r | Result to indicate whether creating the meeting was successful or not . |
createdToken | A unique string provided by the triggering method. Used to correlate the method that triggered this callback. |
f | Pointer to the VidyoCalendarFeedback object. |
c | Pointer to the VidyoCalendar that triggered the callback. |
m | Pointer to the meeting that was created. |
inviteOwner | Contact information on the user that created the invite. |
f | Pointer to the VidyoCalendarFeedback object. |
c | Pointer to the VidyoCalendar that triggered the callback. |
m | Pointer to the VidyoCalendar that triggered the callback. |
f | Pointer to the VidyoCalendarFeedback object. |
c | Pointer to the VidyoCalendar that triggered the callback. |
m | Pointer to the VidyoMeeting object removed for the callback. |
r | Result to indicate whether the meeting was being removed by an action from the local user or the remote owner. |
removedToken | A unique string provided by the triggering method. Used to correlate the method that triggered this callback. |
f | Pointer to the VidyoCalendarFeedback object. |
c | Pointer to the VidyoCalendar that triggered the callback. |
m | Pointer to the VidyoMeeting object removed for the callback. |
r | Result to indicate whether the meeting was being removed by an action from the local user or the remote owner. |
f | Pointer to the VidyoCalendarFeedback object. |
c | Pointer to the VidyoCalendar that triggered the callback. |
m | Pointer to the meeting that was created. |
r | Result to indicate whether creating the meeting was successful or not . |
updatedToken | A unique string provided by the triggering method. Used to correlate the method that triggered this callback. |
f | Pointer to the VidyoCalendarFeedback object. |
c | Pointer to the VidyoCalendar that triggered the callback. |
m | Pointer to the meeting that was created. |
r | Result to indicate whether creating the meeting was successful or not . |
f | Calendar Manager feeback handle |
cm | Calendar Manager object |
calendar | The created calendar |
resultCode | Will hold VIDYO_CALENDARSERVICECODE_Ok for a successfully created calendar, otherwise an error occured |
createToken | Contains the value passed into the original VidyoCalendarManagerCreateCalendarInstance call for matching the request to this response |
f | Pointer to the VidyoCalendarManagerFeedback object. |
cm | Pointer to the VidyoCalendarManager object. |
t | Calendar service type. |
s | Status of the service after the discovery attempt. |
f | Pointer to the VidyoCalendarManagerFeedback object. |
cm | Pointer to the VidyoCalendarManager object. |
c | Pointer to the VidyoCall that triggered the callback. |
p | Pointer to the VidyoParticipant object of the user being called. |
reason | Reason why the VidyoCall ended. |
c | Pointer to the VidyoCall that triggered the callback. |
result | Result of an attempt to initiate the VidyoCall. |
p | Pointer to the VidyoParticipant object of the user being called. |
c | Pointer to the VidyoCall that triggered the callback. |
chatMessage | Pointer to the VidyoChatMessage object created by the server from VidyoCallSendMessage() call. |
c | Pointer to the VidyoCall that triggered the callback. |
participant | Pointer to the VidyoParticipant object that read the message. |
messageId | The ID of the VidyoChatMessage that was read. |
c | Pointer to the VidyoCall that triggered the callback. |
participant | Pointer to the VidyoParticipant object that sent the message. |
chatMessage | Pointer to the VidyoChatMessage object containing the message. |
c | Pointer to the VidyoCall that triggered the callback. |
participant | Pointer to the VidyoParticipant object whose typing state changed. |
typingIndication | New typing state of the VidyoParticipant. |
c | Pointer to the VidyoCall that triggered the callback. |
subject | New subject of the VidyoCall. |
c | The VidyoConnector that triggered the callback. |
cpuEncode | Percent of maximum CPU available to encode the streams. |
cpuDecode | Percent of maximum CPU available to decode the streams. |
bandwidthSend | Percentage of maximum bandwidth avaialble to transmit the streams. |
bandwidthReceive | Percentage of maximum bandwidth avaialble to receive the streams. |
c | The VidyoConnector that triggered the callback. |
participant | The VidyoParticipant who sent the chat message. |
chatMessage | The VidyoChatMessage that was received. |
c | The VidyoConnector that triggered the callback. |
reason | Reason why the established connection became disconnected. |
c | The VidyoConnector that triggered the callback. |
participants | The vector of participants, listed in their order of importance. |
remoteCameras | The vector of remote cameras that are being dynamically renderered, listed in the same order as the participants to which they belong, so that they match one-to-one. |
c | The VidyoConnector that triggered the callback. |
reason | Reason why the connection could not be established. |
c | The VidyoConnector that triggered the callback. |
localCamera | Local camera that was added to the VidyoConnector. |
c | The VidyoConnector that triggered the callback. |
localCamera | Local camera that was removed from the VidyoConnector. |
c | The VidyoConnector that triggered the callback. |
localCamera | Local camera that was selected. NULL if none of them remain selected. |
c | The VidyoConnector that triggered the callback. |
localCamera | Local camera that was selected or NULL if nothing was selected. |
state | New state of the Local camera. |
c | The VidyoConnector that triggered the callback. |
localMicrophone | Local microphone that was added to the VidyoConnector. |
c | The VidyoConnector that triggered the callback. |
localMicrophone | Local microphone that was removed from the VidyoConnector. |
c | The VidyoConnector that triggered the callback. |
localMicrophone | Local microphone that was selected. NULL if none of them remain selected. |
c | The VidyoConnector that triggered the callback. |
localMicrophone | Local microphone that was selected or NULL if nothing was selected. |
state | New state of the Local microphone. |
c | The VidyoConnector that triggered the callback. |
localMonitor | Local monitor that was added to the VidyoConnector. |
c | The VidyoConnector that triggered the callback. |
localMonitor | Local monitor that was removed from the VidyoConnector. |
c | The VidyoConnector that triggered the callback. |
localMonitor | Local monitor that was selected. NULL if none of them remain selected. |
c | The VidyoConnector that triggered the callback. |
localMonitor | Local monitor that was selected or NULL if nothing was selected. |
state | New state of the Local monitor. |
c | The VidyoConnector that triggered the callback. |
localSpeaker | Local speaker that was added to the VidyoConnector. |
c | The VidyoConnector that triggered the callback. |
localSpeaker | Local speaker that was removed from the VidyoConnector. |
c | The VidyoConnector that triggered the callback. |
localSpeaker | Local speaker that was selected. NULL if none of them remain selected. |
c | The VidyoConnector that triggered the callback. |
localSpeaker | Local speaker that was selected or NULL if nothing was selected. |
state | New state of the Local speaker. |
c | The VidyoConnector that triggered the callback. |
localWindowShare | Local, shareable window that was added to the VidyoConnector. |
c | The VidyoConnector that triggered the callback. |
localWindowShare | Local window that was removed from the VidyoConnector. The window is no longer shareable. |
c | The VidyoConnector that triggered the callback. |
localWindowShare | Local window that was selected. NULL if none of them remain selected. |
c | The VidyoConnector that triggered the callback. |
localWindowShare | Local window that was selected or NULL if nothing was selected. |
state | New state of the Local window. |
c | The VidyoConnector that triggered the callback. |
logRecord | The VidyoLogRecord object containing log record data. |
c | The VidyoConnector that triggered the callback. |
participant | New loudest participant. |
audioOnly | LMI_TRUE if the participant does not have video streams. |
c | The VidyoConnector that triggered the callback. |
maxRemoteSources | Maximum number of remote video sources that can be recived both statically and dynamically. |
c | The VidyoConnector that triggered the callback. |
networkInterface | The VidyoNetworkInterface which described the interface. |
c | The VidyoConnector that triggered the callback. |
networkInterface | The VidyoNetworkInterface which described the interface. |
c | The VidyoConnector that triggered the callback. |
networkInterface | The VidyoNetworkInterface which described the interface. |
transportType | The Transport type for which this interface was selected. |
c | The VidyoConnector that triggered the callback. |
networkInterface | The VidyoNetworkInterface which described the interface. |
state | The new state of the interface. |
c | The VidyoConnector that triggered the callback. |
participant | The VidyoParticipant who joined the conference. |
c | The VidyoConnector that triggered the callback. |
participant | The VidyoParticipant who left the conference. |
c | The VidyoConnector that triggered the callback. |
remoteCamera | Remote camera that was added. |
participant | The VidyoParticipant who owns the remote camera. |
c | The VidyoConnector that triggered the callback. |
remoteCamera | Remote camera that was removed. |
participant | The VidyoParticipant who owns the remote camera. |
c | The VidyoConnector that triggered the callback. |
remoteCamera | Remote camera that was removed. |
participant | The VidyoParticipant who owns the remote camera. |
state | The new state of the remote camera. |
c | The VidyoConnector that triggered the callback. |
remoteMicrophone | Remote microphone that was added. |
participant | The VidyoParticipant who owns the remote microphone. |
c | The VidyoConnector that triggered the callback. |
remoteMicrophone | Remote microphone that was removed. |
participant | The VidyoParticipant who owns the remote microphone. |
c | The VidyoConnector that triggered the callback. |
remoteMicrophone | Remote microphone that was removed. |
participant | The VidyoParticipant who owns the remote microphone. |
state | The new state of the remote microphone. |
c | The VidyoConnector that triggered the callback. |
remoteWindowShare | Remote window that was added, or shared. |
participant | The VidyoParticipant who owns the remote window. |
c | The VidyoConnector that triggered the callback. |
remoteWindowShare | Remote window that was removed, or no longer shared. |
participant | The VidyoParticipant who owns the remote window. |
c | The VidyoConnector that triggered the callback. |
remoteWindowShare | Remote window that was removed, or no longer shared. |
participant | The VidyoParticipant who owns the remote window. |
state | The new state of the remote window. |
c | The VidyoConnector that triggered the callback. |
c | The VidyoConnector that triggered the callback. |
c | The VidyoConnector that triggered the callback. |
recorderInCall | LMI_TRUE when a recorder joined, LMI_FALSE when no recorder are in the call |
e | |
localCamera |
e | |
localCamera |
e | |
localCamera |
e | |
localCamera | |
state |
e | |
localMicrophone |
e | |
localMicrophone |
e | |
localMicrophone |
e | |
localMicrophone | |
state |
e | |
localMonitor |
e | |
localMonitor |
e | |
localMonitor |
e | |
localMonitor | |
state |
e | |
localRenderer |
e | |
localRenderer |
e | |
localRenderer |
e | |
localRenderer | |
state |
e | |
localSpeaker |
e | |
localSpeaker |
e | |
localSpeaker |
e | |
localSpeaker | |
state |
e | |
localWindowShare |
e | |
localWindowShare |
e | |
localWindowShare |
e | |
localWindowShare | |
state |
e | |
logRecord |
e | |
compressedFileName | Name if the compression output file. |
result | Result of the file compression. |
e | |
networkInterface |
e | |
networkInterface |
e | |
networkInterface | |
transportType |
e | |
networkInterface | |
state |
e | |
remoteCamera | |
user | |
call | |
room | |
participant |
e | |
remoteCamera | |
user | |
call | |
room | |
participant |
e | |
remoteCamera | |
user | |
call | |
room | |
participant | |
state |
e | |
remoteMicrophone | |
user | |
call | |
room | |
participant |
e | |
remoteMicrophone | |
user | |
call | |
room | |
participant |
e | |
remoteMicrophone | |
user | |
call | |
room | |
participant | |
state |
e | |
remoteRenderer | |
user | |
call | |
room |
e | |
remoteRenderer | |
user | |
call | |
room |
e | |
remoteSpeaker | |
user | |
call | |
room |
e | |
remoteSpeaker | |
user | |
call | |
room |
e | |
remoteWindowShare | |
user | |
call | |
room | |
participant |
e | |
remoteWindowShare | |
user | |
call | |
room | |
participant |
e | |
remoteWindowShare | |
user | |
call | |
room | |
participant | |
state |
gateway | The VidyoGateway that triggered the callback. |
reason | Reason why the connection could not be established. |
gateway | The VidyoGateway that triggered the callback. |
reason | Reason why the connection could not be established. |
gateway | The VidyoGateway that triggered the callback. |
w | |
videoFrame | |
state |
w | The VidyoLocalWindowShare object. |
icon |
w | The VidyoLocalWindowShare object. |
videoFrame | |
state |
f | |
meeting | |
attendee |
f | |
meeting | |
attendee |
room | Pointer to the VidyoRoom that triggered the callback. |
cpuEncode | Percent of maximum CPU available to encode the streams. |
cpuDecode | Percent of maximum CPU available to decode the streams. |
bandwidthSend | Percentage of maximum bandwidth avaialble to transmit the streams. |
bandwidthReceive | Percentage of maximum bandwidth avaialble to receive the streams. |
room | Pointer to the VidyoRoom that triggered the callback. |
result | result of the operation to delete the room on the server. |
room | Pointer to the VidyoRoom that triggered the callback. |
dynamicSelectedParticipants | Order of participants that need to be rendered in the dynamic layout. |
dynamicSelectedCameras | List of cameras for dynamicSelectedParticipants. |
room | Pointer to the VidyoRoom that triggered the callback. |
result | Result of an attempt to enter the VidyoRoom. |
room | Pointer to the VidyoRoom that triggered the callback. |
reason | Reason why VidyoUser exited VidyoRoom. |
room | Pointer to the VidyoRoom that triggered the callback. |
records | Pointer to the vector of VidyoChatMessage records. |
historySize | Total number of records in the room history. |
result | Result of VidyoRoomGetHistory() call. |
room | Pointer to the VidyoRoom that triggered the callback. |
result | Result of the VidyoRoomGetRoomProperties request. |
roomProperties | Pointer to the VidyoRoomProperties object or NULL on failure. |
room | Pointer to the VidyoRoom that triggered the callback. |
participant | Pointer to an audio-only participant. |
isAudioOnly | LMI_TRUE if the participant is audio only, otherwise LMI_FALSE |
room | Pointer to the VidyoRoom that triggered the callback. |
maxRemoteSources | Maximum number of remote video sources that can be recived both statically and dynamically. |
room | Pointer to the VidyoRoom that triggered the callback. |
reason | Reason why media had beed disabled. |
room | Pointer to the VidyoRoom that triggered the callback. |
room | Pointer to the VidyoRoom that triggered the callback. |
reason | Reason why media failed. |
room | Pointer to the VidyoRoom that triggered the callback. |
room | Pointer to the VidyoRoom that triggered the callback. |
chatMessage | Pointer to the VidyoChatMessage object created by the server from VidyoRoomSendMessage() call. |
room | Pointer to the VidyoRoom that triggered the callback. |
participant | Pointer to the VidyoParticipant object that read the message. |
messageId | The ID of the VidyoChatMessage that was read. |
room | Pointer to the VidyoRoom that triggered the callback. |
participant | Pointer to the VidyoParticipant object that sent the message. |
chatMessage | Pointer to the VidyoChatMessage object containing the message. |
room | Pointer to the VidyoRoom that triggered the callback. |
searchText | Case insensitive text used for the search. |
records | Pointer to the vector of VidyoChatMessage records. |
result | Results of VidyoRoomSearch() call. |
room | Pointer to the VidyoRoom that triggered the callback. |
participant | Pointer to the VidyoParticipant object whose typing state changed. |
typingIndication | New typing state of the VidyoParticipant. |
room | Pointer to the VidyoRoom that triggered the callback. |
participant | Pointer to the VidyoParticipant object. |
room | Pointer to the VidyoRoom that triggered the callback. |
participant | Pointer to the VidyoParticipant object. |
room | Pointer to the VidyoRoom that triggered the callback. |
roomProperties | Updated room properties. |
room | Pointer to the VidyoRoom that triggered the callback. |
isFavorite | |
result |
room | Pointer to the VidyoRoom that triggered the callback. |
result | Result of the VidyoRoomSetProperties request. |
room | Pointer to the VidyoRoom that triggered the callback. |
subject | New subject of the VidyoRoom. |
r | The VidyoRoom that triggered the callback. |
recorderInCall | LMI_TRUE when the call is recorded, LMI_FALSE when recording stops |
u | |
call | |
result | |
createToken |
u | |
call | |
inviter |
u | |
reason |
u | |
searchResult | |
roomInfo |
u | |
contact | |
result |
u | |
licenseKey |
u | |
licenseKey |
u | |
reason |
u | |
result | |
secure |
u | |
searchResult | |
roomInfo |
u | |
uri |
u | |
room | |
result | |
createToken |
u | |
room | |
inviter | |
message |
u | |
searchText | |
searchResult | |
roomInfo | |
numRecords |
u | |
token | |
tokenType |
u | |
contact |
u | |
contact |
u | |
searchText | |
searchResult | |
contacts | |
numRecords |
u |
c | |
connProperties | Property values |
obj | The VidyoCalendar object to construct. |
other | The call object to make a copy of. |
c | |
feedback | |
meeting | |
createToken | A unique string token to match this method call with the resulting asynchronous callback |
obj | The VidyoCalendar object to destruct. |
f | Feedback structure to hold registered member functions |
connectState | Indicates any state transitions against the connection for the calendar service |
disconnected | Indicates tha the connection for the calendar service has been disconnected. |
meetingEvent | Event triggered against the scheduled time for a meeting |
meetingCreatedByService | Indicates the results for the creation of a meeting that was initiated by the calendar service |
meetingCreated | Indicates the results for the creation of a meeting by the local user |
meetingUpdatedByService | Indicates the results for the update of a meeting that was initiated by the calendar service |
meetingUpdated | Indicates the results on the update of a meeting |
meetingRemovedByService | Indicates the results for the removal of a meeting that was initiated by the calendar service |
meetingRemoved | Indicates the results for the removal of a meeting |
getMeetingResults | |
alloc |
obj | The VidyoCalendarFeedback object to construct. |
other | The feedback object to make a copy of. |
obj | The VidyoCalendarFeedback object to destruct. |
serviceType | Type of service to retrieve the connection param types for |
c | Pointer to the VidyoCalendar object. |
c | Vidyo calendar service object. |
year | 4 digit year to search for the meetings within - (yyyy). |
month | 1-2 digit month to search for the meetings within - ((mm) - no zero padding required). |
day | 1-2 digit day to search for meetings within - ((dd) - no zero padding required). |
createToken | A unique string token to match this method call with the resulting asynchronous callback |
c | Vidyo calendar service object. |
year | 4 digit year to search for the meetings within - (yyyy). |
month | 1-2 digit month to search for the meetings within - (<m>m - no zero padding required). |
createToken | A unique string token to match this method call with the resulting asynchronous callback |
c | Vidyo calendar service object. |
year | 4 digit year to search for the meetings within - (yyyy). |
month | 1-2 digit month to search for the meetings within - (mm - no zero padding required). |
day | 1-2 digit day that falls within the week which we will search for the meetings within - (dd - no zero padding required). Week used to retrieve meetings will begin on a Sunday and end on a Saturday, based on the weekday passed in from the parameters. |
createToken | A unique string token to match this method call with the resulting asynchronous callback |
c | Pointer to the VidyoCalendar object. |
c | Pointer to the VidyoCalendar object. |
calendarMgr | |
feedback | |
alloc |
calMgr | |
feedback | Calendar feeback handle |
svcId | The service Id to create the calendar against. Use VidyoCalendarManagerGetCalendarSvcString to retrieve the string for the ID |
calendarName | Name of the calendar or calendar folder that will be used to operate against for the service. An empty string indicates that the default calendar should be used. |
createToken |
calMgr | |
cal | Calendar handle |
calendarMgr |
f | Feedback structure to hold registered member functions |
serviceStatus | |
uninitialized | |
calendarCreated | |
alloc |
calendarId | Enumerated calendar ID to retrieve the string value for. |
calendarMgr | Calendar manager object to retrieve the supported calendar types from. |
serviceTypes | Calendar manager object to retrieve the supported calendar types from. |
calendarMgr |
calendarMgr | Calendar manager object to retrieve the supported calendar types from. |
serviceTypes | The set of calendar service types that the implementer wants to let the user of the library use. |
calendarMgr |
c | Calendar service to update the meeting against |
feedback | Instance belonging to this calendar service |
meeting | Meeting object to update |
createToken | A unique string token to match this method call with the resulting asynchronous callback |
c | |
searchText | |
beginDate | |
endDate | |
index | |
pageSize |
c | Pointer to the VidyoCalendar object. |
regexp | A string that contains a regular expression which will be used in searches, to identify whether a meeting contains a reference to a Vidyo room URL or key. If the search finds the string, then it will accessible through the meeting attributes |
c | Calendar service to update the meeting against |
feedback | Instance belonging to this calendar service |
meeting | Meeting object to update |
createToken | A unique string token to match this method call with the resulting asynchronous callback |
c | Pointer to the VidyoCall object. |
onInitiated | Callback that is triggered when the enter operation completes. This could be a successful enter or a failure due to permissions, etc. |
onEnded | Callback that is triggered when the room has been exited. |
obj | Pointer to the VidyoCall object to construct. |
other | Pointer to the VidyoCall object to make a copy of. |
obj | Pointer to the VidyoCall object to destruct. |
c | Pointer to the VidyoCall object. |
c | Pointer to the VidyoCall object. |
participants | Pointer to the LmiVector of VidyoParticipant objects. |
c | Pointer to the VidyoCall object. |
renderers | Pointer to the LmiVector of VidyoRemoteRenderer objects. |
c | Pointer to the VidyoCall object. |
speakers | Pointer to the LmiVector of VidyoRemoteSpeaker objects. |
c | Pointer to the VidyoCall object. |
c |
c | Pointer to the VidyoCall object. |
c | Pointer to the VidyoCall object. |
onInitiated | Callback that is triggered when the enter operation completes. This could be a successful enter or a failure due to permissions, etc. |
onEnded | Callback that is triggered when the room has been exited. |
c | The VidyoCall object. |
onMessageReceived | Callback that is triggered when a new message has been received. |
onMessageAcknowledged | Callback that is triggered when a sent message has been acknowledged. |
onMessageRead | Callback that is triggered when a sent message has been read. |
onMessageTypingIndication | Callback that is triggered when a remote participant is typing. |
c | The VidyoCall object. |
onSetSubject | Callback that is triggered when the subject has been changed. |
c | Pointer to the VidyoCall object. |
c | Pointer to the VidyoCall object. |
message | Message to be sent. |
c | Pointer to the VidyoCall object. |
subject | New subject of the VidyoCall. |
c | The VidyoConnector object. |
other | The VidyoConnector object from which to assign. |
c | The VidyoConnector object. |
viewId | A platform specific view ID where the participant will be rendered. |
localCamera | The VidyoLocalCamera that will be shown. |
displayCropped | Render the image as cropped. Otherwise letterbox. |
allowZoom | Allow zooming of the image with mouse or touch. |
c | The VidyoConnector object. |
viewId | A platform specific view ID where the participant will be rendered. |
remoteCamera | The VidyoRemoteCamera that will be shown. |
displayCropped | Render the image as cropped. Otherwise letterbox. |
allowZoom | Allow zooming of the image with mouse or touch. |
c | The VidyoConnector object. |
viewId | A platform specific view ID where the participant will be rendered. |
remoteWindowShare | The VidyoRemoteWindowShare that will be shown. |
displayCropped | Render the image as cropped. Otherwise letterbox. |
allowZoom | Allow zooming of the image with mouse or touch. |
c | The VidyoConnector object. |
host | Host to which the connection will be made. |
token | Token generated by the backend that contains the user ID and other metadata that will be used for authentication. |
displayName | A display name that will be used in the UI. |
resourceId | An alphanumeric string. This resourceId does not need to be pre-provisioned but in order to create a connection between multiple participants, the same resourceId has to be specified. |
onSuccess | Callback that is triggered when the connection is sucessfully established. |
onFailure | Callback that is triggered when the connection establishemnt failed. |
onDisconnected | Callback that is triggered when an established connection is disconnected. |
c | The VidyoConnector object. |
viewId | A platform-specific view ID where the VidyoConnector's rendering window will be added as a child window. It will be used to render the preview and composite remote participants. |
viewStyle | Type of the composite renderer which represents the visual style and behaviour. |
remoteParticipants | Number of remote participants to composite into the window. Setting the value to 0 (zero) will render the preview only. |
logFileFilter |
A space-separated (or comma-separated) sequence of names of log levels, each optionally followed by a category. Categories are separated from levels by the character '@'. Either a level or category may be specified as 'all' or '*' (interchangeably), meaning all levels or categories. A level specified without a category is equivalent to a level@*. The levels are: 'fatal', 'error', 'warning', 'info', 'debug', 'sent', 'received', 'enter', and 'leave'. The level may be prefixed by '-' or '!' (interchangeably), meaning to remove the given level (or levels, see below) from the given category. The string 'none' is equivalent to '-all'. The first level in the list may be prefixed by '+'. If the first level begins with a '+' or '-'/'!', the string is used to modify the listener's existing levels and categories. Otherwise, unless the add parameter is true, the levels and categories specified in the string replace all existing levels and categories for the listener. The leading character '+' may be present before other levels, but is ignored. Unless they are preceded by '=', level names imply other levels as well. In particular, each of the levels 'fatal', 'error', 'warning', 'info', and 'debug' implies the levels higher than it, when specified positively; 'sent' and 'received' always imply each other; and 'enter' and 'leave' always imply each other. See VidyoConnectorGetLogCategories for determining the names and descriptions of registered categories. Level names are case-insensitive; category names are case-sensitive. Example: "all" - all levels, all categories. Example: "all -enter" - all categories, all levels but enter and leave. Example: "*@VidyoClient" - all levels for the VidyoClient category. Example: "-*@VidyoClient" - remove all levels from the VidyoClient category. Example: "debug" - all categories, fatal, error, warning, info, and debug levels. Example: "=debug" - all categories, debug level only. Example: "all -=enter" - all categories, all levels but enter (leave is still included). Example: "error@VidyoClient" - fatal and error only for the VidyoClient category. Example: "warning debug@VidyoClient" - fatal, error, and warning for all categories; additionally, info and debug for the VidyoClient category. |
logFileName | Full path to the file where the log should be stored; otherwise, NULL or empty string, in order to use the default OS-dependent writable path. |
userData | Arbitrary user data that can be retrieved later. |
c | The VidyoConnector object to construct. |
other | The VidyoConnector object from which to construct a copy. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object to destruct. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
port | Local listening port for debugging. |
logFilter | Log filter to use on the debug port. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
viewId | The view ID of the view to hide. |
c | The VidyoConnector object. |
onAdded | Callback that is triggered for every new or existing camera added. |
onRemoved | Callback that is triggered when the camera is removed. |
onSelected | Callback that is triggered when a camera is selected for use. |
onStateUpdated | Callback that is triggered when a camera state is updated. |
c | The VidyoConnector object. |
onAdded | Callback that is triggered for every new or existing microphone added. |
onRemoved | Callback that is triggered when the microphone is removed. |
onSelected | Callback that is triggered when a microphone is selected for use. |
onStateUpdated | Callback that is triggered when a microphone state is updated. |
c | The VidyoConnector object. |
onAdded | Callback that is triggered for every new or existing monitor added. |
onRemoved | Callback that is triggered when the monitor is removed. |
onSelected | Callback that is triggered when a monitor is selected for use. |
onStateUpdated | Callback that is triggered when a monitor state is updated. |
c | The VidyoConnector object. |
onAdded | Callback that is triggered for every new or existing speaker added. |
onRemoved | Callback that is triggered when the speaker is removed. |
onSelected | Callback that is triggered when a speaker is selected for use. |
onStateUpdated | Callback that is triggered when a speaker state is updated. |
c | The VidyoConnector object. |
onAdded | Callback that is triggered for every new or existing window added. |
onRemoved | Callback that is triggered when the window is removed. |
onSelected | Callback that is triggered when a window is selected for use. |
onStateUpdated | Callback that is triggered when a window state is updated. |
c | The VidyoConnector object. |
onLog | Callback that is triggered for every new log record. |
filter |
A space-separated (or comma-separated) sequence of names of log levels, each optionally followed by a category. Categories are separated from levels by the character '@'. Either a level or category may be specified as 'all' or '*' (interchangeably), meaning all levels or categories. A level specified without a category is equivalent to a level@*. The levels are: 'fatal', 'error', 'warning', 'info', 'debug', 'sent', 'received', 'enter', and 'leave'. The level may be prefixed by '-' or '!' (interchangeably), meaning to remove the given level (or levels, see below) from the given category. The string 'none' is equivalent to '-all'. The first level in the list may be prefixed by '+'. If the first level begins with a '+' or '-'/'!', the string is used to modify the listener's existing levels and 45categories. Otherwise, unless the add parameter is true, the levels and categories specified in the string replace all existing levels and categories for the listener. The leading character '+' may be present before other levels, but is ignored. Unless they are preceded by '=', level names imply other levels as well. In particular, each of the levels 'fatal', 'error', 'warning', 'info', and 'debug' implies the levels higher than it, when specified positively; 'sent' and 'received' always imply each other; and 'enter' and 'leave' always imply each other. See VidyoConnectorGetLogCategories for determining the names and descriptions of registered categories. Level names are case-insensitive; category names are case-sensitive. Example: "all" - all levels, all categories. Example: "all -enter" - all categories, all levels but enter and leave. Example: "*@VidyoClient" - all levels for the VidyoClient category. Example: "-*@VidyoClient" - remove all levels from the VidyoClient category. Example: "debug" - all categories, fatal, error, warning, info, and debug levels. Example: "=debug" - all categories, debug level only. Example: "all -=enter" - all categories, all levels but enter (leave is still included). Example: "error@VidyoClient" - fatal and error only for the VidyoClient category. Example: "warning debug@VidyoClient" - fatal, error, and warning for all categories; additionally, info and debug for the VidyoClient category. |
c | The VidyoConnector object. |
onChatMessageReceived | Callback that is triggered when a chat message is received from a participant. |
c | The VidyoConnector object. |
onAdded | Callback that is triggered for every new or existing network interface added. |
onRemoved | Callback that is triggered when the network interface is removed. |
onSelected | Callback that is triggered when a network interface is selected for use. |
onStateUpdated | Callback that is triggered when a network interface state changes. |
c | The VidyoConnector object. |
onJoined | Callback that is triggered when another participant joins a conference. |
onLeft | Callback that is triggered when an existing participant leaves a conference. |
onDynamicChanged | Callback that is triggered when the order of participants has changed, based on their importance according to active speech detection. |
onLoudestChanged | Callback that is triggered when a new participant becomes the loudest, based on active speech detection. |
c | The VidyoConnector object. |
onRecorderInCallChanged | Callback that is triggered when a recorder joins or leaves the call. |
c | The VidyoConnector object. |
onAdded | Callback that is triggered each time one of the other participants adds a remote camera into a conference. |
onRemoved | Callback that is triggered each time one of the other participants removes a remote camera from a conference. |
onStateUpdated | Callback that is triggered each time one of the other participants remote camera chagnes state in a conference. |
c | The VidyoConnector object. |
onAdded | Callback that is triggered when another participant adds a microphone into a conference. |
onRemoved | Callback that is triggered when another participant removes a microphone from a conference. |
onStateUpdated | Callback that is triggered when another participant microphone changes state in a conference. |
c | The VidyoConnector object. |
onAdded | Callback that is triggered when another participant adds a window-share into a conference. |
onRemoved | Callback that is triggered when another participant removes a window-share from a conference. |
onStateUpdated | Callback that is triggered when another participant window-share changes state in a conference. |
c | The VidyoConnector object. |
onAvailableResourcesChanged | Callback that is triggered when local resource availability changes. |
onMaxRemoteSourcesChanged | Callback that is triggered when the maximum number of decoded sources changes. |
c | The VidyoConnector object. |
onWebProxyCredentialsRequest | Callback that is triggered when web proxy credentials are requested. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
localCamera | Local camera to select. NULL if none of them should be selected. |
c | The VidyoConnector object. |
localMicrophone | Local microphone to select. NULL if none of them should be selected. |
c | The VidyoConnector object. |
localMonitor | Local monitor to share in a conference. NULL if none of them should be shared. |
c | The VidyoConnector object. |
localSpeaker | Local speaker to select. NULL if none of them should be selected. |
c | The VidyoConnector object. |
localWindowShare | Local window to share in a conference. NULL if none of them should be shared. |
c | The VidyoConnector object. |
networkInterface | Network interface to be selected. |
c | The VidyoConnector object. |
networkInterface | Network interface to be selected. |
c | The VidyoConnector object. |
message | A message to send to all the other participants. |
c | The VidyoConnector object. |
privacy | Flag to show/hide the local camera. |
c | The VidyoConnector object. |
latitude | Latitude of the geographic coordinate. |
longitude | Longitude of the geographic coordinate. |
c | The VidyoConnector object. |
privacy | Flag to mute/unmute the microphone. |
c | The VidyoConnector object. |
mode | Desired operating mode. |
c | The VidyoConnector object. |
preview | Flag to show/hide the local camera preview. |
c | The VidyoConnector object. |
privacy | Flag to mute/unmute the speaker. |
c | The VidyoConnector object. |
viewId | A platform specific view ID to be positioned. |
speedPercentage | Percentage of animation speed with default of 50, 100 for slowest and 0 for instant. |
c | The VidyoConnector object. |
viewId | A platform specific view ID to be positioned. |
red | Red component of the color 0-255. |
green | Green component of the color 0-255. |
blue | Blue component of the color 0-255. |
c | The VidyoConnector object. |
proxyAddress | The web proxy server address. |
username | The web proxy server user name. |
password | The web proxy server password. |
c | The VidyoConnector object. |
viewId | A platform specific view ID to be positioned. |
showMeters | Boolean to show or hide the audio meters. |
c | The VidyoConnector object. |
preview | Flag to show/hide the local camera preview. |
c | The VidyoConnector object. |
viewId | A platform specific view ID to be positioned. |
x | X coordinate. |
y | Y coordinate. |
width | Width of the view. |
height | Height of the view. |
c | The VidyoConnector object. |
viewId | A platform specific view ID to be positioned. |
showLabel | Boolean to show or hide the label. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
c | The VidyoConnector object. |
logger |
obj | The VidyoDevice object. |
other | The call object to make a copy of. |
obj | The VidyoDevice object to construct. |
other | The call object to make a copy of. |
obj | The VidyoDevice object comparing against. |
other | The VidyoDevice object comparing. |
device | Pointer to the VidyoDevice object to destruct. |
d | The VidyoDevice object. |
d | The VidyoDevice object. |
d | The VidyoDevice object. |
e | The VidyoEndpoint object. |
viewId | A platform specific view ID where the participant will be rendered. |
localCamera | The VidyoLocalCamera that will be shown. |
displayCropped | Render the image as cropped. Otherwise letterbox. |
allowZoom | Allow zooming of the image with mouse or touch. |
e | The VidyoEndpoint object. |
viewId | A platform specific view ID where the participant will be rendered. |
camera | The VidyoRemoteCamera that will be shown. |
displayCropped | Render the image as cropped. Otherwise letterbox. |
allowZoom | Allow zooming of the image with mouse or touch. |
e | The VidyoEndpoint object. |
viewId | A platform specific view ID where the participant will be rendered. |
remoteWindowShare | The VidyoRemoteWindowShare that will be shown. |
displayCropped | Render the image as cropped. Otherwise letterbox. |
allowZoom | Allow zooming of the image with mouse or touch. |
e | |
compressedFileName | Name if the compression output file. |
onComplete | Callback that is triggered when the compression completes. |
e | |
viewId | A platform specific parent view ID where the VidyoEndpoint's rendering window will be added as a child window. It will be used to render preview and composite remote participants. |
viewStyle | Type of the composite renderer which represents the visual style and behaviour. |
remoteParticipants | Number of remote participants to composite into the window. Setting the value to 0 will render preview only. |
consoleLogFilter | |
fileLogFilter | |
fileLogName | |
alloc |
obj | The VidyoEndpoint object to construct. |
other | The call object to make a copy of. |
e | |
monitor | |
width | |
height |
e | |
viewId | A platform specific parent view ID where the rendering window will be added as a child window. |
x | X coordinate of the child window within the parent view ID. |
y | Y coordinate of the child window within the parent view ID. |
width | Width of the child window within the parent view ID. |
height | Height of the child window within the parent view ID. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
obj | The VidyoEndpoint object to destruct. |
e | The endpoint object to disable. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
port | Debug port will output debug logging. |
logFilter | Log filter to use on the debug port. |
e | |
fileLogName | |
fileLogFilter |
e | |
licenseKey |
e |
e |
e | The endpoint object to extract stats. |
e | The endpoint object to extract stats. |
e | The VidyoEndpoint object. |
viewId | The view ID of the view to hide. |
e | The VidyoEndpoint object. |
e | |
localCamera |
e | |
localCamera |
e | |
localMicrophone | |
previewedPreCall |
e | |
localMicrophone |
e | |
localMonitor |
e | |
localMonitor |
e | |
localRenderer |
e | |
localRenderer |
e | |
localSpeaker |
e | |
localSpeaker |
e | |
localWindowShare |
e | |
localWindowShare |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered for every new or existing camera added. |
onRemoved | Callback that is triggered when the camera is removed. |
onSelected | Callback that is triggered when a camera is selected for use. |
onStateUpdated | Callback that is triggered when a camera state is updated. |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered for every new or existing microphone added. |
onRemoved | Callback that is triggered when the microphone is removed. |
onSelected | Callback that is triggered when a microphone is selected for use. |
onStateUpdated | Callback that is triggered when a microphone state is updated. |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered for every new or existing monitor added. |
onRemoved | Callback that is triggered when the monitor is removed. |
onSelected | Callback that is triggered when a monitor is selected for use. |
onStateUpdated | Callback that is triggered when a monitor state is updated. |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered for every new or existing window added. |
onRemoved | Callback that is triggered when the window is removed. |
onSelected | Callback that is triggered when a window is selected for use. |
onStateUpdated | Callback that is triggered when a window state changes. |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered for every new or existing speaker added. |
onRemoved | Callback that is triggered when the speaker is removed. |
onSelected | Callback that is triggered when a speaker is selected for use. |
onStateUpdated | Callback that is triggered when a speaker state is updated. |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered for every new or existing window added. |
onRemoved | Callback that is triggered when the window is removed. |
onSelected | Callback that is triggered when a window is selected for use. |
onStateUpdated | Callback that is triggered when a window state changes. |
e | The VidyoEndpoint object. |
onLog | Callback that is triggered for every new log record. |
filter |
A space-separated (or comma-separated) sequence of names of log levels, each optionally followed by a category. Categories are separated from levels by the character '@'. Either a level or category may be specified as 'all' or '*' (interchangeably), meaning all levels or categories. A level specified without a category is equivalent to a level@*. The levels are: 'fatal', 'error', 'warning', 'info', 'debug', 'sent', 'received', 'enter', and 'leave'. The level may be prefixed by '-' or '!' (interchangeably), meaning to remove the given level (or levels, see below) from the given category. The string 'none' is equivalent to '-all'. The first level in the list may be prefixed by '+'. If the first level begins with a '+' or '-'/'!', the string is used to modify the listener's existing levels and 45categories. Otherwise, unless the add parameter is true, the levels and categories specified in the string replace all existing levels and categories for the listener. The leading character '+' may be present before other levels, but is ignored. Unless they are preceded by '=', level names imply other levels as well. In particular, each of the levels 'fatal', 'error', 'warning', 'info', and 'debug' implies the levels higher than it, when specified positively; 'sent' and 'received' always imply each other; and 'enter' and 'leave' always imply each other. See VidyoEndpointGetLogCategories for determining the names and descriptions of registered categories. Level names are case-insensitive; category names are case-sensitive. Example: "all" - all levels, all categories. Example: "all -enter" - all categories, all levels but enter and leave. Example: "*@VidyoClient" - all levels for the VidyoClient category. Example: "-*@VidyoClient" - remove all levels from the VidyoClient category. Example: "debug" - all categories, fatal, error, warning, info, and debug levels. Example: "=debug" - all categories, debug level only. Example: "all -=enter" - all categories, all levels but enter (leave is still included). Example: "error@VidyoClient" - fatal and error only for the VidyoClient category. Example: "warning debug@VidyoClient" - fatal, error, and warning for all categories; additionally, info and debug for the VidyoClient category. |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered for every new or existing network interface added. |
onRemoved | Callback that is triggered when the network interface is removed. |
onSelected | Callback that is triggered when a network interface is selected for use. |
onStateUpdated | Callback that is triggered when a network interface state changes. |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered when another participant adds a camera into a conference. |
onRemoved | Callback that is triggered when another participant removes a camera from a conference. |
onStateUpdated | Callback that is triggered when another participant updates a camera state in a conference. |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered when another participant adds a microphone into a conference. |
onRemoved | Callback that is triggered when another participant removes a microphone from a conference. |
onStateUpdated | Callback that is triggered when another participant updates a microphone state in a conference. |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered for every new or existing window added. |
onRemoved | Callback that is triggered when the window is removed. |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered for every new or existing window added. |
onRemoved | Callback that is triggered when the window is removed. |
e | The VidyoEndpoint object. |
onAdded | Callback that is triggered when another participant adds a window-share into a conference. |
onRemoved | Callback that is triggered when another participant removes a window-share from a conference. |
onStateUpdated | Callback that is triggered when another participant updates a window-share state in a conference. |
e | |
localRenderer |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
localCamera | Camera to be selected. |
e | The VidyoEndpoint object. |
localMicrophone | Microphone to be selected. |
e | The VidyoEndpoint object. |
localMonitor | Monitor to be selected. |
e | The VidyoEndpoint object. |
localSpeaker | Speaker to be selected. |
e | The VidyoEndpoint object. |
localWindowShare | Window to be selected. |
e | The VidyoEndpoint object. |
networkInterface | Network interface to be selected. |
e | The VidyoEndpoint object. |
networkInterface | Network interface to be selected. |
e | |
applicationTag |
e | The VidyoEndpoint object. |
privacy | Flag to show/hide the camera. |
e | |
consoleLogFilter |
e | |
levelName | |
categoryName | |
on |
e | The VidyoEndpoint object. |
debugLogFilter | Log filter to use on the debug port. |
e | |
fileLogFilter |
e | |
levelName | |
categoryName | |
on |
e | |
latitude | |
longitude |
e | The VidyoEndpoint object. |
privacy | Flag to mute/unmute the microphone. |
e | The VidyoEndpoint object. |
mode | Desired operating mode. |
e | |
poolId |
e | The VidyoEndpoint object. |
preview | Flag to show/hide the camera preview. |
e | The VidyoEndpoint object. |
privacy | Flag to mute/unmute the speaker. |
e | The VidyoEndpoint object. |
viewId | A platform specific view ID to be positioned. |
speedPercentage | Percentage of animation speed with default of 50, 100 for slowest and 0 for instant. |
e | The VidyoEndpoint object. |
viewId | A platform specific view ID to be positioned. |
red | Red component of the color 0-255. |
green | Green component of the color 0-255. |
blue | Blue component of the color 0-255. |
e | The VidyoEndpoint object. |
viewId | A platform specific view ID to be positioned. |
showMeters | Boolean to show or hide the audio meters. |
e | The VidyoEndpoint object. |
preview | Flag to show/hide the camera preview. |
e | The VidyoEndpoint object. |
viewId | A platform specific view ID to be positioned. |
x | X coordinate. |
y | Y coordinate. |
width | Width of the view. |
height | Height of the view. |
e | The VidyoEndpoint object. |
viewId | A platform specific view ID to be positioned. |
showLabel | Boolean to show or hide the label. |
e |
e |
e |
e |
e |
e |
e |
e |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | The VidyoEndpoint object. |
e | |
licenseKey | |
isValid |
obj | The VidyoGateway object. |
other | The call object to make a copy of. |
gateway | The VidyoGateway object. |
host | Host to which the connection will be made. |
token | Token generated by the backend that contains the user ID and other metadata that will be used for authentication. |
displayName | A display name that will be used in the UI. |
resourceId | An alphanumeric string. This resourceId does does not need to be pre-provisioned but in order to create a connection between multiple participants, the same resource ID has to be specified. |
onSuccess | Callback that is triggered when the connection is sucessfully established. |
onFailure | Callback that is triggered when the connection establishemnt failed. |
onDisconnected | Callback that is triggered when an established connection is disconnected. |
obj | The VidyoGateway object to construct. |
other | The call object to make a copy of. |
gateway | Pointer to the VidyoGateway object to destruct. |
gateway | The VidyoGateway object. |
c | The VidyoLocalCamera object. |
localRenderer |
c | The VidyoLocalCamera object. |
remoteRenderer |
c | The VidyoLocalCamera object. |
allow | Allow or prohibit camera control. |
obj | The VidyoLocalCamera object to construct. |
other | The call object to make a copy of. |
c | The VidyoLocalCamera object. |
pan | Number of nudges to pan the camera. |
tilt | Number of nudges to tilt the camera. |
zoom | Number of nudges to zoom the camera. |
obj | The VidyoLocalCamera object to destruct. |
c | The VidyoLocalCamera object. |
c | The VidyoLocalCamera object. |
c | The VidyoLocalCamera object. |
c | The VidyoLocalCamera object. |
c | The VidyoLocalCamera object. |
capabilities |
c | The VidyoLocalCamera object. |
c | The VidyoLocalCamera object. |
c | The VidyoLocalCamera object. |
localRenderer |
c | The VidyoLocalCamera object. |
remoteRenderer |
c | The VidyoLocalCamera object. |
c | The VidyoLocalCamera object. |
aspectRatioWidth | Width of the aspect ratio. |
aspectRatioHeight | Height of the aspect ration. |
c | The VidyoLocalCamera object. |
minWidth | |
minHeight | |
maxWidth | |
maxHeight | |
maxFrameInterval | |
minFrameInterval | |
aspectRatioWidth | |
aspectRatioHeight | |
temporalSpatialTradeOff |
c | The VidyoLocalCamera object. |
capabilities | |
temporalSpatialTradeOff |
c | The VidyoLocalCamera object. |
minWidth | |
minHeight | |
maxWidth | |
maxHeight | |
maxFrameInterval | |
minFrameInterval | |
aspectRatioWidth | |
aspectRatioHeight | |
temporalSpatialTradeOff | |
capabilities |
c | The VidyoLocalCamera object. |
width | Maximum width. |
height | Maximum height. |
frameInterval | Maximum frame interval. Setting to 0 selects the fastest frame rate. |
c | The VidyoLocalCamera object. |
localRenderer | |
x | |
y | |
width | |
height | |
frameInterval |
c | The VidyoLocalCamera object. |
previewLabel | Display name to set on the camera. |
c | The VidyoLocalCamera object. |
show | Show or hide camera controls. |
m | The VidyoLocalMicrophone object. |
speaker |
m | The VidyoLocalMicrophone object. |
remoteSpeaker |
obj | The VidyoLocalMicrophone object to construct. |
other | The call object to make a copy of. |
obj | The VidyoLocalMicrophone object to destruct. |
m | The VidyoLocalMicrophone object. |
m | The VidyoLocalMicrophone object. |
dir |
m | The VidyoLocalMicrophone object. |
m | The VidyoLocalMicrophone object. |
m | The VidyoLocalMicrophone object. |
m | The VidyoLocalMicrophone object. |
m | The VidyoLocalMicrophone object. |
m | The VidyoLocalMicrophone object. |
microphone | The local microphone object to extract stats. |
m | The VidyoLocalMicrophone object. |
m | The VidyoLocalMicrophone object. |
m | The VidyoLocalMicrophone object. |
m | The VidyoLocalMicrophone object. |
dtmfTone |
m | The VidyoLocalMicrophone object. |
speaker |
m | The VidyoLocalMicrophone object. |
remoteSpeaker |
m | The VidyoLocalMicrophone object. |
m | The VidyoLocalMicrophone object. |
autoGain |
m | The VidyoLocalMicrophone object. |
speaker | |
isEnable |
m | The VidyoLocalMicrophone object. |
signalType | The signal type of the microphone. |
m | The VidyoLocalMicrophone object. |
voiceProcessing |
m | The VidyoLocalMicrophone object. |
volumePercent |
microphone | The local microphone object to extract stats. |
m | The VidyoLocalMonitor object. |
renderer |
m | The VidyoLocalMonitor object. |
remoteRenderer |
m | The VidyoLocalMonitor object. |
obj | The VidyoLocalMonitor object to construct. |
other | The call object to make a copy of. |
obj | The VidyoLocalMonitor object to destruct. |
m | The VidyoLocalMonitor object. |
m | The VidyoLocalMonitor object. |
m | The VidyoLocalMonitor object. |
maxWidth | Maximum width of the preview image. |
maxHeight | Maximum height of the preview image. |
videoFrame | Video Frame to which the image will be assigned. |
w | |
maxWidth | Maximum width of the preview image. |
maxHeight | Maximum height of the preview image. |
onComplete | Callback that is triggered when a preview frame is captured. |
m | The VidyoLocalMonitor object. |
w |
m | The VidyoLocalMonitor object. |
renderer |
m | The VidyoLocalMonitor object. |
remoteRenderer |
m | The VidyoLocalMonitor object. |
maxFrameInterval | |
minFrameInterval | |
maxWidth | |
minWidth | |
maxHeight | |
minHeight |
m | The VidyoLocalMonitor object. |
frameInterval |
m | The VidyoLocalMonitor object. |
maxFrameInterval | |
minFrameInterval | |
width | |
height | |
scaleFactor |
obj | The VidyoLocalRenderer object to construct. |
other | The call object to make a copy of. |
obj | The VidyoLocalRenderer object to destruct. |
r |
r |
r |
r |
r |
r | |
numStreams |
r | |
x | |
y | |
width | |
height |
obj | The VidyoLocalSpeaker object to construct. |
other | The call object to make a copy of. |
obj | The VidyoLocalSpeaker object to destruct. |
s | The VidyoLocalSpeaker object. |
s | The VidyoLocalSpeaker object. |
s | The VidyoLocalSpeaker object. |
s | The VidyoLocalSpeaker object. |
s | The VidyoLocalSpeaker object. |
s | The VidyoLocalSpeaker object. |
dtmfTone |
s | The VidyoLocalSpeaker object. |
s | The VidyoLocalSpeaker object. |
volumePercent |
s | The VidyoLocalSpeaker object. |
w | The VidyoLocalWindowShare object. |
renderer |
w | The VidyoLocalWindowShare object. |
remoteRenderer |
m |
obj | The VidyoLocalWindowShare object to construct. |
other | The call object to make a copy of. |
obj | The VidyoLocalWindowShare object to destruct. |
w | The VidyoLocalWindowShare object. |
maxWidth | Maximum width of the icon image. |
maxHeight | Maximum height of the icon image. |
onComplete | Callback that is triggered when a icon frame is captured. |
w | The VidyoLocalWindowShare object. |
w | The VidyoLocalWindowShare object. |
w | The VidyoLocalWindowShare object. |
w | The VidyoLocalWindowShare object. |
maxWidth | Maximum width of the preview image. |
maxHeight | Maximum height of the preview image. |
onComplete | Callback that is triggered when a preview frame is captured. |
w | The VidyoLocalWindowShare object. |
w | The VidyoLocalWindowShare object. |
w | The VidyoLocalWindowShare object. |
w | The VidyoLocalWindowShare object. |
renderer |
w | The VidyoLocalWindowShare object. |
remoteRenderer |
m | |
maxFrameInterval | |
minFrameInterval | |
maxWidth | |
minWidth | |
maxHeight | |
minHeight |
w | The VidyoLocalWindowShare object. |
frameInterval | |
showCursor | |
redactOccludedAreas |
m | |
maxFrameInterval | |
minFrameInterval | |
width | |
height | |
scaleFactor |
m | Meeting to add the attendee to |
a | Attendee to add |
obj | The VidyoMeeting object to construct. |
other | The call object to make a copy of. |
obj | The VidyoRoom object to destruct. |
f | |
attendeeAdded | |
attendeeRemoved | |
alloc |
obj | The VidyoMeetingFeedback object to destruct. |
m | Meeting to retrieve attendees from |
a | List of attendees for the meeting as per the role argument |
m | Meeting to retrieve attendees from |
a | List of attendees for the meeting as per the role argument |
r | The participation role to filter the attendee list by. |
m |
m |
m |
m |
m |
m |
m |
m |
m |
m |
m | Meeting to remove the attendee from |
a | Attendee to remove |
m | Meeting to send an invite response for |
a | Attendee that the response is associated with |
s | The participation status for the meeting - typically accepted-declined-tentative. |
m |
d | The VidyoNetworkInterface object to construct. |
s | The existing VidyoNetworkInterface object to copy. |
n | The VidyoNetworkInterface object to destruct. |
n | The VidyoNetworkInterface object. |
n | The VidyoNetworkInterface object. |
n | The VidyoNetworkInterface object. |
n | The VidyoNetworkInterface object. |
n | The VidyoNetworkInterface object. |
obj | The VidyoParticipant object to construct. |
other | The call object to make a copy of. |
obj | The VidyoParticipant object to destruct. |
p | The VidyoParticipant object. |
contact |
p | The VidyoParticipant object. |
p | The VidyoParticipant object. |
p | The VidyoParticipant object. |
p | The VidyoParticipant object. |
p | The VidyoParticipant object. |
p | The VidyoParticipant object. |
p | The VidyoParticipant object. |
c | The VidyoRemoteCamera object. |
localRenderer | |
mode |
obj | The VidyoRemoteCamera object to construct. |
other | The call object to make a copy of. |
c | The VidyoRemoteCamera object. |
pan | Number of nudges to pan the camera. |
tilt | Number of nudges to tilt the camera. |
zoom | Number of nudges to zoom the camera. |
obj | The VidyoRemoteCamera object to destruct. |
c | The VidyoRemoteCamera object. |
c | The VidyoRemoteCamera object. |
index |
c | The VidyoRemoteCamera object. |
c | The VidyoRemoteCamera object. |
c | The VidyoRemoteCamera object. |
c | The VidyoRemoteCamera object. |
localRenderer |
c | The VidyoRemoteCamera object. |
localRenderer | |
x | |
y | |
width | |
height | |
frameInterval |
c | The VidyoRemoteCamera object. |
show | Show or hide camera controls. |
m | The VidyoRemoteMicrophone object. |
speaker | |
mode |
obj | The VidyoRemoteMicrophone object to construct. |
other | The call object to make a copy of. |
obj | The VidyoRemoteMicrophone object to destruct. |
m | The VidyoRemoteMicrophone object. |
m | The VidyoRemoteMicrophone object. |
m | The VidyoRemoteMicrophone object. |
m | The VidyoRemoteMicrophone object. |
speaker |
obj | The VidyoRemoteRenderer object to construct. |
other | The call object to make a copy of. |
obj | The VidyoRemoteRenderer object to destruct. |
r |
r |
obj | The VidyoRemoteSpeaker object to construct. |
other | The call object to make a copy of. |
obj | The VidyoRemoteSpeaker object to destruct. |
s |
s |
w | The VidyoRemoteWindowShare object. |
renderer |
obj | The VidyoRemoteWindowShare object to construct. |
other | The call object to make a copy of. |
obj | The VidyoRemoteWindowShare object to destruct. |
w | The VidyoRemoteWindowShare object. |
w | The VidyoRemoteWindowShare object. |
w | The VidyoRemoteWindowShare object. |
renderer |
w | The VidyoRemoteWindowShare object. |
localRenderer | |
x | |
y | |
width | |
height | |
frameInterval |
r | |
onEntered | Callback that is triggered when the enter operation completes. This could be a successful enter or a failure due to permissions, etc. |
onExited | Callback that is triggered when the room has been exited. |
r | |
onMediaRouteAcquired | Callback that is triggered when the acquire media route operation is complete. |
r | Vidyo room object. |
localCamera | |
removeOthers |
r | Vidyo room object. |
localMicrophone | |
removeOthers | |
isAES |
r | Vidyo room object. |
localMonitor | |
removeOthers |
r | Vidyo room object. |
localRenderer | |
removeOthers |
r | Vidyo room object. |
localSpeaker | |
removeOthers | |
isAES |
r | Vidyo room object. |
localWindowShare | |
removeOthers |
obj | The VidyoRoom object to construct. |
other | The call object to make a copy of. |
r | Vidyo room object. |
onDeleteResult | Callback that is triggered when delete operation completes. |
obj | The VidyoRoom object to destruct. |
r |
r | |
onMediaEnabled | Callback that is triggered when the media has been successfully enabled. |
onMediaFailed | Callback that is triggered when the could not be enabled. |
onMediaDisabled | Callback that is triggered when the media has been disabled after being previously enabled sucessfully. |
r | |
onEntered | Callback that is triggered when the enter operation completes. This could be a successful enter or a failure due to permissions, etc. |
onExited | Callback that is triggered when the room has been exited. |
r | The room object. |
numMessages | The number of latest messages to request. |
onGetHistoryResults | Callback that is triggered when history results are ready. |
r | The room object. |
messageId | The ID of the message to use as an apex. |
numMessagesBefore | The number of messages before the apex. |
numMessagesAfter | The number of messages after the apex. |
onGetHistoryResults | Callback that is triggered when history results are ready. |
r | The room object. |
time | The time to use as an apex. |
numMessagesBefore | The number of messages before the apex. |
numMessagesAfter | The number of messages after the apex. |
onGetHistoryResults | Callback that is triggered when history results are ready. |
r |
r | |
onGetRoomPropertiesResult | Callback that is triggered when get properties operation completes. |
r | Vidyo room object. |
cameras |
r | Vidyo room object. |
mics |
r | Vidyo room object. |
monitors |
r | Vidyo room object. |
renderers |
r | Vidyo room object. |
speakers |
r | Vidyo room object. |
windowShares |
r | The room object to extract stats. |
stats | The stats object to fill. |
r |
r |
r |
r | Vidyo room object. |
r | |
userId | |
message |
r | |
message |
r | |
userIds | |
message |
r |
r | Vidyo room object. |
searchText | The text to search the messages in the room. |
index | The start index from which the recent rooms are required. A value of '0' represents rooms starting from the beginning. A value of 'n' represents rooms starting from 'n'th record. This is used for paging the response. |
pageSize | The maximum number of room records that can be sent in the response. This is used for paging the response. |
onMessageSearchResults | Callback that is triggered when message search results are ready. |
r | The VidyoRoom object. |
onMessageReceived | Callback that is triggered when a new message has been received. |
onMessageAcknowledged | Callback that is triggered when a sent message has been acknowledged. |
onMessageRead | Callback that is triggered when a sent message has been read. |
onMessageTypingIndication | Callback that is triggered when a remote participant is typing. |
r | The VidyoRoom object. |
onParticipantJoined | Callback that is triggered when another participant joins a conference. |
onParticipantLeft | Callback that is triggered when an existing participant leaves a conference. |
onDynamicParticipantChanged | Callback that is triggered when the order of participants has changed, based on their importance according to active speech detection. |
onLoudestParticipantChanged | Callback that is triggered when a new participant becomes the loudest, based on active speech detection. |
r | The VidyoRoom object. |
onRecorderInCallChanged | Callback that is triggered when a recorder joins or leaves the call. |
r | The VidyoRoom object. |
onAvailableResourcesChanged | Callback that is triggered when local resource availability changes. |
onMaxRemoteSourcesChanged | Callback that is triggered when the maximum number of decoded sources changes. |
r | The VidyoRoom object. |
onRoomPropertiesChanged | Callback that is triggered when room properties have changed. |
r | The VidyoRoom object. |
onSetSubject | Callback that is triggered when the subject has been changed. |
r |
r | Vidyo room object. |
localCamera |
r | Vidyo room object. |
localMicrophone |
r | Vidyo room object. |
localMonitor |
r | Vidyo room object. |
localRenderer |
r | Vidyo room object. |
localSpeaker |
r | Vidyo room object. |
localWindowShare |
r | |
message |
r | The room object. |
messageId | The message id of message being acknowledged. |
r | The room object. |
typingIndication | The typing indication state. |
r | |
generation | |
x | |
y | |
width | |
height | |
frameInterval |
r | |
renderer |
r | Vidyo room object. |
isFavorite | |
onSetFavoriteResult | Callback that is triggered when set favorite operation completes. |
r | |
count |
r | |
count |
r | |
roomProperties | |
onSetRoomPropertiesResult | Callback that is triggered when set properties operation completes. |
r | |
subject |
r | |
userData |
r | Vidyo room object. |
r | The VidyoRoom object. |
r | The VidyoRoom object. |
r | The VidyoRoom object. |
r | The VidyoRoom object. |
r | The VidyoRoom object. |
r | The VidyoRoom object. |
u | |
userId |
u | |
fieldSet | |
fieldRelations | |
fieldValues | |
searchToken | |
index | |
pageSize | |
onRoomSearchResults | Callback that is triggered when the room search results are ready. |
u | |
fieldSet | |
fieldValues | |
searchToken | |
index | |
pageSize | |
onUserSearchResults | Callback that is triggered when the user search results are ready. |
u | |
userId |
u | |
userId |
user | |
endpoint | |
alloc |
obj | The VidyoUser object to construct. |
other | The call object to make a copy of. |
u | |
userId | |
createToken | |
onCallCreated | Callback that is triggered when the call creation results are ready. |
u | |
id | |
createToken | |
onRoomCreated | Callback that is triggered when the room creation results are ready. |
u | |
id | |
createToken | |
onRoomCreated | Callback that is triggered when the room creation results are ready. |
u | |
name | |
description | |
createToken | |
onRoomCreated | Callback that is triggered when the room creation results are ready. |
obj | The VidyoUser object to destruct. |
u | |
userId | |
onGetContactResult | Callback that is triggered when the contact search results are ready. |
u | |
userIds | |
createToken | |
onRoomCreated | Callback that is triggered when the room creation results are ready. |
u | |
roster |
u |
u | |
index | The start index from which the recent rooms are required. A value of '0' represents rooms starting from the beginning. A value of 'n' represents rooms starting from 'n'th record. This is used for paging the response. |
pageSize | The maximum number of room records that can be sent in the response. This is used for paging the response. |
onFavoriteRoomResults | Callback that is triggered when the favorite room search results are ready. |
u |
u | Vidyo user object. |
index | The start index from which the recent rooms are required. A value of '0' represents rooms starting from the beginning. A value of 'n' represents rooms starting from 'n'th record. This is used for paging the response. |
pageSize | The maximum number of room records that can be sent in the response. This is used for paging the response. |
onRecentRoomResults | Callback that is triggered when the recent room search results are ready. |
r | The user object to extract stats. |
stats | The stats object to fill. |
u | Pointer to the VidyoUser object. |
username | Username of the user logging in. |
password | Password of the user logging in. |
host | Hostname or the IP address of the server. |
port | Optional port of the server. Default is "5222" for xmpp, "443" for wss. |
serviceType | Optional type of the service. Default is "wss". |
onLoginComplete | Callback that is triggered when the user login operation is complete. This could be a successful login or a failure to login due to credentials, hostname, etc. |
onLoggedOut | Callback that is triggered when the user is logged out. |
onConnectionStatusChanged | Callback that is triggered when the user's connection status temporarily changes due to network lag and might be re-established without logging out. |
onTokenReceived | Callback that is triggered when the user receives a token that can be used for subsequent logins. This token can be stored in stead of a password. |
onWebProxyCredentialsRequest | Callback that is triggered when the user is behind a web proxy which requires credentials to establish a connection. |
u | Pointer to the VidyoUser object. |
displayName | Display name of the guest user. |
host | Hostname or the IP address of the server. |
port | Optional port of the server. Default is "5222" for xmpp, "443" for wss. |
serviceType | Optional type of the service. Default is "wss". |
onLoginComplete | Callback that is triggered when the user login operation is complete. This could be a successful login or a failure to login due to credentials, hostname, etc. |
onLoggedOut | Callback that is triggered when the user is logged out. |
onConnectionStatusChanged | Callback that is triggered when the user's connection status temporarily changes due to network lag and might be re-established without logging out. |
onTokenReceived | Callback that is triggered when the user receives a token that can be used for subsequent logins. This token can be stored in stead of a password. |
onWebProxyCredentialsRequest | Callback that is triggered when the user is behind a web proxy which requires credentials to establish a connection. |
u | Pointer to the VidyoUser object. |
accessToken | The short-term token used to re-login. |
host | Hostname or the IP address of the server. |
port | Optional port of the server. Default is "5222" for xmpp, "443" for wss. |
serviceType | Optional type of the service. Default is "wss". |
onLoginComplete | Callback that is triggered when the user login operation is complete. This could be a successful login or a failure to login due to credentials, hostname, etc. |
onLoggedOut | Callback that is triggered when the user is logged out. |
onConnectionStatusChanged | Callback that is triggered when the user's connection status temporarily changes due to network lag and might be re-established without logging out. |
onTokenReceived | Callback that is triggered when the user receives a token that can be used for subsequent logins. This token can be stored in stead of a password. |
onWebProxyCredentialsRequest | Callback that is triggered when the user is behind a web proxy which requires credentials to establish a connection. |
u | Pointer to the VidyoUser object. |
refreshToken | The short-term token used to re-login. |
host | Hostname or the IP address of the server. |
port | Optional port of the server. Default is "5222" for xmpp, "443" for wss. |
serviceType | Optional type of the service. Default is "wss". |
onLoginComplete | Callback that is triggered when the user login operation is complete. This could be a successful login or a failure to login due to credentials, hostname, etc. |
onLoggedOut | Callback that is triggered when the user is logged out. |
onConnectionStatusChanged | Callback that is triggered when the user's connection status temporarily changes due to network lag and might be re-established without logging out. |
onTokenReceived | Callback that is triggered when the user receives a token that can be used for subsequent logins. This token can be stored in stead of a password. |
onWebProxyCredentialsRequest | Callback that is triggered when the user is behind a web proxy which requires credentials to establish a connection. |
u | Pointer to the VidyoUser object. |
provisionToken | The provision token used to login. |
host | Hostname or the IP address of the server. |
port | Optional port of the server. Default is "5222" for xmpp, "443" for wss. |
serviceType | Optional type of the service. Default is "wss". |
onLoginComplete | Callback that is triggered when the user login operation is complete. This could be a successful login or a failure to login due to credentials, hostname, etc. |
onLoggedOut | Callback that is triggered when the user is logged out. |
onConnectionStatusChanged | Callback that is triggered when the user's connection status temporarily changes due to network lag and might be re-established without logging out. |
onTokenReceived | Callback that is triggered when the user receives a token that can be used for subsequent logins. This token can be stored in stead of a password. |
onWebProxyCredentialsRequest | Callback that is triggered when the user is behind a web proxy which requires credentials to establish a connection. |
user |
u | The VidyoUser object. |
onCallCreatedByInvite | Callback that is triggered when the user is being invited to a call. |
u | The VidyoUser object. |
onUpdateSelf | Callback that is triggered when the users' own contact information changes. |
onUpdateRosterContact | Callback that is triggered when a roster contact is updated. |
onRemoveRosterContact | Callback that is triggered when a contact is removed from the roster . |
u | The VidyoUser object. |
onLicenseReceived | Callback that is triggered when the new license is received from the server. |
onGetLicenseKey | Callback that is triggered when the user needs a previousely received license key. |
u | The VidyoUser object. |
onRoomCreatedByInvite | Callback that is triggered when the user is being invited to a room. |
u | |
userId |
u | |
searchText | |
index | |
pageSize | |
onRoomSearchResults | Callback that is triggered when the room search results are ready. |
u | |
searchText | |
index | |
pageSize | |
onRoomSearchResults | Callback that is triggered when the room search results are ready. |
u | |
searchText | |
index | |
pageSize | |
onRoomSearchResults | Callback that is triggered when the room search results are ready. |
u | |
searchText | |
index | |
pageSize | |
onRoomSearchResults | Callback that is triggered when the room search results are ready. |
u | |
searchText | |
index | |
pageSize | |
onRoomSearchResults | Callback that is triggered when the room search results are ready. |
u | |
searchText | |
index | |
pageSize | |
onRoomSearchResults | Callback that is triggered when the room search results are ready. |
u | |
searchText | |
index | |
pageSize | |
onUserSearchResults | Callback that is triggered when the user search results are ready. |
u | |
ca | The contents of the Certificate Authrity file. |
caFilePath | The full path Certificate Authrity file. |
caDir | The full path to the directory containing Certificate Authrity files. |
u | |
displayName |
u | |
proxyAddress | |
username | |
password |
u | The VidyoUser object. |
u | The VidyoUser object. |
u | The VidyoUser object. |
u | The VidyoUser object. |
u | |
state | |
status |
obj | The VidyoVirtualDeviceManager object to construct. |
other | The call object to make a copy of. |
obj | The VidyoVirtualDeviceManager object to destruct. |
m | |
endpoint | |
camera | |
state |
m | |
endpoint | |
microphone | |
state |
m | |
endpoint | |
speaker | |
state |
m | |
endpoint |
obj | The VidyoVirtualShareManager object to construct. |
other | The call object to make a copy of. |
obj | The VidyoVirtualShareManager object to destruct. |
m | |
endpoint | |
monitor | |
state |
m | |
endpoint | |
windowShare | |
state |
m | |
endpoint |