Table of Contents:

Vidyo Legal Copyright Notice

Legend

[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.

Package: CalendarManager

Member Of:

VidyoClient

Description:

The CalendarServices package encapsulates all APIs related to calendar specific actions and items (i.e. a meeting, attendees, etc).

Member Types:

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.

Package: CalendarSchedule

Member Of:

VidyoClient

Description:

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.

Member Types:

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).

Package: Connector

Member Of:

VidyoClient

Description:

Package that encapsulates all the APIs required to build a simple videoconferencing application.

Member Types:

VidyoConnector The videoconferencing API that handles all aspects of the media (audio/video) connection.
VidyoGateway A wrapper for Vidyo gateways.

Member Functions:

VidyoConnectorInitialize Initialize the VidyoConnector API.
VidyoConnectorUninitialize Uninitialize the VidyoConnector API.

Package: Device

Member Of:

VidyoClient

Description:

The VidyoDevice package.

Member Types:

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

Package: Endpoint

Member Of:

VidyoClient

Description:

The VidyoClient package encapsulates all APIs required to build a vidyo conferencing application.

Member Types:

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

Member Functions:

VidyoClientGetBuildTag
VidyoClientGetVersion
VidyoClientInitialize
VidyoClientUninitialize

Package: Meeting

Member Of:

VidyoClient

Description:

Represents a meeting or appointment. The meeting may have information in it to identify it as a Vidyo specific meeting.

Member Types:

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.

Package: Participant

Member Of:

VidyoClient

Description:

The VidyoParticipant package.

Package: Stats

Member Of:

VidyoClient

Description:

Statistics for VidyoClient

Member Types:

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.

Package: VidyoClient

Member Of:

Lmi

Description:

The VidyoClient package encapsulates all APIs required to build a vidyo conferencing application.

Member Packages:

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

Member Types:

VidyoMeetingAttendee Stores information for a meeting attendee.
VidyoNetworkInterface Stores network interface information.

Type: VidyoAttendeeParticipationRole

Member Of:

VidyoMeetingAttendee

Description:

This indicates the role of the local user in a meeting. Maps directly to participation roles defined in IETF RFC 5545.

Include:

Lmi/VidyoClient/VidyoMeetingAttendee.h

Values:

VIDYO_ATTENDEEPARTICIPATIONROLE_Chair
VIDYO_ATTENDEEPARTICIPATIONROLE_Required
VIDYO_ATTENDEEPARTICIPATIONROLE_Optional
VIDYO_ATTENDEEPARTICIPATIONROLE_Informational Maps to NON-PARTICIPANT role in RFC type

Type: VidyoAttendeeParticipationStatus

Member Of:

VidyoMeetingAttendee

Description:

This indicates the role of the local user in a meeting. Maps directly to participation statuses defined in IETF RFC 5545.

Include:

Lmi/VidyoClient/VidyoMeetingAttendee.h

Values:

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

Type: VidyoBandwidthSummaryStats

Member Of:

Stats

Description:

Staticstics for an endpoint rate shaper.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoCachedLogger

Member Of:

VidyoLogger

Description:

Include:

Lmi/VidyoClient/VidyoLogger.h

Member Functions:

Type: VidyoCalendar REFERENCE COUNTED

Member Of:

CalendarSchedule

Description:

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

Include:

Lmi/VidyoClient/VidyoCalendar.h

Member Variables:

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.

Member Types:

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.

Member Functions:

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

Example 1:

				
		TODO -

		VidyoCalendar myVidyoCalendar;
		VidyoCalendarFeedback myVidyoCalendarFeedback;
		LmiAllocator* alloc;

	
			

Type: VidyoCalendarConnProps

Member Of:

VidyoCalendar

Description:

Properties for connecting to a calendar service.

Include:

Lmi/VidyoClient/VidyoCalendarConnProps.h

Member Variables:

connPropType VidyoCalendarConnectParamType
connPropValue LmiString

Member Functions:

Type: VidyoCalendarConnectParamType

Member Of:

VidyoCalendar

Description:

This type indicates the connection parameter types that would be required for connecting to a specific calendar service.

Include:

Lmi/VidyoClient/VidyoCalendarConnProps.h

Values:

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.

Type: VidyoCalendarCreateResult

Member Of:

CalendarManager

Description:

Indicates the result code for the creation of the calendar instance .

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Values:

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)

Type: VidyoCalendarFeedback REFERENCE COUNTED

Member Of:

CalendarSchedule

Description:

Interface for registering callbacks that notify an application about events on the VidyoCalendar object. Multiple feedbacks can be registerd on the same VidyoCalendar.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Member Types:

Member Callbacks:

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

- VidyoCalendarGetMeetingsByDay

- VidyoCalendarSearchMeetings

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

Member Functions:

VidyoCalendarFeedbackConstruct Construct the calendar feedback instance.
VidyoCalendarFeedbackConstructCopy Constructs a VidyoCalendarFeedback object as a copy of another.
VidyoCalendarFeedbackDestruct Destructs an VidyoCalendarFeedback object.

Type: VidyoCalendarManager REFERENCE COUNTED

Member Of:

CalendarManager

Description:

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.

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Member Types:

Member Functions:

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

Example 1:

				
		TODO -

		VidyoCalendar myVidyoCalendar;
		VidyoCalendarFeedback myVidyoCalendarFeedback;
		LmiAllocator* alloc;
	
			

Type: VidyoCalendarManagerDefaultServices

Member Of:

CalendarSchedule

Description:

Calendar service ID's.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Values:

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 .

Type: VidyoCalendarManagerFeedback REFERENCE COUNTED

Member Of:

CalendarManager

Description:

Interface for registering callbacks that notify an application about events on the VidyoCalendarManager object. Multiple feedbacks can be registered on the same VidyoCalendarManager.

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Member Types:

Member Callbacks:

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

Member Functions:

VidyoCalendarManagerFeedbackConstruct

Type: VidyoCalendarServiceCode

Member Of:

CalendarSchedule

Description:

This type indicates the result of an attempt to log in to some service.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Values:

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.

Type: VidyoCalendarServiceStatus

Member Of:

CalendarManager

Description:

Indicates the result code for the creation of the calendar instance .

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Values:

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.

Type: VidyoCalendarState

Member Of:

CalendarSchedule

Description:

Types of services available to reference for calendar specific data and events.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Values:

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

Type: VidyoCall REFERENCE COUNTED

Member Of:

Endpoint

Description:

Establishes and manages a point-to-point call.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Member Variables:

id LmiString Unique ID of the VidyoCall.

Member Types:

VidyoCallEndReason Reasons why a VidyoCall is ending.
VidyoCallInitiatedResult Result of an attempt to enter a VidyoCall.

Member Callbacks:

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.

Member Functions:

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.

Type: VidyoCallEndReason

Member Of:

VidyoCall

Description:

Reasons why a VidyoCall is ending.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoCallInitiatedResult

Member Of:

VidyoCall

Description:

Result of an attempt to enter a VidyoCall.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoChatMessage

Member Of:

Endpoint

Description:

Contains the text message and additional information about who sent it and when.

Include:

Lmi/VidyoClient/VidyoChatMessage.h

Member Variables:

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.

Member Types:

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.

Member Functions:

Type: VidyoChatMessageSenderType

Member Of:

VidyoChatMessage

Description:

Type of the VidyoChatMessage sender.

Include:

Lmi/VidyoClient/VidyoChatMessage.h

Values:

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.

Type: VidyoChatMessageType

Member Of:

VidyoChatMessage

Description:

Type of a message. This type will depend on the content of the message or where it originated.

Include:

Lmi/VidyoClient/VidyoChatMessage.h

Values:

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.

Type: VidyoChatMessageTypingIndication

Member Of:

VidyoChatMessage

Description:

Typing indicator of VidyoParticipant state in the VidyoRoom.

Include:

Lmi/VidyoClient/VidyoChatMessage.h

Values:

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.

Type: VidyoConnector REFERENCE COUNTED

Member Of:

Connector

Description:

The videoconferencing API that handles all aspects of the media (audio/video) connection.

Include:

Lmi/VidyoClient/VidyoConnector.h

Member Types:

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.

Member Callbacks:

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.

Member Functions:

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.

Type: VidyoConnectorDisconnectReason

Member Of:

VidyoConnector

Description:

Reasons why an established connection was disconnected.

Include:

Lmi/VidyoClient/VidyoConnector.h

Values:

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.

Type: VidyoConnectorFailReason

Member Of:

VidyoConnector

Description:

Reasons why a connection attempt failed.

Include:

Lmi/VidyoClient/VidyoConnector.h

Values:

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.

Type: VidyoConnectorMode

Member Of:

VidyoConnector

Description:

Operating modes of a VidyoConnector object.

Include:

Lmi/VidyoClient/VidyoConnector.h

Values:

VIDYO_CONNECTORMODE_Default The default operating mode.
VIDYO_CONNECTORMODE_Foreground Runs in the foreground.
VIDYO_CONNECTORMODE_Background Runs in the background.

Note 1:

The default is currently VIDYO_CONNECTORMODE_Foreground.

Type: VidyoConnectorState

Member Of:

VidyoConnector

Description:

States of a connection, mostly representing the progress of a connection attempt.

Include:

Lmi/VidyoClient/VidyoConnector.h

Values:

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.

Type: VidyoConnectorViewStyle

Member Of:

VidyoConnector

Description:

Styles of the composite renderer, which apply to its layout and behaviour.

Include:

Lmi/VidyoClient/VidyoConnector.h

Values:

VIDYO_CONNECTORVIEWSTYLE_Default The default style.
VIDYO_CONNECTORVIEWSTYLE_Tiles Participants are shown in sizes that best reflect their order of importance.

Note 1:

The default is currently VIDYO_CONNECTORVIEWSTYLE_Tiles.

Type: VidyoConsoleLogger

Member Of:

VidyoLogger

Description:

Include:

Lmi/VidyoClient/VidyoLogger.h

Member Functions:

VidyoConsoleLoggerGetBase

Type: VidyoContact

Member Of:

Endpoint

Description:

Stores contact information and presence status.

Include:

Lmi/VidyoClient/VidyoContact.h

Member Variables:

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

Member Types:

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.

Member Functions:

Type: VidyoContactInfo

Member Of:

Endpoint

Description:

Stores contact information returned from search.

Include:

Lmi/VidyoClient/VidyoContactInfo.h

Member Variables:

id LmiString
name LmiString
handle LmiString
nickname LmiString
emails LmiVector(VidyoContactInfoProperty)
telephones LmiVector(VidyoContactInfoProperty)
groups LmiVector(LmiString)
photo LmiString
timestamp LmiTime

Member Types:

VidyoContactInfoProperty Contact Property that has value and metadata for fields.

Member Functions:

Type: VidyoContactInfoProperty

Member Of:

VidyoContactInfo

Description:

Contact Property that has value and metadata for fields.

Include:

Lmi/VidyoClient/VidyoContactInfo.h

Member Variables:

value LmiString
types LmiVector(LmiString)

Member Functions:

Type: VidyoContactPresenceState

Member Of:

VidyoContact

Description:

Presence status codes.

Include:

Lmi/VidyoClient/VidyoContact.h

Values:

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

Type: VidyoContactProperty

Member Of:

VidyoContact

Description:

Contact Property that has value and metadata for fields.

Include:

Lmi/VidyoClient/VidyoContact.h

Member Variables:

value LmiString
types LmiVector(LmiString)

Member Functions:

Type: VidyoContactSubscriptionState

Member Of:

VidyoContact

Description:

Describes the relationship between a contact publishing its contact information and a contact subscribing to that information.

Include:

Lmi/VidyoClient/VidyoContact.h

Values:

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.

Type: VidyoDevice REFERENCE COUNTED

Member Of:

Device

Description:

A wrapper class for Local and Remote devices.

Include:

Lmi/VidyoClient/VidyoDevice.h

Member Variables:

id LmiString Unique ID of the device.
name LmiString Name of the device.
type VidyoDeviceType Type of the device.

Member Types:

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.

Member Functions:

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.

Type: VidyoDeviceAudioSignalType

Member Of:

VidyoDevice

Description:

Sets the type of the auido signal which determines how it is processed such as noise suppression, echo cancellation etc.

Include:

Lmi/VidyoClient/VidyoDevice.h

Values:

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.

Type: VidyoDeviceState

Member Of:

VidyoDevice

Description:

Operational state of a device.

Include:

Lmi/VidyoClient/VidyoDevice.h

Values:

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.

Type: VidyoDeviceType

Member Of:

VidyoDevice

Description:

Device type.

Include:

Lmi/VidyoClient/VidyoDevice.h

Values:

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.

Type: VidyoEndpoint REFERENCE COUNTED

Member Of:

Endpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Member Types:

VidyoEndpointLogCompressionResult Result of file log compression.
VidyoEndpointMediaState
VidyoEndpointMode Operating modes of the VidyoEndpoint.
VidyoEndpointTone

Member Callbacks:

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

Member Functions:

VidyoEndpointAssignViewToLocalCamera Shows a preview of a local camera in a view.
VidyoEndpointAssignViewToRemoteCamera Shows a participant in a view.
VidyoEndpointAssignViewToRemoteWindowShare Shows a participant in a view.
VidyoEndpointCompressLogs
VidyoEndpointConstruct
VidyoEndpointConstructCopy Constructs an VidyoEndpoint object as a copy of another.
VidyoEndpointCreateRenderer
VidyoEndpointCreateRendererFromViewId
VidyoEndpointCycleCamera Cycles camera selection to the next available camera.
VidyoEndpointCycleMicrophone Cycles microphone selection to the next available microphone.
VidyoEndpointCycleSpeaker Cycles speaker selection to the next available speaker.
VidyoEndpointDestruct Destructs an VidyoEndpoint object.
VidyoEndpointDisable Stop background tasks associated with an endpoint.
VidyoEndpointDisableDebug
VidyoEndpointEnableDebug Enabled debug mode on the endpoint which will start debug logging and enable statistics.
VidyoEndpointEnableFileLogger
VidyoEndpointGenerateLicenseKey
VidyoEndpointGetApplicationTag
VidyoEndpointGetId
VidyoEndpointGetStats Fill in data in VidyoEndpointStats from an endpoint.
VidyoEndpointGetStatsJson Fill in data in VidyoEndpointStats from an endpoint.
VidyoEndpointHideView Hides a view which is used for custom layout of sources.
VidyoEndpointIsDebugEnabled Checks if debug mode is enabled on the endpoint.
VidyoEndpointLocalCameraSelectAdvanced
VidyoEndpointLocalCameraUnselectAdvanced
VidyoEndpointLocalMicrophoneSelectAdvanced
VidyoEndpointLocalMicrophoneUnselectAdvanced
VidyoEndpointLocalMonitorSelectAdvanced
VidyoEndpointLocalMonitorUnselectAdvanced
VidyoEndpointLocalRendererSelectAdvanced
VidyoEndpointLocalRendererUnselectAdvanced
VidyoEndpointLocalSpeakerSelectAdvanced
VidyoEndpointLocalSpeakerUnselectAdvanced
VidyoEndpointLocalWindowShareSelectAdvanced
VidyoEndpointLocalWindowShareUnselectAdvanced
VidyoEndpointRegisterLocalCameraEventListener Registers to get notified about camera events.
VidyoEndpointRegisterLocalMicrophoneEventListener Registers to get notified about microphone events.
VidyoEndpointRegisterLocalMonitorEventListener Registers to get notified about monitor events.
VidyoEndpointRegisterLocalRendererEventListener Registers to get notified about renderer events.
VidyoEndpointRegisterLocalSpeakerEventListener Registers to get notified about speaker events.
VidyoEndpointRegisterLocalWindowShareEventListener Registers to get notified about window events.
VidyoEndpointRegisterLogEventListener Registers to get notified about log events.
VidyoEndpointRegisterNetworkInterfaceEventListener Registers to get notified about network interface events.
VidyoEndpointRegisterRemoteCameraEventListener Registers to get notified about camera events from other participants.
VidyoEndpointRegisterRemoteMicrophoneEventListener Registers to get notified about microphone events from other participants.
VidyoEndpointRegisterRemoteRendererEventListener Registers to get notified about renderer events.
VidyoEndpointRegisterRemoteSpeakerEventListener Registers to get notified about speaker events.
VidyoEndpointRegisterRemoteWindowShareEventListener Registers to get notified about window-shares from other participants.
VidyoEndpointRemoveRenderer
VidyoEndpointSelectDefaultCamera Resets the camera selection to pick the Default camera.
VidyoEndpointSelectDefaultMicrophone Resets the microphone selection to pick the Default microphone.
VidyoEndpointSelectDefaultNetworkInterfaceForMedia Selects the default "any" network interface to be used for Media.
VidyoEndpointSelectDefaultNetworkInterfaceForSignaling Selects the default "any" network interface to be used for Signaling.
VidyoEndpointSelectDefaultSpeaker Resets the speaker selection to pick the Default speaker.
VidyoEndpointSelectLocalCamera Selects the camera to be used.
VidyoEndpointSelectLocalMicrophone Selects the microphone to be used.
VidyoEndpointSelectLocalMonitor Selects the monitor to be used.
VidyoEndpointSelectLocalSpeaker Selects the speaker to be used.
VidyoEndpointSelectLocalWindowShare Selects the window to be used.
VidyoEndpointSelectNetworkInterfaceForMedia Selects the network interface to be used for Media.
VidyoEndpointSelectNetworkInterfaceForSignaling Selects the network interface to be used for Signaling.
VidyoEndpointSetApplicationTag
VidyoEndpointSetCameraPrivacy Sets the flag to show/hide the camera.
VidyoEndpointSetConsoleLoggerFilter
VidyoEndpointSetConsoleLoggerLevelAndCategory
VidyoEndpointSetDebugFilter
VidyoEndpointSetFileLoggerFilter
VidyoEndpointSetFileLoggerLevelAndCategory
VidyoEndpointSetLocation
VidyoEndpointSetMicrophonePrivacy Sets the flag to mute/unmute the microphone.
VidyoEndpointSetMode Sets the operating mode of the VidyoEndpoint.
VidyoEndpointSetPoolId
VidyoEndpointSetPreview [REPLACED BY VidyoEndpointShowPreview] Sets the flag to show/hide the camera preview.
VidyoEndpointSetSpeakerPrivacy Sets the flag to mute/unmute the speaker.
VidyoEndpointSetViewAnimationSpeed Sets the speed of transition animaiton for windows moving around inside the view.
VidyoEndpointSetViewBackgroundColor Shows or hides the label on the view which displays the participant name or preview.
VidyoEndpointShowAudioMeters Shows or hides the audio meters in the view.
VidyoEndpointShowPreview Sets the flag to show/hide the camera preview while in the call.
VidyoEndpointShowViewAt Sets the position of the view every time it's changed on the screen.
VidyoEndpointShowViewLabel Shows or hides the label on the view which displays the participant name or preview.
VidyoEndpointStartDeviceDetection
VidyoEndpointStartLocationDetection
VidyoEndpointStartNetworkInterfaceDetection
VidyoEndpointStartShareDetection
VidyoEndpointStopDeviceDetection
VidyoEndpointStopLocationDetection
VidyoEndpointStopNetworkInterfaceDetection
VidyoEndpointStopShareDetection
VidyoEndpointUnregisterLocalCameraEventListener Unregisters local camera event notifications.
VidyoEndpointUnregisterLocalMicrophoneEventListener Unregisters local microphone event notifications.
VidyoEndpointUnregisterLocalMonitorEventListener Unregisters local monitor event notifications.
VidyoEndpointUnregisterLocalRendererEventListener Unregisters local renderer event notifications.
VidyoEndpointUnregisterLocalSpeakerEventListener Unregisters local speaker event notifications.
VidyoEndpointUnregisterLocalWindowShareEventListener Unregisters local window share event notifications.
VidyoEndpointUnregisterLogEventListener Unregisters log event notifications.
VidyoEndpointUnregisterNetworkInterfaceEventListener Unregisters network interface event notifications.
VidyoEndpointUnregisterRemoteCameraEventListener Unregisters remote camera event notifications.
VidyoEndpointUnregisterRemoteMicrophoneEventListener Unregisters remote microphone event notifications.
VidyoEndpointUnregisterRemoteRendererEventListener Unregisters remote renderer event notifications.
VidyoEndpointUnregisterRemoteSpeakerEventListener Unregisters remote speaker event notifications.
VidyoEndpointUnregisterRemoteWindowShareEventListener Unregisters remote window share event notifications.
VidyoEndpointValidateLicenseKey

Type: VidyoEndpointLogCompressionResult

Member Of:

VidyoEndpoint

Description:

Result of file log compression.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

VIDYO_ENDPOINTLOGCOMPRESSIONRESULT_Success File Compressed successfully.
VIDYO_ENDPOINTLOGCOMPRESSIONRESULT_MiscError The compression failed some miscellaneous reason.

Type: VidyoEndpointMediaState

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

VIDYO_ENDPOINTMEDIASTATE_Idle
VIDYO_ENDPOINTMEDIASTATE_GreenRoom
VIDYO_ENDPOINTMEDIASTATE_Live

Type: VidyoEndpointMode

Member Of:

VidyoEndpoint

Description:

Operating modes of the VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

VIDYO_ENDPOINTMODE_Default The default operating mode.
VIDYO_ENDPOINTMODE_Foreground Runs in the foreground.
VIDYO_ENDPOINTMODE_Background Runs in the background.

Note 1:

The default is currently VIDYO_ENDPOINTMODE_Foreground.

Type: VidyoEndpointStats

Member Of:

Stats

Description:

Statistics for an endpoint.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoEndpointTone

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

VIDYO_ENDPOINTTONE_Join
VIDYO_ENDPOINTTONE_Leave
VIDYO_ENDPOINTTONE_MsgRecv
VIDYO_ENDPOINTTONE_MsgSend
VIDYO_ENDPOINTTONE_Ring
VIDYO_ENDPOINTTONE_Max

Type: VidyoFeedbackLogger

Member Of:

VidyoLogger

Description:

Include:

Lmi/VidyoClient/VidyoLogger.h

Member Callbacks:

Member Functions:

Type: VidyoFileLogger

Member Of:

VidyoLogger

Description:

Include:

Lmi/VidyoClient/VidyoLogger.h

Member Functions:

Type: VidyoFormField

Member Of:

CalendarManager

Description:

Attributes related to an HTML form input field.

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Member Variables:

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

Member Functions:

Type: VidyoFormFieldOption

Member Of:

CalendarManager

Description:

Option properties for an HTML drop down select input field.

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Member Variables:

value LmiString String value representing the option text label
selected LmiBool Indicates whether the option was selected or not

Member Functions:

Type: VidyoFormFieldTextWrapMode

Member Of:

CalendarManager

Description:

This enum is used to represent the wrapping modes defined for a textarea HTML form input field.

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Values:

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.

Type: VidyoFormFieldType

Member Of:

CalendarManager

Description:

This enum contains type values that releate directly to HTML form input fields.

Include:

Lmi/VidyoClient/VidyoFormField.h

Values:

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.

Type: VidyoGateway REFERENCE COUNTED

Member Of:

Connector

Description:

A wrapper for Vidyo gateways.

Include:

Lmi/VidyoClient/VidyoGateway.h

Member Types:

VidyoGatewayDisconnectReason Reasons why an established connection was disconnected.
VidyoGatewayFailReason Reasons why a connection attempt failed.
VidyoGatewayState States of the VidyoGateway.

Member Callbacks:

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.

Member Functions:

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.

Type: VidyoGatewayDisconnectReason

Member Of:

VidyoGateway

Description:

Reasons why an established connection was disconnected.

Include:

Lmi/VidyoClient/VidyoGateway.h

Values:

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.

Type: VidyoGatewayFailReason

Member Of:

VidyoGateway

Description:

Reasons why a connection attempt failed.

Include:

Lmi/VidyoClient/VidyoGateway.h

Values:

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.

Type: VidyoGatewayState

Member Of:

VidyoGateway

Description:

States of the VidyoGateway.

Include:

Lmi/VidyoClient/VidyoGateway.h

Values:

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.

Type: VidyoGenerationDiff

Member Of:

VidyoRoom

Description:

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.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Member Variables:

participant VidyoParticipant
newIndex LmiInt
oldIndex LmiInt

Member Functions:

Type: VidyoHttpLogger

Member Of:

VidyoLogger

Description:

Include:

Lmi/VidyoClient/VidyoLogger.h

Member Functions:

Type: VidyoLocalCamera REFERENCE COUNTED

Member Of:

Device

Description:

This object represents a camera on the local endpoint.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Member Variables:

id LmiString Unique ID.
name LmiString Name.

Member Types:

VidyoLocalCameraPosition Position of the camera.

Member Callbacks:

Member Functions:

VidyoLocalCameraAddToLocalRenderer
VidyoLocalCameraAddToRemoteRenderer
VidyoLocalCameraAllowRemoteCameraControl Allows the PTZ conrol of the camera by remote participants.
VidyoLocalCameraConstructCopy Constructs an VidyoLocalCamera object as a copy of another.
VidyoLocalCameraControlPTZ Send the PTZ Nudge commands to the local camera.
VidyoLocalCameraDestruct Destructs an VidyoLocalCamera object.
VidyoLocalCameraGetId Gets the unique ID of the camera.
VidyoLocalCameraGetName Gets the name of the camera.
VidyoLocalCameraGetPosition Gets the position of the camera.
VidyoLocalCameraGetPreviewLabel Gets the preview label of the camera.
VidyoLocalCameraGetVideoCapabilities
VidyoLocalCameraIsPaused
VidyoLocalCameraIsSuspended Checks if the camera is suspended.
VidyoLocalCameraRemoveFromLocalRenderer
VidyoLocalCameraRemoveFromRemoteRenderer
VidyoLocalCameraResume
VidyoLocalCameraSetAspectRatioConstraint Sets the aspect ratio constraint on the camera which will adjust local camera frames to match.
VidyoLocalCameraSetBoundsConstraint
VidyoLocalCameraSetCapabilitiesConstraint
VidyoLocalCameraSetConstraints
VidyoLocalCameraSetMaxConstraint Sets the maximum resolution and framerate constraint on the local camera. This overrides the defaults which are based on the CPU profile of the endpoint.
VidyoLocalCameraSetPositionInLocalRenderer
VidyoLocalCameraSetPreviewLabel Set the preview label of the camera.
VidyoLocalCameraShowCameraControl Shows camera control when rendering preview.

Type: VidyoLocalCameraPosition

Member Of:

VidyoLocalCamera

Description:

Position of the camera.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Values:

VIDYO_LOCALCAMERAPOSITION_Unknown Position is unknown.
VIDYO_LOCALCAMERAPOSITION_Front Facing towards the screen.
VIDYO_LOCALCAMERAPOSITION_Back Facing away from the screen.

Type: VidyoLocalMicrophone REFERENCE COUNTED

Member Of:

Device

Description:

This object represents a microphone on the local endpoint.

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Member Variables:

id LmiString Unique ID.
name LmiString Name.

Member Types:

Member Callbacks:

Member Functions:

VidyoLocalMicrophoneAddToLocalSpeaker
VidyoLocalMicrophoneAddToRemoteSpeaker
VidyoLocalMicrophoneConstructCopy Constructs an VidyoLocalMicrophone object as a copy of another.
VidyoLocalMicrophoneDestruct Destructs an VidyoLocalMicrophone object.
VidyoLocalMicrophoneDisableDebugRecording
VidyoLocalMicrophoneEnableDebugRecording
VidyoLocalMicrophoneGetAutoGain
VidyoLocalMicrophoneGetId Gets the unique ID of the microphone.
VidyoLocalMicrophoneGetName Gets the name of the microphone.
VidyoLocalMicrophoneGetSignalType Gets signal type of the microphone, which affects how the audio is processed.
VidyoLocalMicrophoneGetVoiceProcessing
VidyoLocalMicrophoneGetVolume
VidyoLocalMicrophoneHideDebugDialog Hides an audio debug dialog for the local microphone.
VidyoLocalMicrophoneIsDebugRecordingEnabled
VidyoLocalMicrophoneIsPaused
VidyoLocalMicrophonePause
VidyoLocalMicrophonePlayTone
VidyoLocalMicrophoneRemoveFromLocalSpeaker
VidyoLocalMicrophoneRemoveFromRemoteSpeaker
VidyoLocalMicrophoneResume
VidyoLocalMicrophoneSetAutoGain
VidyoLocalMicrophoneSetEchoCancellation
VidyoLocalMicrophoneSetSignalType Sets the signal type of the microhone which changes how the auido is processed.
VidyoLocalMicrophoneSetVoiceProcessing
VidyoLocalMicrophoneSetVolume
VidyoLocalMicrophoneShowDebugDialog Shows an audio debug dialog for the local microphone.

Type: VidyoLocalMicrophoneStats

Member Of:

Stats

Description:

Staticstics for a local microphone.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoLocalMonitor REFERENCE COUNTED

Member Of:

Device

Description:

This object represents a monitor on the local endpoint.

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Member Variables:

id LmiString Unique ID.
name LmiString Name.

Member Types:

VidyoLocalMonitorState State of the monitor.

Member Callbacks:

VidyoLocalMonitorOnPreviewDataUriComplete

Member Functions:

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

Type: VidyoLocalMonitorState

Member Of:

VidyoLocalMonitor

Description:

State of the monitor.

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Values:

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.

Type: VidyoLocalRenderer REFERENCE COUNTED

Member Of:

Device

Description:

Include:

Lmi/VidyoClient/VidyoLocalRenderer.h

Member Variables:

id LmiString
name LmiString

Member Types:

VidyoLocalRendererViewStyle Styles of the composite renderer, which apply to its layout and behaviour.

Member Callbacks:

Member Functions:

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

Type: VidyoLocalRendererStats

Member Of:

Stats

Description:

Statistics for a local renderer.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoLocalRendererStreamStats

Member Of:

Stats

Description:

Statistics for a local renderer.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoLocalRendererViewStyle

Member Of:

VidyoLocalRenderer

Description:

Styles of the composite renderer, which apply to its layout and behaviour.

Include:

Lmi/VidyoClient/VidyoLocalRenderer.h

Values:

VIDYO_LOCALRENDERERVIEWSTYLE_Default The default style.
VIDYO_LOCALRENDERERVIEWSTYLE_Tiles Participants are shown in sizes that best reflect their order of importance.

Note 1:

The default is currently VIDYO_LOCALRENDERERVIEWSTYLE_Tiles.

Type: VidyoLocalSpeaker REFERENCE COUNTED

Member Of:

Device

Description:

This object represents a speaker on the local endpoint.

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Member Variables:

id LmiString Unique ID.
name LmiString Name.

Member Types:

Member Callbacks:

Member Functions:

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

Type: VidyoLocalSpeakerStats

Member Of:

Stats

Description:

Staticstics for a local speaker.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoLocalSpeakerStreamStats

Member Of:

Stats

Description:

Staticstics for a local speaker.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoLocalVideoSourceStats

Member Of:

Stats

Description:

Statistics for a local video source.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoLocalWindowShare REFERENCE COUNTED

Member Of:

Device

Description:

This object represents a window share on the local endpoint.

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Member Variables:

id LmiString Unique ID.
name LmiString Name of the window share.
applicationName LmiString Name of the application which owns the window.

Member Types:

VidyoLocalWindowShareState State of the window share.

Member Callbacks:

VidyoLocalWindowShareOnApplicationIconDataUriComplete
VidyoLocalWindowShareOnPreviewDataUriComplete

Member Functions:

VidyoLocalWindowShareAddToLocalRenderer
VidyoLocalWindowShareAddToRemoteRenderer
VidyoLocalWindowShareClearConstraints
VidyoLocalWindowShareConstructCopy Constructs an VidyoLocalWindowShare object as a copy of another.
VidyoLocalWindowShareDestruct Destructs an VidyoLocalWindowShare object.
VidyoLocalWindowShareGetApplicationIconFrameDataUriAsync
VidyoLocalWindowShareGetApplicationName Gets the name of the application which owns the window.
VidyoLocalWindowShareGetId Gets the unique ID of the window share.
VidyoLocalWindowShareGetName Gets the name of the window share.
VidyoLocalWindowShareGetPreviewFrameDataUriAsync
VidyoLocalWindowShareGetProcessId Gets the ID of the process which owns the window share.
VidyoLocalWindowShareIsApplicationNameSet Checks if the name of the application name is set.
VidyoLocalWindowShareIsNameSet Checks if the name of the window share is set.
VidyoLocalWindowShareRemoveFromLocalRenderer
VidyoLocalWindowShareRemoveFromRemoteRenderer
VidyoLocalWindowShareSetBoundsConstraints
VidyoLocalWindowShareSetCapability
VidyoLocalWindowShareSetDiscrerteConstraints

Type: VidyoLocalWindowShareState

Member Of:

VidyoLocalWindowShare

Description:

State of the window share.

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Values:

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.

Type: VidyoLogLevel

Member Of:

VidyoLogRecord

Description:

An identifier for the level, or type, of a logged event. This indicates the degree of significance of the event.

Include:

Lmi/VidyoClient/VidyoLogRecord.h

Values:

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.

Type: VidyoLogRecord

Member Of:

Endpoint

Description:

A record of one logged event.

Include:

Lmi/VidyoClient/VidyoLogRecord.h

Member Variables:

level VidyoLogLevel
categoryName LmiSizeT
name const char*
file const char *
line LmiInt
functionName const char *
message const char *
threadName const char *
eventTime LmiTime

Member Types:

VidyoLogLevel An identifier for the level, or type, of a logged event. This indicates the degree of significance of the event.

Member Functions:

Type: VidyoLogger

Member Of:

Endpoint

Description:

Include:

Lmi/VidyoClient/VidyoLogger.h

Member Types:

VidyoCachedLogger
VidyoConsoleLogger
VidyoFeedbackLogger
VidyoFileLogger
VidyoHttpLogger
VidyoLoggerCategory

Member Functions:

Type: VidyoLoggerCategory

Member Of:

VidyoLogger

Description:

Include:

Lmi/VidyoClient/VidyoLogger.h

Member Functions:

Type: VidyoMediaConnectionTransportInfo

Member Of:

Stats

Description:

Information about media connection transport.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoMediaFormat

Member Of:

Endpoint

Description:

Represents the media format.

Include:

Lmi/VidyoClient/VidyoMediaFormats.h

Values:

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

Type: VidyoMeeting REFERENCE COUNTED

Member Of:

Meeting

Description:

Represents a meeting and all the related attributes.

Include:

Lmi/VidyoClient/VidyoMeeting.h

Member Variables:

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.

Member Types:

VidyoMeetingFeedback Interface for registering callbacks that notify an application about events on the VidyoMeeting object. Multiple feedbacks can be registered on the same VidyoMeeting.

Member Functions:

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

Type: VidyoMeetingActionResult

Member Of:

Meeting

Description:

This type indicates the result of an attempt to create a meeting.

Include:

Lmi/VidyoClient/VidyoMeeting.h

Values:

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.

Type: VidyoMeetingAttendee

Member Of:

VidyoClient

Description:

Stores information for a meeting attendee.

Include:

Lmi/VidyoClient/VidyoMeetingAttendee.h

Member Variables:

name LmiString Attendee name as held by the underlying calendar service
email 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

Member Types:

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.

Member Functions:

Type: VidyoMeetingFeedback REFERENCE COUNTED

Member Of:

VidyoMeeting

Description:

Interface for registering callbacks that notify an application about events on the VidyoMeeting object. Multiple feedbacks can be registered on the same VidyoMeeting.

Include:

Lmi/VidyoClient/VidyoMeeting.h

Member Callbacks:

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

Member Functions:

VidyoMeetingFeedbackConstruct
VidyoMeetingFeedbackDestruct Destructs an VidyoMeetingFeedback object.

Type: VidyoMeetingSearchResult

Member Of:

CalendarSchedule

Description:

This type indicates the result of a search for a meeting(s).

Include:

Lmi/VidyoClient/VidyoCalendar.h

Values:

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.

Type: VidyoMeetingType

Member Of:

Meeting

Description:

Type of meeting.

Include:

Lmi/VidyoClient/VidyoMeeting.h

Values:

VIDYO_MEETINGTYPE_Vidyo A meeting containing Vidyo specific invite information.
VIDYO_MEETINGTYPE_Standard Standard meeting - not Vidyo specific.

Type: VidyoNetworkInterface REFERENCE COUNTED

Member Of:

VidyoClient

Description:

Stores network interface information.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Member Variables:

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.

Member Types:

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.

Member Functions:

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.

Type: VidyoNetworkInterfaceFamily

Member Of:

VidyoNetworkInterface

Description:

The family of a network interface.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Values:

VIDYO_NETWORKINTERFACEFAMILY_Unspecified The interface state is unknown.
VIDYO_NETWORKINTERFACEFAMILY_IPV4 The interface IPV4.
VIDYO_NETWORKINTERFACEFAMILY_IPV6 The interface is IPV6.

Type: VidyoNetworkInterfaceState

Member Of:

VidyoNetworkInterface

Description:

The state of a network interface.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Values:

VIDYO_NETWORKINTERFACESTATE_Unknown The interface state is unknown.
VIDYO_NETWORKINTERFACESTATE_Up The interface is up.
VIDYO_NETWORKINTERFACESTATE_Down The interface is down.

Type: VidyoNetworkInterfaceStats

Member Of:

Stats

Description:

Staticstics for a network interface.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

name LmiString Interface name.
type LmiString Interface type such as wifi or wired.
isUp LmiBool State of the interface.

Member Functions:

Type: VidyoNetworkInterfaceTransportType

Member Of:

VidyoNetworkInterface

Description:

The trasport type used over the network interface.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Values:

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.

Type: VidyoNetworkInterfaceType

Member Of:

VidyoNetworkInterface

Description:

The connection type of a network interface.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Values:

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.

Type: VidyoParticipant REFERENCE COUNTED

Member Of:

Endpoint

Description:

This object represents a participant in the room or call.

Include:

Lmi/VidyoClient/VidyoParticipant.h

Member Variables:

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.

Member Types:

Member Functions:

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.

Type: VidyoParticipantGenerationStats

Member Of:

Stats

Description:

Staticstics for a participnat generation, ordered list of dynamic participants.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoParticipantStats

Member Of:

Stats

Description:

Staticstics for a room.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoRateShaperStats

Member Of:

Stats

Description:

Staticstics for an endpoint rate shaper.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

delayNormal LmiUint Normal delay.
packetsNormal LmiUint Normal packets.
dropNormal LmiUint Dropped normal.
delayRetransmit LmiUint Retransmit delay.
packetsRetransmit LmiUint Retransmitted packets.

Member Functions:

Type: VidyoRemoteCamera REFERENCE COUNTED

Member Of:

Device

Description:

This object represents a camera which belongs to the remote participant.

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Member Variables:

id LmiString Unique ID.
name LmiString Name.

Member Types:

VidyoRemoteCameraMode
VidyoRemoteCameraPosition Position of the camera.

Member Callbacks:

Member Functions:

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.

Type: VidyoRemoteCameraMode

Member Of:

VidyoRemoteCamera

Description:

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Values:

VIDYO_REMOTECAMERAMODE_Dynamic
VIDYO_REMOTECAMERAMODE_Static

Type: VidyoRemoteCameraPosition

Member Of:

VidyoRemoteCamera

Description:

Position of the camera.

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Values:

VIDYO_REMOTECAMERAPOSITION_Unknown Position is unknown.
VIDYO_REMOTECAMERAPOSITION_Front Facing towards the screen.
VIDYO_REMOTECAMERAPOSITION_Back Facing away from the screen.

Type: VidyoRemoteMicrophone REFERENCE COUNTED

Member Of:

Device

Description:

This object represents a microphone which belongs to the remote participant.

Include:

Lmi/VidyoClient/VidyoRemoteMicrophone.h

Member Variables:

id LmiString Unique ID.
name LmiString Name.
signalType VidyoDeviceAudioSignalType Signal Type.

Member Types:

VidyoRemoteMicrophoneMode

Member Callbacks:

Member Functions:

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

Type: VidyoRemoteMicrophoneMode

Member Of:

VidyoRemoteMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoRemoteMicrophone.h

Values:

VIDYO_REMOTEMICROPHONEMODE_Dynamic
VIDYO_REMOTEMICROPHONEMODE_Static

Type: VidyoRemoteMicrophoneStats

Member Of:

Stats

Description:

Staticstics for a remote microphone.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoRemoteRenderer REFERENCE COUNTED

Member Of:

Device

Description:

Include:

Lmi/VidyoClient/VidyoRemoteRenderer.h

Member Variables:

id LmiString
name LmiString

Member Types:

Member Functions:

VidyoRemoteRendererConstructCopy Constructs an VidyoRemoteRenderer object as a copy of another.
VidyoRemoteRendererDestruct Destructs an VidyoRemoteRenderer object.
VidyoRemoteRendererGetId
VidyoRemoteRendererGetName

Type: VidyoRemoteRendererStreamStats

Member Of:

Stats

Description:

Statistics for a remote renderer.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoRemoteSpeaker REFERENCE COUNTED

Member Of:

Device

Description:

Include:

Lmi/VidyoClient/VidyoRemoteSpeaker.h

Member Types:

Member Functions:

VidyoRemoteSpeakerConstructCopy Constructs an VidyoRemoteSpeaker object as a copy of another.
VidyoRemoteSpeakerDestruct Destructs an VidyoRemoteSpeaker object.
VidyoRemoteSpeakerGetId
VidyoRemoteSpeakerGetName

Type: VidyoRemoteSpeakerStreamStats

Member Of:

Stats

Description:

Staticstics for a remote speaker.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoRemoteVideoSourceStats

Member Of:

Stats

Description:

Statistics for a remote video source.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoRemoteWindowShare REFERENCE COUNTED

Member Of:

Device

Description:

This object represents a window share which belongs to the remote participant.

Include:

Lmi/VidyoClient/VidyoRemoteWindowShare.h

Member Variables:

id LmiString Unique ID.
name LmiString Name.

Member Callbacks:

Member Functions:

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

Type: VidyoRoom REFERENCE COUNTED

Member Of:

Endpoint

Description:

Establishes and manages a conference room. See VidyoRoomType for sescription of room types.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Member Variables:

id LmiString Unique ID that identifies a VidyoRoom at the server.
type VidyoRoomType Type of VidyoRoom such as topic or Conversation.

Member Types:

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.

Member Callbacks:

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.

Member Functions:

VidyoRoomAcceptIncoming
VidyoRoomAcquireMediaRoute
VidyoRoomAddLocalCamera
VidyoRoomAddLocalMicrophone
VidyoRoomAddLocalMonitor
VidyoRoomAddLocalRenderer
VidyoRoomAddLocalSpeaker
VidyoRoomAddLocalWindowShare
VidyoRoomConstructCopy Constructs an VidyoRoom object as a copy of another.
VidyoRoomDelete Delete a room.
VidyoRoomDestruct Destructs an VidyoRoom object.
VidyoRoomDisableMedia
VidyoRoomEnableMedia
VidyoRoomEnter
VidyoRoomGetHistory Gets the latest history of the room.
VidyoRoomGetHistoryById Gets the history of the room before and after the messageId.
VidyoRoomGetHistoryByTime Gets the history of the room before and after the messageId.
VidyoRoomGetId
VidyoRoomGetRoomProperties
VidyoRoomGetSelectedLocalCameras
VidyoRoomGetSelectedLocalMicrophones
VidyoRoomGetSelectedLocalMonitors
VidyoRoomGetSelectedLocalRenderers
VidyoRoomGetSelectedLocalSpeakers
VidyoRoomGetSelectedLocalWindowShares
VidyoRoomGetStats Fill in data in VidyoRoomStats from a room.
VidyoRoomGetType
VidyoRoomGetUser
VidyoRoomGetUserData
VidyoRoomHideStatisticsDialog Hides statistics for a room.
VidyoRoomInvite
VidyoRoomInviteAll
VidyoRoomInviteN
VidyoRoomLeave Leaves the room. This triggers VidyoRoomOnExited.
VidyoRoomMessageSearch Searches the room for text messages.
VidyoRoomRegisterMessageEventListener Registers to get notified about message events.
VidyoRoomRegisterParticipantEventListener Registers to get notified about participant events.
VidyoRoomRegisterRecoderInCallEventListener Registers to get notified when a a call is being recorded.
VidyoRoomRegisterResourceManagerEventListener Registers to get notified about resource-management events.
VidyoRoomRegisterRoomPropertiesEventListener Registers to get notified about participant events.
VidyoRoomRegisterSubjectEventListener Registers to get notified about subject events.
VidyoRoomRejectIncoming
VidyoRoomRemoveLocalCamera
VidyoRoomRemoveLocalMicrophone
VidyoRoomRemoveLocalMonitor
VidyoRoomRemoveLocalRenderer
VidyoRoomRemoveLocalSpeaker
VidyoRoomRemoveLocalWindowShare
VidyoRoomSendMessage
VidyoRoomSendMessageAcknowledged Send the acknowledgement to message in a conference room.
VidyoRoomSendMessageTypingIndication Send a typing indication state to all participants of a room.
VidyoRoomSetDynamicGenerationPosition
VidyoRoomSetDynamicLocalRenderer
VidyoRoomSetFavorite
VidyoRoomSetMaxAudioSources
VidyoRoomSetMaxVideoSources
VidyoRoomSetRoomProperties
VidyoRoomSetSubject
VidyoRoomSetUserData
VidyoRoomShowStatisticsDialog Shows statistics for a room.
VidyoRoomUnregisterMessageEventListener Unregisters message event notifications.
VidyoRoomUnregisterParticipantEventListener Unregisters participant event notifications.
VidyoRoomUnregisterRecoderInCallEventListener Unregisters recorder in call event notifications.
VidyoRoomUnregisterResourceManagerEventListener Unregisters resource manager event notifications.
VidyoRoomUnregisterRoomPropertiesEventListener Unregisters room properties event notifications.
VidyoRoomUnregisterSubjectEventListener Unregisters subject event notifications.

Type: VidyoRoomDeleteResult

Member Of:

VidyoRoom

Description:

This type indicates the result of delete room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoRoomEnterResult

Member Of:

VidyoRoom

Description:

Result of an attempt to enter a VidyoRoom.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoRoomExitReason

Member Of:

VidyoRoom

Description:

Reason why a user is no longer a participant of a VidyoRoom.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoRoomGetPropertiesResult

Member Of:

VidyoRoom

Description:

This type indicates the result of get room properties.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoRoomInfo

Member Of:

Endpoint

Description:

descriptive details of a room.

Include:

Lmi/VidyoClient/VidyoRoomInfo.h

Member Variables:

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.

Member Functions:

Type: VidyoRoomMediaDisableReason

Member Of:

VidyoRoom

Description:

This type indicates the reason why media support is now disabled on a room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoRoomMediaFailReason

Member Of:

VidyoRoom

Description:

This type indicates the reason why an attempt to enable media on a room failed.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoRoomParticipantProfile

Member Of:

VidyoRoomProperties

Description:

Participant's profile describing the source restrictions and the chat restriction.

Include:

Lmi/VidyoClient/VidyoRoomProperties.h

Member Variables:

userId LmiString
microphone VidyoRoomProfileControlMode
camera VidyoRoomProfileControlMode
windowShare VidyoRoomProfileControlMode
chat VidyoRoomProfileControlMode

Member Functions:

Type: VidyoRoomProfileControlMode

Member Of:

VidyoRoom

Description:

Describes the profile control mode.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

VIDYO_ROOMPROFILECONTROLMODE_AlwaysOn Profile is always ON.
VIDYO_ROOMPROFILECONTROLMODE_AlwaysOff Profile is always OFF.
VIDYO_ROOMPROFILECONTROLMODE_Default Profile will take the default behavior.

Type: VidyoRoomProperties

Member Of:

VidyoRoom

Description:

Properties of a room.

Include:

Lmi/VidyoClient/VidyoRoomProperties.h

Member Variables:

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.

Member Types:

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.

Member Functions:

Type: VidyoRoomSchedule

Member Of:

VidyoRoomProperties

Description:

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.

Include:

Lmi/VidyoClient/VidyoRoomProperties.h

Member Variables:

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

Member Functions:

Type: VidyoRoomSearchField

Member Of:

VidyoUser

Description:

This type specify the room property to search.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoRoomSearchFieldRelation

Member Of:

VidyoUser

Description:

This type specify the relation between room property fields that apply in the search, AND operator gets evaluated before OR.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

VIDYO_ROOMSEARCHFIELDRELATION_AND apply logical AND between the fields.
VIDYO_ROOMSEARCHFIELDRELATION_OR apply logical OR between the fields.

Type: VidyoRoomSearchResult

Member Of:

VidyoRoom

Description:

Result of get room history.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoRoomSetFavoriteResult

Member Of:

VidyoRoom

Description:

This type indicates the result of set favorite room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoRoomSetPropertiesResult

Member Of:

VidyoRoom

Description:

This type indicates the result of set room properties.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoRoomState

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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

Type: VidyoRoomStats

Member Of:

Stats

Description:

Staticstics for a room.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoRoomType

Member Of:

VidyoRoom

Description:

This indicates the type of the room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoTimeRange

Member Of:

VidyoVideoFrameIntervalRange

Description:

A time range class used to represent a range of time intervals.

Include:

Lmi/VidyoClient/VidyoVideoCapability.h

Member Variables:

begin LmiTime The first time interval of the range.
end LmiTime The last time interval of the range.

Member Functions:

Type: VidyoUser REFERENCE COUNTED

Member Of:

Endpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Member Types:

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.

Member Callbacks:

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

Member Functions:

VidyoUserAddRosterContact
VidyoUserAdvancedSearchRooms
VidyoUserAdvancedSearchUsers
VidyoUserAllowSubscriber
VidyoUserBlockSubscriber
VidyoUserConstruct
VidyoUserConstructCopy Constructs an VidyoUser object as a copy of another.
VidyoUserCreateCall
VidyoUserCreateRoomFromId Finds and existing room with the id specified and privdes a new VidyoRoom object in the VidyoUserFeedbackRoomCreated callback.
VidyoUserCreateRoomWithId Gets a room with the id specified and privdes a new VidyoRoom object in the VidyoUserFeedbackRoomCreated callback.
VidyoUserCreateTopicRoom Creates a new topic room and privdes a new VidyoRoom object in the VidyoUserFeedbackRoomCreated callback.
VidyoUserDestruct Destructs an VidyoUser object.
VidyoUserGetContact
VidyoUserGetConversationRoom Finds a Conversation room and privdes a new VidyoRoom object in the VidyoUserFeedbackRoomCreated callback.
VidyoUserGetCurrentRoster
VidyoUserGetEndpoint
VidyoUserGetFavoriteRooms
VidyoUserGetId
VidyoUserGetRecentRooms Get the recent rooms of the user.
VidyoUserGetStats Fill in data in VidyoUserStats from a room.
VidyoUserLogin
VidyoUserLoginAsGuest
VidyoUserLoginWithAccessToken
VidyoUserLoginWithRefreshToken
VidyoUserLoginWithTenantToken
VidyoUserLogout
VidyoUserRegisterCallEventListener Registers to get notified about invite to call events.
VidyoUserRegisterContactEventListener Registers to get notified about contact events.
VidyoUserRegisterLicenseEventListener Registers to get notified about license events.
VidyoUserRegisterRoomEventListener Registers to get notified about invite to room events.
VidyoUserRemoveRosterContact
VidyoUserSearchConversationRooms
VidyoUserSearchRooms
VidyoUserSearchRoomsWithName
VidyoUserSearchRoomsWithOwner
VidyoUserSearchRoomsWithSubject
VidyoUserSearchTopicRooms
VidyoUserSearchUsers
VidyoUserSetCA
VidyoUserSetDisplayName
VidyoUserSetWebProxyAddressCredentials
VidyoUserUnregisterCallEventListener Unregisters call event notifications.
VidyoUserUnregisterContactEventListener Unregisters contact event notifications.
VidyoUserUnregisterLicenseEventListener Unregisters license event notifications.
VidyoUserUnregisterRoomEventListener Unregisters room event notifications.
VidyoUserUpdatePresence

Type: VidyoUserCallCreateResult

Member Of:

VidyoUser

Description:

This type indicates the result of an attempt to create call.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoUserConnectionStatusChangedReason

Member Of:

VidyoUser

Description:

This type indicates the reason for a change in connection status .

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoUserGetContactResult

Member Of:

VidyoUser

Description:

This type indicates the result of getting a contact vCard.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoUserLoginResult

Member Of:

VidyoUser

Description:

This type indicates the result of an attempt to log in to some service.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoUserLogoutReason

Member Of:

VidyoUser

Description:

This type indicates the reason that a user that was once logged in is no longer logged in.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoUserRoomCreateResult

Member Of:

VidyoUser

Description:

This type indicates the result of an attempt to create room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoUserSearchField

Member Of:

VidyoUser

Description:

This type specify the user details to search.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoUserSearchResult

Member Of:

VidyoUser

Description:

This type indicates the result of a search for user or room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

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.

Type: VidyoUserState

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

VIDYO_USERSTATE_Idle
VIDYO_USERSTATE_LoggingIn
VIDYO_USERSTATE_LoggedIn
VIDYO_USERSTATE_Reconnecting

Type: VidyoUserStats

Member Of:

Stats

Description:

Statistics for an user.

Include:

Lmi/VidyoClient/VidyoStatistics.h

Member Variables:

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.

Member Functions:

Type: VidyoUserTokenType

Member Of:

VidyoUser

Description:

An enumeration of authentication key types.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Values:

VIDYO_USERTOKENTYPE_RefreshToken The associated key is a refresh token.
VIDYO_USERTOKENTYPE_AccessToken The associated key is an access token.

Type: VidyoVideoCapability

Member Of:

Device

Description:

Represents the capability of a Video Source.

Include:

Lmi/VidyoClient/VidyoVideoCapability.h

Member Variables:

width LmiSizeT
height LmiSizeT
ranges LmiVector(VidyoVideoFrameIntervalRange)

Member Types:

VidyoVideoFrameIntervalRange Represents frame interval range and media formats supported by that range.

Member Functions:

Type: VidyoVideoFrameIntervalRange

Member Of:

VidyoVideoCapability

Description:

Represents frame interval range and media formats supported by that range.

Include:

Lmi/VidyoClient/VidyoVideoCapability.h

Member Variables:

range VidyoTimeRange
step LmiTime
formats LmiVector(VidyoMediaFormat)

Member Types:

VidyoTimeRange A time range class used to represent a range of time intervals.

Member Callbacks:

Member Functions:

Type: VidyoVirtualDeviceManager REFERENCE COUNTED

Member Of:

Device

Description:

Include:

Lmi/VidyoClient/VidyoVirtualDeviceManager.h

Member Types:

Member Callbacks:

Member Functions:

VidyoVirtualDeviceManagerConstructCopy Constructs an VidyoVirtualDeviceManager object as a copy of another.
VidyoVirtualDeviceManagerDestruct Destructs an VidyoVirtualDeviceManager object.
VidyoVirtualDeviceManagerLocalCameraEvent
VidyoVirtualDeviceManagerLocalMicrophoneEvent
VidyoVirtualDeviceManagerLocalSpeakerEvent
VidyoVirtualDeviceManagerMediaFailedEvent

Type: VidyoVirtualShareManager REFERENCE COUNTED

Member Of:

Device

Description:

Include:

Lmi/VidyoClient/VidyoVirtualShareManager.h

Member Types:

Member Callbacks:

Member Functions:

VidyoVirtualShareManagerConstructCopy Constructs an VidyoVirtualShareManager object as a copy of another.
VidyoVirtualShareManagerDestruct Destructs an VidyoVirtualShareManager object.
VidyoVirtualShareManagerLocalMonitorEvent
VidyoVirtualShareManagerLocalWindowShareEvent
VidyoVirtualShareManagerMediaFailedEvent

Callback: VidyoCalendarFeedbackConnectResult

Member Of:

VidyoCalendarFeedback

Description:

Triggered when service is connected. Triggered through method(s): VidyoCalendarConnect

Include:

Lmi/VidyoClient/VidyoCalendar.h

Syntax:

void (*VidyoCalendarFeedbackConnectResult)(VidyoCalendarFeedback *f, VidyoCalendar* c, VidyoCalendarServiceCode result)

Parameters:

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.

Callback: VidyoCalendarFeedbackDisconnected

Member Of:

VidyoCalendarFeedback

Description:

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.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Syntax:

void (*VidyoCalendarFeedbackDisconnected)(VidyoCalendarFeedback *f, VidyoCalendar* c, VidyoCalendarServiceCode result)

Parameters:

f Pointer to the VidyoCalendarFeedback object.
c Pointer to the VidyoCalendar that triggered the callback.
result Reason for the disconnect.

Callback: VidyoCalendarFeedbackGetMeetingsResult

Member Of:

VidyoCalendarFeedback

Description:

Triggered from a meeting search request. Triggered through method(s): - VidyoCalendarGetMeetingsByMonth - VidyoCalendarGetMeetingsByWeek - VidyoCalendarGetMeetingsByDay - VidyoCalendarSearchMeetings

Include:

Lmi/VidyoClient/VidyoCalendar.h

Syntax:

void (*VidyoCalendarFeedbackGetMeetingsResult)(VidyoCalendarFeedback *f, VidyoCalendar* c, VidyoMeetingSearchResult searchResult, const LmiVector(VidyoMeeting) *meetings)

Parameters:

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.

Callback: VidyoCalendarFeedbackMeetingCreated

Member Of:

VidyoCalendarFeedback

Description:

Triggered when a meeting is created by the local user. Triggered through method(s): VidyoCalendarCreateMeeting

Include:

Lmi/VidyoClient/VidyoCalendar.h

Syntax:

void (*VidyoCalendarFeedbackMeetingCreated)(VidyoCalendarFeedback *f, VidyoCalendar* c, VidyoMeeting* m, VidyoMeetingActionResult r, LmiString * createdToken)

Parameters:

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.

Callback: VidyoCalendarFeedbackMeetingCreatedByService

Member Of:

VidyoCalendarFeedback

Description:

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

Include:

Lmi/VidyoClient/VidyoCalendar.h

Syntax:

void (*VidyoCalendarFeedbackMeetingCreatedByService)(VidyoCalendarFeedback *f, VidyoCalendar* c, VidyoMeeting* m, VidyoMeetingAttendee * inviteOwner)

Parameters:

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.

Callback: VidyoCalendarFeedbackMeetingEventNotification

Member Of:

VidyoCalendarFeedback

Description:

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.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Syntax:

void (*VidyoCalendarFeedbackMeetingEventNotification)(VidyoCalendarFeedback *f, VidyoCalendar* c, VidyoMeeting* m)

Parameters:

f Pointer to the VidyoCalendarFeedback object.
c Pointer to the VidyoCalendar that triggered the callback.
m Pointer to the VidyoCalendar that triggered the callback.

Callback: VidyoCalendarFeedbackMeetingRemoved

Member Of:

VidyoCalendarFeedback

Description:

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.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Syntax:

void (*VidyoCalendarFeedbackMeetingRemoved)(VidyoCalendarFeedback *f, VidyoCalendar* c, VidyoMeeting *m, VidyoMeetingActionResult r, LmiString * removedToken)

Parameters:

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.

Callback: VidyoCalendarFeedbackMeetingRemovedByService

Member Of:

VidyoCalendarFeedback

Description:

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.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Syntax:

void (*VidyoCalendarFeedbackMeetingRemovedByService)(VidyoCalendarFeedback *f, VidyoCalendar* c, VidyoMeeting *m, VidyoMeetingActionResult r)

Parameters:

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.

Callback: VidyoCalendarFeedbackMeetingUpdated

Member Of:

VidyoCalendarFeedback

Description:

Triggered when a meeting is updated. Triggered from the method VidyoCalendarUpdateMeeting

Include:

Lmi/VidyoClient/VidyoCalendar.h

Syntax:

void (*VidyoCalendarFeedbackMeetingUpdated)(VidyoCalendarFeedback *f, VidyoCalendar* c, VidyoMeeting* m, VidyoMeetingActionResult r, LmiString * updatedToken)

Parameters:

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.

Callback: VidyoCalendarFeedbackMeetingUpdatedByService

Member Of:

VidyoCalendarFeedback

Description:

Triggered when a meeting is updated. Triggered from an event originating through the calendar service

Include:

Lmi/VidyoClient/VidyoCalendar.h

Syntax:

void (*VidyoCalendarFeedbackMeetingUpdatedByService)(VidyoCalendarFeedback *f, VidyoCalendar* c, VidyoMeeting* m, VidyoMeetingActionResult r)

Parameters:

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 .

Callback: VidyoCalendarManagerFeedbackCalendarCreated

Member Of:

VidyoCalendarManagerFeedback

Description:

Returns the created VidyoCalendar that was initiated through VidyoCalendarManagerCreateCalendarInstance.

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Syntax:

void (*VidyoCalendarManagerFeedbackCalendarCreated)(VidyoCalendarManagerFeedback *f, VidyoCalendarManager * cm, VidyoCalendar * calendar, VidyoCalendarServiceCode resultCode, LmiString * createToken)

Parameters:

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

Callback: VidyoCalendarManagerFeedbackServiceDiscovery

Member Of:

VidyoCalendarManagerFeedback

Description:

Triggered through the construction of calendar manager. Returns the results from discovering the avialability for the supported calendar services. Triggered through method(s): VidyoCalendarManagerConstruct

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Syntax:

void (*VidyoCalendarManagerFeedbackServiceDiscovery)(VidyoCalendarManagerFeedback *f, VidyoCalendarManager * cm, LmiString *t, VidyoCalendarServiceStatus s)

Parameters:

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.

Callback: VidyoCalendarManagerFeedbackUninitialized

Member Of:

VidyoCalendarManagerFeedback

Description:

Triggered through the construction of calendar manager. Returns the results from discovering the avialability for the supported calendar services. Triggered through method(s): VidyoCalendarManagerConstruct

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Syntax:

void (*VidyoCalendarManagerFeedbackUninitialized)(VidyoCalendarManagerFeedback *f, VidyoCalendarManager * cm)

Parameters:

f Pointer to the VidyoCalendarManagerFeedback object.
cm Pointer to the VidyoCalendarManager object.

Callback: VidyoCallOnEnded

Member Of:

VidyoCall

Description:

Callback that is triggered when VidyoCall has ended.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoCallOnEnded)(VidyoCall* c, VidyoParticipant* p, VidyoCallEndReason reason)

Parameters:

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.

Callback: VidyoCallOnInitiated

Member Of:

VidyoCall

Description:

Callback that is triggered when initiating a VidyoCall.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoCallOnInitiated)(VidyoCall* c, VidyoCallInitiatedResult result, VidyoParticipant* p)

Parameters:

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.

Callback: VidyoCallOnMessageAcknowledged

Member Of:

VidyoCall

Description:

Callback that is triggered when a VidyoChatMessage is delivered to the VidyoCall on the server.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoCallOnMessageAcknowledged)(VidyoCall* c, VidyoChatMessage* chatMessage)

Parameters:

c Pointer to the VidyoCall that triggered the callback.
chatMessage Pointer to the VidyoChatMessage object created by the server from VidyoCallSendMessage() call.

Note 1:

The VidyoChatMessage has the messageId that was assigned by the server which can be referenced by the VidyoCallOnMessageRead callback. Currently the only way to correlate the message that was sent with VidyoCallSendMessage() to the acknowledged message is with the message body.

Callback: VidyoCallOnMessageRead

Member Of:

VidyoCall

Description:

Callback that is triggered when a message that was acknowledged by the server was read by the other VidyoParticipant in the room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoCallOnMessageRead)(VidyoCall* c, VidyoParticipant* participant, LmiInt64 messageId)

Parameters:

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.

Callback: VidyoCallOnMessageReceived

Member Of:

VidyoCall

Description:

Callback that is triggered when a new text message arrives.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoCallOnMessageReceived)(VidyoCall* c, VidyoParticipant* participant, VidyoChatMessage* chatMessage)

Parameters:

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.

Callback: VidyoCallOnMessageTypingIndication

Member Of:

VidyoCall

Description:

Callback that is triggered when typing state of a remote VidyoParticipant changes.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoCallOnMessageTypingIndication)(VidyoCall* c, VidyoParticipant* participant, VidyoChatMessageTypingIndication typingIndication)

Parameters:

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.

Callback: VidyoCallOnSetSubject

Member Of:

VidyoCall

Description:

Callback that is triggered when the subject of the VidyoCall has changed.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoCallOnSetSubject)(VidyoCall* c, const char* subject)

Parameters:

c Pointer to the VidyoCall that triggered the callback.
subject New subject of the VidyoCall.

Callback: VidyoConnectorOnAvailableResourcesChanged

Member Of:

VidyoConnector

Description:

Callback that is triggered each time the available local resources change.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnAvailableResourcesChanged)(VidyoConnector* c, LmiUint cpuEncode, LmiUint cpuDecode, LmiUint bandwidthSend, LmiUint bandwidthReceive)

Parameters:

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.

Callback: VidyoConnectorOnChatMessageReceived

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a chat message is received from one of the other participants.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnChatMessageReceived)(VidyoConnector* c, const VidyoParticipant* participant, VidyoChatMessage* chatMessage)

Parameters:

c The VidyoConnector that triggered the callback.
participant The VidyoParticipant who sent the chat message.
chatMessage The VidyoChatMessage that was received.

Callback: VidyoConnectorOnDisconnected

Member Of:

VidyoConnector

Description:

Callback that is triggered when an established connection is disconnected.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnDisconnected)(VidyoConnector* c, VidyoConnectorDisconnectReason reason)

Parameters:

c The VidyoConnector that triggered the callback.
reason Reason why the established connection became disconnected.

Callback: VidyoConnectorOnDynamicParticipantChanged

Member Of:

VidyoConnector

Description:

Callback that is triggered each time the order of dyanmic participants has changed, based on active speech detection.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnDynamicParticipantChanged)(VidyoConnector* c, LmiVector(VidyoParticipant)* participants, LmiVector(VidyoRemoteCamera)* remoteCameras)

Parameters:

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.

Callback: VidyoConnectorOnFailure

Member Of:

VidyoConnector

Description:

Callback that is triggered when the connection attempt has failed.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnFailure)(VidyoConnector* c, VidyoConnectorFailReason reason)

Parameters:

c The VidyoConnector that triggered the callback.
reason Reason why the connection could not be established.

Callback: VidyoConnectorOnLocalCameraAdded

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a local camera becomes available to a VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalCameraAdded)(VidyoConnector* c, VidyoLocalCamera* localCamera)

Parameters:

c The VidyoConnector that triggered the callback.
localCamera Local camera that was added to the VidyoConnector.

Callback: VidyoConnectorOnLocalCameraRemoved

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a local camera is no longer available to a VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalCameraRemoved)(VidyoConnector* c, VidyoLocalCamera* localCamera)

Parameters:

c The VidyoConnector that triggered the callback.
localCamera Local camera that was removed from the VidyoConnector.

Callback: VidyoConnectorOnLocalCameraSelected

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in which local camera is selected for use.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalCameraSelected)(VidyoConnector* c, VidyoLocalCamera* localCamera)

Parameters:

c The VidyoConnector that triggered the callback.
localCamera Local camera that was selected. NULL if none of them remain selected.

Callback: VidyoConnectorOnLocalCameraStateUpdated

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in the state of the camera such as being suspended or disabled.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalCameraStateUpdated)(VidyoConnector* c, VidyoLocalCamera* localCamera, VidyoDeviceState state)

Parameters:

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.

Callback: VidyoConnectorOnLocalMicrophoneAdded

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a local microphone becomes available to a VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalMicrophoneAdded)(VidyoConnector* c, VidyoLocalMicrophone* localMicrophone)

Parameters:

c The VidyoConnector that triggered the callback.
localMicrophone Local microphone that was added to the VidyoConnector.

Callback: VidyoConnectorOnLocalMicrophoneRemoved

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a local microphone is no longer available to a VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalMicrophoneRemoved)(VidyoConnector* c, VidyoLocalMicrophone* localMicrophone)

Parameters:

c The VidyoConnector that triggered the callback.
localMicrophone Local microphone that was removed from the VidyoConnector.

Callback: VidyoConnectorOnLocalMicrophoneSelected

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in which local microphone is selected for use.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalMicrophoneSelected)(VidyoConnector* c, VidyoLocalMicrophone* localMicrophone)

Parameters:

c The VidyoConnector that triggered the callback.
localMicrophone Local microphone that was selected. NULL if none of them remain selected.

Callback: VidyoConnectorOnLocalMicrophoneStateUpdated

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in the state of the microphone such as being suspended or disabled.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalMicrophoneStateUpdated)(VidyoConnector* c, VidyoLocalMicrophone* localMicrophone, VidyoDeviceState state)

Parameters:

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.

Callback: VidyoConnectorOnLocalMonitorAdded

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a local monitor becomes available to a VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalMonitorAdded)(VidyoConnector* c, VidyoLocalMonitor* localMonitor)

Parameters:

c The VidyoConnector that triggered the callback.
localMonitor Local monitor that was added to the VidyoConnector.

Callback: VidyoConnectorOnLocalMonitorRemoved

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a local monitor is no longer available to a VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalMonitorRemoved)(VidyoConnector* c, VidyoLocalMonitor* localMonitor)

Parameters:

c The VidyoConnector that triggered the callback.
localMonitor Local monitor that was removed from the VidyoConnector.

Callback: VidyoConnectorOnLocalMonitorSelected

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in which local monitor is selected for sharing.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalMonitorSelected)(VidyoConnector* c, VidyoLocalMonitor* localMonitor)

Parameters:

c The VidyoConnector that triggered the callback.
localMonitor Local monitor that was selected. NULL if none of them remain selected.

Callback: VidyoConnectorOnLocalMonitorStateUpdated

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in the state of the monitor such as being suspended or disabled.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalMonitorStateUpdated)(VidyoConnector* c, VidyoLocalMonitor* localMonitor, VidyoDeviceState state)

Parameters:

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.

Callback: VidyoConnectorOnLocalSpeakerAdded

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a local speaker becomes available to a VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalSpeakerAdded)(VidyoConnector* c, VidyoLocalSpeaker* localSpeaker)

Parameters:

c The VidyoConnector that triggered the callback.
localSpeaker Local speaker that was added to the VidyoConnector.

Callback: VidyoConnectorOnLocalSpeakerRemoved

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a local speaker is no longer available to a VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalSpeakerRemoved)(VidyoConnector* c, VidyoLocalSpeaker* localSpeaker)

Parameters:

c The VidyoConnector that triggered the callback.
localSpeaker Local speaker that was removed from the VidyoConnector.

Callback: VidyoConnectorOnLocalSpeakerSelected

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in which local speaker is selected for use.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalSpeakerSelected)(VidyoConnector* c, VidyoLocalSpeaker* localSpeaker)

Parameters:

c The VidyoConnector that triggered the callback.
localSpeaker Local speaker that was selected. NULL if none of them remain selected.

Callback: VidyoConnectorOnLocalSpeakerStateUpdated

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in the state of the speaker such as being suspended or disabled.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalSpeakerStateUpdated)(VidyoConnector* c, VidyoLocalSpeaker* localSpeaker, VidyoDeviceState state)

Parameters:

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.

Callback: VidyoConnectorOnLocalWindowShareAdded

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a local window becomes available for a VidyoConnector to share in a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalWindowShareAdded)(VidyoConnector* c, VidyoLocalWindowShare* localWindowShare)

Parameters:

c The VidyoConnector that triggered the callback.
localWindowShare Local, shareable window that was added to the VidyoConnector.

Callback: VidyoConnectorOnLocalWindowShareRemoved

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a local window is no longer available for a VidyoConnector to share in a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalWindowShareRemoved)(VidyoConnector* c, VidyoLocalWindowShare* localWindowShare)

Parameters:

c The VidyoConnector that triggered the callback.
localWindowShare Local window that was removed from the VidyoConnector. The window is no longer shareable.

Callback: VidyoConnectorOnLocalWindowShareSelected

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in which local window is selected for sharing.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalWindowShareSelected)(VidyoConnector* c, VidyoLocalWindowShare* localWindowShare)

Parameters:

c The VidyoConnector that triggered the callback.
localWindowShare Local window that was selected. NULL if none of them remain selected.

Callback: VidyoConnectorOnLocalWindowShareStateUpdated

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in the state of the window such as being suspended or disabled.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnLocalWindowShareStateUpdated)(VidyoConnector* c, VidyoLocalWindowShare* localWindowShare, VidyoDeviceState state)

Parameters:

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.

Callback: VidyoConnectorOnLog

Member Of:

VidyoConnector

Description:

Callback that is triggered for every log record.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnLog)(VidyoConnector* c, const VidyoLogRecord* logRecord)

Parameters:

c The VidyoConnector that triggered the callback.
logRecord The VidyoLogRecord object containing log record data.

Callback: VidyoConnectorOnLoudestParticipantChanged

Member Of:

VidyoConnector

Description:

Callback that is triggered each time one of the other participants becomes the loudest, based on active speech detection.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnLoudestParticipantChanged)(VidyoConnector* c, const VidyoParticipant* participant, LmiBool audioOnly)

Parameters:

c The VidyoConnector that triggered the callback.
participant New loudest participant.
audioOnly LMI_TRUE if the participant does not have video streams.

Callback: VidyoConnectorOnMaxRemoteSourcesChanged

Member Of:

VidyoConnector

Description:

Callback that is triggered each time the local client's maximum decoding capability changes.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnMaxRemoteSourcesChanged)(VidyoConnector* c, LmiUint maxRemoteSources)

Parameters:

c The VidyoConnector that triggered the callback.
maxRemoteSources Maximum number of remote video sources that can be recived both statically and dynamically.

Note 1:

When the application is managing the statically viewed sources through the VidyoConnectorAssign*() API, such as VidyoConnectorAssignViewToRemoteCamera(), the application is responsible for keeping track of the number of these views. When the number of maximum remote participants that can be decoded falls below what the applicaiton has statically viewed, the application must choose which static sources to enable or disable to meet the resource manager constraints.

Callback: VidyoConnectorOnNetworkInterfaceAdded

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a network interface is available to a VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnNetworkInterfaceAdded)(VidyoConnector* c, VidyoNetworkInterface* networkInterface)

Parameters:

c The VidyoConnector that triggered the callback.
networkInterface The VidyoNetworkInterface which described the interface.

Callback: VidyoConnectorOnNetworkInterfaceRemoved

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a network interface is no longer available to a VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnNetworkInterfaceRemoved)(VidyoConnector* c, VidyoNetworkInterface* networkInterface)

Parameters:

c The VidyoConnector that triggered the callback.
networkInterface The VidyoNetworkInterface which described the interface.

Callback: VidyoConnectorOnNetworkInterfaceSelected

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in which network interface is selected for use.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnNetworkInterfaceSelected)(VidyoConnector* c, VidyoNetworkInterface* networkInterface, VidyoNetworkInterfaceTransportType transportType)

Parameters:

c The VidyoConnector that triggered the callback.
networkInterface The VidyoNetworkInterface which described the interface.
transportType The Transport type for which this interface was selected.

Callback: VidyoConnectorOnNetworkInterfaceStateUpdated

Member Of:

VidyoConnector

Description:

Callback that is triggered each time there is a change in the state of the network interface such as being up or down.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnNetworkInterfaceStateUpdated)(VidyoConnector* c, VidyoNetworkInterface* networkInterface, VidyoNetworkInterfaceState state)

Parameters:

c The VidyoConnector that triggered the callback.
networkInterface The VidyoNetworkInterface which described the interface.
state The new state of the interface.

Callback: VidyoConnectorOnParticipantJoined

Member Of:

VidyoConnector

Description:

Callback that is triggered each time another participant joins a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnParticipantJoined)(VidyoConnector* c, VidyoParticipant* participant)

Parameters:

c The VidyoConnector that triggered the callback.
participant The VidyoParticipant who joined the conference.

Callback: VidyoConnectorOnParticipantLeft

Member Of:

VidyoConnector

Description:

Callback that is triggered each time an existing participant leaves a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnParticipantLeft)(VidyoConnector* c, VidyoParticipant* participant)

Parameters:

c The VidyoConnector that triggered the callback.
participant The VidyoParticipant who left the conference.

Callback: VidyoConnectorOnRemoteCameraAdded

Member Of:

VidyoConnector

Description:

Callback that is triggered each time one of the other participants adds a remote camera into a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnRemoteCameraAdded)(VidyoConnector* c, VidyoRemoteCamera* remoteCamera, const VidyoParticipant* participant)

Parameters:

c The VidyoConnector that triggered the callback.
remoteCamera Remote camera that was added.
participant The VidyoParticipant who owns the remote camera.

Callback: VidyoConnectorOnRemoteCameraRemoved

Member Of:

VidyoConnector

Description:

Callback that is triggered each time one of the other participants removes a remote camera from a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnRemoteCameraRemoved)(VidyoConnector* c, VidyoRemoteCamera* remoteCamera, const VidyoParticipant* participant)

Parameters:

c The VidyoConnector that triggered the callback.
remoteCamera Remote camera that was removed.
participant The VidyoParticipant who owns the remote camera.

Callback: VidyoConnectorOnRemoteCameraStateUpdated

Member Of:

VidyoConnector

Description:

Callback that is triggered each time one of the other participants remote camera changes state in a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnRemoteCameraStateUpdated)(VidyoConnector* c, VidyoRemoteCamera* remoteCamera, const VidyoParticipant* participant, VidyoDeviceState state)

Parameters:

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.

Callback: VidyoConnectorOnRemoteMicrophoneAdded

Member Of:

VidyoConnector

Description:

Callback that is triggered each time one of the other participants adds a remote microphone into a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnRemoteMicrophoneAdded)(VidyoConnector* c, VidyoRemoteMicrophone* remoteMicrophone, const VidyoParticipant* participant)

Parameters:

c The VidyoConnector that triggered the callback.
remoteMicrophone Remote microphone that was added.
participant The VidyoParticipant who owns the remote microphone.

Callback: VidyoConnectorOnRemoteMicrophoneRemoved

Member Of:

VidyoConnector

Description:

Callback that is triggered each time one of the other participants removes a remote microphone from a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnRemoteMicrophoneRemoved)(VidyoConnector* c, VidyoRemoteMicrophone* remoteMicrophone, const VidyoParticipant* participant)

Parameters:

c The VidyoConnector that triggered the callback.
remoteMicrophone Remote microphone that was removed.
participant The VidyoParticipant who owns the remote microphone.

Callback: VidyoConnectorOnRemoteMicrophoneStateUpdated

Member Of:

VidyoConnector

Description:

Callback that is triggered each time one of the other participants remote microphone changes state in a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnRemoteMicrophoneStateUpdated)(VidyoConnector* c, VidyoRemoteMicrophone* remoteMicrophone, const VidyoParticipant* participant, VidyoDeviceState state)

Parameters:

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.

Callback: VidyoConnectorOnRemoteWindowShareAdded

Member Of:

VidyoConnector

Description:

Callback that is triggered each time one of the other participants adds, or shares, a remote window into a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnRemoteWindowShareAdded)(VidyoConnector* c, VidyoRemoteWindowShare* remoteWindowShare, const VidyoParticipant* participant)

Parameters:

c The VidyoConnector that triggered the callback.
remoteWindowShare Remote window that was added, or shared.
participant The VidyoParticipant who owns the remote window.

Callback: VidyoConnectorOnRemoteWindowShareRemoved

Member Of:

VidyoConnector

Description:

Callback that is triggered each time one of the other participants removes a remote window from a conference, or stops sharing it.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnRemoteWindowShareRemoved)(VidyoConnector* c, VidyoRemoteWindowShare* remoteWindowShare, const VidyoParticipant* participant)

Parameters:

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.

Callback: VidyoConnectorOnRemoteWindowShareStateUpdated

Member Of:

VidyoConnector

Description:

Callback that is triggered each time one of the other participants remote window changes state in a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void(*VidyoConnectorOnRemoteWindowShareStateUpdated)(VidyoConnector* c, VidyoRemoteWindowShare* remoteWindowShare, const VidyoParticipant* participant, VidyoDeviceState state)

Parameters:

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.

Callback: VidyoConnectorOnSuccess

Member Of:

VidyoConnector

Description:

Callback that is triggered when the connection is sucessfully established.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnSuccess)(VidyoConnector* c)

Parameters:

c The VidyoConnector that triggered the callback.

Callback: VidyoConnectorOnWebProxyCredentialsRequest

Member Of:

VidyoConnector

Description:

Callback that is triggered when Web Proxy Server requires password.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorOnWebProxyCredentialsRequest)(VidyoConnector* c)

Parameters:

c The VidyoConnector that triggered the callback.

Callback: VidyoConnectorRecorderInCall

Member Of:

VidyoConnector

Description:

Callback that is triggered each time a recorder joins or leaves the call.

Include:

Lmi/VidyoClient/VidyoConnector.h

Syntax:

void (*VidyoConnectorRecorderInCall)(VidyoConnector* c, LmiBool recorderInCall )

Parameters:

c The VidyoConnector that triggered the callback.
recorderInCall LMI_TRUE when a recorder joined, LMI_FALSE when no recorder are in the call

Callback: VidyoEndpointOnLocalCameraAdded

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a local camera becomes available to a VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalCameraAdded)(VidyoEndpoint* e, VidyoLocalCamera* localCamera)

Parameters:

e
localCamera

Callback: VidyoEndpointOnLocalCameraRemoved

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a local camera is no longer available to a VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalCameraRemoved)(VidyoEndpoint* e, VidyoLocalCamera* localCamera)

Parameters:

e
localCamera

Callback: VidyoEndpointOnLocalCameraSelected

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in which local camera is selected for use.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalCameraSelected)(VidyoEndpoint* e, VidyoLocalCamera* localCamera)

Parameters:

e
localCamera

Callback: VidyoEndpointOnLocalCameraStateUpdated

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in the state of the camera such as being suspended or disabled.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalCameraStateUpdated)(VidyoEndpoint* e, VidyoLocalCamera* localCamera, VidyoDeviceState state)

Parameters:

e
localCamera
state

Callback: VidyoEndpointOnLocalMicrophoneAdded

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a local microphone becomes available to a VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalMicrophoneAdded)(VidyoEndpoint* e, VidyoLocalMicrophone* localMicrophone)

Parameters:

e
localMicrophone

Callback: VidyoEndpointOnLocalMicrophoneRemoved

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a local microphone is no longer available to a VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalMicrophoneRemoved)(VidyoEndpoint* e, VidyoLocalMicrophone* localMicrophone)

Parameters:

e
localMicrophone

Callback: VidyoEndpointOnLocalMicrophoneSelected

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in which local microphone is selected for use.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalMicrophoneSelected)(VidyoEndpoint* e, VidyoLocalMicrophone* localMicrophone)

Parameters:

e
localMicrophone

Callback: VidyoEndpointOnLocalMicrophoneStateUpdated

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in the state of the microphone such as being suspended or disabled.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalMicrophoneStateUpdated)(VidyoEndpoint* e, VidyoLocalMicrophone* localMicrophone, VidyoDeviceState state)

Parameters:

e
localMicrophone
state

Callback: VidyoEndpointOnLocalMonitorAdded

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a local monitor becomes available to a VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalMonitorAdded)(VidyoEndpoint* e, VidyoLocalMonitor* localMonitor)

Parameters:

e
localMonitor

Callback: VidyoEndpointOnLocalMonitorRemoved

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a local monitor is no longer available to a VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalMonitorRemoved)(VidyoEndpoint* e, VidyoLocalMonitor* localMonitor)

Parameters:

e
localMonitor

Callback: VidyoEndpointOnLocalMonitorSelected

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in which local monitor is selected for sharing.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalMonitorSelected)(VidyoEndpoint* e, VidyoLocalMonitor* localMonitor)

Parameters:

e
localMonitor

Callback: VidyoEndpointOnLocalMonitorStateUpdated

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in the state of the monitor such as being suspended or disabled.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalMonitorStateUpdated)(VidyoEndpoint* e, VidyoLocalMonitor* localMonitor, VidyoDeviceState state)

Parameters:

e
localMonitor
state

Callback: VidyoEndpointOnLocalRendererAdded

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalRendererAdded)(VidyoEndpoint* e, VidyoLocalRenderer* localRenderer)

Parameters:

e
localRenderer

Callback: VidyoEndpointOnLocalRendererRemoved

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalRendererRemoved)(VidyoEndpoint* e, VidyoLocalRenderer* localRenderer)

Parameters:

e
localRenderer

Callback: VidyoEndpointOnLocalRendererSelected

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalRendererSelected)(VidyoEndpoint* e, VidyoLocalRenderer* localRenderer)

Parameters:

e
localRenderer

Callback: VidyoEndpointOnLocalRendererStateUpdated

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalRendererStateUpdated)(VidyoEndpoint* e, VidyoLocalRenderer* localRenderer, VidyoDeviceState state)

Parameters:

e
localRenderer
state

Callback: VidyoEndpointOnLocalSpeakerAdded

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a local speaker becomes available to a VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalSpeakerAdded)(VidyoEndpoint* e, VidyoLocalSpeaker* localSpeaker)

Parameters:

e
localSpeaker

Callback: VidyoEndpointOnLocalSpeakerRemoved

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a local speaker is no longer available to a VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalSpeakerRemoved)(VidyoEndpoint* e, VidyoLocalSpeaker* localSpeaker)

Parameters:

e
localSpeaker

Callback: VidyoEndpointOnLocalSpeakerSelected

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in which local speaker is selected for use.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalSpeakerSelected)(VidyoEndpoint* e, VidyoLocalSpeaker* localSpeaker)

Parameters:

e
localSpeaker

Callback: VidyoEndpointOnLocalSpeakerStateUpdated

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in the state of the speaker such as being suspended or disabled.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalSpeakerStateUpdated)(VidyoEndpoint* e, VidyoLocalSpeaker* localSpeaker, VidyoDeviceState state)

Parameters:

e
localSpeaker
state

Callback: VidyoEndpointOnLocalWindowShareAdded

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a local window becomes available for a VidyoEndpoint to share in a conference.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalWindowShareAdded)(VidyoEndpoint* e, VidyoLocalWindowShare* localWindowShare)

Parameters:

e
localWindowShare

Callback: VidyoEndpointOnLocalWindowShareRemoved

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a local window is no longer available for a VidyoEndpoint to share in a conference.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalWindowShareRemoved)(VidyoEndpoint* e, VidyoLocalWindowShare* localWindowShare)

Parameters:

e
localWindowShare

Callback: VidyoEndpointOnLocalWindowShareSelected

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in which local window is selected for sharing.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalWindowShareSelected)(VidyoEndpoint* e, VidyoLocalWindowShare* localWindowShare)

Parameters:

e
localWindowShare

Callback: VidyoEndpointOnLocalWindowShareStateUpdated

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in the state of the window such as being suspended or disabled.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLocalWindowShareStateUpdated)(VidyoEndpoint* e, VidyoLocalWindowShare* localWindowShare, VidyoDeviceState state)

Parameters:

e
localWindowShare
state

Callback: VidyoEndpointOnLog

Member Of:

VidyoEndpoint

Description:

Callback that is triggered for every log record.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLog)(VidyoEndpoint* e, const VidyoLogRecord* logRecord)

Parameters:

e
logRecord

Callback: VidyoEndpointOnLogCompressionComplete

Member Of:

VidyoEndpoint

Description:

Callback that is triggered when the file log compression completes.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnLogCompressionComplete)(VidyoEndpoint* e, LmiString *compressedFileName, VidyoEndpointLogCompressionResult result)

Parameters:

e
compressedFileName Name if the compression output file.
result Result of the file compression.

Callback: VidyoEndpointOnNetworkInterfaceAdded

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a network interface is available to a VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnNetworkInterfaceAdded)(VidyoEndpoint* e, VidyoNetworkInterface* networkInterface)

Parameters:

e
networkInterface

Callback: VidyoEndpointOnNetworkInterfaceRemoved

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time a network interface is no longer available to a VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnNetworkInterfaceRemoved)(VidyoEndpoint* e, VidyoNetworkInterface* networkInterface)

Parameters:

e
networkInterface

Callback: VidyoEndpointOnNetworkInterfaceSelected

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in which network interface is selected for use.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnNetworkInterfaceSelected)(VidyoEndpoint* e, VidyoNetworkInterface* networkInterface, VidyoNetworkInterfaceTransportType transportType)

Parameters:

e
networkInterface
transportType

Callback: VidyoEndpointOnNetworkInterfaceStateUpdated

Member Of:

VidyoEndpoint

Description:

Callback that is triggered each time there is a change in the state of the network interface such as being up or down.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnNetworkInterfaceStateUpdated)(VidyoEndpoint* e, VidyoNetworkInterface* networkInterface, VidyoNetworkInterfaceState state)

Parameters:

e
networkInterface
state

Callback: VidyoEndpointOnRemoteCameraAdded

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteCameraAdded)(VidyoEndpoint* e, VidyoRemoteCamera* remoteCamera, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room, const VidyoParticipant* participant)

Parameters:

e
remoteCamera
user
call
room
participant

Callback: VidyoEndpointOnRemoteCameraRemoved

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteCameraRemoved)(VidyoEndpoint* e, VidyoRemoteCamera* remoteCamera, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room, const VidyoParticipant* participant)

Parameters:

e
remoteCamera
user
call
room
participant

Callback: VidyoEndpointOnRemoteCameraStateUpdated

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteCameraStateUpdated)(VidyoEndpoint* e, VidyoRemoteCamera* remoteCamera, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room, const VidyoParticipant* participant, VidyoDeviceState state)

Parameters:

e
remoteCamera
user
call
room
participant
state

Callback: VidyoEndpointOnRemoteMicrophoneAdded

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteMicrophoneAdded)(VidyoEndpoint* e, VidyoRemoteMicrophone* remoteMicrophone, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room, const VidyoParticipant* participant)

Parameters:

e
remoteMicrophone
user
call
room
participant

Callback: VidyoEndpointOnRemoteMicrophoneRemoved

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteMicrophoneRemoved)(VidyoEndpoint* e, VidyoRemoteMicrophone* remoteMicrophone, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room, const VidyoParticipant* participant)

Parameters:

e
remoteMicrophone
user
call
room
participant

Callback: VidyoEndpointOnRemoteMicrophoneStateUpdated

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteMicrophoneStateUpdated)(VidyoEndpoint* e, VidyoRemoteMicrophone* remoteMicrophone, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room, const VidyoParticipant* participant, VidyoDeviceState state)

Parameters:

e
remoteMicrophone
user
call
room
participant
state

Callback: VidyoEndpointOnRemoteRendererAdded

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteRendererAdded)(VidyoEndpoint* e, VidyoRemoteRenderer* remoteRenderer, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room)

Parameters:

e
remoteRenderer
user
call
room

Callback: VidyoEndpointOnRemoteRendererRemoved

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteRendererRemoved)(VidyoEndpoint* e, VidyoRemoteRenderer* remoteRenderer, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room)

Parameters:

e
remoteRenderer
user
call
room

Callback: VidyoEndpointOnRemoteSpeakerAdded

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteSpeakerAdded)(VidyoEndpoint* e, VidyoRemoteSpeaker* remoteSpeaker, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room)

Parameters:

e
remoteSpeaker
user
call
room

Callback: VidyoEndpointOnRemoteSpeakerRemoved

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteSpeakerRemoved)(VidyoEndpoint* e, VidyoRemoteSpeaker* remoteSpeaker, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room)

Parameters:

e
remoteSpeaker
user
call
room

Callback: VidyoEndpointOnRemoteWindowShareAdded

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteWindowShareAdded)(VidyoEndpoint* e, VidyoRemoteWindowShare* remoteWindowShare, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room, const VidyoParticipant* participant)

Parameters:

e
remoteWindowShare
user
call
room
participant

Callback: VidyoEndpointOnRemoteWindowShareRemoved

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteWindowShareRemoved)(VidyoEndpoint* e, VidyoRemoteWindowShare* remoteWindowShare, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room, const VidyoParticipant* participant)

Parameters:

e
remoteWindowShare
user
call
room
participant

Callback: VidyoEndpointOnRemoteWindowShareStateUpdated

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoEndpointOnRemoteWindowShareStateUpdated)(VidyoEndpoint* e, VidyoRemoteWindowShare* remoteWindowShare, const VidyoUser* user, const VidyoCall* call, const VidyoRoom* room, const VidyoParticipant* participant, VidyoDeviceState state)

Parameters:

e
remoteWindowShare
user
call
room
participant
state

Callback: VidyoGatewayOnDisconnected

Member Of:

VidyoGateway

Description:

Callback that is triggered when an established connection is disconnected.

Include:

Lmi/VidyoClient/VidyoGateway.h

Syntax:

void (*VidyoGatewayOnDisconnected)(VidyoGateway* gateway, VidyoGatewayDisconnectReason reason)

Parameters:

gateway The VidyoGateway that triggered the callback.
reason Reason why the connection could not be established.

Callback: VidyoGatewayOnFailure

Member Of:

VidyoGateway

Description:

Callback that is triggered when the connection establishemnt failed.

Include:

Lmi/VidyoClient/VidyoGateway.h

Syntax:

void (*VidyoGatewayOnFailure)(VidyoGateway* gateway, VidyoGatewayFailReason reason)

Parameters:

gateway The VidyoGateway that triggered the callback.
reason Reason why the connection could not be established.

Callback: VidyoGatewayOnSuccess

Member Of:

VidyoGateway

Description:

Callback that is triggered when the connection is sucessfully established.

Include:

Lmi/VidyoClient/VidyoGateway.h

Syntax:

void (*VidyoGatewayOnSuccess)(VidyoGateway* gateway)

Parameters:

gateway The VidyoGateway that triggered the callback.

Callback: VidyoLocalMonitorOnPreviewDataUriComplete

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Syntax:

void (*VidyoLocalMonitorOnPreviewDataUriComplete)(const VidyoLocalMonitor* w, const LmiString* videoFrame, VidyoLocalMonitorState state)

Parameters:

w
videoFrame
state

Callback: VidyoLocalWindowShareOnApplicationIconDataUriComplete

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Syntax:

void (*VidyoLocalWindowShareOnApplicationIconDataUriComplete)(const VidyoLocalWindowShare* w, const LmiString* icon)

Parameters:

w The VidyoLocalWindowShare object.
icon

Callback: VidyoLocalWindowShareOnPreviewDataUriComplete

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Syntax:

void (*VidyoLocalWindowShareOnPreviewDataUriComplete)(const VidyoLocalWindowShare* w, const LmiString* videoFrame, VidyoLocalWindowShareState state)

Parameters:

w The VidyoLocalWindowShare object.
videoFrame
state

Callback: VidyoMeetingFeedbackMeetingAttendeeAdded

Member Of:

VidyoMeetingFeedback

Description:

Indicates that an attendee was added to the meeting. Triggered by: VidyoMeetingAddAttendee or from addition by a remote user

Include:

Lmi/VidyoClient/VidyoMeeting.h

Syntax:

void (*VidyoMeetingFeedbackMeetingAttendeeAdded)(VidyoMeetingFeedback* f, VidyoMeeting* meeting, VidyoMeetingAttendee* attendee)

Parameters:

f
meeting
attendee

Callback: VidyoMeetingFeedbackMeetingAttendeeRemoved

Member Of:

VidyoMeetingFeedback

Description:

Indicates that an attendee was removed from the meeting. Triggered by: VidyoMeetingRemoveAttendee or from addition by a remote user

Include:

Lmi/VidyoClient/VidyoMeeting.h

Syntax:

void (*VidyoMeetingFeedbackMeetingAttendeeRemoved)(VidyoMeetingFeedback* f, VidyoMeeting* meeting, VidyoMeetingAttendee* attendee)

Parameters:

f
meeting
attendee

Callback: VidyoRoomOnAvailableResourcesChanged

Member Of:

VidyoRoom

Description:

Callback that is triggered when the available resources such as CPU and bandwidth change when media is enabled.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnAvailableResourcesChanged)(VidyoRoom* room, LmiUint cpuEncode, LmiUint cpuDecode, LmiUint bandwidthSend, LmiUint bandwidthReceive)

Parameters:

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.

Callback: VidyoRoomOnDeleteResult

Member Of:

VidyoRoom

Description:

Callback that is triggered when server acknowleges a VidyoRoom has been deleted on the server.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnDeleteResult)(VidyoRoom* room, VidyoRoomDeleteResult result)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
result result of the operation to delete the room on the server.

Callback: VidyoRoomOnDynamicParticipantChanged

Member Of:

VidyoRoom

Description:

This callback is invoked to report that the list of dynamically selected participants in a conference has changed.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnDynamicParticipantChanged)(VidyoRoom* room, LmiVector(VidyoParticipant) *dynamicSelectedParticipants, LmiVector(VidyoRemoteCamera) *dynamicSelectedCameras)

Parameters:

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.

Callback: VidyoRoomOnEntered

Member Of:

VidyoRoom

Description:

Callback that is triggered when entering the VidyoRoom as a result of VidyoRoomEnter() or VidyoRoomAcceptIncoming() request.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnEntered)(VidyoRoom* room, VidyoRoomEnterResult result)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
result Result of an attempt to enter the VidyoRoom.

Callback: VidyoRoomOnExited

Member Of:

VidyoRoom

Description:

Callback that is triggered when the VidyoUser exited the VidyoRoom or as a result of VidyoRoomLeave() request.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnExited)(VidyoRoom* room, VidyoRoomExitReason reason)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
reason Reason why VidyoUser exited VidyoRoom.

Callback: VidyoRoomOnGetHistoryResults

Member Of:

VidyoRoom

Description:

Callback that is triggered as a result of VidyoRoomGetHistory() call.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnGetHistoryResults)(VidyoRoom* room, const LmiVector(VidyoChatMessage) *records, LmiInt64 historySize, VidyoRoomSearchResult result)

Parameters:

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.

Callback: VidyoRoomOnGetRoomPropertiesResult

Member Of:

VidyoRoom

Description:

Callback that is triggered when VidyoRoomGetRoomProperties() request completes.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnGetRoomPropertiesResult)(VidyoRoom* room, VidyoRoomGetPropertiesResult result, const VidyoRoomProperties* roomProperties)

Parameters:

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.

Callback: VidyoRoomOnLoudestParticipantChanged

Member Of:

VidyoRoom

Description:

This callback is invoked to report that an audio-only participant has gain or lost loudest speaker status.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnLoudestParticipantChanged)(VidyoRoom* room, VidyoParticipant* participant, LmiBool isAudioOnly)

Parameters:

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

Callback: VidyoRoomOnMaxRemoteSourcesChanged

Member Of:

VidyoRoom

Description:

Callback that is triggered when maximum decoding capability changes when media is enabled.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnMaxRemoteSourcesChanged)(VidyoRoom* room, LmiUint maxRemoteSources)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
maxRemoteSources Maximum number of remote video sources that can be recived both statically and dynamically.

Callback: VidyoRoomOnMediaDisabled

Member Of:

VidyoRoom

Description:

Callback that is triggered when media has been disbled after a successfully enabling it with VidyoRoomEnableMedia().

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnMediaDisabled)(VidyoRoom* room, VidyoRoomMediaDisableReason reason)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
reason Reason why media had beed disabled.

Callback: VidyoRoomOnMediaEnabled

Member Of:

VidyoRoom

Description:

Callback that is triggered when media was enabled as a result of VidyoRoomEnableMedia() request.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnMediaEnabled)(VidyoRoom* room)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.

Callback: VidyoRoomOnMediaFailed

Member Of:

VidyoRoom

Description:

Callback that is triggered when media enabling failed as a result of VidyoRoomEnableMedia() request.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnMediaFailed)(VidyoRoom* room, VidyoRoomMediaFailReason reason)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
reason Reason why media failed.

Callback: VidyoRoomOnMediaRouteAcquired

Member Of:

VidyoRoom

Description:

Callback that is triggered when media route is discovered as a result of VidyoRoomAcquireMediaRoute() request.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnMediaRouteAcquired)(VidyoRoom* room)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.

Callback: VidyoRoomOnMessageAcknowledged

Member Of:

VidyoRoom

Description:

Callback that is triggered when a VidyoChatMessage is delivered to the VidyoRoom on the server.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnMessageAcknowledged)(VidyoRoom* room, VidyoChatMessage* chatMessage)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
chatMessage Pointer to the VidyoChatMessage object created by the server from VidyoRoomSendMessage() call.

Note 1:

The VidyoChatMessage has the messageId that was assigned by the server which can be referenced by the VidyoRoomOnMessageRead callback. Currently the only way to correlate the message that was sent with VidyoRoomSendMessage() to the acknowledged message is with the message body.

Callback: VidyoRoomOnMessageRead

Member Of:

VidyoRoom

Description:

Callback that is triggered when a message that was acknowledged by the server was read by the other VidyoParticipant in the room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnMessageRead)(VidyoRoom* room, VidyoParticipant* participant, LmiInt64 messageId)

Parameters:

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.

Callback: VidyoRoomOnMessageReceived

Member Of:

VidyoRoom

Description:

Callback that is triggered for every VidyoChatMessage that was sent to the VidyoRoom by every other VidyoParticipant after the VidyoRoomOnEntered returned successfully.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnMessageReceived)(VidyoRoom* room, VidyoParticipant* participant, VidyoChatMessage* chatMessage)

Parameters:

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.

Callback: VidyoRoomOnMessageSearchResults

Member Of:

VidyoRoom

Description:

Callback that is triggered as a result of VidyoRoomSearch() call.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnMessageSearchResults)(VidyoRoom* room, const char* searchText, const LmiVector(VidyoChatMessage)* records, VidyoRoomSearchResult result)

Parameters:

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.

Callback: VidyoRoomOnMessageTypingIndication

Member Of:

VidyoRoom

Description:

Callback that is triggered when typing state of a remote VidyoParticipant changes.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnMessageTypingIndication)(VidyoRoom* room, VidyoParticipant* participant, VidyoChatMessageTypingIndication typingIndication)

Parameters:

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.

Callback: VidyoRoomOnParticipantJoined

Member Of:

VidyoRoom

Description:

Callback that is triggered when VidyoParticipant is entering or has been in the room when VidyoUser Entered.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnParticipantJoined)(VidyoRoom* room, VidyoParticipant* participant)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
participant Pointer to the VidyoParticipant object.

Callback: VidyoRoomOnParticipantLeft

Member Of:

VidyoRoom

Description:

Callback that is triggered when VidyoParticipant is leaving or is being removed when this VidyoUser Exited.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnParticipantLeft)(VidyoRoom* room, VidyoParticipant* participant)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
participant Pointer to the VidyoParticipant object.

Callback: VidyoRoomOnRoomPropertiesChanged

Member Of:

VidyoRoom

Description:

Callback that is triggered when VidyoRoomProperties is changed on the server side.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnRoomPropertiesChanged)(VidyoRoom* room, const VidyoRoomProperties* roomProperties)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
roomProperties Updated room properties.

Callback: VidyoRoomOnSetFavoriteResult

Member Of:

VidyoRoom

Description:

Callback that is triggered when server acknowleges a VidyoRoom's favorite status for current logged-in user has changed.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnSetFavoriteResult)(VidyoRoom* room, LmiBool isFavorite, VidyoRoomSetFavoriteResult result)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
isFavorite
result

Callback: VidyoRoomOnSetRoomPropertiesResult

Member Of:

VidyoRoom

Description:

Callback that is triggered when VidyoRoomSetProperties request completes.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnSetRoomPropertiesResult)(VidyoRoom* room, VidyoRoomSetPropertiesResult result)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
result Result of the VidyoRoomSetProperties request.

Callback: VidyoRoomOnSetSubject

Member Of:

VidyoRoom

Description:

Callback that is triggered when the subject of the VidyoRoom has changed.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomOnSetSubject)(VidyoRoom* room, const char* subject)

Parameters:

room Pointer to the VidyoRoom that triggered the callback.
subject New subject of the VidyoRoom.

Callback: VidyoRoomRecorderInCall

Member Of:

VidyoRoom

Description:

Callback that is triggered when the call is recorded or when call recording stops.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoRoomRecorderInCall)(VidyoRoom* r, LmiBool recorderInCall )

Parameters:

r The VidyoRoom that triggered the callback.
recorderInCall LMI_TRUE when the call is recorded, LMI_FALSE when recording stops

Callback: VidyoUserOnCallCreated

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnCallCreated)(VidyoUser* u, VidyoCall* call, VidyoUserCallCreateResult result, const LmiString *createToken)

Parameters:

u
call
result
createToken

Callback: VidyoUserOnCallCreatedByInvite

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnCallCreatedByInvite)(VidyoUser* u, VidyoCall* call, const VidyoContact* inviter)

Parameters:

u
call
inviter

Callback: VidyoUserOnConnectionStatusChanged

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnConnectionStatusChanged)(VidyoUser* u, VidyoUserConnectionStatusChangedReason reason)

Parameters:

u
reason

Callback: VidyoUserOnFavoriteRoomResults

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnFavoriteRoomResults)(VidyoUser* u, VidyoUserSearchResult searchResult, const LmiVector(VidyoRoomInfo)* roomInfo)

Parameters:

u
searchResult
roomInfo

Callback: VidyoUserOnGetContactResult

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnGetContactResult)(VidyoUser* u, const VidyoContact* contact, VidyoUserGetContactResult result)

Parameters:

u
contact
result

Callback: VidyoUserOnGetLicenseKey

Member Of:

VidyoUser

Description:

Requests the license key that was presumably stored when received via VidyoUserLicenseReceivedCallback

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnGetLicenseKey)(VidyoUser* u, LmiString* licenseKey)

Parameters:

u
licenseKey

Callback: VidyoUserOnLicenseReceived

Member Of:

VidyoUser

Description:

Informs about new license received by VidyoUser

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnLicenseReceived)(VidyoUser* u, const LmiString* licenseKey)

Parameters:

u
licenseKey

Callback: VidyoUserOnLoggedOut

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnLoggedOut)(VidyoUser* u, VidyoUserLogoutReason reason)

Parameters:

u
reason

Callback: VidyoUserOnLoginComplete

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnLoginComplete)(VidyoUser* u, VidyoUserLoginResult result, LmiBool secure)

Parameters:

u
result
secure

Callback: VidyoUserOnRecentRoomResults

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnRecentRoomResults)(VidyoUser* u, VidyoUserSearchResult searchResult, const LmiVector(VidyoRoomInfo)* roomInfo)

Parameters:

u
searchResult
roomInfo

Callback: VidyoUserOnRemoveRosterContact

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnRemoveRosterContact)(VidyoUser* u, const LmiString* uri)

Parameters:

u
uri

Callback: VidyoUserOnRoomCreated

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnRoomCreated)(VidyoUser* u, VidyoRoom* room, VidyoUserRoomCreateResult result, const LmiString *createToken)

Parameters:

u
room
result
createToken

Callback: VidyoUserOnRoomCreatedByInvite

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnRoomCreatedByInvite)(VidyoUser* u, VidyoRoom* room, const VidyoContact* inviter, const char* message)

Parameters:

u
room
inviter
message

Callback: VidyoUserOnRoomSearchResults

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnRoomSearchResults)(VidyoUser* u, const char* searchText, VidyoUserSearchResult searchResult, const LmiVector(VidyoRoomInfo)* roomInfo, LmiSizeT numRecords)

Parameters:

u
searchText
searchResult
roomInfo
numRecords

Callback: VidyoUserOnTokenReceived

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnTokenReceived)(VidyoUser* u, LmiString *token, VidyoUserTokenType tokenType)

Parameters:

u
token
tokenType

Callback: VidyoUserOnUpdateRosterContact

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnUpdateRosterContact)(VidyoUser* u, const VidyoContact* contact)

Parameters:

u
contact

Callback: VidyoUserOnUpdateSelf

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnUpdateSelf)(VidyoUser* u, const VidyoContact* contact)

Parameters:

u
contact

Callback: VidyoUserOnUserSearchResults

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnUserSearchResults)(VidyoUser* u, const char* searchText, VidyoUserSearchResult searchResult, const LmiVector(VidyoContactInfo)* contacts, LmiSizeT numRecords)

Parameters:

u
searchText
searchResult
contacts
numRecords

Callback: VidyoUserOnWebProxyCredentialsRequest

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Syntax:

void (*VidyoUserOnWebProxyCredentialsRequest)(VidyoUser* u)

Parameters:

u

Function: VidyoCalendarConnect

Member Of:

VidyoCalendar

Description:

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

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarConnect(VidyoCalendar* c, LmiVector(VidyoFormField)* connProperties)

Parameters:

c
connProperties Property values

Returns:

Function: VidyoCalendarConstructCopy

Member Of:

VidyoCalendar

Description:

Constructs an VidyoCalendar object as a copy of another.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

VidyoCalendar *VidyoCalendarConstructCopy(VidyoCalendar *obj, const VidyoCalendar *other)

Parameters:

obj The VidyoCalendar object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoCalendarCreateMeeting

Member Of:

VidyoCalendar

Description:

Creates a calendar meeting Triggers callback(s): VidyoCalendarFeedbackMeetingCreated

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarCreateMeeting( VidyoCalendar* c, VidyoCalendarFeedback *feedback, VidyoMeeting *meeting, LmiString *createToken)

Parameters:

c
feedback
meeting
createToken A unique string token to match this method call with the resulting asynchronous callback

Returns:

r

Function: VidyoCalendarDestruct

Member Of:

VidyoCalendar

Description:

Destructs an VidyoCalendar object.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

void VidyoCalendarDestruct(VidyoCalendar *obj)

Parameters:

obj The VidyoCalendar object to destruct.

Function: VidyoCalendarFeedbackConstruct

Member Of:

VidyoCalendarFeedback

Description:

Construct the calendar feedback instance.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

VidyoCalendarFeedback* VidyoCalendarFeedbackConstruct(VidyoCalendarFeedback* f, VidyoCalendarFeedbackConnectResult connectState, VidyoCalendarFeedbackDisconnected disconnected, VidyoCalendarFeedbackMeetingEventNotification meetingEvent, VidyoCalendarFeedbackMeetingCreatedByService meetingCreatedByService, VidyoCalendarFeedbackMeetingCreated meetingCreated, VidyoCalendarFeedbackMeetingUpdatedByService meetingUpdatedByService, VidyoCalendarFeedbackMeetingUpdated meetingUpdated, VidyoCalendarFeedbackMeetingRemovedByService meetingRemovedByService, VidyoCalendarFeedbackMeetingRemoved meetingRemoved, VidyoCalendarFeedbackGetMeetingsResult getMeetingResults, LmiAllocator* alloc)

Parameters:

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

Returns:

Function: VidyoCalendarFeedbackConstructCopy

Member Of:

VidyoCalendarFeedback

Description:

Constructs a VidyoCalendarFeedback object as a copy of another.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

VidyoCalendarFeedback *VidyoCalendarFeedbackConstructCopy(VidyoCalendarFeedback *obj, const VidyoCalendarFeedback *other)

Parameters:

obj The VidyoCalendarFeedback object to construct.
other The feedback object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoCalendarFeedbackDestruct

Member Of:

VidyoCalendarFeedback

Description:

Destructs an VidyoCalendarFeedback object.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

void VidyoCalendarFeedbackDestruct(VidyoCalendarFeedback *obj)

Parameters:

obj The VidyoCalendarFeedback object to destruct.

Function: VidyoCalendarGetConnectFields

Member Of:

VidyoCalendar

Description:

Retrieves the connection fields needed to connect to a service, based on the service type.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

LmiVector(VidyoFormField) VidyoCalendarGetConnectFields(VidyoCalendarManagerDefaultServices serviceType )

Parameters:

serviceType Type of service to retrieve the connection param types for

Returns:

Function: VidyoCalendarGetId

Member Of:

VidyoCalendar

Description:

Retreives the unique string Id that identifies the instance of the calendar.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoCalendarGetId(const VidyoCalendar* c)

Parameters:

c Pointer to the VidyoCalendar object.

Returns:

LmiString that holds the Id for the calendar.

Function: VidyoCalendarGetMeetingsByDay

Member Of:

VidyoCalendar

Description:

Get a list of meetings by day. Triggers callback(s): VidyoCalendarFeedbackGetMeetingsResult

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarGetMeetingsByDay(VidyoCalendar* c, LmiUint year, LmiUint month, LmiUint day, LmiString *createToken)

Parameters:

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

Returns:

Function: VidyoCalendarGetMeetingsByMonth

Member Of:

VidyoCalendar

Description:

Get a list of meetings by month. Triggers callback(s): VidyoCalendarFeedbackGetMeetingsResult

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarGetMeetingsByMonth(VidyoCalendar* c, LmiUint year, LmiUint month, LmiString *createToken)

Parameters:

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

Returns:

Function: VidyoCalendarGetMeetingsByWeek

Member Of:

VidyoCalendar

Description:

Get a list of meetings by week. Triggers callback(s): VidyoCalendarFeedbackGetMeetingsResult

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarGetMeetingsByWeek(VidyoCalendar* c, LmiUint year, LmiUint month, LmiUint day, LmiString *createToken)

Parameters:

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

Returns:

Function: VidyoCalendarGetServiceState

Member Of:

VidyoCalendar

Description:

Retreives the user data pointer that was previousely set by Calendaring VidyoCalendarSetUserData.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

const VidyoCalendarState * VidyoCalendarGetServiceState(const VidyoCalendar* c)

Parameters:

c Pointer to the VidyoCalendar object.

Returns:

LmiString that holds the state of the calendar.

Function: VidyoCalendarGetServiceType

Member Of:

VidyoCalendar

Description:

Retreives the service type for the calendar.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

const LmiString * VidyoCalendarGetServiceType(const VidyoCalendar* c)

Parameters:

c Pointer to the VidyoCalendar object.

Returns:

Value for the service type .

Function: VidyoCalendarManagerConstruct

Member Of:

VidyoCalendarManager

Description:

Constructor for Vidyo Calendar Service Manager

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Library:

VidyoClient

Syntax:

VidyoCalendarManager* VidyoCalendarManagerConstruct(VidyoCalendarManager *calendarMgr, VidyoCalendarManagerFeedback* feedback, LmiAllocator* alloc)

Parameters:

calendarMgr
feedback
alloc

Returns:

Function: VidyoCalendarManagerCreateCalendarInstance

Member Of:

VidyoCalendarManager

Description:

Creates a VidyoCalendar which is returned through VidyoCalendarManagerFeedbackCalendarCreated. Will be identifiable through the service ID and calendarName.

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarManagerCreateCalendarInstance(VidyoCalendarManager* calMgr, VidyoCalendarFeedback * feedback, LmiString * svcId, LmiString * calendarName, LmiString * createToken)

Parameters:

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

Returns:

Function: VidyoCalendarManagerDeleteCalendarInstance

Member Of:

VidyoCalendarManager

Description:

Destructs the for VidyoCalendar calendar instance passed in.

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Library:

VidyoClient

Syntax:

void VidyoCalendarManagerDeleteCalendarInstance(VidyoCalendarManager* calMgr, VidyoCalendar * cal)

Parameters:

calMgr
cal Calendar handle

Function: VidyoCalendarManagerDestruct

Member Of:

VidyoCalendarManager

Description:

Destructor for Vidyo Calendar Service Manager

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Library:

VidyoClient

Syntax:

void VidyoCalendarManagerDestruct(VidyoCalendarManager *calendarMgr)

Parameters:

calendarMgr

Function: VidyoCalendarManagerFeedbackConstruct

Member Of:

VidyoCalendarManagerFeedback

Description:

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Library:

VidyoClient

Syntax:

VidyoCalendarManagerFeedback* VidyoCalendarManagerFeedbackConstruct(VidyoCalendarManagerFeedback* f, VidyoCalendarManagerFeedbackServiceDiscovery serviceStatus, VidyoCalendarManagerFeedbackUninitialized uninitialized, VidyoCalendarManagerFeedbackCalendarCreated calendarCreated, LmiAllocator* alloc)

Parameters:

f Feedback structure to hold registered member functions
serviceStatus
uninitialized
calendarCreated
alloc

Returns:

Function: VidyoCalendarManagerGetCalendarSvcString

Member Of:

VidyoCalendarManager

Description:

Retrieves the list of calendar types that the given calendar manager is configured to operate against.

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Library:

VidyoClient

Syntax:

LmiString* VidyoCalendarManagerGetCalendarSvcString(VidyoCalendarManagerDefaultServices calendarId)

Parameters:

calendarId Enumerated calendar ID to retrieve the string value for.

Returns:

String identifying the calendar service

Function: VidyoCalendarManagerGetCalendarTypes

Member Of:

VidyoCalendarManager

Description:

Retrieves the list of calendar types that the given calendar manager is configured to operate against.

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarManagerGetCalendarTypes(VidyoCalendarManager *calendarMgr, LmiVector(VidyoCalendarManagerDefaultServices) * serviceTypes)

Parameters:

calendarMgr Calendar manager object to retrieve the supported calendar types from.
serviceTypes Calendar manager object to retrieve the supported calendar types from.

Returns:

Function: VidyoCalendarManagerInitialize

Member Of:

VidyoCalendarManager

Description:

Prepares the environment for accessing the underlying calendar services

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarManagerInitialize(VidyoCalendarManager *calendarMgr)

Parameters:

calendarMgr

Returns:

Function: VidyoCalendarManagerSetCalendarTypes

Member Of:

VidyoCalendarManager

Description:

Specifies a specific list of calendar types that the given calendar manager will be allowed to operate against.

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarManagerSetCalendarTypes(VidyoCalendarManager *calendarMgr, LmiVector(VidyoCalendarManagerDefaultServices) * serviceTypes)

Parameters:

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.

Returns:

LmiBool

Function: VidyoCalendarManagerUninitialize

Member Of:

VidyoCalendarManager

Description:

Cleans up all resources related to calendar processing. MUST be performed before destructing the VidyoCalendarManager

Include:

Lmi/VidyoClient/VidyoCalendarManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarManagerUninitialize(VidyoCalendarManager *calendarMgr)

Parameters:

calendarMgr

Returns:

Function: VidyoCalendarRemoveMeeting

Member Of:

VidyoCalendar

Description:

Removes a meeting from the calendar Triggers callback(s): VidyoCalendarFeedbackMeetingRemoved

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarRemoveMeeting(VidyoCalendar* c, VidyoCalendarFeedback *feedback, VidyoMeeting *meeting, LmiString *createToken)

Parameters:

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

Returns:

r

Function: VidyoCalendarSearchMeetings

Member Of:

VidyoCalendar

Description:

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?

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarSearchMeetings(VidyoCalendar* c, LmiString * searchText, LmiString * beginDate, LmiString * endDate, LmiUint index, LmiUint pageSize)

Parameters:

c
searchText
beginDate
endDate
index
pageSize

Returns:

Function: VidyoCalendarSetRoomIdMatchString

Member Of:

VidyoCalendar

Description:

Sets the regular expression string that will be used to identify Vidyo room URLs or key information, during a meeting search or retrieval.

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarSetRoomIdMatchString(const VidyoCalendar* c, LmiString * regexp)

Parameters:

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

Returns:

True for a successful set, false if there was an issue setting the value.

Function: VidyoCalendarUpdateMeeting

Member Of:

VidyoCalendar

Description:

Updates a calendar meeting Triggers callback(s): VidyoCalendarFeedbackMeetingUpdated

Include:

Lmi/VidyoClient/VidyoCalendar.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCalendarUpdateMeeting(VidyoCalendar* c, VidyoCalendarFeedback *feedback, VidyoMeeting *meeting, LmiString *createToken)

Parameters:

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

Returns:

r

Function: VidyoCallAccept

Member Of:

VidyoCall

Description:

Accepts an incoming VidyoCall that was notified by the VidyoUserOnCallCreatedByInvite callback.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCallAccept(VidyoCall* c, VidyoCallOnInitiated onInitiated, VidyoCallOnEnded onEnded)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoCallConstructCopy

Member Of:

VidyoCall

Description:

Constructs the VidyoCall object as a copy of another.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

VidyoCall *VidyoCallConstructCopy(VidyoCall *obj, const VidyoCall *other)

Parameters:

obj Pointer to the VidyoCall object to construct.
other Pointer to the VidyoCall object to make a copy of.

Returns:

Pointer to the constructed object on success, or NULL on failure.

Function: VidyoCallDestruct

Member Of:

VidyoCall

Description:

Destructs the VidyoCall object.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoCallDestruct(VidyoCall *obj)

Parameters:

obj Pointer to the VidyoCall object to destruct.

Function: VidyoCallGetId

Member Of:

VidyoCall

Description:

Gets the unique ID of the VidyoCall

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoCallGetId(const VidyoCall* c)

Parameters:

c Pointer to the VidyoCall object.

Returns:

Pointer to the unique ID of the VidyoCall.

Function: VidyoCallGetParticipants

Member Of:

VidyoCall

Description:

Gets the LmiVector of VidyoParticipant objects in the VidyoCall.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCallGetParticipants(VidyoCall* c, LmiVector(VidyoParticipant) *participants)

Parameters:

c Pointer to the VidyoCall object.
participants Pointer to the LmiVector of VidyoParticipant objects.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

VidyoParticipant is the remote party in the call.

Note 2:

Currently there is maximum of one entry in this vector.

Function: VidyoCallGetRemoteRenderers

Member Of:

VidyoCall

Description:

Gets the LmiVector of VidyoRemoteRenderer objects in the VidyoCall.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCallGetRemoteRenderers(VidyoCall* c, LmiVector(VidyoRemoteRenderer) *renderers)

Parameters:

c Pointer to the VidyoCall object.
renderers Pointer to the LmiVector of VidyoRemoteRenderer objects.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

Only in progress VidyoCall will have a non-empty vector.

Note 2:

Currently there is maximum of one entry in this vector.

Function: VidyoCallGetRemoteSpeakers

Member Of:

VidyoCall

Description:

Gets the LmiVector of VidyoRemoteSpeaker objects in the VidyoCall.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCallGetRemoteSpeakers(VidyoCall* c, LmiVector(VidyoRemoteSpeaker) *speakers)

Parameters:

c Pointer to the VidyoCall object.
speakers Pointer to the LmiVector of VidyoRemoteSpeaker objects.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

Only in progress VidyoCall will have a non-empty vector.

Note 2:

Currently there is maximum of one entry in this vector.

Function: VidyoCallGetSubject

Member Of:

VidyoCall

Description:

Gets the current subject of the VidyoCall.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

const char* VidyoCallGetSubject(VidyoCall* c)

Parameters:

c Pointer to the VidyoCall object.

Returns:

≈subject of the VidyoCall.

Function: VidyoCallGetUser

Member Of:

VidyoCall

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

VidyoUser *VidyoCallGetUser(VidyoCall *c)

Parameters:

c

Returns:

Function: VidyoCallHangUp

Member Of:

VidyoCall

Description:

Hangs up an in-progress VidyoCall.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoCallHangUp(VidyoCall* c)

Parameters:

c Pointer to the VidyoCall object.

Function: VidyoCallInitiate

Member Of:

VidyoCall

Description:

Initiates a VidyoCall.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCallInitiate(VidyoCall* c, VidyoCallOnInitiated onInitiated, VidyoCallOnEnded onEnded)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoCallRegisterMessageEventListener

Member Of:

VidyoCall

Description:

Registers to get notified about message events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCallRegisterMessageEventListener(VidyoCall* c, VidyoCallOnMessageReceived onMessageReceived, VidyoCallOnMessageAcknowledged onMessageAcknowledged, VidyoCallOnMessageRead onMessageRead, VidyoCallOnMessageTypingIndication onMessageTypingIndication)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoCallRegisterSubjectEventListener

Member Of:

VidyoCall

Description:

Registers to get notified about subject events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCallRegisterSubjectEventListener(VidyoCall* c, VidyoCallOnSetSubject onSetSubject)

Parameters:

c The VidyoCall object.
onSetSubject Callback that is triggered when the subject has been changed.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoCallReject

Member Of:

VidyoCall

Description:

Rejects an incoming VidyoCall that was notified by the VidyoUserFeedbackCallCreatedByInvite callback.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoCallReject(VidyoCall* c)

Parameters:

c Pointer to the VidyoCall object.

Function: VidyoCallSendMessage

Member Of:

VidyoCall

Description:

Sends a message to the remote user in the VidyoCall.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCallSendMessage(VidyoCall* c, const char* message)

Parameters:

c Pointer to the VidyoCall object.
message Message to be sent.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoCallSetSubject

Member Of:

VidyoCall

Description:

Sets a new subject on the VidyoCall.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoCallSetSubject(VidyoCall* c, const char* subject)

Parameters:

c Pointer to the VidyoCall object.
subject New subject of the VidyoCall.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoClientGetBuildTag

Member Of:

Endpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

const LmiString *VidyoClientGetBuildTag(void)

Returns:

Build tag of the VidyoClient library.

Function: VidyoClientGetVersion

Member Of:

Endpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

const LmiString *VidyoClientGetVersion(void)

Returns:

Version of the VidyoClient library.

Function: VidyoClientInitialize

Member Of:

Endpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoClientInitialize(void)

Returns:

Function: VidyoClientUninitialize

Member Of:

Endpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoClientUninitialize(void)

Function: VidyoConnectorAssign

Member Of:

VidyoConnector

Description:

Assigns one VidyoConnector object the value of another.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

VidyoConnector *VidyoConnectorAssign(VidyoConnector* c, const VidyoConnector *other)

Parameters:

c The VidyoConnector object.
other The VidyoConnector object from which to assign.

Returns:

The destination object on success. NULL on failure.

Function: VidyoConnectorAssignViewToLocalCamera

Member Of:

VidyoConnector

Description:

Assigns the view in which to show the preview from a local camera.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorAssignViewToLocalCamera(VidyoConnector* c, const LmiViewId* viewId, VidyoLocalCamera* localCamera, LmiBool displayCropped, LmiBool allowZoom)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

This API will work only if compositing had been disabled by passing a NULL LmiViewId to VidyoConnectorConstruct.

Note 2:

The view will not be shown until VidyoConnectorShowViewAt is called with valid parameters.

Function: VidyoConnectorAssignViewToRemoteCamera

Member Of:

VidyoConnector

Description:

Assigns the view in which to show the remote camera of one of the other participants.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorAssignViewToRemoteCamera(VidyoConnector* c, const LmiViewId* viewId, VidyoRemoteCamera* remoteCamera, LmiBool displayCropped, LmiBool allowZoom)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

This API will work only if compositing had been disabled by passing a NULL LmiViewId to VidyoConnectorConstruct.

Note 2:

The application needs to make sure the sources are hidden when the local CPU and bandwidth are limited, by monitoring the VidyoConnectorOnResourcesChanged callback and showing/hiding sources based on avaialble resources.

Note 3:

The view will not be shown until VidyoConnectorShowViewAt is called with valid parameters.

Function: VidyoConnectorAssignViewToRemoteWindowShare

Member Of:

VidyoConnector

Description:

Shows a participant in a view.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorAssignViewToRemoteWindowShare(VidyoConnector* c, const LmiViewId* viewId, VidyoRemoteWindowShare* remoteWindowShare, LmiBool displayCropped, LmiBool allowZoom)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

This API will work only if compositing had been disabled by passing a NULL LmiViewId to VidyoConnectorConstruct.

Note 2:

The view will not be shown until VidyoConnectorShowViewAt is called with valid parameters.

Function: VidyoConnectorConnect

Member Of:

VidyoConnector

Description:

Connects to a live conference with the specified resourceId.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorConnect(VidyoConnector* c, const char* host, const char* token, const char* displayName, const char *resourceId, VidyoConnectorOnSuccess onSuccess, VidyoConnectorOnFailure onFailure, VidyoConnectorOnDisconnected onDisconnected)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorConstruct

Member Of:

VidyoConnector

Description:

Constructs the VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

VidyoConnector* VidyoConnectorConstruct(VidyoConnector* c, const LmiViewId* viewId, VidyoConnectorViewStyle viewStyle, LmiUint remoteParticipants, const char* logFileFilter, const char* logFileName, const LmiVoidPtr userData)

Parameters:

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.

Returns:

The constructed object on success. NULL on failure.

Note 1:

LmiViewId is HWND on Windows, NSView on Mac OS X, UIView on iOS, window on X11, ViewGroup on Android.

Note 2:

The view will not be shown until VidyoConnectorShowViewAt is called with valid parameters.

Function: VidyoConnectorConstructCopy

Member Of:

VidyoConnector

Description:

Constructs an VidyoConnector object as a copy of another.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

VidyoConnector *VidyoConnectorConstructCopy(VidyoConnector* c, const VidyoConnector *other)

Parameters:

c The VidyoConnector object to construct.
other The VidyoConnector object from which to construct a copy.

Returns:

The constructed object on success. NULL on failure.

Function: VidyoConnectorCycleCamera

Member Of:

VidyoConnector

Description:

Cycles camera selection to the next available camera.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorCycleCamera(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorCycleMicrophone

Member Of:

VidyoConnector

Description:

Cycles microphone selection to the next available microphone.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorCycleMicrophone(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorCycleSpeaker

Member Of:

VidyoConnector

Description:

Cycles speaker selection to the next available speaker.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorCycleSpeaker(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorDestruct

Member Of:

VidyoConnector

Description:

Destructs an VidyoConnector object.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

void VidyoConnectorDestruct(VidyoConnector* c)

Parameters:

c The VidyoConnector object to destruct.

Function: VidyoConnectorDisable

Member Of:

VidyoConnector

Description:

Disables connector object, releases all devices as precursor to destruct.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

void VidyoConnectorDisable(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Function: VidyoConnectorDisableDebug

Member Of:

VidyoConnector

Description:

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

void VidyoConnectorDisableDebug(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Function: VidyoConnectorDisconnect

Member Of:

VidyoConnector

Description:

Disconnects a live conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

void VidyoConnectorDisconnect(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Function: VidyoConnectorEnableDebug

Member Of:

VidyoConnector

Description:

Enabled debug mode which will start debug logging and enable statistics.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorEnableDebug(VidyoConnector* c, LmiUint port, const char *logFilter)

Parameters:

c The VidyoConnector object.
port Local listening port for debugging.
logFilter Log filter to use on the debug port.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorGetState

Member Of:

VidyoConnector

Description:

Retrieves the state of the VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

VidyoConnectorState VidyoConnectorGetState(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

The state of the VidyoConnector.

Function: VidyoConnectorGetStatsJson

Member Of:

VidyoConnector

Description:

Retrieves VidyoConnector statistics in JSON format.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

const LmiString *VidyoConnectorGetStatsJson(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

JSON encoded string on success, NULL on failure.

Function: VidyoConnectorGetVersion

Member Of:

VidyoConnector

Description:

Retrieves version of the VidyoConnector library.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

const LmiString *VidyoConnectorGetVersion(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

Version on success, NULL on failure.

Function: VidyoConnectorHideView

Member Of:

VidyoConnector

Description:

Hides a view which is used for custom layout of sources.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorHideView(VidyoConnector* c, const LmiViewId* viewId)

Parameters:

c The VidyoConnector object.
viewId The view ID of the view to hide.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorInitialize

Member Of:

Connector

Description:

Initialize the VidyoConnector API.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorInitialize(void)

Returns:

Note 1:

This function is required: Any application that uses the VidyoConnector API must initialize it first, typically when the application starts.

Function: VidyoConnectorRegisterLocalCameraEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about local camera events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterLocalCameraEventListener(VidyoConnector* c, VidyoConnectorOnLocalCameraAdded onAdded, VidyoConnectorOnLocalCameraRemoved onRemoved, VidyoConnectorOnLocalCameraSelected onSelected, VidyoConnectorOnLocalCameraStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterLocalMicrophoneEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about local microphone events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterLocalMicrophoneEventListener(VidyoConnector* c, VidyoConnectorOnLocalMicrophoneAdded onAdded, VidyoConnectorOnLocalMicrophoneRemoved onRemoved, VidyoConnectorOnLocalMicrophoneSelected onSelected, VidyoConnectorOnLocalMicrophoneStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterLocalMonitorEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about local monitor events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterLocalMonitorEventListener(VidyoConnector* c, VidyoConnectorOnLocalMonitorAdded onAdded, VidyoConnectorOnLocalMonitorRemoved onRemoved, VidyoConnectorOnLocalMonitorSelected onSelected, VidyoConnectorOnLocalMonitorStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterLocalSpeakerEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about local speaker events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterLocalSpeakerEventListener(VidyoConnector* c, VidyoConnectorOnLocalSpeakerAdded onAdded, VidyoConnectorOnLocalSpeakerRemoved onRemoved, VidyoConnectorOnLocalSpeakerSelected onSelected, VidyoConnectorOnLocalSpeakerStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterLocalWindowShareEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about local shareable-window events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterLocalWindowShareEventListener(VidyoConnector* c, VidyoConnectorOnLocalWindowShareAdded onAdded, VidyoConnectorOnLocalWindowShareRemoved onRemoved, VidyoConnectorOnLocalWindowShareSelected onSelected, VidyoConnectorOnLocalWindowShareStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterLogEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about log events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterLogEventListener(VidyoConnector* c, VidyoConnectorOnLog onLog, const char* filter)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterMessageEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about message events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterMessageEventListener(VidyoConnector* c, VidyoConnectorOnChatMessageReceived onChatMessageReceived)

Parameters:

c The VidyoConnector object.
onChatMessageReceived Callback that is triggered when a chat message is received from a participant.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterNetworkInterfaceEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about network interface events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterNetworkInterfaceEventListener(VidyoConnector* c, VidyoConnectorOnNetworkInterfaceAdded onAdded, VidyoConnectorOnNetworkInterfaceRemoved onRemoved, VidyoConnectorOnNetworkInterfaceSelected onSelected, VidyoConnectorOnNetworkInterfaceStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterParticipantEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about participant events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterParticipantEventListener(VidyoConnector* c, VidyoConnectorOnParticipantJoined onJoined, VidyoConnectorOnParticipantLeft onLeft, VidyoConnectorOnDynamicParticipantChanged onDynamicChanged, VidyoConnectorOnLoudestParticipantChanged onLoudestChanged)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterRecoderInCallEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified when a recorder joins or leaves the call.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterRecoderInCallEventListener(VidyoConnector* c, VidyoConnectorRecorderInCall onRecorderInCallChanged)

Parameters:

c The VidyoConnector object.
onRecorderInCallChanged Callback that is triggered when a recorder joins or leaves the call.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterRemoteCameraEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about remote camera events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterRemoteCameraEventListener(VidyoConnector* c, VidyoConnectorOnRemoteCameraAdded onAdded, VidyoConnectorOnRemoteCameraRemoved onRemoved, VidyoConnectorOnRemoteCameraStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterRemoteMicrophoneEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about remote microphone events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterRemoteMicrophoneEventListener(VidyoConnector* c, VidyoConnectorOnRemoteMicrophoneAdded onAdded, VidyoConnectorOnRemoteMicrophoneRemoved onRemoved, VidyoConnectorOnRemoteMicrophoneStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterRemoteWindowShareEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about remote shreable-window events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterRemoteWindowShareEventListener(VidyoConnector* c, VidyoConnectorOnRemoteWindowShareAdded onAdded, VidyoConnectorOnRemoteWindowShareRemoved onRemoved, VidyoConnectorOnRemoteWindowShareStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterResourceManagerEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about resource-management events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterResourceManagerEventListener(VidyoConnector* c, VidyoConnectorOnAvailableResourcesChanged onAvailableResourcesChanged, VidyoConnectorOnMaxRemoteSourcesChanged onMaxRemoteSourcesChanged)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorRegisterWebProxyEventListener

Member Of:

VidyoConnector

Description:

Registers to get notified about web proxy events.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorRegisterWebProxyEventListener(VidyoConnector* c, VidyoConnectorOnWebProxyCredentialsRequest onWebProxyCredentialsRequest)

Parameters:

c The VidyoConnector object.
onWebProxyCredentialsRequest Callback that is triggered when web proxy credentials are requested.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectDefaultCamera

Member Of:

VidyoConnector

Description:

Resets the camera selection to pick the Default camera.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectDefaultCamera(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectDefaultMicrophone

Member Of:

VidyoConnector

Description:

Resets the microphone selection to pick the Default microphone.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectDefaultMicrophone(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectDefaultNetworkInterfaceForMedia

Member Of:

VidyoConnector

Description:

Selects the default "any" network interface to be used for Media.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectDefaultNetworkInterfaceForMedia(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectDefaultNetworkInterfaceForSignaling

Member Of:

VidyoConnector

Description:

Selects the default "any" network interface to be used for Signaling.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectDefaultNetworkInterfaceForSignaling(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectDefaultSpeaker

Member Of:

VidyoConnector

Description:

Resets the speaker selection to pick the Default speaker.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectDefaultSpeaker(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectLocalCamera

Member Of:

VidyoConnector

Description:

Selects the local camera to use.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectLocalCamera(VidyoConnector* c, const VidyoLocalCamera* localCamera)

Parameters:

c The VidyoConnector object.
localCamera Local camera to select. NULL if none of them should be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectLocalMicrophone

Member Of:

VidyoConnector

Description:

Selects the local microphone to use.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectLocalMicrophone(VidyoConnector* c, const VidyoLocalMicrophone* localMicrophone)

Parameters:

c The VidyoConnector object.
localMicrophone Local microphone to select. NULL if none of them should be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectLocalMonitor

Member Of:

VidyoConnector

Description:

Selects the local monitor to share in a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectLocalMonitor(VidyoConnector* c, const VidyoLocalMonitor *localMonitor)

Parameters:

c The VidyoConnector object.
localMonitor Local monitor to share in a conference. NULL if none of them should be shared.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectLocalSpeaker

Member Of:

VidyoConnector

Description:

Selects the local speaker to use.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectLocalSpeaker(VidyoConnector* c, const VidyoLocalSpeaker* localSpeaker)

Parameters:

c The VidyoConnector object.
localSpeaker Local speaker to select. NULL if none of them should be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectLocalWindowShare

Member Of:

VidyoConnector

Description:

Selects the local window to share in a conference.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectLocalWindowShare(VidyoConnector* c, const VidyoLocalWindowShare* localWindowShare)

Parameters:

c The VidyoConnector object.
localWindowShare Local window to share in a conference. NULL if none of them should be shared.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectNetworkInterfaceForMedia

Member Of:

VidyoConnector

Description:

Selects the network interface to be used for Media.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectNetworkInterfaceForMedia(VidyoConnector* c, const VidyoNetworkInterface* networkInterface)

Parameters:

c The VidyoConnector object.
networkInterface Network interface to be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSelectNetworkInterfaceForSignaling

Member Of:

VidyoConnector

Description:

Selects the network interface to be used for Signaling.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSelectNetworkInterfaceForSignaling(VidyoConnector* c, const VidyoNetworkInterface* networkInterface)

Parameters:

c The VidyoConnector object.
networkInterface Network interface to be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSendChatMessage

Member Of:

VidyoConnector

Description:

Sends a message to all the other participants.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSendChatMessage(VidyoConnector* c, const char* message)

Parameters:

c The VidyoConnector object.
message A message to send to all the other participants.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSetCameraPrivacy

Member Of:

VidyoConnector

Description:

Sets the flag to show/hide the local camera.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSetCameraPrivacy(VidyoConnector* c, LmiBool privacy)

Parameters:

c The VidyoConnector object.
privacy Flag to show/hide the local camera.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSetLocation

Member Of:

VidyoConnector

Description:

Sets the geographic location of the endpoint using the VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSetLocation(VidyoConnector* c, LmiFloat64 latitude, LmiFloat64 longitude)

Parameters:

c The VidyoConnector object.
latitude Latitude of the geographic coordinate.
longitude Longitude of the geographic coordinate.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

Setting the location manually overrides other proximity detection mechanisms that are used by VidyoConnector to determine the best routing performance.

Function: VidyoConnectorSetMicrophonePrivacy

Member Of:

VidyoConnector

Description:

Sets the flag to mute/unmute the microphone.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSetMicrophonePrivacy(VidyoConnector* c, LmiBool privacy)

Parameters:

c The VidyoConnector object.
privacy Flag to mute/unmute the microphone.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSetMode

Member Of:

VidyoConnector

Description:

Sets the operating mode of the VidyoConnector.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSetMode(VidyoConnector* c, VidyoConnectorMode mode)

Parameters:

c The VidyoConnector object.
mode Desired operating mode.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSetPreview [REPLACED BY VidyoConnectorShowPreview]

Member Of:

VidyoConnector

Description:

Sets the flag to show/hide the local camera preview.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSetPreview(VidyoConnector* c, LmiBool preview)

Parameters:

c The VidyoConnector object.
preview Flag to show/hide the local camera preview.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSetSpeakerPrivacy

Member Of:

VidyoConnector

Description:

Sets the flag to mute/unmute the speaker.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSetSpeakerPrivacy(VidyoConnector* c, LmiBool privacy)

Parameters:

c The VidyoConnector object.
privacy Flag to mute/unmute the speaker.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorSetViewAnimationSpeed

Member Of:

VidyoConnector

Description:

Sets the speed of transition animation for windows moving around inside the view.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSetViewAnimationSpeed(VidyoConnector* c, const LmiViewId* viewId, LmiUint speedPercentage)

Parameters:

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.

Returns:

Note 1:

Not supported in WebRTC.

Note 2:

If viewId is NULL then the composite renderer constructed in VidyoConnectorConstruct will be assumed.

Function: VidyoConnectorSetViewBackgroundColor

Member Of:

VidyoConnector

Description:

Set the background color of the view.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorSetViewBackgroundColor(VidyoConnector* c, const LmiViewId* viewId, LmiUint8 red, LmiUint8 green, LmiUint8 blue)

Parameters:

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.

Returns:

Note 1:

If viewId is NULL then the composite renderer constructed in VidyoConnectorConstruct will be assumed.

Function: VidyoConnectorSetWebProxyAddressCredentials

Member Of:

VidyoConnector

Description:

Sets web proxy server address and credentials.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

void VidyoConnectorSetWebProxyAddressCredentials(VidyoConnector* c, const char* proxyAddress, const char* username, const char* password)

Parameters:

c The VidyoConnector object.
proxyAddress The web proxy server address.
username The web proxy server user name.
password The web proxy server password.

Function: VidyoConnectorShowAudioMeters

Member Of:

VidyoConnector

Description:

Shows or hides the audio meters in the view.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorShowAudioMeters(VidyoConnector* c, const LmiViewId* viewId, LmiBool showMeters)

Parameters:

c The VidyoConnector object.
viewId A platform specific view ID to be positioned.
showMeters Boolean to show or hide the audio meters.

Returns:

Note 1:

If viewId is NULL then the composite renderer constructed in VidyoConnectorConstruct will be assumed.

Function: VidyoConnectorShowPreview

Member Of:

VidyoConnector

Description:

Sets the flag to show/hide the local camera preview.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorShowPreview(VidyoConnector* c, LmiBool preview)

Parameters:

c The VidyoConnector object.
preview Flag to show/hide the local camera preview.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorShowViewAt

Member Of:

VidyoConnector

Description:

Sets the position of the view every time it's changed on the screen.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorShowViewAt(VidyoConnector* c, const LmiViewId* viewId, LmiInt x, LmiInt y, LmiUint width, LmiUint height)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

The view will not be shown until this funciton is called with valid parameters.

Note 2:

If viewId is NULL then the composite renderer constructed in VidyoConnectorConstruct will be positioned.

Function: VidyoConnectorShowViewLabel

Member Of:

VidyoConnector

Description:

Shows or hides the label on the view which displays the participant name or preview.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorShowViewLabel(VidyoConnector* c, const LmiViewId* viewId, LmiBool showLabel)

Parameters:

c The VidyoConnector object.
viewId A platform specific view ID to be positioned.
showLabel Boolean to show or hide the label.

Returns:

Note 1:

If viewId is NULL then the composite renderer constructed in VidyoConnectorConstruct will be assumed.

Function: VidyoConnectorUninitialize

Member Of:

Connector

Description:

Uninitialize the VidyoConnector API.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

void VidyoConnectorUninitialize(void)

Note 1:

This function is required: Any application that uses the VidyoConnector API must uninitialize it once it is no longer needed or before the application exits.

Function: VidyoConnectorUnregisterLocalCameraEventListener

Member Of:

VidyoConnector

Description:

Unregisters local camera event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterLocalCameraEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterLocalMicrophoneEventListener

Member Of:

VidyoConnector

Description:

Unregisters local microphone event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterLocalMicrophoneEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterLocalMonitorEventListener

Member Of:

VidyoConnector

Description:

Unregisters local monitor event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterLocalMonitorEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterLocalSpeakerEventListener

Member Of:

VidyoConnector

Description:

Unregisters local speaker event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterLocalSpeakerEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterLocalWindowShareEventListener

Member Of:

VidyoConnector

Description:

Unregisters local window share event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterLocalWindowShareEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterLogEventListener

Member Of:

VidyoConnector

Description:

Unregisters log event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterLogEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterMessageEventListener

Member Of:

VidyoConnector

Description:

Unregisters message event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterMessageEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterNetworkInterfaceEventListener

Member Of:

VidyoConnector

Description:

Unregisters network interface event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterNetworkInterfaceEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterParticipantEventListener

Member Of:

VidyoConnector

Description:

Unregisters participant event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterParticipantEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterRecoderInCallEventListener

Member Of:

VidyoConnector

Description:

Unregisters recorder in call event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterRecoderInCallEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterRemoteCameraEventListener

Member Of:

VidyoConnector

Description:

Unregisters remote camera event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterRemoteCameraEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterRemoteMicrophoneEventListener

Member Of:

VidyoConnector

Description:

Unregisters remote microphone event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterRemoteMicrophoneEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterRemoteWindowShareEventListener

Member Of:

VidyoConnector

Description:

Unregisters remote window share event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterRemoteWindowShareEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterResourceManagerEventListener

Member Of:

VidyoConnector

Description:

Unregisters resource manager event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterResourceManagerEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConnectorUnregisterWebProxyEventListener

Member Of:

VidyoConnector

Description:

Unregisters web proxy event notifications.

Include:

Lmi/VidyoClient/VidyoConnector.h

Library:

VidyoClient

Syntax:

LmiBool VidyoConnectorUnregisterWebProxyEventListener(VidyoConnector* c)

Parameters:

c The VidyoConnector object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoConsoleLoggerGetBase

Member Of:

VidyoConsoleLogger

Description:

Include:

Lmi/VidyoClient/VidyoLogger.h

Library:

VidyoClient

Syntax:

VidyoLogger* VidyoConsoleLoggerGetBase(VidyoConsoleLogger* logger)

Parameters:

logger

Returns:

Function: VidyoDeviceAssign

Member Of:

VidyoDevice

Description:

Assigns one VidyoDevice object the value of another.

Include:

Lmi/VidyoClient/VidyoDevice.h

Library:

VidyoClient

Syntax:

VidyoDevice *VidyoDeviceAssign(VidyoDevice *obj, const VidyoDevice *other)

Parameters:

obj The VidyoDevice object.
other The call object to make a copy of.

Returns:

A pointer to the destination object on success, or NULL on failure.

Function: VidyoDeviceConstructCopy

Member Of:

VidyoDevice

Description:

Constructs an VidyoDevice object as a copy of another.

Include:

Lmi/VidyoClient/VidyoDevice.h

Library:

VidyoClient

Syntax:

VidyoDevice *VidyoDeviceConstructCopy(VidyoDevice *obj, const VidyoDevice *other)

Parameters:

obj The VidyoDevice object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoDeviceDerivedEqual

Member Of:

VidyoDevice

Description:

Compare the values of two derived devices for equality.

Include:

Lmi/VidyoClient/VidyoDevice.h

Library:

VidyoClient

Syntax:

LmiBool VidyoDeviceDerivedEqual(const VidyoDevice *obj, const VidyoDevice *other)

Parameters:

obj The VidyoDevice object comparing against.
other The VidyoDevice object comparing.

Returns:

Whether the pointers contained in the shared void pointer objects are the same.

Function: VidyoDeviceDestruct

Member Of:

VidyoDevice

Description:

Destruct an instance of VidyoDevice. This may block until there are no more threads running.

Include:

Lmi/VidyoClient/VidyoDevice.h

Library:

VidyoClient

Syntax:

void VidyoDeviceDestruct(VidyoDevice* device)

Parameters:

device Pointer to the VidyoDevice object to destruct.

Function: VidyoDeviceGetId

Member Of:

VidyoDevice

Description:

Gets the device id.

Include:

Lmi/VidyoClient/VidyoDevice.h

Library:

VidyoClient

Syntax:

const LmiString *VidyoDeviceGetId(const VidyoDevice* d)

Parameters:

d The VidyoDevice object.

Returns:

Device id.

Function: VidyoDeviceGetName

Member Of:

VidyoDevice

Description:

Gets the device name.

Include:

Lmi/VidyoClient/VidyoDevice.h

Library:

VidyoClient

Syntax:

const LmiString *VidyoDeviceGetName(const VidyoDevice* d)

Parameters:

d The VidyoDevice object.

Returns:

Device name.

Function: VidyoDeviceGetType

Member Of:

VidyoDevice

Description:

Gets the device type.

Include:

Lmi/VidyoClient/VidyoDevice.h

Library:

VidyoClient

Syntax:

VidyoDeviceType VidyoDeviceGetType(const VidyoDevice* d)

Parameters:

d The VidyoDevice object.

Returns:

Device Type.

Function: VidyoEndpointAssignViewToLocalCamera

Member Of:

VidyoEndpoint

Description:

Shows a preview of a local camera in a view.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointAssignViewToLocalCamera(VidyoEndpoint* e, const LmiViewId* viewId, VidyoLocalCamera* localCamera, LmiBool displayCropped, LmiBool allowZoom)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

This API will work only if compositing had been disabled by passing a NULL LmiViewId to VidyoEndpointConstruct.

Note 2:

The view will not be shown until VidyoEndpointShowViewAt is called with valid parameters.

Function: VidyoEndpointAssignViewToRemoteCamera

Member Of:

VidyoEndpoint

Description:

Shows a participant in a view.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointAssignViewToRemoteCamera(VidyoEndpoint* e, const LmiViewId* viewId, VidyoRemoteCamera* camera, LmiBool displayCropped, LmiBool allowZoom)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

This API will work only if compositing had been disabled by passing a NULL LmiViewId to VidyoEndpointConstruct.

Note 2:

The application needs to make sure the sources are hidden when the local CPU and bandwidth are limited, by monitoring the VidyoEndpointOnResourcesChanged callback and showing/hiding sources based on avaialble resources.

Note 3:

The view will not be shown until VidyoEndpointShowViewAt is called with valid parameters.

Function: VidyoEndpointAssignViewToRemoteWindowShare

Member Of:

VidyoEndpoint

Description:

Shows a participant in a view.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointAssignViewToRemoteWindowShare(VidyoEndpoint* e, const LmiViewId* viewId, VidyoRemoteWindowShare* remoteWindowShare, LmiBool displayCropped, LmiBool allowZoom)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

This API will work only if compositing had been disabled by passing a NULL LmiViewId to VidyoEndpointConstruct.

Note 2:

The view will not be shown until VidyoEndpointShowViewAt is called with valid parameters.

Function: VidyoEndpointCompressLogs

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointCompressLogs(VidyoEndpoint *e, LmiString *compressedFileName, VidyoEndpointOnLogCompressionComplete onComplete)

Parameters:

e
compressedFileName Name if the compression output file.
onComplete Callback that is triggered when the compression completes.

Returns:

Function: VidyoEndpointConstruct

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

VidyoEndpoint* VidyoEndpointConstruct(VidyoEndpoint* e, const LmiViewId* viewId, VidyoLocalRendererViewStyle viewStyle, LmiUint remoteParticipants, const char* consoleLogFilter, const char* fileLogFilter, const char* fileLogName, LmiAllocator* alloc)

Parameters:

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

Returns:

Function: VidyoEndpointConstructCopy

Member Of:

VidyoEndpoint

Description:

Constructs an VidyoEndpoint object as a copy of another.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

VidyoEndpoint *VidyoEndpointConstructCopy(VidyoEndpoint *obj, const VidyoEndpoint *other)

Parameters:

obj The VidyoEndpoint object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoEndpointCreateRenderer

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointCreateRenderer(VidyoEndpoint* e, const VidyoLocalMonitor* monitor, LmiUint width, LmiUint height)

Parameters:

e
monitor
width
height

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointCreateRendererFromViewId

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointCreateRendererFromViewId(VidyoEndpoint* e, const LmiViewId* viewId, LmiInt x, LmiInt y, LmiUint width, LmiUint height)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

LmiViewId is HWND on windows, NSView on mac, UIView on iOS, window on X11, ViewGroup on android.

Function: VidyoEndpointCycleCamera

Member Of:

VidyoEndpoint

Description:

Cycles camera selection to the next available camera.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointCycleCamera(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointCycleMicrophone

Member Of:

VidyoEndpoint

Description:

Cycles microphone selection to the next available microphone.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointCycleMicrophone(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointCycleSpeaker

Member Of:

VidyoEndpoint

Description:

Cycles speaker selection to the next available speaker.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointCycleSpeaker(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointDestruct

Member Of:

VidyoEndpoint

Description:

Destructs an VidyoEndpoint object.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointDestruct(VidyoEndpoint *obj)

Parameters:

obj The VidyoEndpoint object to destruct.

Function: VidyoEndpointDisable

Member Of:

VidyoEndpoint

Description:

Stop background tasks associated with an endpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointDisable(VidyoEndpoint *e)

Parameters:

e The endpoint object to disable.

Function: VidyoEndpointDisableDebug

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointDisableDebug(VidyoEndpoint *e)

Parameters:

e The VidyoEndpoint object.

Function: VidyoEndpointEnableDebug

Member Of:

VidyoEndpoint

Description:

Enabled debug mode on the endpoint which will start debug logging and enable statistics.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointEnableDebug(VidyoEndpoint* e, LmiUint port, const char *logFilter)

Parameters:

e The VidyoEndpoint object.
port Debug port will output debug logging.
logFilter Log filter to use on the debug port.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointEnableFileLogger

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointEnableFileLogger(VidyoEndpoint *e, const char *fileLogName, const char *fileLogFilter)

Parameters:

e
fileLogName
fileLogFilter

Returns:

Function: VidyoEndpointGenerateLicenseKey

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointGenerateLicenseKey(VidyoEndpoint *e, LmiString *licenseKey)

Parameters:

e
licenseKey

Returns:

Function: VidyoEndpointGetApplicationTag

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoEndpointGetApplicationTag(const VidyoEndpoint* e)

Parameters:

e

Returns:

Function: VidyoEndpointGetId

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoEndpointGetId(const VidyoEndpoint* e)

Parameters:

e

Returns:

Function: VidyoEndpointGetStats

Member Of:

VidyoEndpoint

Description:

Fill in data in VidyoEndpointStats from an endpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

VidyoEndpointStats *VidyoEndpointGetStats(VidyoEndpoint *e)

Parameters:

e The endpoint object to extract stats.

Returns:

Pointer to the endpoint stats on Success or NULL on failure.

Function: VidyoEndpointGetStatsJson

Member Of:

VidyoEndpoint

Description:

Fill in data in VidyoEndpointStats from an endpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiString *VidyoEndpointGetStatsJson(VidyoEndpoint *e)

Parameters:

e The endpoint object to extract stats.

Returns:

Pointer to the json encoded string containing the stats on Success or NULL on failure.

Function: VidyoEndpointHideView

Member Of:

VidyoEndpoint

Description:

Hides a view which is used for custom layout of sources.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointHideView(VidyoEndpoint* e, const LmiViewId* viewId)

Parameters:

e The VidyoEndpoint object.
viewId The view ID of the view to hide.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointIsDebugEnabled

Member Of:

VidyoEndpoint

Description:

Checks if debug mode is enabled on the endpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointIsDebugEnabled(VidyoEndpoint *e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE if enabled, LMI_FALSE otherwise.

Function: VidyoEndpointLocalCameraSelectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalCameraSelectAdvanced(VidyoEndpoint *e, const VidyoLocalCamera *localCamera)

Parameters:

e
localCamera

Function: VidyoEndpointLocalCameraUnselectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalCameraUnselectAdvanced(VidyoEndpoint *e, const VidyoLocalCamera *localCamera)

Parameters:

e
localCamera

Function: VidyoEndpointLocalMicrophoneSelectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalMicrophoneSelectAdvanced(VidyoEndpoint *e, const VidyoLocalMicrophone *localMicrophone, LmiBool previewedPreCall)

Parameters:

e
localMicrophone
previewedPreCall

Function: VidyoEndpointLocalMicrophoneUnselectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalMicrophoneUnselectAdvanced(VidyoEndpoint *e, const VidyoLocalMicrophone *localMicrophone)

Parameters:

e
localMicrophone

Function: VidyoEndpointLocalMonitorSelectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalMonitorSelectAdvanced(VidyoEndpoint *e, const VidyoLocalMonitor *localMonitor)

Parameters:

e
localMonitor

Function: VidyoEndpointLocalMonitorUnselectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalMonitorUnselectAdvanced(VidyoEndpoint *e, const VidyoLocalMonitor *localMonitor)

Parameters:

e
localMonitor

Function: VidyoEndpointLocalRendererSelectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalRendererSelectAdvanced(VidyoEndpoint *e, const VidyoLocalRenderer *localRenderer)

Parameters:

e
localRenderer

Function: VidyoEndpointLocalRendererUnselectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalRendererUnselectAdvanced(VidyoEndpoint *e, const VidyoLocalRenderer *localRenderer)

Parameters:

e
localRenderer

Function: VidyoEndpointLocalSpeakerSelectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalSpeakerSelectAdvanced(VidyoEndpoint *e, const VidyoLocalSpeaker *localSpeaker)

Parameters:

e
localSpeaker

Function: VidyoEndpointLocalSpeakerUnselectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalSpeakerUnselectAdvanced(VidyoEndpoint *e, const VidyoLocalSpeaker *localSpeaker)

Parameters:

e
localSpeaker

Function: VidyoEndpointLocalWindowShareSelectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalWindowShareSelectAdvanced(VidyoEndpoint *e, const VidyoLocalWindowShare *localWindowShare)

Parameters:

e
localWindowShare

Function: VidyoEndpointLocalWindowShareUnselectAdvanced

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointLocalWindowShareUnselectAdvanced(VidyoEndpoint *e, const VidyoLocalWindowShare *localWindowShare)

Parameters:

e
localWindowShare

Function: VidyoEndpointRegisterLocalCameraEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about camera events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterLocalCameraEventListener(VidyoEndpoint* e, VidyoEndpointOnLocalCameraAdded onAdded, VidyoEndpointOnLocalCameraRemoved onRemoved, VidyoEndpointOnLocalCameraSelected onSelected, VidyoEndpointOnLocalCameraStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterLocalMicrophoneEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about microphone events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterLocalMicrophoneEventListener(VidyoEndpoint* e, VidyoEndpointOnLocalMicrophoneAdded onAdded, VidyoEndpointOnLocalMicrophoneRemoved onRemoved, VidyoEndpointOnLocalMicrophoneSelected onSelected, VidyoEndpointOnLocalMicrophoneStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterLocalMonitorEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about monitor events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterLocalMonitorEventListener(VidyoEndpoint* e, VidyoEndpointOnLocalMonitorAdded onAdded, VidyoEndpointOnLocalMonitorRemoved onRemoved, VidyoEndpointOnLocalMonitorSelected onSelected, VidyoEndpointOnLocalMonitorStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterLocalRendererEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about renderer events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterLocalRendererEventListener(VidyoEndpoint* e, VidyoEndpointOnLocalRendererAdded onAdded, VidyoEndpointOnLocalRendererRemoved onRemoved, VidyoEndpointOnLocalRendererSelected onSelected, VidyoEndpointOnLocalRendererStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterLocalSpeakerEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about speaker events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterLocalSpeakerEventListener(VidyoEndpoint* e, VidyoEndpointOnLocalSpeakerAdded onAdded, VidyoEndpointOnLocalSpeakerRemoved onRemoved, VidyoEndpointOnLocalSpeakerSelected onSelected, VidyoEndpointOnLocalSpeakerStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterLocalWindowShareEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about window events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterLocalWindowShareEventListener(VidyoEndpoint* e, VidyoEndpointOnLocalWindowShareAdded onAdded, VidyoEndpointOnLocalWindowShareRemoved onRemoved, VidyoEndpointOnLocalWindowShareSelected onSelected, VidyoEndpointOnLocalWindowShareStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterLogEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about log events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterLogEventListener(VidyoEndpoint* e, VidyoEndpointOnLog onLog, const char* filter)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterNetworkInterfaceEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about network interface events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterNetworkInterfaceEventListener(VidyoEndpoint* e, VidyoEndpointOnNetworkInterfaceAdded onAdded, VidyoEndpointOnNetworkInterfaceRemoved onRemoved, VidyoEndpointOnNetworkInterfaceSelected onSelected, VidyoEndpointOnNetworkInterfaceStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterRemoteCameraEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about camera events from other participants.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterRemoteCameraEventListener(VidyoEndpoint* e, VidyoEndpointOnRemoteCameraAdded onAdded, VidyoEndpointOnRemoteCameraRemoved onRemoved, VidyoEndpointOnRemoteCameraStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterRemoteMicrophoneEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about microphone events from other participants.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterRemoteMicrophoneEventListener(VidyoEndpoint* e, VidyoEndpointOnRemoteMicrophoneAdded onAdded, VidyoEndpointOnRemoteMicrophoneRemoved onRemoved, VidyoEndpointOnRemoteMicrophoneStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterRemoteRendererEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about renderer events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterRemoteRendererEventListener(VidyoEndpoint* e, VidyoEndpointOnRemoteRendererAdded onAdded, VidyoEndpointOnRemoteRendererRemoved onRemoved)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterRemoteSpeakerEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about speaker events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterRemoteSpeakerEventListener(VidyoEndpoint* e, VidyoEndpointOnRemoteSpeakerAdded onAdded, VidyoEndpointOnRemoteSpeakerRemoved onRemoved)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRegisterRemoteWindowShareEventListener

Member Of:

VidyoEndpoint

Description:

Registers to get notified about window-shares from other participants.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointRegisterRemoteWindowShareEventListener(VidyoEndpoint* e, VidyoEndpointOnRemoteWindowShareAdded onAdded, VidyoEndpointOnRemoteWindowShareRemoved onRemoved, VidyoEndpointOnRemoteWindowShareStateUpdated onStateUpdated)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointRemoveRenderer

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointRemoveRenderer(VidyoEndpoint* e, VidyoLocalRenderer* localRenderer)

Parameters:

e
localRenderer

Function: VidyoEndpointSelectDefaultCamera

Member Of:

VidyoEndpoint

Description:

Resets the camera selection to pick the Default camera.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectDefaultCamera(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSelectDefaultMicrophone

Member Of:

VidyoEndpoint

Description:

Resets the microphone selection to pick the Default microphone.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectDefaultMicrophone(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSelectDefaultNetworkInterfaceForMedia

Member Of:

VidyoEndpoint

Description:

Selects the default "any" network interface to be used for Media.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectDefaultNetworkInterfaceForMedia(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSelectDefaultNetworkInterfaceForSignaling

Member Of:

VidyoEndpoint

Description:

Selects the default "any" network interface to be used for Signaling.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectDefaultNetworkInterfaceForSignaling(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSelectDefaultSpeaker

Member Of:

VidyoEndpoint

Description:

Resets the speaker selection to pick the Default speaker.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectDefaultSpeaker(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSelectLocalCamera

Member Of:

VidyoEndpoint

Description:

Selects the camera to be used.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectLocalCamera(VidyoEndpoint* e, const VidyoLocalCamera* localCamera)

Parameters:

e The VidyoEndpoint object.
localCamera Camera to be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSelectLocalMicrophone

Member Of:

VidyoEndpoint

Description:

Selects the microphone to be used.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectLocalMicrophone(VidyoEndpoint* e, const VidyoLocalMicrophone* localMicrophone)

Parameters:

e The VidyoEndpoint object.
localMicrophone Microphone to be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSelectLocalMonitor

Member Of:

VidyoEndpoint

Description:

Selects the monitor to be used.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectLocalMonitor(VidyoEndpoint* e, const VidyoLocalMonitor* localMonitor)

Parameters:

e The VidyoEndpoint object.
localMonitor Monitor to be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSelectLocalSpeaker

Member Of:

VidyoEndpoint

Description:

Selects the speaker to be used.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectLocalSpeaker(VidyoEndpoint* e, const VidyoLocalSpeaker* localSpeaker)

Parameters:

e The VidyoEndpoint object.
localSpeaker Speaker to be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSelectLocalWindowShare

Member Of:

VidyoEndpoint

Description:

Selects the window to be used.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectLocalWindowShare(VidyoEndpoint* e, const VidyoLocalWindowShare* localWindowShare)

Parameters:

e The VidyoEndpoint object.
localWindowShare Window to be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSelectNetworkInterfaceForMedia

Member Of:

VidyoEndpoint

Description:

Selects the network interface to be used for Media.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectNetworkInterfaceForMedia(VidyoEndpoint* e, const VidyoNetworkInterface* networkInterface)

Parameters:

e The VidyoEndpoint object.
networkInterface Network interface to be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSelectNetworkInterfaceForSignaling

Member Of:

VidyoEndpoint

Description:

Selects the network interface to be used for Signaling.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSelectNetworkInterfaceForSignaling(VidyoEndpoint* e, const VidyoNetworkInterface* networkInterface)

Parameters:

e The VidyoEndpoint object.
networkInterface Network interface to be selected.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSetApplicationTag

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetApplicationTag(VidyoEndpoint* e, const char* applicationTag)

Parameters:

e
applicationTag

Returns:

Function: VidyoEndpointSetCameraPrivacy

Member Of:

VidyoEndpoint

Description:

Sets the flag to show/hide the camera.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetCameraPrivacy(VidyoEndpoint* e, LmiBool privacy)

Parameters:

e The VidyoEndpoint object.
privacy Flag to show/hide the camera.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSetConsoleLoggerFilter

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetConsoleLoggerFilter(VidyoEndpoint* e, const char* consoleLogFilter)

Parameters:

e
consoleLogFilter

Returns:

Function: VidyoEndpointSetConsoleLoggerLevelAndCategory

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetConsoleLoggerLevelAndCategory(VidyoEndpoint* e, const char* levelName, const char* categoryName, LmiBool on)

Parameters:

e
levelName
categoryName
on

Returns:

Function: VidyoEndpointSetDebugFilter

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetDebugFilter(VidyoEndpoint* e, const char* debugLogFilter)

Parameters:

e The VidyoEndpoint object.
debugLogFilter Log filter to use on the debug port.

Returns:

Function: VidyoEndpointSetFileLoggerFilter

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetFileLoggerFilter(VidyoEndpoint* e, const char* fileLogFilter)

Parameters:

e
fileLogFilter

Returns:

Function: VidyoEndpointSetFileLoggerLevelAndCategory

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetFileLoggerLevelAndCategory(VidyoEndpoint* e, const char* levelName, const char* categoryName, LmiBool on)

Parameters:

e
levelName
categoryName
on

Returns:

Function: VidyoEndpointSetLocation

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetLocation(VidyoEndpoint* e, LmiFloat64 latitude, LmiFloat64 longitude)

Parameters:

e
latitude
longitude

Returns:

Function: VidyoEndpointSetMicrophonePrivacy

Member Of:

VidyoEndpoint

Description:

Sets the flag to mute/unmute the microphone.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetMicrophonePrivacy(VidyoEndpoint* e, LmiBool privacy)

Parameters:

e The VidyoEndpoint object.
privacy Flag to mute/unmute the microphone.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSetMode

Member Of:

VidyoEndpoint

Description:

Sets the operating mode of the VidyoEndpoint.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetMode(VidyoEndpoint* e, VidyoEndpointMode mode)

Parameters:

e The VidyoEndpoint object.
mode Desired operating mode.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSetPoolId

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetPoolId(VidyoEndpoint* e, const LmiString* poolId)

Parameters:

e
poolId

Returns:

Function: VidyoEndpointSetPreview [REPLACED BY VidyoEndpointShowPreview]

Member Of:

VidyoEndpoint

Description:

Sets the flag to show/hide the camera preview.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetPreview(VidyoEndpoint* e, LmiBool preview)

Parameters:

e The VidyoEndpoint object.
preview Flag to show/hide the camera preview.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSetSpeakerPrivacy

Member Of:

VidyoEndpoint

Description:

Sets the flag to mute/unmute the speaker.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetSpeakerPrivacy(VidyoEndpoint* e, LmiBool privacy)

Parameters:

e The VidyoEndpoint object.
privacy Flag to mute/unmute the speaker.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointSetViewAnimationSpeed

Member Of:

VidyoEndpoint

Description:

Sets the speed of transition animaiton for windows moving around inside the view.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetViewAnimationSpeed(VidyoEndpoint* e, const LmiViewId* viewId, LmiUint speedPercentage)

Parameters:

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.

Returns:

Note 1:

Not supported in WebRTC.

Note 2:

If viewId is NULL then the composite renderer constructed in VidyoEndpointConstruct will be assumed.

Function: VidyoEndpointSetViewBackgroundColor

Member Of:

VidyoEndpoint

Description:

Shows or hides the label on the view which displays the participant name or preview.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointSetViewBackgroundColor(VidyoEndpoint* e, const LmiViewId* viewId, LmiUint8 red, LmiUint8 green, LmiUint8 blue)

Parameters:

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.

Returns:

Note 1:

If viewId is NULL then the composite renderer constructed in VidyoEndpointConstruct will be assumed.

Function: VidyoEndpointShowAudioMeters

Member Of:

VidyoEndpoint

Description:

Shows or hides the audio meters in the view.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointShowAudioMeters(VidyoEndpoint* e, const LmiViewId* viewId, LmiBool showMeters)

Parameters:

e The VidyoEndpoint object.
viewId A platform specific view ID to be positioned.
showMeters Boolean to show or hide the audio meters.

Returns:

Note 1:

If viewId is NULL then the composite renderer constructed in VidyoEndpointConstruct will be assumed.

Function: VidyoEndpointShowPreview

Member Of:

VidyoEndpoint

Description:

Sets the flag to show/hide the camera preview while in the call.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointShowPreview(VidyoEndpoint* e, LmiBool preview)

Parameters:

e The VidyoEndpoint object.
preview Flag to show/hide the camera preview.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointShowViewAt

Member Of:

VidyoEndpoint

Description:

Sets the position of the view every time it's changed on the screen.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointShowViewAt(VidyoEndpoint* e, const LmiViewId* viewId, LmiInt x, LmiInt y, LmiUint width, LmiUint height)

Parameters:

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.

Returns:

Note 1:

The view will not be shown until this funciton is called with valid parameters.

Note 2:

If viewId is NULL then the composite renderer constructed in VidyoEndpointConstruct will be positioned.

Function: VidyoEndpointShowViewLabel

Member Of:

VidyoEndpoint

Description:

Shows or hides the label on the view which displays the participant name or preview.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointShowViewLabel(VidyoEndpoint* e, const LmiViewId* viewId, LmiBool showLabel)

Parameters:

e The VidyoEndpoint object.
viewId A platform specific view ID to be positioned.
showLabel Boolean to show or hide the label.

Returns:

Note 1:

If viewId is NULL then the composite renderer constructed in VidyoEndpointConstruct will be assumed.

Function: VidyoEndpointStartDeviceDetection

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointStartDeviceDetection(VidyoEndpoint* e)

Parameters:

e

Returns:

Function: VidyoEndpointStartLocationDetection

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointStartLocationDetection(VidyoEndpoint* e)

Parameters:

e

Returns:

Function: VidyoEndpointStartNetworkInterfaceDetection

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointStartNetworkInterfaceDetection(VidyoEndpoint* e)

Parameters:

e

Returns:

Function: VidyoEndpointStartShareDetection

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointStartShareDetection(VidyoEndpoint* e)

Parameters:

e

Returns:

Function: VidyoEndpointStopDeviceDetection

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointStopDeviceDetection(VidyoEndpoint* e)

Parameters:

e

Function: VidyoEndpointStopLocationDetection

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointStopLocationDetection(VidyoEndpoint* e)

Parameters:

e

Function: VidyoEndpointStopNetworkInterfaceDetection

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointStopNetworkInterfaceDetection(VidyoEndpoint* e)

Parameters:

e

Function: VidyoEndpointStopShareDetection

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoEndpointStopShareDetection(VidyoEndpoint* e)

Parameters:

e

Function: VidyoEndpointUnregisterLocalCameraEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters local camera event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterLocalCameraEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterLocalMicrophoneEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters local microphone event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterLocalMicrophoneEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterLocalMonitorEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters local monitor event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterLocalMonitorEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterLocalRendererEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters local renderer event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterLocalRendererEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterLocalSpeakerEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters local speaker event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterLocalSpeakerEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterLocalWindowShareEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters local window share event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterLocalWindowShareEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterLogEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters log event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterLogEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterNetworkInterfaceEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters network interface event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterNetworkInterfaceEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterRemoteCameraEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters remote camera event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterRemoteCameraEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterRemoteMicrophoneEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters remote microphone event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterRemoteMicrophoneEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterRemoteRendererEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters remote renderer event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterRemoteRendererEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterRemoteSpeakerEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters remote speaker event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterRemoteSpeakerEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointUnregisterRemoteWindowShareEventListener

Member Of:

VidyoEndpoint

Description:

Unregisters remote window share event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointUnregisterRemoteWindowShareEventListener(VidyoEndpoint* e)

Parameters:

e The VidyoEndpoint object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoEndpointValidateLicenseKey

Member Of:

VidyoEndpoint

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoEndpointValidateLicenseKey(VidyoEndpoint *e, const LmiString *licenseKey, LmiBool *isValid)

Parameters:

e
licenseKey
isValid

Returns:

Function: VidyoGatewayAssign

Member Of:

VidyoGateway

Description:

Assigns one VidyoGateway object the value of another.

Include:

Lmi/VidyoClient/VidyoGateway.h

Library:

VidyoClient

Syntax:

VidyoGateway *VidyoGatewayAssign(VidyoGateway *obj, const VidyoGateway *other)

Parameters:

obj The VidyoGateway object.
other The call object to make a copy of.

Returns:

A pointer to the destination object on success, or NULL on failure.

Function: VidyoGatewayConnect

Member Of:

VidyoGateway

Description:

Connects to a gateway to a live conference with the specified resourceId.

Include:

Lmi/VidyoClient/VidyoGateway.h

Library:

VidyoClient

Syntax:

LmiBool VidyoGatewayConnect(VidyoGateway* gateway, const char* host, const char* token, const char* displayName, const char *resourceId, VidyoGatewayOnSuccess onSuccess, VidyoGatewayOnFailure onFailure, VidyoGatewayOnDisconnected onDisconnected)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoGatewayConstructCopy

Member Of:

VidyoGateway

Description:

Constructs an VidyoGateway object as a copy of another.

Include:

Lmi/VidyoClient/VidyoGateway.h

Library:

VidyoClient

Syntax:

VidyoGateway *VidyoGatewayConstructCopy(VidyoGateway *obj, const VidyoGateway *other)

Parameters:

obj The VidyoGateway object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoGatewayDestruct

Member Of:

VidyoGateway

Description:

Destruct an instance of VidyoGateway. This may block until there are no more threads running.

Include:

Lmi/VidyoClient/VidyoGateway.h

Library:

VidyoClient

Syntax:

void VidyoGatewayDestruct(VidyoGateway* gateway)

Parameters:

gateway Pointer to the VidyoGateway object to destruct.

Function: VidyoGatewayDisconnect

Member Of:

VidyoGateway

Description:

Disconnects a live gateway call.

Include:

Lmi/VidyoClient/VidyoGateway.h

Library:

VidyoClient

Syntax:

void VidyoGatewayDisconnect(VidyoGateway* gateway)

Parameters:

gateway The VidyoGateway object.

Function: VidyoGatewayInitialize

Member Of:

VidyoGateway

Description:

Initialize the VidyoGateway library.

Include:

Lmi/VidyoClient/VidyoGateway.h

Library:

VidyoClient

Syntax:

LmiBool VidyoGatewayInitialize(void)

Returns:

Note 1:

The library must be Initialized once the application starts, before any other VidyoGateway APIs. It must also be Uninitialized before exiting the application or after the library is no loger needed.

Function: VidyoGatewayUninitialize

Member Of:

VidyoGateway

Description:

Uninitialize the VidyoGateway library.

Include:

Lmi/VidyoClient/VidyoGateway.h

Library:

VidyoClient

Syntax:

void VidyoGatewayUninitialize(void)

Function: VidyoLocalCameraAddToLocalRenderer

Member Of:

VidyoLocalCamera

Description:

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiVoidPtr VidyoLocalCameraAddToLocalRenderer(VidyoLocalCamera* c, const VidyoLocalRenderer* localRenderer)

Parameters:

c The VidyoLocalCamera object.
localRenderer

Returns:

Function: VidyoLocalCameraAddToRemoteRenderer

Member Of:

VidyoLocalCamera

Description:

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraAddToRemoteRenderer(VidyoLocalCamera* c, const VidyoRemoteRenderer* remoteRenderer)

Parameters:

c The VidyoLocalCamera object.
remoteRenderer

Returns:

Function: VidyoLocalCameraAllowRemoteCameraControl

Member Of:

VidyoLocalCamera

Description:

Allows the PTZ conrol of the camera by remote participants.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraAllowRemoteCameraControl(VidyoLocalCamera* c, LmiBool allow)

Parameters:

c The VidyoLocalCamera object.
allow Allow or prohibit camera control.

Returns:

LMI_TRUE on success.

Function: VidyoLocalCameraConstructCopy

Member Of:

VidyoLocalCamera

Description:

Constructs an VidyoLocalCamera object as a copy of another.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

VidyoLocalCamera *VidyoLocalCameraConstructCopy(VidyoLocalCamera *obj, const VidyoLocalCamera *other)

Parameters:

obj The VidyoLocalCamera object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoLocalCameraControlPTZ

Member Of:

VidyoLocalCamera

Description:

Send the PTZ Nudge commands to the local camera.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraControlPTZ(VidyoLocalCamera *c, LmiInt pan, LmiInt tilt, LmiInt zoom)

Parameters:

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.

Returns:

LMI_TRUE when the control command was sent, LMI_FALSE otherwise.

Note 1:

Positive numbers increase the nudge, and negative numbers decrease the nudge for left/right up/down zoom in/out.

Function: VidyoLocalCameraDestruct

Member Of:

VidyoLocalCamera

Description:

Destructs an VidyoLocalCamera object.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

void VidyoLocalCameraDestruct(VidyoLocalCamera *obj)

Parameters:

obj The VidyoLocalCamera object to destruct.

Function: VidyoLocalCameraGetId

Member Of:

VidyoLocalCamera

Description:

Gets the unique ID of the camera.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalCameraGetId(const VidyoLocalCamera* c)

Parameters:

c The VidyoLocalCamera object.

Returns:

Unique ID of the camera.

Function: VidyoLocalCameraGetName

Member Of:

VidyoLocalCamera

Description:

Gets the name of the camera.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalCameraGetName(const VidyoLocalCamera* c)

Parameters:

c The VidyoLocalCamera object.

Returns:

Name of the camera.

Function: VidyoLocalCameraGetPosition

Member Of:

VidyoLocalCamera

Description:

Gets the position of the camera.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

VidyoLocalCameraPosition VidyoLocalCameraGetPosition(const VidyoLocalCamera* c)

Parameters:

c The VidyoLocalCamera object.

Returns:

Position of the camera.

Function: VidyoLocalCameraGetPreviewLabel

Member Of:

VidyoLocalCamera

Description:

Gets the preview label of the camera.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalCameraGetPreviewLabel(const VidyoLocalCamera* c)

Parameters:

c The VidyoLocalCamera object.

Returns:

Display name of the camera.

Function: VidyoLocalCameraGetVideoCapabilities

Member Of:

VidyoLocalCamera

Description:

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraGetVideoCapabilities(const VidyoLocalCamera* c, LmiVector(VidyoVideoCapability) *capabilities)

Parameters:

c The VidyoLocalCamera object.
capabilities

Returns:

Function: VidyoLocalCameraIsPaused

Member Of:

VidyoLocalCamera

Description:

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraIsPaused(const VidyoLocalCamera* c)

Parameters:

c The VidyoLocalCamera object.

Returns:

Function: VidyoLocalCameraIsSuspended

Member Of:

VidyoLocalCamera

Description:

Checks if the camera is suspended.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraIsSuspended(const VidyoLocalCamera *c)

Parameters:

c The VidyoLocalCamera object.

Returns:

LMI_TRUE is suspended, LMI_FALSE otherwise.

Function: VidyoLocalCameraRemoveFromLocalRenderer

Member Of:

VidyoLocalCamera

Description:

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraRemoveFromLocalRenderer(VidyoLocalCamera* c, const VidyoLocalRenderer* localRenderer)

Parameters:

c The VidyoLocalCamera object.
localRenderer

Returns:

Function: VidyoLocalCameraRemoveFromRemoteRenderer

Member Of:

VidyoLocalCamera

Description:

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraRemoveFromRemoteRenderer(VidyoLocalCamera* c, const VidyoRemoteRenderer* remoteRenderer)

Parameters:

c The VidyoLocalCamera object.
remoteRenderer

Returns:

Function: VidyoLocalCameraResume

Member Of:

VidyoLocalCamera

Description:

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

void VidyoLocalCameraResume(VidyoLocalCamera* c)

Parameters:

c The VidyoLocalCamera object.

Function: VidyoLocalCameraSetAspectRatioConstraint

Member Of:

VidyoLocalCamera

Description:

Sets the aspect ratio constraint on the camera which will adjust local camera frames to match.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraSetAspectRatioConstraint(VidyoLocalCamera* c, LmiUint aspectRatioWidth, LmiUint aspectRatioHeight)

Parameters:

c The VidyoLocalCamera object.
aspectRatioWidth Width of the aspect ratio.
aspectRatioHeight Height of the aspect ration.

Returns:

LMI_TRUE on success.

Note 1:

The default aspect ration is 16x9.

Function: VidyoLocalCameraSetBoundsConstraint

Member Of:

VidyoLocalCamera

Description:

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraSetBoundsConstraint(VidyoLocalCamera* c, LmiUint minWidth, LmiUint minHeight, LmiUint maxWidth, LmiUint maxHeight, LmiTime maxFrameInterval, LmiTime minFrameInterval, LmiUint aspectRatioWidth, LmiUint aspectRatioHeight, LmiUint temporalSpatialTradeOff)

Parameters:

c The VidyoLocalCamera object.
minWidth
minHeight
maxWidth
maxHeight
maxFrameInterval
minFrameInterval
aspectRatioWidth
aspectRatioHeight
temporalSpatialTradeOff

Returns:

Function: VidyoLocalCameraSetCapabilitiesConstraint

Member Of:

VidyoLocalCamera

Description:

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraSetCapabilitiesConstraint(VidyoLocalCamera* c, const LmiVector(VidyoVideoCapability)* capabilities, LmiUint temporalSpatialTradeOff)

Parameters:

c The VidyoLocalCamera object.
capabilities
temporalSpatialTradeOff

Returns:

Function: VidyoLocalCameraSetConstraints

Member Of:

VidyoLocalCamera

Description:

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraSetConstraints(VidyoLocalCamera* c, LmiUint minWidth, LmiUint minHeight, LmiUint maxWidth, LmiUint maxHeight, LmiUint maxFrameInterval, LmiUint minFrameInterval, LmiUint aspectRatioWidth, LmiUint aspectRatioHeight, LmiUint temporalSpatialTradeOff, const LmiVector(VidyoVideoCapability)* capabilities)

Parameters:

c The VidyoLocalCamera object.
minWidth
minHeight
maxWidth
maxHeight
maxFrameInterval
minFrameInterval
aspectRatioWidth
aspectRatioHeight
temporalSpatialTradeOff
capabilities

Returns:

Function: VidyoLocalCameraSetMaxConstraint

Member Of:

VidyoLocalCamera

Description:

Sets the maximum resolution and framerate constraint on the local camera. This overrides the defaults which are based on the CPU profile of the endpoint.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraSetMaxConstraint(VidyoLocalCamera* c, LmiUint width, LmiUint height, LmiTime frameInterval)

Parameters:

c The VidyoLocalCamera object.
width Maximum width.
height Maximum height.
frameInterval Maximum frame interval. Setting to 0 selects the fastest frame rate.

Returns:

LMI_TRUE on success.

Note 1:

The constraint is restricted to 16x9 resoluitons that are available from the camera capabilities.

Function: VidyoLocalCameraSetPositionInLocalRenderer

Member Of:

VidyoLocalCamera

Description:

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraSetPositionInLocalRenderer(VidyoLocalCamera *c, const VidyoLocalRenderer *localRenderer, LmiInt x, LmiInt y, LmiUint width, LmiUint height, LmiTime frameInterval)

Parameters:

c The VidyoLocalCamera object.
localRenderer
x
y
width
height
frameInterval

Returns:

Function: VidyoLocalCameraSetPreviewLabel

Member Of:

VidyoLocalCamera

Description:

Set the preview label of the camera.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraSetPreviewLabel(VidyoLocalCamera* c, const LmiString* previewLabel)

Parameters:

c The VidyoLocalCamera object.
previewLabel Display name to set on the camera.

Returns:

LMI_TRUE on success, LMI_FALSE otherwise.

Function: VidyoLocalCameraShowCameraControl

Member Of:

VidyoLocalCamera

Description:

Shows camera control when rendering preview.

Include:

Lmi/VidyoClient/VidyoLocalCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalCameraShowCameraControl(VidyoLocalCamera* c, LmiBool show)

Parameters:

c The VidyoLocalCamera object.
show Show or hide camera controls.

Returns:

LMI_TRUE on success.

Note 1:

Applies to Composite and Custom rendering layouts.

Function: VidyoLocalMicrophoneAddToLocalSpeaker

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneAddToLocalSpeaker(VidyoLocalMicrophone* m, const VidyoLocalSpeaker* speaker)

Parameters:

m The VidyoLocalMicrophone object.
speaker

Returns:

Function: VidyoLocalMicrophoneAddToRemoteSpeaker

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneAddToRemoteSpeaker(VidyoLocalMicrophone* m, const VidyoRemoteSpeaker* remoteSpeaker)

Parameters:

m The VidyoLocalMicrophone object.
remoteSpeaker

Returns:

Function: VidyoLocalMicrophoneConstructCopy

Member Of:

VidyoLocalMicrophone

Description:

Constructs an VidyoLocalMicrophone object as a copy of another.

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

VidyoLocalMicrophone *VidyoLocalMicrophoneConstructCopy(VidyoLocalMicrophone *obj, const VidyoLocalMicrophone *other)

Parameters:

obj The VidyoLocalMicrophone object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoLocalMicrophoneDestruct

Member Of:

VidyoLocalMicrophone

Description:

Destructs an VidyoLocalMicrophone object.

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

void VidyoLocalMicrophoneDestruct(VidyoLocalMicrophone *obj)

Parameters:

obj The VidyoLocalMicrophone object to destruct.

Function: VidyoLocalMicrophoneDisableDebugRecording

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneDisableDebugRecording(VidyoLocalMicrophone* m)

Parameters:

m The VidyoLocalMicrophone object.

Returns:

Function: VidyoLocalMicrophoneEnableDebugRecording

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneEnableDebugRecording(VidyoLocalMicrophone* m, const LmiString* dir)

Parameters:

m The VidyoLocalMicrophone object.
dir

Returns:

Function: VidyoLocalMicrophoneGetAutoGain

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneGetAutoGain(VidyoLocalMicrophone* m)

Parameters:

m The VidyoLocalMicrophone object.

Returns:

Function: VidyoLocalMicrophoneGetId

Member Of:

VidyoLocalMicrophone

Description:

Gets the unique ID of the microphone.

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalMicrophoneGetId(const VidyoLocalMicrophone* m)

Parameters:

m The VidyoLocalMicrophone object.

Returns:

Unique ID of the microphone.

Function: VidyoLocalMicrophoneGetName

Member Of:

VidyoLocalMicrophone

Description:

Gets the name of the microphone.

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalMicrophoneGetName(const VidyoLocalMicrophone* m)

Parameters:

m The VidyoLocalMicrophone object.

Returns:

Name of the microphone.

Function: VidyoLocalMicrophoneGetSignalType

Member Of:

VidyoLocalMicrophone

Description:

Gets signal type of the microphone, which affects how the audio is processed.

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

VidyoDeviceAudioSignalType VidyoLocalMicrophoneGetSignalType(VidyoLocalMicrophone* m)

Parameters:

m The VidyoLocalMicrophone object.

Returns:

The signal type of the microphone.

Note 1:

The default signal type is Voice.

Function: VidyoLocalMicrophoneGetVoiceProcessing

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneGetVoiceProcessing(VidyoLocalMicrophone* m)

Parameters:

m The VidyoLocalMicrophone object.

Returns:

Function: VidyoLocalMicrophoneGetVolume

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiUint VidyoLocalMicrophoneGetVolume(VidyoLocalMicrophone* m)

Parameters:

m The VidyoLocalMicrophone object.

Returns:

Function: VidyoLocalMicrophoneHideDebugDialog

Member Of:

VidyoLocalMicrophone

Description:

Hides an audio debug dialog for the local microphone.

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

void VidyoLocalMicrophoneHideDebugDialog(VidyoLocalMicrophone *microphone)

Parameters:

microphone The local microphone object to extract stats.

Function: VidyoLocalMicrophoneIsDebugRecordingEnabled

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneIsDebugRecordingEnabled(VidyoLocalMicrophone* m)

Parameters:

m The VidyoLocalMicrophone object.

Returns:

Function: VidyoLocalMicrophoneIsPaused

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneIsPaused(const VidyoLocalMicrophone* m)

Parameters:

m The VidyoLocalMicrophone object.

Returns:

Function: VidyoLocalMicrophonePause

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

void VidyoLocalMicrophonePause(VidyoLocalMicrophone* m)

Parameters:

m The VidyoLocalMicrophone object.

Function: VidyoLocalMicrophonePlayTone

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

void VidyoLocalMicrophonePlayTone(VidyoLocalMicrophone* m, char dtmfTone)

Parameters:

m The VidyoLocalMicrophone object.
dtmfTone

Function: VidyoLocalMicrophoneRemoveFromLocalSpeaker

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneRemoveFromLocalSpeaker(VidyoLocalMicrophone* m, const VidyoLocalSpeaker* speaker)

Parameters:

m The VidyoLocalMicrophone object.
speaker

Returns:

Function: VidyoLocalMicrophoneRemoveFromRemoteSpeaker

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneRemoveFromRemoteSpeaker(VidyoLocalMicrophone* m, const VidyoRemoteSpeaker* remoteSpeaker)

Parameters:

m The VidyoLocalMicrophone object.
remoteSpeaker

Returns:

Function: VidyoLocalMicrophoneResume

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

void VidyoLocalMicrophoneResume(VidyoLocalMicrophone* m)

Parameters:

m The VidyoLocalMicrophone object.

Function: VidyoLocalMicrophoneSetAutoGain

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneSetAutoGain(VidyoLocalMicrophone* m, LmiBool autoGain)

Parameters:

m The VidyoLocalMicrophone object.
autoGain

Returns:

Function: VidyoLocalMicrophoneSetEchoCancellation

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneSetEchoCancellation(VidyoLocalMicrophone* m, const VidyoLocalSpeaker* speaker, LmiBool isEnable)

Parameters:

m The VidyoLocalMicrophone object.
speaker
isEnable

Returns:

Function: VidyoLocalMicrophoneSetSignalType

Member Of:

VidyoLocalMicrophone

Description:

Sets the signal type of the microhone which changes how the auido is processed.

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneSetSignalType(VidyoLocalMicrophone* m, VidyoDeviceAudioSignalType signalType)

Parameters:

m The VidyoLocalMicrophone object.
signalType The signal type of the microphone.

Returns:

LMI_TRUE on success.

Function: VidyoLocalMicrophoneSetVoiceProcessing

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMicrophoneSetVoiceProcessing(VidyoLocalMicrophone* m, LmiBool voiceProcessing)

Parameters:

m The VidyoLocalMicrophone object.
voiceProcessing

Returns:

Function: VidyoLocalMicrophoneSetVolume

Member Of:

VidyoLocalMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

void VidyoLocalMicrophoneSetVolume(VidyoLocalMicrophone* m, LmiUint volumePercent)

Parameters:

m The VidyoLocalMicrophone object.
volumePercent

Function: VidyoLocalMicrophoneShowDebugDialog

Member Of:

VidyoLocalMicrophone

Description:

Shows an audio debug dialog for the local microphone.

Include:

Lmi/VidyoClient/VidyoLocalMicrophone.h

Library:

VidyoClient

Syntax:

void VidyoLocalMicrophoneShowDebugDialog(VidyoLocalMicrophone *microphone)

Parameters:

microphone The local microphone object to extract stats.

Note 1:

The dialog is a platform-specific native window that will pop up outside of the application.

Function: VidyoLocalMonitorAddToLocalRenderer

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

LmiVoidPtr VidyoLocalMonitorAddToLocalRenderer(VidyoLocalMonitor* m, const VidyoLocalRenderer* renderer)

Parameters:

m The VidyoLocalMonitor object.
renderer

Returns:

Function: VidyoLocalMonitorAddToRemoteRenderer

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMonitorAddToRemoteRenderer(VidyoLocalMonitor* m, const VidyoRemoteRenderer* remoteRenderer)

Parameters:

m The VidyoLocalMonitor object.
remoteRenderer

Returns:

Function: VidyoLocalMonitorClearConstraints

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

void VidyoLocalMonitorClearConstraints(VidyoLocalMonitor* m)

Parameters:

m The VidyoLocalMonitor object.

Function: VidyoLocalMonitorConstructCopy

Member Of:

VidyoLocalMonitor

Description:

Constructs an VidyoLocalMonitor object as a copy of another.

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

VidyoLocalMonitor *VidyoLocalMonitorConstructCopy(VidyoLocalMonitor *obj, const VidyoLocalMonitor *other)

Parameters:

obj The VidyoLocalMonitor object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoLocalMonitorDestruct

Member Of:

VidyoLocalMonitor

Description:

Destructs an VidyoLocalMonitor object.

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

void VidyoLocalMonitorDestruct(VidyoLocalMonitor *obj)

Parameters:

obj The VidyoLocalMonitor object to destruct.

Function: VidyoLocalMonitorGetId

Member Of:

VidyoLocalMonitor

Description:

Gets the unique ID of the monitor.

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalMonitorGetId(const VidyoLocalMonitor* m)

Parameters:

m The VidyoLocalMonitor object.

Returns:

Unique ID of the monitor.

Function: VidyoLocalMonitorGetName

Member Of:

VidyoLocalMonitor

Description:

Gets the name of the monitor.

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalMonitorGetName(const VidyoLocalMonitor* m)

Parameters:

m The VidyoLocalMonitor object.

Returns:

Name of the monitor.

Function: VidyoLocalMonitorGetPreviewFrameDataUri

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

VidyoLocalMonitorState VidyoLocalMonitorGetPreviewFrameDataUri(VidyoLocalMonitor *m, LmiSizeT maxWidth, LmiSizeT maxHeight, LmiString *videoFrame)

Parameters:

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.

Returns:

Note 1:

The aspect ratio will be preserved.

Note 2:

The videoFrame will only contain the new image if VidyoLocalMonitorState VIDYO_LOCALMONITORSTATE_Ok, otherwise will will be assigned last valid preview image.

Function: VidyoLocalMonitorGetPreviewFrameDataUriAsync

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMonitorGetPreviewFrameDataUriAsync(VidyoLocalMonitor* w, LmiSizeT maxWidth, LmiSizeT maxHeight, VidyoLocalMonitorOnPreviewDataUriComplete onComplete)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

The aspect ratio will be preserved.

Function: VidyoLocalMonitorPrecludeWindow

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

void VidyoLocalMonitorPrecludeWindow(VidyoLocalMonitor* m, const VidyoLocalWindowShare* w)

Parameters:

m The VidyoLocalMonitor object.
w

Function: VidyoLocalMonitorRemoveFromLocalRenderer

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMonitorRemoveFromLocalRenderer(VidyoLocalMonitor* m, const VidyoLocalRenderer* renderer)

Parameters:

m The VidyoLocalMonitor object.
renderer

Returns:

Function: VidyoLocalMonitorRemoveFromRemoteRenderer

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMonitorRemoveFromRemoteRenderer(VidyoLocalMonitor* m, const VidyoRemoteRenderer* remoteRenderer)

Parameters:

m The VidyoLocalMonitor object.
remoteRenderer

Returns:

Function: VidyoLocalMonitorSetBoundsConstraints

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMonitorSetBoundsConstraints(VidyoLocalMonitor* m, LmiTime maxFrameInterval, LmiTime minFrameInterval, LmiUint maxWidth, LmiUint minWidth, LmiUint maxHeight, LmiUint minHeight)

Parameters:

m The VidyoLocalMonitor object.
maxFrameInterval
minFrameInterval
maxWidth
minWidth
maxHeight
minHeight

Returns:

Function: VidyoLocalMonitorSetCaptureInterval

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMonitorSetCaptureInterval(VidyoLocalMonitor* m, LmiTime frameInterval)

Parameters:

m The VidyoLocalMonitor object.
frameInterval

Returns:

Function: VidyoLocalMonitorSetDiscrerteConstraints

Member Of:

VidyoLocalMonitor

Description:

Include:

Lmi/VidyoClient/VidyoLocalMonitor.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalMonitorSetDiscrerteConstraints(VidyoLocalMonitor* m, LmiTime maxFrameInterval, LmiTime minFrameInterval, LmiUint width, LmiUint height, LmiFloat32 scaleFactor)

Parameters:

m The VidyoLocalMonitor object.
maxFrameInterval
minFrameInterval
width
height
scaleFactor

Returns:

Function: VidyoLocalRendererConstructCopy

Member Of:

VidyoLocalRenderer

Description:

Constructs an VidyoLocalRenderer object as a copy of another.

Include:

Lmi/VidyoClient/VidyoLocalRenderer.h

Library:

VidyoClient

Syntax:

VidyoLocalRenderer *VidyoLocalRendererConstructCopy(VidyoLocalRenderer *obj, const VidyoLocalRenderer *other)

Parameters:

obj The VidyoLocalRenderer object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoLocalRendererDestruct

Member Of:

VidyoLocalRenderer

Description:

Destructs an VidyoLocalRenderer object.

Include:

Lmi/VidyoClient/VidyoLocalRenderer.h

Library:

VidyoClient

Syntax:

void VidyoLocalRendererDestruct(VidyoLocalRenderer *obj)

Parameters:

obj The VidyoLocalRenderer object to destruct.

Function: VidyoLocalRendererGetId

Member Of:

VidyoLocalRenderer

Description:

Include:

Lmi/VidyoClient/VidyoLocalRenderer.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalRendererGetId(const VidyoLocalRenderer* r)

Parameters:

r

Returns:

Function: VidyoLocalRendererGetName

Member Of:

VidyoLocalRenderer

Description:

Include:

Lmi/VidyoClient/VidyoLocalRenderer.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalRendererGetName(const VidyoLocalRenderer* r)

Parameters:

r

Returns:

Function: VidyoLocalRendererIsPaused

Member Of:

VidyoLocalRenderer

Description:

Include:

Lmi/VidyoClient/VidyoLocalRenderer.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalRendererIsPaused(const VidyoLocalRenderer* r)

Parameters:

r

Returns:

Function: VidyoLocalRendererPause

Member Of:

VidyoLocalRenderer

Description:

Include:

Lmi/VidyoClient/VidyoLocalRenderer.h

Library:

VidyoClient

Syntax:

void VidyoLocalRendererPause(VidyoLocalRenderer* r)

Parameters:

r

Function: VidyoLocalRendererResume

Member Of:

VidyoLocalRenderer

Description:

Include:

Lmi/VidyoClient/VidyoLocalRenderer.h

Library:

VidyoClient

Syntax:

void VidyoLocalRendererResume(VidyoLocalRenderer* r)

Parameters:

r

Function: VidyoLocalRendererSetMaxStreams

Member Of:

VidyoLocalRenderer

Description:

Sets the maximum number of streams that can be displayed in the renderer.

Include:

Lmi/VidyoClient/VidyoLocalRenderer.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalRendererSetMaxStreams(VidyoLocalRenderer *r, LmiUint numStreams)

Parameters:

r
numStreams

Returns:

Note 1:

This API will return failure if the conference scene has been constructed externally.

Function: VidyoLocalRendererSetPosition

Member Of:

VidyoLocalRenderer

Description:

Include:

Lmi/VidyoClient/VidyoLocalRenderer.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalRendererSetPosition(VidyoLocalRenderer* r, LmiInt x, LmiInt y, LmiUint width, LmiUint height)

Parameters:

r
x
y
width
height

Returns:

Function: VidyoLocalSpeakerConstructCopy

Member Of:

VidyoLocalSpeaker

Description:

Constructs an VidyoLocalSpeaker object as a copy of another.

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Library:

VidyoClient

Syntax:

VidyoLocalSpeaker *VidyoLocalSpeakerConstructCopy(VidyoLocalSpeaker *obj, const VidyoLocalSpeaker *other)

Parameters:

obj The VidyoLocalSpeaker object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoLocalSpeakerDestruct

Member Of:

VidyoLocalSpeaker

Description:

Destructs an VidyoLocalSpeaker object.

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Library:

VidyoClient

Syntax:

void VidyoLocalSpeakerDestruct(VidyoLocalSpeaker *obj)

Parameters:

obj The VidyoLocalSpeaker object to destruct.

Function: VidyoLocalSpeakerGetId

Member Of:

VidyoLocalSpeaker

Description:

Gets the unique ID of the speaker.

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalSpeakerGetId(const VidyoLocalSpeaker* s)

Parameters:

s The VidyoLocalSpeaker object.

Returns:

Unique ID of the speaker.

Function: VidyoLocalSpeakerGetName

Member Of:

VidyoLocalSpeaker

Description:

Gets the name of the speaker.

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalSpeakerGetName(const VidyoLocalSpeaker* s)

Parameters:

s The VidyoLocalSpeaker object.

Returns:

Name of the speaker.

Function: VidyoLocalSpeakerGetVolume

Member Of:

VidyoLocalSpeaker

Description:

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Library:

VidyoClient

Syntax:

LmiUint VidyoLocalSpeakerGetVolume(VidyoLocalSpeaker* s)

Parameters:

s The VidyoLocalSpeaker object.

Returns:

Function: VidyoLocalSpeakerIsPaused

Member Of:

VidyoLocalSpeaker

Description:

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalSpeakerIsPaused(const VidyoLocalSpeaker* s)

Parameters:

s The VidyoLocalSpeaker object.

Returns:

Function: VidyoLocalSpeakerPause

Member Of:

VidyoLocalSpeaker

Description:

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Library:

VidyoClient

Syntax:

void VidyoLocalSpeakerPause(VidyoLocalSpeaker* s)

Parameters:

s The VidyoLocalSpeaker object.

Function: VidyoLocalSpeakerPlayTone

Member Of:

VidyoLocalSpeaker

Description:

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Library:

VidyoClient

Syntax:

void VidyoLocalSpeakerPlayTone(VidyoLocalSpeaker* s, char dtmfTone)

Parameters:

s The VidyoLocalSpeaker object.
dtmfTone

Function: VidyoLocalSpeakerResume

Member Of:

VidyoLocalSpeaker

Description:

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Library:

VidyoClient

Syntax:

void VidyoLocalSpeakerResume(VidyoLocalSpeaker* s)

Parameters:

s The VidyoLocalSpeaker object.

Function: VidyoLocalSpeakerSetVolume

Member Of:

VidyoLocalSpeaker

Description:

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Library:

VidyoClient

Syntax:

void VidyoLocalSpeakerSetVolume(VidyoLocalSpeaker* s, LmiUint volumePercent)

Parameters:

s The VidyoLocalSpeaker object.
volumePercent

Function: VidyoLocalSpeakerStopSound

Member Of:

VidyoLocalSpeaker

Description:

Include:

Lmi/VidyoClient/VidyoLocalSpeaker.h

Library:

VidyoClient

Syntax:

void VidyoLocalSpeakerStopSound(VidyoLocalSpeaker* s)

Parameters:

s The VidyoLocalSpeaker object.

Function: VidyoLocalWindowShareAddToLocalRenderer

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiVoidPtr VidyoLocalWindowShareAddToLocalRenderer(VidyoLocalWindowShare* w, const VidyoLocalRenderer* renderer)

Parameters:

w The VidyoLocalWindowShare object.
renderer

Returns:

Function: VidyoLocalWindowShareAddToRemoteRenderer

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalWindowShareAddToRemoteRenderer(VidyoLocalWindowShare* w, const VidyoRemoteRenderer* remoteRenderer)

Parameters:

w The VidyoLocalWindowShare object.
remoteRenderer

Returns:

Function: VidyoLocalWindowShareClearConstraints

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

void VidyoLocalWindowShareClearConstraints(VidyoLocalWindowShare* m)

Parameters:

m

Function: VidyoLocalWindowShareConstructCopy

Member Of:

VidyoLocalWindowShare

Description:

Constructs an VidyoLocalWindowShare object as a copy of another.

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

VidyoLocalWindowShare *VidyoLocalWindowShareConstructCopy(VidyoLocalWindowShare *obj, const VidyoLocalWindowShare *other)

Parameters:

obj The VidyoLocalWindowShare object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoLocalWindowShareDestruct

Member Of:

VidyoLocalWindowShare

Description:

Destructs an VidyoLocalWindowShare object.

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

void VidyoLocalWindowShareDestruct(VidyoLocalWindowShare *obj)

Parameters:

obj The VidyoLocalWindowShare object to destruct.

Function: VidyoLocalWindowShareGetApplicationIconFrameDataUriAsync

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalWindowShareGetApplicationIconFrameDataUriAsync(VidyoLocalWindowShare* w, LmiSizeT maxWidth, LmiSizeT maxHeight, VidyoLocalWindowShareOnApplicationIconDataUriComplete onComplete)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoLocalWindowShareGetApplicationName

Member Of:

VidyoLocalWindowShare

Description:

Gets the name of the application which owns the window.

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalWindowShareGetApplicationName(const VidyoLocalWindowShare* w)

Parameters:

w The VidyoLocalWindowShare object.

Returns:

Function: VidyoLocalWindowShareGetId

Member Of:

VidyoLocalWindowShare

Description:

Gets the unique ID of the window share.

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalWindowShareGetId(const VidyoLocalWindowShare* w)

Parameters:

w The VidyoLocalWindowShare object.

Returns:

Unique ID of the window share.

Function: VidyoLocalWindowShareGetName

Member Of:

VidyoLocalWindowShare

Description:

Gets the name of the window share.

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoLocalWindowShareGetName(const VidyoLocalWindowShare* w)

Parameters:

w The VidyoLocalWindowShare object.

Returns:

Name of the window share.

Function: VidyoLocalWindowShareGetPreviewFrameDataUriAsync

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalWindowShareGetPreviewFrameDataUriAsync(VidyoLocalWindowShare* w, LmiSizeT maxWidth, LmiSizeT maxHeight, VidyoLocalWindowShareOnPreviewDataUriComplete onComplete)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Note 1:

The aspect ratio will be preserved.

Function: VidyoLocalWindowShareGetProcessId

Member Of:

VidyoLocalWindowShare

Description:

Gets the ID of the process which owns the window share.

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiUint VidyoLocalWindowShareGetProcessId(VidyoLocalWindowShare* w)

Parameters:

w The VidyoLocalWindowShare object.

Returns:

ID of the process which owns the window share.

Function: VidyoLocalWindowShareIsApplicationNameSet

Member Of:

VidyoLocalWindowShare

Description:

Checks if the name of the application name is set.

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalWindowShareIsApplicationNameSet(const VidyoLocalWindowShare* w)

Parameters:

w The VidyoLocalWindowShare object.

Returns:

LMI_TRUE when the applicaiton name is set, LMI_FALSE otherwise.

Function: VidyoLocalWindowShareIsNameSet

Member Of:

VidyoLocalWindowShare

Description:

Checks if the name of the window share is set.

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalWindowShareIsNameSet(const VidyoLocalWindowShare* w)

Parameters:

w The VidyoLocalWindowShare object.

Returns:

LMI_TRUE when the window share name is set, LMI_FALSE otherwise.

Function: VidyoLocalWindowShareRemoveFromLocalRenderer

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalWindowShareRemoveFromLocalRenderer(VidyoLocalWindowShare* w, const VidyoLocalRenderer* renderer)

Parameters:

w The VidyoLocalWindowShare object.
renderer

Returns:

Function: VidyoLocalWindowShareRemoveFromRemoteRenderer

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalWindowShareRemoveFromRemoteRenderer(VidyoLocalWindowShare* w, const VidyoRemoteRenderer* remoteRenderer)

Parameters:

w The VidyoLocalWindowShare object.
remoteRenderer

Returns:

Function: VidyoLocalWindowShareSetBoundsConstraints

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalWindowShareSetBoundsConstraints(VidyoLocalWindowShare* m, LmiTime maxFrameInterval, LmiTime minFrameInterval, LmiUint maxWidth, LmiUint minWidth, LmiUint maxHeight, LmiUint minHeight)

Parameters:

m
maxFrameInterval
minFrameInterval
maxWidth
minWidth
maxHeight
minHeight

Returns:

Function: VidyoLocalWindowShareSetCapability

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalWindowShareSetCapability(VidyoLocalWindowShare* w, LmiTime frameInterval, LmiBool showCursor, LmiBool redactOccludedAreas)

Parameters:

w The VidyoLocalWindowShare object.
frameInterval
showCursor
redactOccludedAreas

Returns:

Function: VidyoLocalWindowShareSetDiscrerteConstraints

Member Of:

VidyoLocalWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoLocalWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoLocalWindowShareSetDiscrerteConstraints(VidyoLocalWindowShare* m, LmiTime maxFrameInterval, LmiTime minFrameInterval, LmiUint width, LmiUint height, LmiFloat32 scaleFactor)

Parameters:

m
maxFrameInterval
minFrameInterval
width
height
scaleFactor

Returns:

Function: VidyoMeetingAddAttendee

Member Of:

VidyoMeeting

Description:

Adds an attendee to the meeting Triggers callback(s): VidyoMeetingFeedbackAttendeeAdded

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

LmiBool VidyoMeetingAddAttendee(VidyoMeeting* m, VidyoMeetingAttendee *a)

Parameters:

m Meeting to add the attendee to
a Attendee to add

Returns:

Function: VidyoMeetingConstructCopy

Member Of:

VidyoMeeting

Description:

Constructs an VidyoMeeting object as a copy of another.

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

VidyoMeeting *VidyoMeetingConstructCopy(VidyoMeeting *obj, const VidyoMeeting *other)

Parameters:

obj The VidyoMeeting object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoMeetingDestruct

Member Of:

VidyoMeeting

Description:

Destructs an VidyoMeeting object.

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

void VidyoMeetingDestruct(VidyoMeeting *obj)

Parameters:

obj The VidyoRoom object to destruct.

Function: VidyoMeetingFeedbackConstruct

Member Of:

VidyoMeetingFeedback

Description:

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

VidyoMeetingFeedback* VidyoMeetingFeedbackConstruct(VidyoMeetingFeedback* f, VidyoMeetingFeedbackMeetingAttendeeAdded attendeeAdded, VidyoMeetingFeedbackMeetingAttendeeRemoved attendeeRemoved, LmiAllocator* alloc)

Parameters:

f
attendeeAdded
attendeeRemoved
alloc

Returns:

Function: VidyoMeetingFeedbackDestruct

Member Of:

VidyoMeetingFeedback

Description:

Destructs an VidyoMeetingFeedback object.

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

void VidyoMeetingFeedbackDestruct(VidyoMeetingFeedback *obj)

Parameters:

obj The VidyoMeetingFeedback object to destruct.

Function: VidyoMeetingGetAttendees

Member Of:

VidyoMeeting

Description:

Retrieve all attendees for the meeting

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

LmiBool VidyoMeetingGetAttendees(VidyoMeeting* m, LmiVector(VidyoMeetingAttendee) *a )

Parameters:

m Meeting to retrieve attendees from
a List of attendees for the meeting as per the role argument

Returns:

Function: VidyoMeetingGetAttendeesByRole

Member Of:

VidyoMeeting

Description:

Retrieve all attendees for the meeting

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

LmiBool VidyoMeetingGetAttendeesByRole(VidyoMeeting* m, LmiVector(VidyoMeetingAttendee) *a, VidyoAttendeeParticipationRole r )

Parameters:

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.

Returns:

Function: VidyoMeetingGetBody

Member Of:

VidyoMeeting

Description:

Retrieve up to 2K bytes of body data from a Vidyo meeting

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

const LmiString * VidyoMeetingGetBody(const VidyoMeeting* m)

Parameters:

m

Returns:

Function: VidyoMeetingGetEndDateTime

Member Of:

VidyoMeeting

Description:

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

const LmiString * VidyoMeetingGetEndDateTime(const VidyoMeeting* m)

Parameters:

m

Returns:

Function: VidyoMeetingGetId

Member Of:

VidyoMeeting

Description:

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

const LmiString * VidyoMeetingGetId(const VidyoMeeting* m)

Parameters:

m

Returns:

Function: VidyoMeetingGetLocation

Member Of:

VidyoMeeting

Description:

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

const LmiString * VidyoMeetingGetLocation(const VidyoMeeting* m)

Parameters:

m

Returns:

Function: VidyoMeetingGetOwnerEmail

Member Of:

VidyoMeeting

Description:

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

const LmiString * VidyoMeetingGetOwnerEmail(const VidyoMeeting* m)

Parameters:

m

Returns:

Function: VidyoMeetingGetOwnerName

Member Of:

VidyoMeeting

Description:

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

const LmiString * VidyoMeetingGetOwnerName(const VidyoMeeting* m)

Parameters:

m

Returns:

Function: VidyoMeetingGetStartDateTime

Member Of:

VidyoMeeting

Description:

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

const LmiString * VidyoMeetingGetStartDateTime(const VidyoMeeting* m)

Parameters:

m

Returns:

Function: VidyoMeetingGetSubject

Member Of:

VidyoMeeting

Description:

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

const LmiString * VidyoMeetingGetSubject(const VidyoMeeting* m)

Parameters:

m

Returns:

Function: VidyoMeetingGetType

Member Of:

VidyoMeeting

Description:

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

const VidyoMeetingType * VidyoMeetingGetType(const VidyoMeeting* m)

Parameters:

m

Returns:

Function: VidyoMeetingGetVidyoMeetingRoomId

Member Of:

VidyoMeeting

Description:

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

const LmiString * VidyoMeetingGetVidyoMeetingRoomId(const VidyoMeeting* m)

Parameters:

m

Returns:

Function: VidyoMeetingRemoveAttendee

Member Of:

VidyoMeeting

Description:

Removes an attendee from the meeting Triggers callback(s): VidyoMeetingFeedbackAttendeeRemoved

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

LmiBool VidyoMeetingRemoveAttendee(VidyoMeeting* m, VidyoMeetingAttendee *a)

Parameters:

m Meeting to remove the attendee from
a Attendee to remove

Returns:

Function: VidyoMeetingRespondToInvite

Member Of:

VidyoMeeting

Description:

Respond to a meeting invite

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

LmiBool VidyoMeetingRespondToInvite(VidyoMeeting* m, VidyoMeetingAttendee *a, VidyoAttendeeParticipationStatus s )

Parameters:

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.

Returns:

r

Function: VidyoMeetingRetrieveBody

Member Of:

VidyoMeeting

Description:

To retrieve entire body from a Vidyo meeting

Include:

Lmi/VidyoClient/VidyoMeeting.h

Library:

VidyoClient

Syntax:

const LmiString * VidyoMeetingRetrieveBody(const VidyoMeeting* m)

Parameters:

m

Returns:

Function: VidyoNetworkInterfaceConstructCopy

Member Of:

VidyoNetworkInterface

Description:

Constructs an VidyoNetworkInterface object as a copy of an existing object.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Library:

VidyoClient

Syntax:

VidyoNetworkInterface *VidyoNetworkInterfaceConstructCopy(VidyoNetworkInterface *d, const VidyoNetworkInterface *s)

Parameters:

d The VidyoNetworkInterface object to construct.
s The existing VidyoNetworkInterface object to copy.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoNetworkInterfaceDestruct

Member Of:

VidyoNetworkInterface

Description:

Destructs an VidyoNetworkInterface object.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Library:

VidyoClient

Syntax:

void VidyoNetworkInterfaceDestruct(VidyoNetworkInterface *n)

Parameters:

n The VidyoNetworkInterface object to destruct.

Function: VidyoNetworkInterfaceGetAddress

Member Of:

VidyoNetworkInterface

Description:

Gets the address of the network interface.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoNetworkInterfaceGetAddress(const VidyoNetworkInterface* n)

Parameters:

n The VidyoNetworkInterface object.

Returns:

Address of the network interface.

Function: VidyoNetworkInterfaceGetFamily

Member Of:

VidyoNetworkInterface

Description:

Gets the family of the network interface.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Library:

VidyoClient

Syntax:

VidyoNetworkInterfaceFamily VidyoNetworkInterfaceGetFamily(const VidyoNetworkInterface* n)

Parameters:

n The VidyoNetworkInterface object.

Returns:

Family of the network interface.

Function: VidyoNetworkInterfaceGetName

Member Of:

VidyoNetworkInterface

Description:

Gets the name of the network interface.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoNetworkInterfaceGetName(const VidyoNetworkInterface* n)

Parameters:

n The VidyoNetworkInterface object.

Returns:

Name of the network interface.

Function: VidyoNetworkInterfaceGetState

Member Of:

VidyoNetworkInterface

Description:

Gets the state of the network interface.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Library:

VidyoClient

Syntax:

VidyoNetworkInterfaceState VidyoNetworkInterfaceGetState(const VidyoNetworkInterface* n)

Parameters:

n The VidyoNetworkInterface object.

Returns:

State of the network interface.

Function: VidyoNetworkInterfaceGetType

Member Of:

VidyoNetworkInterface

Description:

Gets the type of the network interface.

Include:

Lmi/VidyoClient/VidyoNetworkInterface.h

Library:

VidyoClient

Syntax:

VidyoNetworkInterfaceType VidyoNetworkInterfaceGetType(const VidyoNetworkInterface* n)

Parameters:

n The VidyoNetworkInterface object.

Returns:

Type of the network interface.

Function: VidyoParticipantConstructCopy

Member Of:

VidyoParticipant

Description:

Constructs an VidyoParticipant object as a copy of another.

Include:

Lmi/VidyoClient/VidyoParticipant.h

Library:

VidyoClient

Syntax:

VidyoParticipant *VidyoParticipantConstructCopy(VidyoParticipant *obj, const VidyoParticipant *other)

Parameters:

obj The VidyoParticipant object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoParticipantDestruct

Member Of:

VidyoParticipant

Description:

Destructs an VidyoParticipant object.

Include:

Lmi/VidyoClient/VidyoParticipant.h

Library:

VidyoClient

Syntax:

void VidyoParticipantDestruct(VidyoParticipant *obj)

Parameters:

obj The VidyoParticipant object to destruct.

Function: VidyoParticipantGetContact

Member Of:

VidyoParticipant

Description:

Include:

Lmi/VidyoClient/VidyoParticipant.h

Library:

VidyoClient

Syntax:

VidyoContact* VidyoParticipantGetContact(const VidyoParticipant* p, VidyoContact* contact)

Parameters:

p The VidyoParticipant object.
contact

Returns:

Function: VidyoParticipantGetId

Member Of:

VidyoParticipant

Description:

Gets the ID that is unique to the room or call only.

Include:

Lmi/VidyoClient/VidyoParticipant.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoParticipantGetId(const VidyoParticipant* p)

Parameters:

p The VidyoParticipant object.

Returns:

ID that is unique to the room or call only.

Function: VidyoParticipantGetName

Member Of:

VidyoParticipant

Description:

Gets the display name of the participant.

Include:

Lmi/VidyoClient/VidyoParticipant.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoParticipantGetName(const VidyoParticipant* p)

Parameters:

p The VidyoParticipant object.

Returns:

Display name of the participant.

Function: VidyoParticipantGetUserId

Member Of:

VidyoParticipant

Description:

Gets the ID that is globally unique such as user@domain.

Include:

Lmi/VidyoClient/VidyoParticipant.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoParticipantGetUserId(const VidyoParticipant* p)

Parameters:

p The VidyoParticipant object.

Returns:

ID that is globally unique such as user@domain.

Function: VidyoParticipantIsHidden

Member Of:

VidyoParticipant

Description:

Gets the hidden state of the participant.

Include:

Lmi/VidyoClient/VidyoParticipant.h

Library:

VidyoClient

Syntax:

LmiBool VidyoParticipantIsHidden(const VidyoParticipant* p)

Parameters:

p The VidyoParticipant object.

Returns:

LMI_TRUE if the participant is hidden, LMI_FALSE otherwise.

Function: VidyoParticipantIsLocal

Member Of:

VidyoParticipant

Description:

Include:

Lmi/VidyoClient/VidyoParticipant.h

Library:

VidyoClient

Syntax:

LmiBool VidyoParticipantIsLocal(VidyoParticipant *p)

Parameters:

p The VidyoParticipant object.

Returns:

Function: VidyoParticipantIsRecording

Member Of:

VidyoParticipant

Description:

Gets the recording state of the participant.

Include:

Lmi/VidyoClient/VidyoParticipant.h

Library:

VidyoClient

Syntax:

LmiBool VidyoParticipantIsRecording(const VidyoParticipant* p)

Parameters:

p The VidyoParticipant object.

Returns:

LMI_TRUE if the participant is recording, LMI_FALSE otherwise.

Function: VidyoParticipantIsSelectable

Member Of:

VidyoParticipant

Description:

Gets the selectable state of the participant.

Include:

Lmi/VidyoClient/VidyoParticipant.h

Library:

VidyoClient

Syntax:

LmiBool VidyoParticipantIsSelectable(const VidyoParticipant* p)

Parameters:

p The VidyoParticipant object.

Returns:

LMI_TRUE if the participant is selectable, LMI_FALSE otherwise.

Function: VidyoRemoteCameraAddToLocalRenderer

Member Of:

VidyoRemoteCamera

Description:

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

LmiVoidPtr VidyoRemoteCameraAddToLocalRenderer(VidyoRemoteCamera* c, const VidyoLocalRenderer* localRenderer, VidyoRemoteCameraMode mode)

Parameters:

c The VidyoRemoteCamera object.
localRenderer
mode

Returns:

Function: VidyoRemoteCameraConstructCopy

Member Of:

VidyoRemoteCamera

Description:

Constructs an VidyoRemoteCamera object as a copy of another.

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

VidyoRemoteCamera *VidyoRemoteCameraConstructCopy(VidyoRemoteCamera *obj, const VidyoRemoteCamera *other)

Parameters:

obj The VidyoRemoteCamera object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoRemoteCameraControlPTZ

Member Of:

VidyoRemoteCamera

Description:

Send the PTZ Nudge commands to the remote camera.

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRemoteCameraControlPTZ(VidyoRemoteCamera *c, LmiInt pan, LmiInt tilt, LmiInt zoom)

Parameters:

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.

Returns:

LMI_TRUE when the control command was sent, LMI_FALSE otherwise.

Note 1:

Positive numbers increase the nudge, and negative numbers decrease the nudge for left/right up/down zoom in/out.

Function: VidyoRemoteCameraDestruct

Member Of:

VidyoRemoteCamera

Description:

Destructs an VidyoRemoteCamera object.

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

void VidyoRemoteCameraDestruct(VidyoRemoteCamera *obj)

Parameters:

obj The VidyoRemoteCamera object to destruct.

Function: VidyoRemoteCameraGetId

Member Of:

VidyoRemoteCamera

Description:

Gets the unique ID of the camera.

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoRemoteCameraGetId(const VidyoRemoteCamera* c)

Parameters:

c The VidyoRemoteCamera object.

Returns:

Unique ID of the camera.

Function: VidyoRemoteCameraGetLocalRenderingStreamId

Member Of:

VidyoRemoteCamera

Description:

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

LmiVoidPtr VidyoRemoteCameraGetLocalRenderingStreamId(VidyoRemoteCamera* c, LmiInt index)

Parameters:

c The VidyoRemoteCamera object.
index

Returns:

Function: VidyoRemoteCameraGetName

Member Of:

VidyoRemoteCamera

Description:

Gets the name of the camera.

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoRemoteCameraGetName(const VidyoRemoteCamera* c)

Parameters:

c The VidyoRemoteCamera object.

Returns:

Name of the camera.

Function: VidyoRemoteCameraGetPosition

Member Of:

VidyoRemoteCamera

Description:

Gets the position of the camera.

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

VidyoRemoteCameraPosition VidyoRemoteCameraGetPosition(const VidyoRemoteCamera* c)

Parameters:

c The VidyoRemoteCamera object.

Returns:

Position of the camera.

Function: VidyoRemoteCameraIsControllable

Member Of:

VidyoRemoteCamera

Description:

Checks if the remote camera is controllable.

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRemoteCameraIsControllable(VidyoRemoteCamera *c)

Parameters:

c The VidyoRemoteCamera object.

Returns:

LMI_TRUE if controllable, LMI_FALSE otherwise.

Function: VidyoRemoteCameraRemoveFromLocalRenderer

Member Of:

VidyoRemoteCamera

Description:

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRemoteCameraRemoveFromLocalRenderer(VidyoRemoteCamera* c, const VidyoLocalRenderer* localRenderer)

Parameters:

c The VidyoRemoteCamera object.
localRenderer

Returns:

Function: VidyoRemoteCameraSetPositionInLocalRenderer

Member Of:

VidyoRemoteCamera

Description:

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRemoteCameraSetPositionInLocalRenderer(VidyoRemoteCamera *c, const VidyoLocalRenderer *localRenderer, LmiInt x, LmiInt y, LmiUint width, LmiUint height, LmiTime frameInterval)

Parameters:

c The VidyoRemoteCamera object.
localRenderer
x
y
width
height
frameInterval

Returns:

Function: VidyoRemoteCameraShowCameraControl

Member Of:

VidyoRemoteCamera

Description:

Shows camera control when rendering remote camera.

Include:

Lmi/VidyoClient/VidyoRemoteCamera.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRemoteCameraShowCameraControl(VidyoRemoteCamera* c, LmiBool show)

Parameters:

c The VidyoRemoteCamera object.
show Show or hide camera controls.

Returns:

LMI_TRUE on success.

Note 1:

Applies to Composite and Custom rendering layouts.

Function: VidyoRemoteMicrophoneAddToLocalSpeaker

Member Of:

VidyoRemoteMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoRemoteMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRemoteMicrophoneAddToLocalSpeaker(VidyoRemoteMicrophone* m, const VidyoLocalSpeaker* speaker, VidyoRemoteMicrophoneMode mode)

Parameters:

m The VidyoRemoteMicrophone object.
speaker
mode

Returns:

Function: VidyoRemoteMicrophoneConstructCopy

Member Of:

VidyoRemoteMicrophone

Description:

Constructs an VidyoRemoteMicrophone object as a copy of another.

Include:

Lmi/VidyoClient/VidyoRemoteMicrophone.h

Library:

VidyoClient

Syntax:

VidyoRemoteMicrophone *VidyoRemoteMicrophoneConstructCopy(VidyoRemoteMicrophone *obj, const VidyoRemoteMicrophone *other)

Parameters:

obj The VidyoRemoteMicrophone object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoRemoteMicrophoneDestruct

Member Of:

VidyoRemoteMicrophone

Description:

Destructs an VidyoRemoteMicrophone object.

Include:

Lmi/VidyoClient/VidyoRemoteMicrophone.h

Library:

VidyoClient

Syntax:

void VidyoRemoteMicrophoneDestruct(VidyoRemoteMicrophone *obj)

Parameters:

obj The VidyoRemoteMicrophone object to destruct.

Function: VidyoRemoteMicrophoneGetId

Member Of:

VidyoRemoteMicrophone

Description:

Gets the unique ID of the microphone.

Include:

Lmi/VidyoClient/VidyoRemoteMicrophone.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoRemoteMicrophoneGetId(const VidyoRemoteMicrophone* m)

Parameters:

m The VidyoRemoteMicrophone object.

Returns:

Unique ID of the microphone.

Function: VidyoRemoteMicrophoneGetName

Member Of:

VidyoRemoteMicrophone

Description:

Gets the name of the microphone.

Include:

Lmi/VidyoClient/VidyoRemoteMicrophone.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoRemoteMicrophoneGetName(const VidyoRemoteMicrophone* m)

Parameters:

m The VidyoRemoteMicrophone object.

Returns:

Name of the microphone.

Function: VidyoRemoteMicrophoneGetSignalType

Member Of:

VidyoRemoteMicrophone

Description:

Gets signal type of the microphone, which affects how the audio is processed.

Include:

Lmi/VidyoClient/VidyoRemoteMicrophone.h

Library:

VidyoClient

Syntax:

VidyoDeviceAudioSignalType VidyoRemoteMicrophoneGetSignalType(const VidyoRemoteMicrophone* m)

Parameters:

m The VidyoRemoteMicrophone object.

Returns:

The signal type of the microphone.

Function: VidyoRemoteMicrophoneRemoveFromLocalSpeaker

Member Of:

VidyoRemoteMicrophone

Description:

Include:

Lmi/VidyoClient/VidyoRemoteMicrophone.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRemoteMicrophoneRemoveFromLocalSpeaker(VidyoRemoteMicrophone* m, const VidyoLocalSpeaker* speaker)

Parameters:

m The VidyoRemoteMicrophone object.
speaker

Returns:

Function: VidyoRemoteRendererConstructCopy

Member Of:

VidyoRemoteRenderer

Description:

Constructs an VidyoRemoteRenderer object as a copy of another.

Include:

Lmi/VidyoClient/VidyoRemoteRenderer.h

Library:

VidyoClient

Syntax:

VidyoRemoteRenderer *VidyoRemoteRendererConstructCopy(VidyoRemoteRenderer *obj, const VidyoRemoteRenderer *other)

Parameters:

obj The VidyoRemoteRenderer object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoRemoteRendererDestruct

Member Of:

VidyoRemoteRenderer

Description:

Destructs an VidyoRemoteRenderer object.

Include:

Lmi/VidyoClient/VidyoRemoteRenderer.h

Library:

VidyoClient

Syntax:

void VidyoRemoteRendererDestruct(VidyoRemoteRenderer *obj)

Parameters:

obj The VidyoRemoteRenderer object to destruct.

Function: VidyoRemoteRendererGetId

Member Of:

VidyoRemoteRenderer

Description:

Include:

Lmi/VidyoClient/VidyoRemoteRenderer.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoRemoteRendererGetId(const VidyoRemoteRenderer* r)

Parameters:

r

Returns:

Function: VidyoRemoteRendererGetName

Member Of:

VidyoRemoteRenderer

Description:

Include:

Lmi/VidyoClient/VidyoRemoteRenderer.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoRemoteRendererGetName(const VidyoRemoteRenderer* r)

Parameters:

r

Returns:

Function: VidyoRemoteSpeakerConstructCopy

Member Of:

VidyoRemoteSpeaker

Description:

Constructs an VidyoRemoteSpeaker object as a copy of another.

Include:

Lmi/VidyoClient/VidyoRemoteSpeaker.h

Library:

VidyoClient

Syntax:

VidyoRemoteSpeaker *VidyoRemoteSpeakerConstructCopy(VidyoRemoteSpeaker *obj, const VidyoRemoteSpeaker *other)

Parameters:

obj The VidyoRemoteSpeaker object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoRemoteSpeakerDestruct

Member Of:

VidyoRemoteSpeaker

Description:

Destructs an VidyoRemoteSpeaker object.

Include:

Lmi/VidyoClient/VidyoRemoteSpeaker.h

Library:

VidyoClient

Syntax:

void VidyoRemoteSpeakerDestruct(VidyoRemoteSpeaker *obj)

Parameters:

obj The VidyoRemoteSpeaker object to destruct.

Function: VidyoRemoteSpeakerGetId

Member Of:

VidyoRemoteSpeaker

Description:

Include:

Lmi/VidyoClient/VidyoRemoteSpeaker.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoRemoteSpeakerGetId(const VidyoRemoteSpeaker* s)

Parameters:

s

Returns:

Function: VidyoRemoteSpeakerGetName

Member Of:

VidyoRemoteSpeaker

Description:

Include:

Lmi/VidyoClient/VidyoRemoteSpeaker.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoRemoteSpeakerGetName(const VidyoRemoteSpeaker* s)

Parameters:

s

Returns:

Function: VidyoRemoteWindowShareAddToLocalRenderer

Member Of:

VidyoRemoteWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoRemoteWindowShare.h

Library:

VidyoClient

Syntax:

LmiVoidPtr VidyoRemoteWindowShareAddToLocalRenderer(VidyoRemoteWindowShare* w, const VidyoLocalRenderer* renderer)

Parameters:

w The VidyoRemoteWindowShare object.
renderer

Returns:

Function: VidyoRemoteWindowShareConstructCopy

Member Of:

VidyoRemoteWindowShare

Description:

Constructs an VidyoRemoteWindowShare object as a copy of another.

Include:

Lmi/VidyoClient/VidyoRemoteWindowShare.h

Library:

VidyoClient

Syntax:

VidyoRemoteWindowShare *VidyoRemoteWindowShareConstructCopy(VidyoRemoteWindowShare *obj, const VidyoRemoteWindowShare *other)

Parameters:

obj The VidyoRemoteWindowShare object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoRemoteWindowShareDestruct

Member Of:

VidyoRemoteWindowShare

Description:

Destructs an VidyoRemoteWindowShare object.

Include:

Lmi/VidyoClient/VidyoRemoteWindowShare.h

Library:

VidyoClient

Syntax:

void VidyoRemoteWindowShareDestruct(VidyoRemoteWindowShare *obj)

Parameters:

obj The VidyoRemoteWindowShare object to destruct.

Function: VidyoRemoteWindowShareGetId

Member Of:

VidyoRemoteWindowShare

Description:

Gets the unique ID of the window share.

Include:

Lmi/VidyoClient/VidyoRemoteWindowShare.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoRemoteWindowShareGetId(const VidyoRemoteWindowShare* w)

Parameters:

w The VidyoRemoteWindowShare object.

Returns:

Unique ID of the window share.

Function: VidyoRemoteWindowShareGetName

Member Of:

VidyoRemoteWindowShare

Description:

Gets the name of the window share.

Include:

Lmi/VidyoClient/VidyoRemoteWindowShare.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoRemoteWindowShareGetName(const VidyoRemoteWindowShare* w)

Parameters:

w The VidyoRemoteWindowShare object.

Returns:

Name of the window share.

Function: VidyoRemoteWindowShareRemoveFromLocalRenderer

Member Of:

VidyoRemoteWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoRemoteWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRemoteWindowShareRemoveFromLocalRenderer(VidyoRemoteWindowShare* w, const VidyoLocalRenderer* renderer)

Parameters:

w The VidyoRemoteWindowShare object.
renderer

Returns:

Function: VidyoRemoteWindowShareSetPositionInLocalRenderer

Member Of:

VidyoRemoteWindowShare

Description:

Include:

Lmi/VidyoClient/VidyoRemoteWindowShare.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRemoteWindowShareSetPositionInLocalRenderer(VidyoRemoteWindowShare *w, const VidyoLocalRenderer *localRenderer, LmiInt x, LmiInt y, LmiUint width, LmiUint height, LmiTime frameInterval)

Parameters:

w The VidyoRemoteWindowShare object.
localRenderer
x
y
width
height
frameInterval

Returns:

Function: VidyoRoomAcceptIncoming

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomAcceptIncoming(VidyoRoom* r, VidyoRoomOnEntered onEntered, VidyoRoomOnExited onExited)

Parameters:

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.

Returns:

Function: VidyoRoomAcquireMediaRoute

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomAcquireMediaRoute(VidyoRoom* r, VidyoRoomOnMediaRouteAcquired onMediaRouteAcquired)

Parameters:

r
onMediaRouteAcquired Callback that is triggered when the acquire media route operation is complete.

Returns:

Function: VidyoRoomAddLocalCamera

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomAddLocalCamera(VidyoRoom *r, const VidyoLocalCamera *localCamera, LmiBool removeOthers)

Parameters:

r Vidyo room object.
localCamera
removeOthers

Function: VidyoRoomAddLocalMicrophone

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomAddLocalMicrophone(VidyoRoom *r, const VidyoLocalMicrophone *localMicrophone, LmiBool removeOthers, LmiBool isAES)

Parameters:

r Vidyo room object.
localMicrophone
removeOthers
isAES

Function: VidyoRoomAddLocalMonitor

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomAddLocalMonitor(VidyoRoom *r, const VidyoLocalMonitor *localMonitor, LmiBool removeOthers)

Parameters:

r Vidyo room object.
localMonitor
removeOthers

Function: VidyoRoomAddLocalRenderer

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomAddLocalRenderer(VidyoRoom *r, const VidyoLocalRenderer *localRenderer, LmiBool removeOthers)

Parameters:

r Vidyo room object.
localRenderer
removeOthers

Function: VidyoRoomAddLocalSpeaker

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomAddLocalSpeaker(VidyoRoom *r, const VidyoLocalSpeaker *localSpeaker, LmiBool removeOthers, LmiBool isAES)

Parameters:

r Vidyo room object.
localSpeaker
removeOthers
isAES

Function: VidyoRoomAddLocalWindowShare

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomAddLocalWindowShare(VidyoRoom *r, const VidyoLocalWindowShare *localWindowShare, LmiBool removeOthers)

Parameters:

r Vidyo room object.
localWindowShare
removeOthers

Function: VidyoRoomConstructCopy

Member Of:

VidyoRoom

Description:

Constructs an VidyoRoom object as a copy of another.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

VidyoRoom *VidyoRoomConstructCopy(VidyoRoom *obj, const VidyoRoom *other)

Parameters:

obj The VidyoRoom object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoRoomDelete

Member Of:

VidyoRoom

Description:

Delete a room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomDelete(VidyoRoom *r, VidyoRoomOnDeleteResult onDeleteResult)

Parameters:

r Vidyo room object.
onDeleteResult Callback that is triggered when delete operation completes.

Function: VidyoRoomDestruct

Member Of:

VidyoRoom

Description:

Destructs an VidyoRoom object.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomDestruct(VidyoRoom *obj)

Parameters:

obj The VidyoRoom object to destruct.

Function: VidyoRoomDisableMedia

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomDisableMedia(VidyoRoom* r)

Parameters:

r

Returns:

Function: VidyoRoomEnableMedia

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomEnableMedia(VidyoRoom* r, VidyoRoomOnMediaEnabled onMediaEnabled, VidyoRoomOnMediaFailed onMediaFailed, VidyoRoomOnMediaDisabled onMediaDisabled)

Parameters:

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.

Returns:

Function: VidyoRoomEnter

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomEnter(VidyoRoom *r, VidyoRoomOnEntered onEntered, VidyoRoomOnExited onExited)

Parameters:

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.

Returns:

Function: VidyoRoomGetHistory

Member Of:

VidyoRoom

Description:

Gets the latest history of the room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomGetHistory(VidyoRoom *r, LmiUint32 numMessages, VidyoRoomOnGetHistoryResults onGetHistoryResults)

Parameters:

r The room object.
numMessages The number of latest messages to request.
onGetHistoryResults Callback that is triggered when history results are ready.

Returns:

LMI_TRUE if the operation is successful, LMI_FALSE otherwise.

Function: VidyoRoomGetHistoryById

Member Of:

VidyoRoom

Description:

Gets the history of the room before and after the messageId.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomGetHistoryById(VidyoRoom *r, LmiInt64 messageId, LmiUint32 numMessagesBefore, LmiUint32 numMessagesAfter, VidyoRoomOnGetHistoryResults onGetHistoryResults)

Parameters:

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.

Returns:

LMI_TRUE if the operation is successful, LMI_FALSE otherwise.

Function: VidyoRoomGetHistoryByTime

Member Of:

VidyoRoom

Description:

Gets the history of the room before and after the messageId.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomGetHistoryByTime(VidyoRoom *r, LmiTime time, LmiUint32 numMessagesBefore, LmiUint32 numMessagesAfter, VidyoRoomOnGetHistoryResults onGetHistoryResults)

Parameters:

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.

Returns:

LMI_TRUE if the operation is successful, LMI_FALSE otherwise.

Function: VidyoRoomGetId

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

const LmiString* VidyoRoomGetId(const VidyoRoom* r)

Parameters:

r

Returns:

Function: VidyoRoomGetRoomProperties

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomGetRoomProperties(VidyoRoom* r, VidyoRoomOnGetRoomPropertiesResult onGetRoomPropertiesResult)

Parameters:

r
onGetRoomPropertiesResult Callback that is triggered when get properties operation completes.

Returns:

Function: VidyoRoomGetSelectedLocalCameras

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomGetSelectedLocalCameras(VidyoRoom *r, LmiVector(VidyoLocalCamera)* cameras)

Parameters:

r Vidyo room object.
cameras

Function: VidyoRoomGetSelectedLocalMicrophones

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomGetSelectedLocalMicrophones(VidyoRoom *r, LmiVector(VidyoLocalMicrophone)* mics)

Parameters:

r Vidyo room object.
mics

Function: VidyoRoomGetSelectedLocalMonitors

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomGetSelectedLocalMonitors(VidyoRoom *r, LmiVector(VidyoLocalMonitor)* monitors)

Parameters:

r Vidyo room object.
monitors

Function: VidyoRoomGetSelectedLocalRenderers

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomGetSelectedLocalRenderers(VidyoRoom *r, LmiVector(VidyoLocalRenderer)* renderers)

Parameters:

r Vidyo room object.
renderers

Function: VidyoRoomGetSelectedLocalSpeakers

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomGetSelectedLocalSpeakers(VidyoRoom *r, LmiVector(VidyoLocalSpeaker)* speakers)

Parameters:

r Vidyo room object.
speakers

Function: VidyoRoomGetSelectedLocalWindowShares

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomGetSelectedLocalWindowShares(VidyoRoom *r, LmiVector(VidyoLocalWindowShare)* windowShares)

Parameters:

r Vidyo room object.
windowShares

Function: VidyoRoomGetStats

Member Of:

VidyoRoom

Description:

Fill in data in VidyoRoomStats from a room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomGetStats(VidyoRoom *r, VidyoRoomStats *stats)

Parameters:

r The room object to extract stats.
stats The stats object to fill.

Returns:

LMI_TRUE on success.

Function: VidyoRoomGetType

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

VidyoRoomType VidyoRoomGetType(const VidyoRoom* r)

Parameters:

r

Returns:

Function: VidyoRoomGetUser

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

VidyoUser *VidyoRoomGetUser(VidyoRoom *r)

Parameters:

r

Returns:

Function: VidyoRoomGetUserData

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiVoidPtr VidyoRoomGetUserData(const VidyoRoom* r)

Parameters:

r

Returns:

Function: VidyoRoomHideStatisticsDialog

Member Of:

VidyoRoom

Description:

Hides statistics for a room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomHideStatisticsDialog(VidyoRoom *r)

Parameters:

r Vidyo room object.

Function: VidyoRoomInvite

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomInvite(VidyoRoom* r, const LmiString* userId, const char* message)

Parameters:

r
userId
message

Returns:

Function: VidyoRoomInviteAll

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomInviteAll(VidyoRoom* r, const char* message)

Parameters:

r
message

Returns:

Function: VidyoRoomInviteN

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomInviteN(VidyoRoom* r, const LmiVector(LmiString)* userIds, const char* message)

Parameters:

r
userIds
message

Returns:

Function: VidyoRoomLeave

Member Of:

VidyoRoom

Description:

Leaves the room. This triggers VidyoRoomOnExited.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomLeave(VidyoRoom* r)

Parameters:

r

Returns:

Function: VidyoRoomMessageSearch

Member Of:

VidyoRoom

Description:

Searches the room for text messages.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomMessageSearch(VidyoRoom *r, const char* searchText, LmiUint index, LmiUint pageSize, VidyoRoomOnMessageSearchResults onMessageSearchResults)

Parameters:

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.

Returns:

Function: VidyoRoomRegisterMessageEventListener

Member Of:

VidyoRoom

Description:

Registers to get notified about message events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomRegisterMessageEventListener(VidyoRoom* r, VidyoRoomOnMessageReceived onMessageReceived, VidyoRoomOnMessageAcknowledged onMessageAcknowledged, VidyoRoomOnMessageRead onMessageRead, VidyoRoomOnMessageTypingIndication onMessageTypingIndication)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoRoomRegisterParticipantEventListener

Member Of:

VidyoRoom

Description:

Registers to get notified about participant events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomRegisterParticipantEventListener(VidyoRoom* r, VidyoRoomOnParticipantJoined onParticipantJoined, VidyoRoomOnParticipantLeft onParticipantLeft, VidyoRoomOnDynamicParticipantChanged onDynamicParticipantChanged, VidyoRoomOnLoudestParticipantChanged onLoudestParticipantChanged)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoRoomRegisterRecoderInCallEventListener

Member Of:

VidyoRoom

Description:

Registers to get notified when a a call is being recorded.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomRegisterRecoderInCallEventListener(VidyoRoom* r, VidyoRoomRecorderInCall onRecorderInCallChanged)

Parameters:

r The VidyoRoom object.
onRecorderInCallChanged Callback that is triggered when a recorder joins or leaves the call.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoRoomRegisterResourceManagerEventListener

Member Of:

VidyoRoom

Description:

Registers to get notified about resource-management events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomRegisterResourceManagerEventListener(VidyoRoom* r, VidyoRoomOnAvailableResourcesChanged onAvailableResourcesChanged, VidyoRoomOnMaxRemoteSourcesChanged onMaxRemoteSourcesChanged)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoRoomRegisterRoomPropertiesEventListener

Member Of:

VidyoRoom

Description:

Registers to get notified about participant events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomRegisterRoomPropertiesEventListener(VidyoRoom* r, VidyoRoomOnRoomPropertiesChanged onRoomPropertiesChanged)

Parameters:

r The VidyoRoom object.
onRoomPropertiesChanged Callback that is triggered when room properties have changed.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoRoomRegisterSubjectEventListener

Member Of:

VidyoRoom

Description:

Registers to get notified about subject events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomRegisterSubjectEventListener(VidyoRoom* r, VidyoRoomOnSetSubject onSetSubject)

Parameters:

r The VidyoRoom object.
onSetSubject Callback that is triggered when the subject has been changed.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoRoomRejectIncoming

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomRejectIncoming(VidyoRoom* r)

Parameters:

r

Returns:

Function: VidyoRoomRemoveLocalCamera

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomRemoveLocalCamera(VidyoRoom *r, const VidyoLocalCamera *localCamera)

Parameters:

r Vidyo room object.
localCamera

Function: VidyoRoomRemoveLocalMicrophone

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomRemoveLocalMicrophone(VidyoRoom *r, const VidyoLocalMicrophone *localMicrophone)

Parameters:

r Vidyo room object.
localMicrophone

Function: VidyoRoomRemoveLocalMonitor

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomRemoveLocalMonitor(VidyoRoom *r, const VidyoLocalMonitor *localMonitor)

Parameters:

r Vidyo room object.
localMonitor

Function: VidyoRoomRemoveLocalRenderer

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomRemoveLocalRenderer(VidyoRoom *r, const VidyoLocalRenderer *localRenderer)

Parameters:

r Vidyo room object.
localRenderer

Function: VidyoRoomRemoveLocalSpeaker

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomRemoveLocalSpeaker(VidyoRoom *r, const VidyoLocalSpeaker *localSpeaker)

Parameters:

r Vidyo room object.
localSpeaker

Function: VidyoRoomRemoveLocalWindowShare

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomRemoveLocalWindowShare(VidyoRoom *r, const VidyoLocalWindowShare *localWindowShare)

Parameters:

r Vidyo room object.
localWindowShare

Function: VidyoRoomSendMessage

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomSendMessage(VidyoRoom* r, const char* message)

Parameters:

r
message

Returns:

Function: VidyoRoomSendMessageAcknowledged

Member Of:

VidyoRoom

Description:

Send the acknowledgement to message in a conference room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomSendMessageAcknowledged(VidyoRoom *r, LmiInt64 messageId)

Parameters:

r The room object.
messageId The message id of message being acknowledged.

Returns:

LMI_TRUE on success, LMI_FALSE if the server doesn't support the feature.

Note 1:

This function is used to acknowledge all the messages until the curser specified by messageId.

Function: VidyoRoomSendMessageTypingIndication

Member Of:

VidyoRoom

Description:

Send a typing indication state to all participants of a room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomSendMessageTypingIndication(VidyoRoom *r, VidyoChatMessageTypingIndication typingIndication)

Parameters:

r The room object.
typingIndication The typing indication state.

Returns:

LMI_TRUE on success, LMI_FALSE on an error.

Function: VidyoRoomSetDynamicGenerationPosition

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomSetDynamicGenerationPosition(VidyoRoom *r, LmiUint generation, LmiInt x, LmiInt y, LmiUint width, LmiUint height, LmiTime frameInterval)

Parameters:

r
generation
x
y
width
height
frameInterval

Returns:

Function: VidyoRoomSetDynamicLocalRenderer

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomSetDynamicLocalRenderer(VidyoRoom* r, const VidyoLocalRenderer* renderer)

Parameters:

r
renderer

Returns:

Function: VidyoRoomSetFavorite

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomSetFavorite(VidyoRoom *r, LmiBool isFavorite, VidyoRoomOnSetFavoriteResult onSetFavoriteResult)

Parameters:

r Vidyo room object.
isFavorite
onSetFavoriteResult Callback that is triggered when set favorite operation completes.

Function: VidyoRoomSetMaxAudioSources

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomSetMaxAudioSources(VidyoRoom* r, LmiUint count)

Parameters:

r
count

Returns:

Function: VidyoRoomSetMaxVideoSources

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomSetMaxVideoSources(VidyoRoom* r, LmiUint count)

Parameters:

r
count

Returns:

Function: VidyoRoomSetRoomProperties

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomSetRoomProperties(VidyoRoom* r, const VidyoRoomProperties *roomProperties, VidyoRoomOnSetRoomPropertiesResult onSetRoomPropertiesResult)

Parameters:

r
roomProperties
onSetRoomPropertiesResult Callback that is triggered when set properties operation completes.

Returns:

Function: VidyoRoomSetSubject

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomSetSubject(VidyoRoom* r, const char* subject)

Parameters:

r
subject

Returns:

Function: VidyoRoomSetUserData

Member Of:

VidyoRoom

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomSetUserData(VidyoRoom* r, LmiVoidPtr userData)

Parameters:

r
userData

Function: VidyoRoomShowStatisticsDialog

Member Of:

VidyoRoom

Description:

Shows statistics for a room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoRoomShowStatisticsDialog(VidyoRoom *r)

Parameters:

r Vidyo room object.

Note 1:

The dialog is a platform-specific native window that will pop up outside of the application.

Function: VidyoRoomUnregisterMessageEventListener

Member Of:

VidyoRoom

Description:

Unregisters message event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomUnregisterMessageEventListener(VidyoRoom* r)

Parameters:

r The VidyoRoom object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoRoomUnregisterParticipantEventListener

Member Of:

VidyoRoom

Description:

Unregisters participant event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomUnregisterParticipantEventListener(VidyoRoom* r)

Parameters:

r The VidyoRoom object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoRoomUnregisterRecoderInCallEventListener

Member Of:

VidyoRoom

Description:

Unregisters recorder in call event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomUnregisterRecoderInCallEventListener(VidyoRoom* r)

Parameters:

r The VidyoRoom object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoRoomUnregisterResourceManagerEventListener

Member Of:

VidyoRoom

Description:

Unregisters resource manager event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomUnregisterResourceManagerEventListener(VidyoRoom* r)

Parameters:

r The VidyoRoom object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoRoomUnregisterRoomPropertiesEventListener

Member Of:

VidyoRoom

Description:

Unregisters room properties event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomUnregisterRoomPropertiesEventListener(VidyoRoom* r)

Parameters:

r The VidyoRoom object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoRoomUnregisterSubjectEventListener

Member Of:

VidyoRoom

Description:

Unregisters subject event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoRoomUnregisterSubjectEventListener(VidyoRoom* r)

Parameters:

r The VidyoRoom object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoUserAddRosterContact

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserAddRosterContact(VidyoUser* u, const LmiString* userId)

Parameters:

u
userId

Returns:

Function: VidyoUserAdvancedSearchRooms

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserAdvancedSearchRooms(VidyoUser* u, const LmiVector(VidyoRoomSearchField)* fieldSet, const LmiVector(VidyoRoomSearchFieldRelation)* fieldRelations, const LmiVector(LmiString)* fieldValues, const char* searchToken, LmiUint index, LmiUint pageSize, VidyoUserOnRoomSearchResults onRoomSearchResults)

Parameters:

u
fieldSet
fieldRelations
fieldValues
searchToken
index
pageSize
onRoomSearchResults Callback that is triggered when the room search results are ready.

Returns:

Function: VidyoUserAdvancedSearchUsers

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserAdvancedSearchUsers(VidyoUser* u, const LmiVector(VidyoUserSearchField)* fieldSet, const LmiVector(LmiString)* fieldValues, const char* searchToken, LmiUint index, LmiUint pageSize, VidyoUserOnUserSearchResults onUserSearchResults)

Parameters:

u
fieldSet
fieldValues
searchToken
index
pageSize
onUserSearchResults Callback that is triggered when the user search results are ready.

Returns:

Function: VidyoUserAllowSubscriber

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserAllowSubscriber(VidyoUser* u, const LmiString* userId)

Parameters:

u
userId

Returns:

Function: VidyoUserBlockSubscriber

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserBlockSubscriber(VidyoUser* u, const LmiString* userId)

Parameters:

u
userId

Returns:

Function: VidyoUserConstruct

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

VidyoUser* VidyoUserConstruct(VidyoUser* user, VidyoEndpoint* endpoint, LmiAllocator* alloc)

Parameters:

user
endpoint
alloc

Returns:

Function: VidyoUserConstructCopy

Member Of:

VidyoUser

Description:

Constructs an VidyoUser object as a copy of another.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

VidyoUser *VidyoUserConstructCopy(VidyoUser *obj, const VidyoUser *other)

Parameters:

obj The VidyoUser object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoUserCreateCall

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserCreateCall(VidyoUser* u, const LmiString *userId, LmiString *createToken, VidyoUserOnCallCreated onCallCreated)

Parameters:

u
userId
createToken
onCallCreated Callback that is triggered when the call creation results are ready.

Returns:

Function: VidyoUserCreateRoomFromId

Member Of:

VidyoUser

Description:

Finds and existing room with the id specified and privdes a new VidyoRoom object in the VidyoUserFeedbackRoomCreated callback.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserCreateRoomFromId(VidyoUser *u, const char *id, LmiString *createToken, VidyoUserOnRoomCreated onRoomCreated)

Parameters:

u
id
createToken
onRoomCreated Callback that is triggered when the room creation results are ready.

Returns:

Note 1:

If the room with the specified id does not exist, the VidyoUserFeedbackRoomCreated callback will return failure.

Function: VidyoUserCreateRoomWithId

Member Of:

VidyoUser

Description:

Gets a room with the id specified and privdes a new VidyoRoom object in the VidyoUserFeedbackRoomCreated callback.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserCreateRoomWithId(VidyoUser *u, const char *id, const char *createToken, VidyoUserOnRoomCreated onRoomCreated)

Parameters:

u
id
createToken
onRoomCreated Callback that is triggered when the room creation results are ready.

Returns:

Note 1:

If the room with the specified id does not exist it will be created with default properties.

Function: VidyoUserCreateTopicRoom

Member Of:

VidyoUser

Description:

Creates a new topic room and privdes a new VidyoRoom object in the VidyoUserFeedbackRoomCreated callback.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserCreateTopicRoom(VidyoUser *u, const char *name, const char *description, LmiString *createToken, VidyoUserOnRoomCreated onRoomCreated)

Parameters:

u
name
description
createToken
onRoomCreated Callback that is triggered when the room creation results are ready.

Returns:

Function: VidyoUserDestruct

Member Of:

VidyoUser

Description:

Destructs an VidyoUser object.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoUserDestruct(VidyoUser *obj)

Parameters:

obj The VidyoUser object to destruct.

Function: VidyoUserGetContact

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserGetContact(VidyoUser* u, const LmiString* userId, VidyoUserOnGetContactResult onGetContactResult)

Parameters:

u
userId
onGetContactResult Callback that is triggered when the contact search results are ready.

Returns:

Function: VidyoUserGetConversationRoom

Member Of:

VidyoUser

Description:

Finds a Conversation room and privdes a new VidyoRoom object in the VidyoUserFeedbackRoomCreated callback.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserGetConversationRoom(VidyoUser *u, const LmiVector(LmiString) *userIds, LmiString *createToken, VidyoUserOnRoomCreated onRoomCreated)

Parameters:

u
userIds
createToken
onRoomCreated Callback that is triggered when the room creation results are ready.

Returns:

Note 1:

This methos has a "Get or Create" semantic since Conversation rooms are auto-created.

Function: VidyoUserGetCurrentRoster

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserGetCurrentRoster(VidyoUser* u, LmiVector(VidyoContact)* roster)

Parameters:

u
roster

Returns:

Function: VidyoUserGetEndpoint

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

VidyoEndpoint* VidyoUserGetEndpoint(VidyoUser* u)

Parameters:

u

Returns:

Function: VidyoUserGetFavoriteRooms

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserGetFavoriteRooms(VidyoUser* u, LmiUint index, LmiUint pageSize, VidyoUserOnFavoriteRoomResults onFavoriteRoomResults)

Parameters:

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.

Returns:

Function: VidyoUserGetId

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

const LmiString *VidyoUserGetId(const VidyoUser* u)

Parameters:

u

Returns:

The ID of the user

Function: VidyoUserGetRecentRooms

Member Of:

VidyoUser

Description:

Get the recent rooms of the user.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserGetRecentRooms(VidyoUser* u, LmiUint index, LmiUint pageSize, VidyoUserOnRecentRoomResults onRecentRoomResults)

Parameters:

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.

Returns:

Function: VidyoUserGetStats

Member Of:

VidyoUser

Description:

Fill in data in VidyoUserStats from a room.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserGetStats(VidyoUser *r, VidyoUserStats *stats)

Parameters:

r The user object to extract stats.
stats The stats object to fill.

Returns:

LMI_TRUE on success.

Function: VidyoUserLogin

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserLogin(VidyoUser* u, const char* username, const char* password, const char* host, LmiUint port, const char* serviceType, VidyoUserOnLoginComplete onLoginComplete, VidyoUserOnLoggedOut onLoggedOut, VidyoUserOnConnectionStatusChanged onConnectionStatusChanged, VidyoUserOnTokenReceived onTokenReceived, VidyoUserOnWebProxyCredentialsRequest onWebProxyCredentialsRequest)

Parameters:

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.

Returns:

Function: VidyoUserLoginAsGuest

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserLoginAsGuest(VidyoUser* u, const char* displayName, const char* host, LmiUint port, const char* serviceType, VidyoUserOnLoginComplete onLoginComplete, VidyoUserOnLoggedOut onLoggedOut, VidyoUserOnConnectionStatusChanged onConnectionStatusChanged, VidyoUserOnTokenReceived onTokenReceived, VidyoUserOnWebProxyCredentialsRequest onWebProxyCredentialsRequest)

Parameters:

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.

Returns:

Function: VidyoUserLoginWithAccessToken

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserLoginWithAccessToken(VidyoUser* u, const char* accessToken, const char* host, LmiUint port, const char* serviceType, VidyoUserOnLoginComplete onLoginComplete, VidyoUserOnLoggedOut onLoggedOut, VidyoUserOnConnectionStatusChanged onConnectionStatusChanged, VidyoUserOnTokenReceived onTokenReceived, VidyoUserOnWebProxyCredentialsRequest onWebProxyCredentialsRequest)

Parameters:

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.

Returns:

Note 1:

A Tenant token should only be used when logging into vidyo.io or similar service

Function: VidyoUserLoginWithRefreshToken

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserLoginWithRefreshToken(VidyoUser* u, const char* refreshToken, const char* host, LmiUint port, const char* serviceType, VidyoUserOnLoginComplete onLoginComplete, VidyoUserOnLoggedOut onLoggedOut, VidyoUserOnConnectionStatusChanged onConnectionStatusChanged, VidyoUserOnTokenReceived onTokenReceived, VidyoUserOnWebProxyCredentialsRequest onWebProxyCredentialsRequest)

Parameters:

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.

Returns:

Note 1:

A Refresh token should only be used when LoginWithAccessToken failed

Function: VidyoUserLoginWithTenantToken

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserLoginWithTenantToken(VidyoUser* u, const char* provisionToken, const char* host, LmiUint port, const char* serviceType, VidyoUserOnLoginComplete onLoginComplete, VidyoUserOnLoggedOut onLoggedOut, VidyoUserOnConnectionStatusChanged onConnectionStatusChanged, VidyoUserOnTokenReceived onTokenReceived, VidyoUserOnWebProxyCredentialsRequest onWebProxyCredentialsRequest)

Parameters:

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.

Returns:

Function: VidyoUserLogout

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserLogout(VidyoUser* user)

Parameters:

user

Returns:

Function: VidyoUserRegisterCallEventListener

Member Of:

VidyoUser

Description:

Registers to get notified about invite to call events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserRegisterCallEventListener(VidyoUser* u, VidyoUserOnCallCreatedByInvite onCallCreatedByInvite)

Parameters:

u The VidyoUser object.
onCallCreatedByInvite Callback that is triggered when the user is being invited to a call.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoUserRegisterContactEventListener

Member Of:

VidyoUser

Description:

Registers to get notified about contact events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserRegisterContactEventListener(VidyoUser* u, VidyoUserOnUpdateSelf onUpdateSelf, VidyoUserOnUpdateRosterContact onUpdateRosterContact, VidyoUserOnRemoveRosterContact onRemoveRosterContact)

Parameters:

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 .

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoUserRegisterLicenseEventListener

Member Of:

VidyoUser

Description:

Registers to get notified about license events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserRegisterLicenseEventListener(VidyoUser* u, VidyoUserOnLicenseReceived onLicenseReceived, VidyoUserOnGetLicenseKey onGetLicenseKey)

Parameters:

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.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoUserRegisterRoomEventListener

Member Of:

VidyoUser

Description:

Registers to get notified about invite to room events.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserRegisterRoomEventListener(VidyoUser* u, VidyoUserOnRoomCreatedByInvite onRoomCreatedByInvite)

Parameters:

u The VidyoUser object.
onRoomCreatedByInvite Callback that is triggered when the user is being invited to a room.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoUserRemoveRosterContact

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserRemoveRosterContact(VidyoUser* u, const LmiString* userId)

Parameters:

u
userId

Returns:

Function: VidyoUserSearchConversationRooms

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserSearchConversationRooms(VidyoUser* u, const char* searchText, LmiUint index, LmiUint pageSize, VidyoUserOnRoomSearchResults onRoomSearchResults)

Parameters:

u
searchText
index
pageSize
onRoomSearchResults Callback that is triggered when the room search results are ready.

Returns:

Function: VidyoUserSearchRooms

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserSearchRooms(VidyoUser* u, const char* searchText, LmiUint index, LmiUint pageSize, VidyoUserOnRoomSearchResults onRoomSearchResults)

Parameters:

u
searchText
index
pageSize
onRoomSearchResults Callback that is triggered when the room search results are ready.

Returns:

Function: VidyoUserSearchRoomsWithName

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserSearchRoomsWithName(VidyoUser* u, const char* searchText, LmiUint index, LmiUint pageSize, VidyoUserOnRoomSearchResults onRoomSearchResults)

Parameters:

u
searchText
index
pageSize
onRoomSearchResults Callback that is triggered when the room search results are ready.

Returns:

Function: VidyoUserSearchRoomsWithOwner

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserSearchRoomsWithOwner(VidyoUser* u, const char* searchText, LmiUint index, LmiUint pageSize, VidyoUserOnRoomSearchResults onRoomSearchResults)

Parameters:

u
searchText
index
pageSize
onRoomSearchResults Callback that is triggered when the room search results are ready.

Returns:

Function: VidyoUserSearchRoomsWithSubject

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserSearchRoomsWithSubject(VidyoUser* u, const char* searchText, LmiUint index, LmiUint pageSize, VidyoUserOnRoomSearchResults onRoomSearchResults)

Parameters:

u
searchText
index
pageSize
onRoomSearchResults Callback that is triggered when the room search results are ready.

Returns:

Function: VidyoUserSearchTopicRooms

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserSearchTopicRooms(VidyoUser* u, const char* searchText, LmiUint index, LmiUint pageSize, VidyoUserOnRoomSearchResults onRoomSearchResults)

Parameters:

u
searchText
index
pageSize
onRoomSearchResults Callback that is triggered when the room search results are ready.

Returns:

Function: VidyoUserSearchUsers

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserSearchUsers(VidyoUser* u, const char* searchText, LmiUint index, LmiUint pageSize, VidyoUserOnUserSearchResults onUserSearchResults)

Parameters:

u
searchText
index
pageSize
onUserSearchResults Callback that is triggered when the user search results are ready.

Returns:

Function: VidyoUserSetCA

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoUserSetCA(VidyoUser* u, const char* ca, const char* caFilePath, const char* caDir)

Parameters:

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.

Function: VidyoUserSetDisplayName

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoUserSetDisplayName(VidyoUser* u, const char* displayName)

Parameters:

u
displayName

Function: VidyoUserSetWebProxyAddressCredentials

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

void VidyoUserSetWebProxyAddressCredentials(VidyoUser* u, const char* proxyAddress, const char* username, const char* password)

Parameters:

u
proxyAddress
username
password

Function: VidyoUserUnregisterCallEventListener

Member Of:

VidyoUser

Description:

Unregisters call event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserUnregisterCallEventListener(VidyoUser* u)

Parameters:

u The VidyoUser object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoUserUnregisterContactEventListener

Member Of:

VidyoUser

Description:

Unregisters contact event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserUnregisterContactEventListener(VidyoUser* u)

Parameters:

u The VidyoUser object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoUserUnregisterLicenseEventListener

Member Of:

VidyoUser

Description:

Unregisters license event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserUnregisterLicenseEventListener(VidyoUser* u)

Parameters:

u The VidyoUser object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoUserUnregisterRoomEventListener

Member Of:

VidyoUser

Description:

Unregisters room event notifications.

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserUnregisterRoomEventListener(VidyoUser* u)

Parameters:

u The VidyoUser object.

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoUserUpdatePresence

Member Of:

VidyoUser

Description:

Include:

Lmi/VidyoClient/VidyoEndpoint.h

Library:

VidyoClient

Syntax:

LmiBool VidyoUserUpdatePresence(VidyoUser* u, VidyoContactPresenceState state, const char *status)

Parameters:

u
state
status

Returns:

Function: VidyoVirtualDeviceManagerConstructCopy

Member Of:

VidyoVirtualDeviceManager

Description:

Constructs an VidyoVirtualDeviceManager object as a copy of another.

Include:

Lmi/VidyoClient/VidyoVirtualDeviceManager.h

Library:

VidyoClient

Syntax:

VidyoVirtualDeviceManager* VidyoVirtualDeviceManagerConstructCopy(VidyoVirtualDeviceManager* obj, const VidyoVirtualDeviceManager* other)

Parameters:

obj The VidyoVirtualDeviceManager object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoVirtualDeviceManagerDestruct

Member Of:

VidyoVirtualDeviceManager

Description:

Destructs an VidyoVirtualDeviceManager object.

Include:

Lmi/VidyoClient/VidyoVirtualDeviceManager.h

Library:

VidyoClient

Syntax:

void VidyoVirtualDeviceManagerDestruct(VidyoVirtualDeviceManager* obj)

Parameters:

obj The VidyoVirtualDeviceManager object to destruct.

Function: VidyoVirtualDeviceManagerLocalCameraEvent

Member Of:

VidyoVirtualDeviceManager

Description:

Include:

Lmi/VidyoClient/VidyoVirtualDeviceManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoVirtualDeviceManagerLocalCameraEvent(VidyoVirtualDeviceManager* m, VidyoEndpoint* endpoint, const VidyoLocalCamera* camera, VidyoDeviceState state)

Parameters:

m
endpoint
camera
state

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoVirtualDeviceManagerLocalMicrophoneEvent

Member Of:

VidyoVirtualDeviceManager

Description:

Include:

Lmi/VidyoClient/VidyoVirtualDeviceManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoVirtualDeviceManagerLocalMicrophoneEvent(VidyoVirtualDeviceManager* m, VidyoEndpoint* endpoint, const VidyoLocalMicrophone* microphone, VidyoDeviceState state)

Parameters:

m
endpoint
microphone
state

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoVirtualDeviceManagerLocalSpeakerEvent

Member Of:

VidyoVirtualDeviceManager

Description:

Include:

Lmi/VidyoClient/VidyoVirtualDeviceManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoVirtualDeviceManagerLocalSpeakerEvent(VidyoVirtualDeviceManager* m, VidyoEndpoint* endpoint, const VidyoLocalSpeaker* speaker, VidyoDeviceState state)

Parameters:

m
endpoint
speaker
state

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoVirtualDeviceManagerMediaFailedEvent

Member Of:

VidyoVirtualDeviceManager

Description:

Include:

Lmi/VidyoClient/VidyoVirtualDeviceManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoVirtualDeviceManagerMediaFailedEvent(VidyoVirtualDeviceManager* m, VidyoEndpoint* endpoint)

Parameters:

m
endpoint

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoVirtualShareManagerConstructCopy

Member Of:

VidyoVirtualShareManager

Description:

Constructs an VidyoVirtualShareManager object as a copy of another.

Include:

Lmi/VidyoClient/VidyoVirtualShareManager.h

Library:

VidyoClient

Syntax:

VidyoVirtualShareManager* VidyoVirtualShareManagerConstructCopy(VidyoVirtualShareManager* obj, const VidyoVirtualShareManager* other)

Parameters:

obj The VidyoVirtualShareManager object to construct.
other The call object to make a copy of.

Returns:

A pointer to a constructed object on success, or NULL on failure.

Function: VidyoVirtualShareManagerDestruct

Member Of:

VidyoVirtualShareManager

Description:

Destructs an VidyoVirtualShareManager object.

Include:

Lmi/VidyoClient/VidyoVirtualShareManager.h

Library:

VidyoClient

Syntax:

void VidyoVirtualShareManagerDestruct(VidyoVirtualShareManager* obj)

Parameters:

obj The VidyoVirtualShareManager object to destruct.

Function: VidyoVirtualShareManagerLocalMonitorEvent

Member Of:

VidyoVirtualShareManager

Description:

Include:

Lmi/VidyoClient/VidyoVirtualShareManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoVirtualShareManagerLocalMonitorEvent(VidyoVirtualShareManager* m, VidyoEndpoint* endpoint, const VidyoLocalMonitor* monitor, VidyoDeviceState state)

Parameters:

m
endpoint
monitor
state

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoVirtualShareManagerLocalWindowShareEvent

Member Of:

VidyoVirtualShareManager

Description:

Include:

Lmi/VidyoClient/VidyoVirtualShareManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoVirtualShareManagerLocalWindowShareEvent(VidyoVirtualShareManager* m, VidyoEndpoint* endpoint, const VidyoLocalWindowShare* windowShare, VidyoDeviceState state)

Parameters:

m
endpoint
windowShare
state

Returns:

LMI_TRUE on success, LMI_FALSE on failure.

Function: VidyoVirtualShareManagerMediaFailedEvent

Member Of:

VidyoVirtualShareManager

Description:

Include:

Lmi/VidyoClient/VidyoVirtualShareManager.h

Library:

VidyoClient

Syntax:

LmiBool VidyoVirtualShareManagerMediaFailedEvent(VidyoVirtualShareManager* m, VidyoEndpoint* endpoint)

Parameters:

m
endpoint

Returns:

LMI_TRUE on success, LMI_FALSE on failure.