Introduction
This guide describes Vidyo’s client library, which allows developers to add real-time communication capabilities to their applications using a simple API that spans multiple platforms (Windows, Mac, Linux, iOS, Android) and languages (C, Objective-C, C#, Java, Javascript).
Legal Notice
(c) 2006-2018 Vidyo Inc.,
433 Hackensack Avenue,
Hackensack, NJ 07601.
All rights reserved.
The information contained herein is proprietary to Vidyo, Inc. and shall not be reproduced, copied (in whole or in part), adapted, modified, disseminated, transmitted, transcribed, stored in a retrieval system, or translated into any language in any form by any means without the express written consent of Vidyo, Inc.
VidyoConnector
The videoconferencing API that handles all aspects of the media (audio/video) connection.
Constructor
Syntax
VidyoConnector* VidyoConnectorConstruct(VidyoConnector* c, const LmiViewId* viewId, VidyoConnectorViewStyle viewStyle, LmiUint remoteParticipants, const char* logFileFilter, const char* logFileName, const LmiVoidPtr userData)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| viewId |
const LmiViewId* |
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. When running custom layout on macOS, the core animation layer should be disabled on this view. |
| viewStyle |
VidyoConnectorViewStyle |
Type of the composite renderer which represents the visual style and behaviour. |
| remoteParticipants |
LmiUint |
Number of remote participants to composite into the window. Setting the value to 0 (zero) will render the preview only. |
| logFileFilter |
const char* |
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 |
const char* |
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 |
const LmiVoidPtr |
Arbitrary user data that can be retrieved later. |
Returns
| Type |
Description |
| VidyoConnector* |
The constructed object on success. NULL on failure. |
Enumerations
VidyoConnector : VidyoConnectorBaseTransportType
Base transport type.
Syntax
VidyoConnectorBaseTransportType
Values
| Name |
Description |
| VIDYO_CONNECTORBASETRANSPORTTYPE_TLS |
Use TLS as base transport. |
| VIDYO_CONNECTORBASETRANSPORTTYPE_TCP |
Use TCP as base transport. |
| VIDYO_CONNECTORBASETRANSPORTTYPE_UDP |
Use UDP as base transport. |
VidyoConnector : VidyoConnectorDisconnectReason
Reasons why an established connection was disconnected.
Syntax
VidyoConnectorDisconnectReason
Values
| Name |
Description |
| 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. |
VidyoConnector : VidyoConnectorFailReason
Reasons why a connection attempt failed.
Syntax
VidyoConnectorFailReason
Values
| Name |
Description |
| 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. |
VidyoConnector : VidyoConnectorMode
Operating modes of a VidyoConnector object.
Syntax
VidyoConnectorMode
Values
| Name |
Description |
| VIDYO_CONNECTORMODE_Default |
The default operating mode. |
| VIDYO_CONNECTORMODE_Foreground |
Runs in the foreground. |
| VIDYO_CONNECTORMODE_Background |
Runs in the background. |
VidyoConnector : VidyoConnectorState
States of a connection, mostly representing the progress of a connection attempt.
Syntax
VidyoConnectorState
Values
| Name |
Description |
| 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 |
Successfully connected. |
VidyoConnector : VidyoConnectorTradeOffProfile
CPU tradeoff profile.
Syntax
VidyoConnectorTradeOffProfile
Values
| Name |
Description |
| VIDYO_CONNECTORTRADEOFFPROFILE_High |
High CPU usage. |
| VIDYO_CONNECTORTRADEOFFPROFILE_Medium |
Balanced CPU usage. |
| VIDYO_CONNECTORTRADEOFFPROFILE_Low |
Low CPU usage. |
VidyoConnector : VidyoConnectorViewStyle
Styles of the composite renderer, which apply to its layout and behaviour.
Syntax
VidyoConnectorViewStyle
Values
| Name |
Description |
| VIDYO_CONNECTORVIEWSTYLE_Default |
The default style. |
| VIDYO_CONNECTORVIEWSTYLE_Tiles |
Participants are shown in sizes that best reflect their order of importance. |
Methods
VidyoConnector : VidyoConnectorConnect
Connects to a live conference with the specified resourceId.
Syntax
LmiBool VidyoConnectorConnect(VidyoConnector* c, const char* host, const char* token, const char* displayName, const char* resourceId, VidyoConnectorOnSuccess onSuccess, VidyoConnectorOnFailure onFailure, VidyoConnectorOnDisconnected onDisconnected)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| host |
const char* |
Host to which the connection will be made. |
| token |
const char* |
Token generated by the backend that contains the user ID and other metadata that will be used for authentication. |
| displayName |
const char* |
A display name that will be used in the UI. |
| resourceId |
const char* |
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 |
VidyoConnectorOnSuccess |
Callback that is triggered when the connection is successfully established. |
| onFailure |
VidyoConnectorOnFailure |
Callback that is triggered when the connection establishemnt failed. |
| onDisconnected |
VidyoConnectorOnDisconnected |
Callback that is triggered when an established connection is disconnected. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnSuccess
Callback that is triggered when the connection is successfully established.
Syntax
void (*VidyoConnectorOnSuccess)(VidyoConnector* c)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
VidyoConnector : VidyoConnectorOnFailure
Callback that is triggered when the connection attempt has failed.
Syntax
void (*VidyoConnectorOnFailure)(VidyoConnector* c, VidyoConnectorFailReason reason)
Parameters
VidyoConnector : VidyoConnectorOnDisconnected
Callback that is triggered when an established connection is disconnected.
Syntax
void (*VidyoConnectorOnDisconnected)(VidyoConnector* c, VidyoConnectorDisconnectReason reason)
Parameters
VidyoConnector : VidyoConnectorRegisterLocalCameraEventListener
Registers to get notified about local camera events.
Syntax
LmiBool VidyoConnectorRegisterLocalCameraEventListener(VidyoConnector* c, VidyoConnectorOnLocalCameraAdded onAdded, VidyoConnectorOnLocalCameraRemoved onRemoved, VidyoConnectorOnLocalCameraSelected onSelected, VidyoConnectorOnLocalCameraStateUpdated onStateUpdated)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnLocalCameraAdded
Callback that is triggered each time a local camera becomes available to a VidyoConnector.
Syntax
void (*VidyoConnectorOnLocalCameraAdded)(VidyoConnector* c, VidyoLocalCamera* localCamera)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localCamera |
VidyoLocalCamera* |
Local camera that was added to the VidyoConnector. |
VidyoConnector : VidyoConnectorOnLocalCameraRemoved
Callback that is triggered each time a local camera is no longer available to a VidyoConnector.
Syntax
void (*VidyoConnectorOnLocalCameraRemoved)(VidyoConnector* c, VidyoLocalCamera* localCamera)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localCamera |
VidyoLocalCamera* |
Local camera that was removed from the VidyoConnector. |
VidyoConnector : VidyoConnectorOnLocalCameraSelected
Callback that is triggered each time there is a change in which local camera is selected for use.
Syntax
void (*VidyoConnectorOnLocalCameraSelected)(VidyoConnector* c, VidyoLocalCamera* localCamera)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localCamera |
VidyoLocalCamera* |
Local camera that was selected. NULL if none of them remain selected. |
VidyoConnector : VidyoConnectorOnLocalCameraStateUpdated
Callback that is triggered each time there is a change in the state of the camera such as being suspended or disabled.
Syntax
void (*VidyoConnectorOnLocalCameraStateUpdated)(VidyoConnector* c, VidyoLocalCamera* localCamera, VidyoDeviceState state)
Parameters
VidyoConnector : VidyoConnectorRegisterLocalCameraFrameListener
Registers to get notified about camera frames.
Syntax
LmiBool VidyoConnectorRegisterLocalCameraFrameListener(VidyoConnector* c, VidyoConnectorOnLocalCameraFrame onFrame, const VidyoLocalCamera* localCamera, LmiUint width, LmiUint height, LmiTime frameInterval)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnLocalCameraFrame
Callback that is triggered each time a local camera produces a video frame.
Syntax
void (*VidyoConnectorOnLocalCameraFrame)(VidyoConnector* c, VidyoLocalCamera* localCamera, const VidyoVideoFrame* videoFrame)
Parameters
VidyoConnector : VidyoConnectorRegisterLocalMicrophoneEnergyListener
Registers to get notified about microphone energies.
Syntax
LmiBool VidyoConnectorRegisterLocalMicrophoneEnergyListener(VidyoConnector* c, VidyoConnectorOnLocalMicrophoneEnergy onEnergy)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnLocalMicrophoneEnergy
Callback that is triggered each time a local microphone produces an audio frame with energy present.
Syntax
void (*VidyoConnectorOnLocalMicrophoneEnergy)(VidyoConnector* c, VidyoLocalMicrophone* localMicrophone, LmiInt audioEnergy)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localMicrophone |
VidyoLocalMicrophone* |
Local microphone that produced the frame. |
| audioEnergy |
LmiInt |
Energy of the audio frame in dBFS (full scale). |
VidyoConnector : VidyoConnectorRegisterLocalMicrophoneEventListener
Registers to get notified about local microphone events.
Syntax
LmiBool VidyoConnectorRegisterLocalMicrophoneEventListener(VidyoConnector* c, VidyoConnectorOnLocalMicrophoneAdded onAdded, VidyoConnectorOnLocalMicrophoneRemoved onRemoved, VidyoConnectorOnLocalMicrophoneSelected onSelected, VidyoConnectorOnLocalMicrophoneStateUpdated onStateUpdated)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnLocalMicrophoneAdded
Callback that is triggered each time a local microphone becomes available to a VidyoConnector.
Syntax
void (*VidyoConnectorOnLocalMicrophoneAdded)(VidyoConnector* c, VidyoLocalMicrophone* localMicrophone)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localMicrophone |
VidyoLocalMicrophone* |
Local microphone that was added to the VidyoConnector. |
VidyoConnector : VidyoConnectorOnLocalMicrophoneRemoved
Callback that is triggered each time a local microphone is no longer available to a VidyoConnector.
Syntax
void (*VidyoConnectorOnLocalMicrophoneRemoved)(VidyoConnector* c, VidyoLocalMicrophone* localMicrophone)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localMicrophone |
VidyoLocalMicrophone* |
Local microphone that was removed from the VidyoConnector. |
VidyoConnector : VidyoConnectorOnLocalMicrophoneSelected
Callback that is triggered each time there is a change in which local microphone is selected for use.
Syntax
void (*VidyoConnectorOnLocalMicrophoneSelected)(VidyoConnector* c, VidyoLocalMicrophone* localMicrophone)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localMicrophone |
VidyoLocalMicrophone* |
Local microphone that was selected. NULL if none of them remain selected. |
VidyoConnector : VidyoConnectorOnLocalMicrophoneStateUpdated
Callback that is triggered each time there is a change in the state of the microphone such as being suspended or disabled.
Syntax
void (*VidyoConnectorOnLocalMicrophoneStateUpdated)(VidyoConnector* c, VidyoLocalMicrophone* localMicrophone, VidyoDeviceState state)
Parameters
VidyoConnector : VidyoConnectorRegisterLocalMicrophoneFrameListener
Registers to get notified about microphone frames.
Syntax
LmiBool VidyoConnectorRegisterLocalMicrophoneFrameListener(VidyoConnector* c, VidyoConnectorOnLocalMicrophoneFrame onFrame, const VidyoLocalMicrophone* localMicrophone)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnLocalMicrophoneFrame
Callback that is triggered each time a local microphone produces an audio frame.
Syntax
void (*VidyoConnectorOnLocalMicrophoneFrame)(VidyoConnector* c, VidyoLocalMicrophone* localMicrophone, const VidyoAudioFrame* audioFrame)
Parameters
VidyoConnector : VidyoConnectorRegisterLocalMonitorEventListener
Registers to get notified about local monitor events.
Syntax
LmiBool VidyoConnectorRegisterLocalMonitorEventListener(VidyoConnector* c, VidyoConnectorOnLocalMonitorAdded onAdded, VidyoConnectorOnLocalMonitorRemoved onRemoved, VidyoConnectorOnLocalMonitorSelected onSelected, VidyoConnectorOnLocalMonitorStateUpdated onStateUpdated)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnLocalMonitorAdded
Callback that is triggered each time a local monitor becomes available to a VidyoConnector.
Syntax
void (*VidyoConnectorOnLocalMonitorAdded)(VidyoConnector* c, VidyoLocalMonitor* localMonitor)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localMonitor |
VidyoLocalMonitor* |
Local monitor that was added to the VidyoConnector. |
VidyoConnector : VidyoConnectorOnLocalMonitorRemoved
Callback that is triggered each time a local monitor is no longer available to a VidyoConnector.
Syntax
void (*VidyoConnectorOnLocalMonitorRemoved)(VidyoConnector* c, VidyoLocalMonitor* localMonitor)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localMonitor |
VidyoLocalMonitor* |
Local monitor that was removed from the VidyoConnector. |
VidyoConnector : VidyoConnectorOnLocalMonitorSelected
Callback that is triggered each time there is a change in which local monitor is selected for sharing.
Syntax
void (*VidyoConnectorOnLocalMonitorSelected)(VidyoConnector* c, VidyoLocalMonitor* localMonitor)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localMonitor |
VidyoLocalMonitor* |
Local monitor that was selected. NULL if none of them remain selected. |
VidyoConnector : VidyoConnectorOnLocalMonitorStateUpdated
Callback that is triggered each time there is a change in the state of the monitor such as being suspended or disabled.
Syntax
void (*VidyoConnectorOnLocalMonitorStateUpdated)(VidyoConnector* c, VidyoLocalMonitor* localMonitor, VidyoDeviceState state)
Parameters
VidyoConnector : VidyoConnectorRegisterLocalMonitorFrameListener
Registers to get notified about monitor frames.
Syntax
LmiBool VidyoConnectorRegisterLocalMonitorFrameListener(VidyoConnector* c, VidyoConnectorOnLocalMonitorFrame onFrame, const VidyoLocalMonitor* localMonitor, LmiUint width, LmiUint height, LmiTime frameInterval)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnLocalMonitorFrame
Callback that is triggered each time a local camera produces a video frame.
Syntax
void (*VidyoConnectorOnLocalMonitorFrame)(VidyoConnector* c, VidyoLocalMonitor* localMonitor, const VidyoVideoFrame* videoFrame)
Parameters
VidyoConnector : VidyoConnectorRegisterLocalSpeakerEventListener
Registers to get notified about local speaker events.
Syntax
LmiBool VidyoConnectorRegisterLocalSpeakerEventListener(VidyoConnector* c, VidyoConnectorOnLocalSpeakerAdded onAdded, VidyoConnectorOnLocalSpeakerRemoved onRemoved, VidyoConnectorOnLocalSpeakerSelected onSelected, VidyoConnectorOnLocalSpeakerStateUpdated onStateUpdated)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnLocalSpeakerAdded
Callback that is triggered each time a local speaker becomes available to a VidyoConnector.
Syntax
void (*VidyoConnectorOnLocalSpeakerAdded)(VidyoConnector* c, VidyoLocalSpeaker* localSpeaker)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localSpeaker |
VidyoLocalSpeaker* |
Local speaker that was added to the VidyoConnector. |
VidyoConnector : VidyoConnectorOnLocalSpeakerRemoved
Callback that is triggered each time a local speaker is no longer available to a VidyoConnector.
Syntax
void (*VidyoConnectorOnLocalSpeakerRemoved)(VidyoConnector* c, VidyoLocalSpeaker* localSpeaker)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localSpeaker |
VidyoLocalSpeaker* |
Local speaker that was removed from the VidyoConnector. |
VidyoConnector : VidyoConnectorOnLocalSpeakerSelected
Callback that is triggered each time there is a change in which local speaker is selected for use.
Syntax
void (*VidyoConnectorOnLocalSpeakerSelected)(VidyoConnector* c, VidyoLocalSpeaker* localSpeaker)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localSpeaker |
VidyoLocalSpeaker* |
Local speaker that was selected. NULL if none of them remain selected. |
VidyoConnector : VidyoConnectorOnLocalSpeakerStateUpdated
Callback that is triggered each time there is a change in the state of the speaker such as being suspended or disabled.
Syntax
void (*VidyoConnectorOnLocalSpeakerStateUpdated)(VidyoConnector* c, VidyoLocalSpeaker* localSpeaker, VidyoDeviceState state)
Parameters
VidyoConnector : VidyoConnectorRegisterLocalWindowShareEventListener
Registers to get notified about local shareable-window events.
Syntax
LmiBool VidyoConnectorRegisterLocalWindowShareEventListener(VidyoConnector* c, VidyoConnectorOnLocalWindowShareAdded onAdded, VidyoConnectorOnLocalWindowShareRemoved onRemoved, VidyoConnectorOnLocalWindowShareSelected onSelected, VidyoConnectorOnLocalWindowShareStateUpdated onStateUpdated)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnLocalWindowShareAdded
Callback that is triggered each time a local window becomes available for a VidyoConnector to share in a conference.
Syntax
void (*VidyoConnectorOnLocalWindowShareAdded)(VidyoConnector* c, VidyoLocalWindowShare* localWindowShare)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localWindowShare |
VidyoLocalWindowShare* |
Local, shareable window that was added to the VidyoConnector. |
VidyoConnector : VidyoConnectorOnLocalWindowShareRemoved
Callback that is triggered each time a local window is no longer available for a VidyoConnector to share in a conference.
Syntax
void (*VidyoConnectorOnLocalWindowShareRemoved)(VidyoConnector* c, VidyoLocalWindowShare* localWindowShare)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localWindowShare |
VidyoLocalWindowShare* |
Local window that was removed from the VidyoConnector. The window is no longer shareable. |
VidyoConnector : VidyoConnectorOnLocalWindowShareSelected
Callback that is triggered each time there is a change in which local window is selected for sharing.
Syntax
void (*VidyoConnectorOnLocalWindowShareSelected)(VidyoConnector* c, VidyoLocalWindowShare* localWindowShare)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| localWindowShare |
VidyoLocalWindowShare* |
Local window that was selected. NULL if none of them remain selected. |
VidyoConnector : VidyoConnectorOnLocalWindowShareStateUpdated
Callback that is triggered each time there is a change in the state of the window such as being suspended or disabled.
Syntax
void (*VidyoConnectorOnLocalWindowShareStateUpdated)(VidyoConnector* c, VidyoLocalWindowShare* localWindowShare, VidyoDeviceState state)
Parameters
VidyoConnector : VidyoConnectorRegisterLocalWindowShareFrameListener
Registers to get notified about window frames.
Syntax
LmiBool VidyoConnectorRegisterLocalWindowShareFrameListener(VidyoConnector* c, VidyoConnectorOnLocalWindowShareFrame onFrame, const VidyoLocalWindowShare* localWindowShare, LmiUint width, LmiUint height, LmiTime frameInterval)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnLocalWindowShareFrame
Callback that is triggered each time a local camera produces a video frame.
Syntax
void (*VidyoConnectorOnLocalWindowShareFrame)(VidyoConnector* c, VidyoLocalWindowShare* localWindowShare, const VidyoVideoFrame* videoFrame)
Parameters
VidyoConnector : VidyoConnectorRegisterLogEventListener
Registers to get notified about log events.
Syntax
LmiBool VidyoConnectorRegisterLogEventListener(VidyoConnector* c, VidyoConnectorOnLog onLog, const char* filter)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| onLog |
VidyoConnectorOnLog |
Callback that is triggered for every new log record. |
| filter |
const char* |
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
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnLog
Callback that is triggered for every log record.
Syntax
void (*VidyoConnectorOnLog)(VidyoConnector* c, const VidyoLogRecord* logRecord)
Parameters
VidyoConnector : VidyoConnectorRegisterMessageEventListener
Registers to get notified about message events.
Syntax
LmiBool VidyoConnectorRegisterMessageEventListener(VidyoConnector* c, VidyoConnectorOnChatMessageReceived onChatMessageReceived)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnChatMessageReceived
Callback that is triggered each time a chat message is received from one of the other participants.
Syntax
void (*VidyoConnectorOnChatMessageReceived)(VidyoConnector* c, const VidyoParticipant* participant, VidyoChatMessage* chatMessage)
Parameters
VidyoConnector : VidyoConnectorRegisterNetworkInterfaceEventListener
Registers to get notified about network interface events.
Syntax
LmiBool VidyoConnectorRegisterNetworkInterfaceEventListener(VidyoConnector* c, VidyoConnectorOnNetworkInterfaceAdded onAdded, VidyoConnectorOnNetworkInterfaceRemoved onRemoved, VidyoConnectorOnNetworkInterfaceSelected onSelected, VidyoConnectorOnNetworkInterfaceStateUpdated onStateUpdated)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnNetworkInterfaceAdded
Callback that is triggered each time a network interface is available to a VidyoConnector.
Syntax
void (*VidyoConnectorOnNetworkInterfaceAdded)(VidyoConnector* c, VidyoNetworkInterface* networkInterface)
Parameters
VidyoConnector : VidyoConnectorOnNetworkInterfaceRemoved
Callback that is triggered each time a network interface is no longer available to a VidyoConnector.
Syntax
void (*VidyoConnectorOnNetworkInterfaceRemoved)(VidyoConnector* c, VidyoNetworkInterface* networkInterface)
Parameters
VidyoConnector : VidyoConnectorOnNetworkInterfaceSelected
Callback that is triggered each time there is a change in which network interface is selected for use.
Syntax
void (*VidyoConnectorOnNetworkInterfaceSelected)(VidyoConnector* c, VidyoNetworkInterface* networkInterface, VidyoNetworkInterfaceTransportType transportType)
Parameters
VidyoConnector : VidyoConnectorOnNetworkInterfaceStateUpdated
Callback that is triggered each time there is a change in the state of the network interface such as being up or down.
Syntax
void (*VidyoConnectorOnNetworkInterfaceStateUpdated)(VidyoConnector* c, VidyoNetworkInterface* networkInterface, VidyoNetworkInterfaceState state)
Parameters
VidyoConnector : VidyoConnectorRegisterParticipantEventListener
Registers to get notified about participant events.
Syntax
LmiBool VidyoConnectorRegisterParticipantEventListener(VidyoConnector* c, VidyoConnectorOnParticipantJoined onJoined, VidyoConnectorOnParticipantLeft onLeft, VidyoConnectorOnDynamicParticipantChanged onDynamicChanged, VidyoConnectorOnLoudestParticipantChanged onLoudestChanged)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnParticipantJoined
Callback that is triggered each time another participant joins a conference.
Syntax
void (*VidyoConnectorOnParticipantJoined)(VidyoConnector* c, VidyoParticipant* participant)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| participant |
VidyoParticipant* |
The VidyoParticipant who joined the conference. |
VidyoConnector : VidyoConnectorOnParticipantLeft
Callback that is triggered each time an existing participant leaves a conference.
Syntax
void (*VidyoConnectorOnParticipantLeft)(VidyoConnector* c, VidyoParticipant* participant)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| participant |
VidyoParticipant* |
The VidyoParticipant who left the conference. |
VidyoConnector : VidyoConnectorOnDynamicParticipantChanged
Callback that is triggered each time the order of dyanmic participants has changed, based on active speech detection.
Syntax
void (*VidyoConnectorOnDynamicParticipantChanged)(VidyoConnector* c, LmiVector(VidyoParticipant)* participants)
Parameters
VidyoConnector : VidyoConnectorOnLoudestParticipantChanged
Callback that is triggered each time one of the other participants becomes the loudest, based on active speech detection.
Syntax
void (*VidyoConnectorOnLoudestParticipantChanged)(VidyoConnector* c, const VidyoParticipant* participant, LmiBool audioOnly)
Parameters
VidyoConnector : VidyoConnectorRegisterRecorderInCallEventListener
Registers to get notified when a recorder joins or leaves the call.
Syntax
LmiBool VidyoConnectorRegisterRecorderInCallEventListener(VidyoConnector* c, VidyoConnectorRecorderInCall onRecorderInCallChanged)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorRecorderInCall
Callback that is triggered each time a recorder joins or leaves the call.
Syntax
void (*VidyoConnectorRecorderInCall)(VidyoConnector* c, LmiBool recorderInCall)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| recorderInCall |
LmiBool |
LMI_TRUE when a recorder joined, LMI_FALSE when no recorder are in the call |
VidyoConnector : VidyoConnectorRegisterRemoteCameraEventListener
Registers to get notified about remote camera events.
Syntax
LmiBool VidyoConnectorRegisterRemoteCameraEventListener(VidyoConnector* c, VidyoConnectorOnRemoteCameraAdded onAdded, VidyoConnectorOnRemoteCameraRemoved onRemoved, VidyoConnectorOnRemoteCameraStateUpdated onStateUpdated)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnRemoteCameraAdded
Callback that is triggered each time one of the other participants adds a remote camera into a conference.
Syntax
void (*VidyoConnectorOnRemoteCameraAdded)(VidyoConnector* c, VidyoRemoteCamera* remoteCamera, const VidyoParticipant* participant)
Parameters
VidyoConnector : VidyoConnectorOnRemoteCameraRemoved
Callback that is triggered each time one of the other participants removes a remote camera from a conference.
Syntax
void (*VidyoConnectorOnRemoteCameraRemoved)(VidyoConnector* c, VidyoRemoteCamera* remoteCamera, const VidyoParticipant* participant)
Parameters
VidyoConnector : VidyoConnectorOnRemoteCameraStateUpdated
Callback that is triggered each time one of the other participants remote camera changes state in a conference.
Syntax
void (*VidyoConnectorOnRemoteCameraStateUpdated)(VidyoConnector* c, VidyoRemoteCamera* remoteCamera, const VidyoParticipant* participant, VidyoDeviceState state)
Parameters
VidyoConnector : VidyoConnectorRegisterRemoteCameraFrameListener
Registers to get notified about camera frames from other participants.
Syntax
LmiBool VidyoConnectorRegisterRemoteCameraFrameListener(VidyoConnector* c, VidyoConnectorOnRemoteCameraFrame onFrame, const VidyoRemoteCamera* remoteCamera, LmiUint width, LmiUint height, LmiTime frameInterval)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnRemoteCameraFrame
Callback that is triggered each time a remote camera produces a video frame.
Syntax
void (*VidyoConnectorOnRemoteCameraFrame)(VidyoConnector* c, VidyoRemoteCamera* remoteCamera, const VidyoParticipant* participant, const VidyoVideoFrame* videoFrame)
Parameters
VidyoConnector : VidyoConnectorRegisterRemoteMicrophoneEnergyListener
Registers to get notified about microphone energies from other participants.
Syntax
LmiBool VidyoConnectorRegisterRemoteMicrophoneEnergyListener(VidyoConnector* c, VidyoConnectorOnRemoteMicrophoneEnergy onEnergy)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnRemoteMicrophoneEnergy
Callback that is triggered each time a remote microphone produces an frame with energy.
Syntax
void (*VidyoConnectorOnRemoteMicrophoneEnergy)(VidyoConnector* c, VidyoRemoteMicrophone* remoteMicrophone, const VidyoParticipant* participant, LmiInt audioEnergy)
Parameters
VidyoConnector : VidyoConnectorRegisterRemoteMicrophoneEventListener
Registers to get notified about remote microphone events.
Syntax
LmiBool VidyoConnectorRegisterRemoteMicrophoneEventListener(VidyoConnector* c, VidyoConnectorOnRemoteMicrophoneAdded onAdded, VidyoConnectorOnRemoteMicrophoneRemoved onRemoved, VidyoConnectorOnRemoteMicrophoneStateUpdated onStateUpdated)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnRemoteMicrophoneAdded
Callback that is triggered each time one of the other participants adds a remote microphone into a conference.
Syntax
void (*VidyoConnectorOnRemoteMicrophoneAdded)(VidyoConnector* c, VidyoRemoteMicrophone* remoteMicrophone, const VidyoParticipant* participant)
Parameters
VidyoConnector : VidyoConnectorOnRemoteMicrophoneRemoved
Callback that is triggered each time one of the other participants removes a remote microphone from a conference.
Syntax
void (*VidyoConnectorOnRemoteMicrophoneRemoved)(VidyoConnector* c, VidyoRemoteMicrophone* remoteMicrophone, const VidyoParticipant* participant)
Parameters
VidyoConnector : VidyoConnectorOnRemoteMicrophoneStateUpdated
Callback that is triggered each time one of the other participants remote microphone changes state in a conference.
Syntax
void (*VidyoConnectorOnRemoteMicrophoneStateUpdated)(VidyoConnector* c, VidyoRemoteMicrophone* remoteMicrophone, const VidyoParticipant* participant, VidyoDeviceState state)
Parameters
VidyoConnector : VidyoConnectorRegisterRemoteMicrophoneFrameListener
Registers to get notified about microphone frames from other participants.
Syntax
LmiBool VidyoConnectorRegisterRemoteMicrophoneFrameListener(VidyoConnector* c, VidyoConnectorOnRemoteMicrophoneFrame onFrame, const VidyoRemoteMicrophone* remoteMicrophone)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnRemoteMicrophoneFrame
Callback that is triggered each time a remote microphone produces an audio frame.
Syntax
void (*VidyoConnectorOnRemoteMicrophoneFrame)(VidyoConnector* c, VidyoRemoteMicrophone* remoteMicrophone, const VidyoParticipant* participant, const VidyoAudioFrame* audioFrame)
Parameters
VidyoConnector : VidyoConnectorRegisterRemoteWindowShareEventListener
Registers to get notified about remote shreable-window events.
Syntax
LmiBool VidyoConnectorRegisterRemoteWindowShareEventListener(VidyoConnector* c, VidyoConnectorOnRemoteWindowShareAdded onAdded, VidyoConnectorOnRemoteWindowShareRemoved onRemoved, VidyoConnectorOnRemoteWindowShareStateUpdated onStateUpdated)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnRemoteWindowShareAdded
Callback that is triggered each time one of the other participants adds, or shares, a remote window into a conference.
Syntax
void (*VidyoConnectorOnRemoteWindowShareAdded)(VidyoConnector* c, VidyoRemoteWindowShare* remoteWindowShare, const VidyoParticipant* participant)
Parameters
VidyoConnector : VidyoConnectorOnRemoteWindowShareRemoved
Callback that is triggered each time one of the other participants removes a remote window from a conference, or stops sharing it.
Syntax
void (*VidyoConnectorOnRemoteWindowShareRemoved)(VidyoConnector* c, VidyoRemoteWindowShare* remoteWindowShare, const VidyoParticipant* participant)
Parameters
VidyoConnector : VidyoConnectorOnRemoteWindowShareStateUpdated
Callback that is triggered each time one of the other participants remote window changes state in a conference.
Syntax
void (*VidyoConnectorOnRemoteWindowShareStateUpdated)(VidyoConnector* c, VidyoRemoteWindowShare* remoteWindowShare, const VidyoParticipant* participant, VidyoDeviceState state)
Parameters
VidyoConnector : VidyoConnectorRegisterRemoteWindowShareFrameListener
Registers to get notified about window-share frames from other participants.
Syntax
LmiBool VidyoConnectorRegisterRemoteWindowShareFrameListener(VidyoConnector* c, VidyoConnectorOnRemoteWindowShareFrame onFrame, const VidyoRemoteWindowShare* remoteWindowShare, LmiUint width, LmiUint height, LmiTime frameInterval)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnRemoteWindowShareFrame
Callback that is triggered each time a remote camera produces a video frame.
Syntax
void (*VidyoConnectorOnRemoteWindowShareFrame)(VidyoConnector* c, VidyoRemoteWindowShare* remoteWindowShare, const VidyoParticipant* participant, const VidyoVideoFrame* videoFrame)
Parameters
VidyoConnector : VidyoConnectorRegisterResourceManagerEventListener
Registers to get notified about resource-management events.
Syntax
LmiBool VidyoConnectorRegisterResourceManagerEventListener(VidyoConnector* c, VidyoConnectorOnAvailableResourcesChanged onAvailableResourcesChanged, VidyoConnectorOnMaxRemoteSourcesChanged onMaxRemoteSourcesChanged)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnAvailableResourcesChanged
Callback that is triggered each time the available local resources change.
Syntax
void (*VidyoConnectorOnAvailableResourcesChanged)(VidyoConnector* c, LmiUint cpuEncode, LmiUint cpuDecode, LmiUint bandwidthSend, LmiUint bandwidthReceive)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| cpuEncode |
LmiUint |
Percent of maximum CPU available to encode the streams. |
| cpuDecode |
LmiUint |
Percent of maximum CPU available to decode the streams. |
| bandwidthSend |
LmiUint |
Percentage of maximum bandwidth avaialble to transmit the streams. |
| bandwidthReceive |
LmiUint |
Percentage of maximum bandwidth avaialble to receive the streams. |
VidyoConnector : VidyoConnectorOnMaxRemoteSourcesChanged
Callback that is triggered each time the local client’s maximum decoding capability changes.
Syntax
void (*VidyoConnectorOnMaxRemoteSourcesChanged)(VidyoConnector* c, LmiUint maxRemoteSources)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector that triggered the callback. |
| maxRemoteSources |
LmiUint |
Maximum number of remote video sources that can be recived both statically and dynamically. |
VidyoConnector : VidyoConnectorRegisterWebProxyEventListener
Registers to get notified about web proxy events.
Syntax
LmiBool VidyoConnectorRegisterWebProxyEventListener(VidyoConnector* c, VidyoConnectorOnWebProxyCredentialsRequest onWebProxyCredentialsRequest)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Callbacks
VidyoConnector : VidyoConnectorOnWebProxyCredentialsRequest
Callback that is triggered when Web Proxy Server requires password.
Syntax
void (*VidyoConnectorOnWebProxyCredentialsRequest)(VidyoConnector* c, LmiString* webProxyAddress)
Parameters
VidyoConnector : VidyoConnectorAssignViewToCompositeRenderer
Composites the preview and remote participants in a view.
Syntax
LmiBool VidyoConnectorAssignViewToCompositeRenderer(VidyoConnector* c, const LmiViewId* viewId, VidyoConnectorViewStyle viewStyle, LmiUint remoteParticipants)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| viewId |
const LmiViewId* |
A platform specific view ID where the participant will be rendered. |
| viewStyle |
VidyoConnectorViewStyle |
Type of the composite renderer which represents the visual style and behaviour. |
| remoteParticipants |
LmiUint |
Number of remote participants to composite into the window. Setting the value to 0 will render preview only. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorAssignViewToLocalCamera
Assigns the view in which to show the preview from a local camera.
Syntax
LmiBool VidyoConnectorAssignViewToLocalCamera(const VidyoConnector* c, const LmiViewId* viewId, const VidyoLocalCamera* localCamera, LmiBool displayCropped, LmiBool allowZoom)
Parameters
| Name |
Type |
Description |
| c |
const VidyoConnector* |
The VidyoConnector object. |
| viewId |
const LmiViewId* |
A platform specific view ID where the participant will be rendered. |
| localCamera |
const VidyoLocalCamera* |
The VidyoLocalCamera that will be shown. |
| displayCropped |
LmiBool |
Render the image as cropped. Otherwise letterbox. |
| allowZoom |
LmiBool |
Allow zooming of the image with mouse or touch. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorAssignViewToLocalMonitor
Shows a VidyoLocalMonitor in a view.
Syntax
LmiBool VidyoConnectorAssignViewToLocalMonitor(const VidyoConnector* c, const LmiViewId* viewId, VidyoLocalMonitor* localMonitor, LmiBool displayCropped, LmiBool allowZoom)
Parameters
| Name |
Type |
Description |
| c |
const VidyoConnector* |
The VidyoConnector object. |
| viewId |
const LmiViewId* |
A platform specific view ID where the VidyoLocalMonitor will be rendered. |
| localMonitor |
VidyoLocalMonitor* |
The VidyoLocalMonitor that will be shown. |
| displayCropped |
LmiBool |
Render the image as cropped. Otherwise letterbox. |
| allowZoom |
LmiBool |
Allow zooming of the image with mouse or touch. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorAssignViewToLocalWindowShare
Shows a VidyoLocalWindowShare in a view.
Syntax
LmiBool VidyoConnectorAssignViewToLocalWindowShare(const VidyoConnector* c, const LmiViewId* viewId, VidyoLocalWindowShare* localWindowShare, LmiBool displayCropped, LmiBool allowZoom)
Parameters
| Name |
Type |
Description |
| c |
const VidyoConnector* |
The VidyoConnector object. |
| viewId |
const LmiViewId* |
A platform specific view ID where the VidyoLocalWindowShare will be rendered. |
| localWindowShare |
VidyoLocalWindowShare* |
The VidyoLocalWindowShare that will be shown. |
| displayCropped |
LmiBool |
Render the image as cropped. Otherwise letterbox. |
| allowZoom |
LmiBool |
Allow zooming of the image with mouse or touch. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorAssignViewToRemoteCamera
Assigns the view in which to show the remote camera of one of the other participants.
Syntax
LmiBool VidyoConnectorAssignViewToRemoteCamera(const VidyoConnector* c, const LmiViewId* viewId, const VidyoRemoteCamera* remoteCamera, LmiBool displayCropped, LmiBool allowZoom)
Parameters
| Name |
Type |
Description |
| c |
const VidyoConnector* |
The VidyoConnector object. |
| viewId |
const LmiViewId* |
A platform specific view ID where the participant will be rendered. |
| remoteCamera |
const VidyoRemoteCamera* |
The VidyoRemoteCamera that will be shown. |
| displayCropped |
LmiBool |
Render the image as cropped. Otherwise letterbox. |
| allowZoom |
LmiBool |
Allow zooming of the image with mouse or touch. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorAssignViewToRemoteWindowShare
Shows a VidyoRemoteWindowShare in a view.
Syntax
LmiBool VidyoConnectorAssignViewToRemoteWindowShare(VidyoConnector* c, const LmiViewId* viewId, const VidyoRemoteWindowShare* remoteWindowShare, LmiBool displayCropped, LmiBool allowZoom)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| viewId |
const LmiViewId* |
A platform specific view ID where the VidyoRemoteWindowShare will be rendered. |
| remoteWindowShare |
const VidyoRemoteWindowShare* |
The VidyoRemoteWindowShare that will be shown. |
| displayCropped |
LmiBool |
Render the image as cropped. Otherwise letterbox. |
| allowZoom |
LmiBool |
Allow zooming of the image with mouse or touch. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorConnectToRoomAsGuestbeta
Connects to a live conference as guest with the specified room key on VidyoCloud. This API is not supported on Vidyo.io.
Syntax
LmiBool VidyoConnectorConnectToRoomAsGuest(VidyoConnector* c, const char* host, const char* displayName, const char* roomKey, VidyoConnectorOnSuccess onSuccess, VidyoConnectorOnFailure onFailure, VidyoConnectorOnDisconnected onDisconnected)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorConnectToRoomWithIdbeta
Connects to a live conference with the specified room ID on VidyoCloud. This API is not supported on Vidyo.io.
Syntax
LmiBool VidyoConnectorConnectToRoomWithId(VidyoConnector* c, const char* host, const char* userName, const char* password, const char* roomId, VidyoConnectorOnSuccess onSuccess, VidyoConnectorOnFailure onFailure, VidyoConnectorOnDisconnected onDisconnected)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorConnectToRoomWithKeybeta
Connects to a live conference with the specified room key on VidyoCloud. This API is not supported on Vidyo.io.
Syntax
LmiBool VidyoConnectorConnectToRoomWithKey(VidyoConnector* c, const char* host, const char* userName, const char* password, const char* roomKey, VidyoConnectorOnSuccess onSuccess, VidyoConnectorOnFailure onFailure, VidyoConnectorOnDisconnected onDisconnected)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorConnectToRoomWithTokenAndIdbeta
Connects to a live conference with the specified room ID on VidyoCloud. This API is not supported on Vidyo.io.
Syntax
LmiBool VidyoConnectorConnectToRoomWithTokenAndId(VidyoConnector* c, const char* host, const char* userName, const char* token, const char* roomId, VidyoConnectorOnSuccess onSuccess, VidyoConnectorOnFailure onFailure, VidyoConnectorOnDisconnected onDisconnected)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorConnectToRoomWithTokenAndKeybeta
Connects to a live conference with the specified room key.
Syntax
LmiBool VidyoConnectorConnectToRoomWithTokenAndKey(VidyoConnector* c, const char* host, const char* userName, const char* token, const char* roomKey, VidyoConnectorOnSuccess onSuccess, VidyoConnectorOnFailure onFailure, VidyoConnectorOnDisconnected onDisconnected)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorCycleCamera
Cycles camera selection to the next available camera.
Syntax
LmiBool VidyoConnectorCycleCamera(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorCycleMicrophone
Cycles microphone selection to the next available microphone.
Syntax
LmiBool VidyoConnectorCycleMicrophone(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorCycleSpeaker
Cycles speaker selection to the next available speaker.
Syntax
LmiBool VidyoConnectorCycleSpeaker(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorDisable
Disables connector object, releases all devices as precursor to destruct.
Syntax
void VidyoConnectorDisable(VidyoConnector* c)
Parameters
Returns
VidyoConnector : VidyoConnectorDisableDebug
Syntax
void VidyoConnectorDisableDebug(VidyoConnector* c)
Parameters
Returns
VidyoConnector : VidyoConnectorDisconnect
Disconnects a live conference. The onDisconnected callback will be called on successful execution.
Syntax
void VidyoConnectorDisconnect(VidyoConnector* c)
Parameters
Returns
VidyoConnector : VidyoConnectorEnableDebug
Enabled debug mode which will start debug logging and enable statistics.
Syntax
LmiBool VidyoConnectorEnableDebug(VidyoConnector* c, LmiUint port, const char* logFilter)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| port |
LmiUint |
Local listening port for debugging. |
| logFilter |
const char* |
Log filter to use on the debug port. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorGetCpuTradeOffProfile
Get current CPU tradeoff profile setting.
Syntax
VidyoConnectorTradeOffProfile VidyoConnectorGetCpuTradeOffProfile(VidyoConnector* c)
Parameters
Returns
VidyoConnector : VidyoConnectorGetState
Retrieves the state of the VidyoConnector.
Syntax
VidyoConnectorState VidyoConnectorGetState(VidyoConnector* c)
Parameters
Returns
VidyoConnector : VidyoConnectorGetStatsJson
Retrieves VidyoConnector statistics in JSON format.
Syntax
const LmiString* VidyoConnectorGetStatsJson(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| const LmiString* |
JSON encoded string on success, NULL on failure. |
VidyoConnector : VidyoConnectorGetVersion
Retrieves version of the VidyoConnector library.
Syntax
const LmiString* VidyoConnectorGetVersion(VidyoConnector* c)
Parameters
Returns
VidyoConnector : VidyoConnectorGetVersionWithoutBuildNumber
Retrieves version of the VidyoConnector library wihtout the build number.
Syntax
const LmiString* VidyoConnectorGetVersionWithoutBuildNumber(VidyoConnector* c)
Parameters
Returns
VidyoConnector : VidyoConnectorHideView
Hides a view which is used for custom layout of sources.
Syntax
LmiBool VidyoConnectorHideView(VidyoConnector* c, const LmiViewId* viewId)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectAudioContentShare
Selects the local microphone to use for audio content share.
Syntax
LmiBool VidyoConnectorSelectAudioContentShare(VidyoConnector* c, const VidyoLocalMicrophone* localMicrophone)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectDefaultCamera
Resets the camera selection to pick the Default camera.
Syntax
LmiBool VidyoConnectorSelectDefaultCamera(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectDefaultMicrophone
Resets the microphone selection to pick the Default microphone.
Syntax
LmiBool VidyoConnectorSelectDefaultMicrophone(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Selects the default ANY network interface to be used for Media.
Syntax
LmiBool VidyoConnectorSelectDefaultNetworkInterfaceForMedia(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectDefaultNetworkInterfaceForSignaling
Selects the default ANY network interface to be used for Signaling.
Syntax
LmiBool VidyoConnectorSelectDefaultNetworkInterfaceForSignaling(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectDefaultSpeaker
Resets the speaker selection to pick the Default speaker.
Syntax
LmiBool VidyoConnectorSelectDefaultSpeaker(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectLocalCamera
Selects the local camera to use.
Syntax
LmiBool VidyoConnectorSelectLocalCamera(VidyoConnector* c, const VidyoLocalCamera* localCamera)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectLocalMicrophone
Selects the local microphone to use.
Syntax
LmiBool VidyoConnectorSelectLocalMicrophone(VidyoConnector* c, const VidyoLocalMicrophone* localMicrophone)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectLocalMonitor
Selects the local monitor to share in a conference.
Syntax
LmiBool VidyoConnectorSelectLocalMonitor(VidyoConnector* c, const VidyoLocalMonitor* localMonitor)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectLocalSpeaker
Selects the local speaker to use.
Syntax
LmiBool VidyoConnectorSelectLocalSpeaker(VidyoConnector* c, const VidyoLocalSpeaker* localSpeaker)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectLocalWindowShare
Selects the local window to share in a conference.
Syntax
LmiBool VidyoConnectorSelectLocalWindowShare(VidyoConnector* c, const VidyoLocalWindowShare* localWindowShare)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
Selects the network interface to be used for Media.
Syntax
LmiBool VidyoConnectorSelectNetworkInterfaceForMedia(VidyoConnector* c, const VidyoNetworkInterface* networkInterface)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectNetworkInterfaceForSignaling
Selects the network interface to be used for Signaling.
Syntax
LmiBool VidyoConnectorSelectNetworkInterfaceForSignaling(VidyoConnector* c, const VidyoNetworkInterface* networkInterface)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSelectVideoContentShare
Selects the local camera to use for video content share.
Syntax
LmiBool VidyoConnectorSelectVideoContentShare(VidyoConnector* c, const VidyoLocalCamera* localCamera)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSendChatMessage
Sends a message to all the other participants.
Syntax
LmiBool VidyoConnectorSendChatMessage(VidyoConnector* c, const char* message)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| message |
const char* |
A message to send to all the other participants. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetAdvancedOptions
Sets up advanced options on the VidyoConnector API.
Syntax
LmiBool VidyoConnectorSetAdvancedOptions(VidyoConnector* c, const char* options)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetCameraNudgeConfiguration
Sets camera PTZ nudge configuration.
Syntax
LmiBool VidyoConnectorSetCameraNudgeConfiguration(VidyoConnector* c, const char* cameraNudgeConfig)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| cameraNudgeConfig |
const char* |
Camera PTZ nudge configuration in JSON format. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetCameraPrivacy
Sets the flag to show/hide the local camera.
Syntax
LmiBool VidyoConnectorSetCameraPrivacy(VidyoConnector* c, LmiBool privacy)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| privacy |
LmiBool |
Flag to show/hide the local camera. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetCertificateAuthorityList
Sets the list of certificate authority’s certificates used to authenticate a TLS connection.
Syntax
void VidyoConnectorSetCertificateAuthorityList(VidyoConnector* c, const char* certificateAuthorityList)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| certificateAuthorityList |
const char* |
The string representing Certificate Authority lists. Note: If the string ‘default’ is passed here, VidyoConnector will use a built-in Certificate Authority list. |
Returns
VidyoConnector : VidyoConnectorSetCpuTradeOffProfile
Set CPU tradeoff profile.
Syntax
LmiBool VidyoConnectorSetCpuTradeOffProfile(VidyoConnector* c, VidyoConnectorTradeOffProfile profile)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetLocation
Sets the geographic location of the endpoint using the VidyoConnector.
Syntax
LmiBool VidyoConnectorSetLocation(VidyoConnector* c, LmiFloat64 latitude, LmiFloat64 longitude)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| latitude |
LmiFloat64 |
Latitude of the geographic coordinate. |
| longitude |
LmiFloat64 |
Longitude of the geographic coordinate. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetMaxBitRate
Sets the max send bit rate for all sources.
Syntax
void VidyoConnectorSetMaxBitRate(VidyoConnector* c, LmiUint bitRate)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| bitRate |
LmiUint |
The max send bit rate for all sources. |
Returns
VidyoConnector : VidyoConnectorSetMicrophonePrivacy
Sets the flag to mute/unmute the microphone.
Syntax
LmiBool VidyoConnectorSetMicrophonePrivacy(VidyoConnector* c, LmiBool privacy)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| privacy |
LmiBool |
Flag to mute/unmute the microphone. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetMode
Sets the operating mode of the VidyoConnector.
Syntax
LmiBool VidyoConnectorSetMode(VidyoConnector* c, VidyoConnectorMode mode)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetPool
Sets a specific media pool to use for audio and video.
Syntax
LmiBool VidyoConnectorSetPool(VidyoConnector* c, const char* name)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetSpeakerPrivacy
Sets the flag to mute/unmute the speaker.
Syntax
LmiBool VidyoConnectorSetSpeakerPrivacy(VidyoConnector* c, LmiBool privacy)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| privacy |
LmiBool |
Flag to mute/unmute the speaker. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetTCPTransport
Enable the use of TCP Transport when connecting.
Syntax
LmiBool VidyoConnectorSetTCPTransport(VidyoConnector* c, LmiBool enable)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetTURNAddressCredentials
Set TURN server and credentials information.
Syntax
LmiBool VidyoConnectorSetTURNAddressCredentials(VidyoConnector* c, const char* turnAddress, LmiUint port, const char* username, const char* password, VidyoConnectorBaseTransportType baseTransport)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetTURNServerCertificateRequired
Set TURN server certificate requirement.
Syntax
LmiBool VidyoConnectorSetTURNServerCertificateRequired(VidyoConnector* c, LmiBool required)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| required |
LmiBool |
LMI_TRUE if TURN server certificate is required. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetUDPTransport
Enable the use of UDP Transport when connecting.
Syntax
LmiBool VidyoConnectorSetUDPTransport(VidyoConnector* c, LmiBool enable)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorSetViewAnimationSpeed
Sets the speed of transition animation for windows moving around inside the view.
Syntax
LmiBool VidyoConnectorSetViewAnimationSpeed(VidyoConnector* c, const LmiViewId* viewId, LmiUint speedPercentage)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| viewId |
const LmiViewId* |
A platform specific view ID to be positioned. |
| speedPercentage |
LmiUint |
Percentage of animation speed with default of 50, 100 for slowest and 0 for instant. |
Returns
VidyoConnector : VidyoConnectorSetViewBackgroundColor
Set the background color of the view.
Syntax
LmiBool VidyoConnectorSetViewBackgroundColor(VidyoConnector* c, const LmiViewId* viewId, LmiUint8 red, LmiUint8 green, LmiUint8 blue)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| viewId |
const LmiViewId* |
A platform specific view ID to be positioned. |
| red |
LmiUint8 |
Red component of the color 0-255. |
| green |
LmiUint8 |
Green component of the color 0-255. |
| blue |
LmiUint8 |
Blue component of the color 0-255. |
Returns
VidyoConnector : VidyoConnectorSetWebProxyAddressCredentials
Sets web proxy server address and credentials.
Syntax
void VidyoConnectorSetWebProxyAddressCredentials(VidyoConnector* c, const char* proxyAddress, const char* username, const char* password)
Parameters
Returns
VidyoConnector : VidyoConnectorSetWebProxyTransport
Enable the use of WebProxy Transport when connecting.
Syntax
LmiBool VidyoConnectorSetWebProxyTransport(VidyoConnector* c, LmiBool enable)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorShowAudioMeters
Shows or hides the audio meters in the view.
Syntax
LmiBool VidyoConnectorShowAudioMeters(VidyoConnector* c, const LmiViewId* viewId, LmiBool showMeters)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| viewId |
const LmiViewId* |
A platform specific view ID to be positioned. |
| showMeters |
LmiBool |
Boolean to show or hide the audio meters. |
Returns
VidyoConnector : VidyoConnectorShowPreview
Sets the flag to show/hide the local camera preview.
Syntax
LmiBool VidyoConnectorShowPreview(VidyoConnector* c, LmiBool preview)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| preview |
LmiBool |
Flag to show/hide the local camera preview. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorShowViewAt
Sets the position of the view every time it’s changed on the screen.
Syntax
LmiBool VidyoConnectorShowViewAt(VidyoConnector* c, const LmiViewId* viewId, LmiInt x, LmiInt y, LmiUint width, LmiUint height)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorShowViewLabel
Shows or hides the label on the view which displays the participant name or preview.
Syntax
LmiBool VidyoConnectorShowViewLabel(VidyoConnector* c, const LmiViewId* viewId, LmiBool showLabel)
Parameters
Returns
VidyoConnector : VidyoConnectorShowWindowSharePreview
Sets the flag to show/hide the window share preview.
Syntax
LmiBool VidyoConnectorShowWindowSharePreview(VidyoConnector* c, LmiBool preview)
Parameters
| Name |
Type |
Description |
| c |
VidyoConnector* |
The VidyoConnector object. |
| preview |
LmiBool |
Flag to show/hide the window share preview. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterLocalCameraEventListener
Unregisters local camera event notifications.
Syntax
LmiBool VidyoConnectorUnregisterLocalCameraEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterLocalCameraFrameListener
Unregisters local camera frame notifications.
Syntax
LmiBool VidyoConnectorUnregisterLocalCameraFrameListener(VidyoConnector* c, const VidyoLocalCamera* localCamera)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterLocalMicrophoneEnergyListener
Unregisters local microphone energy notifications.
Syntax
LmiBool VidyoConnectorUnregisterLocalMicrophoneEnergyListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterLocalMicrophoneEventListener
Unregisters local microphone event notifications.
Syntax
LmiBool VidyoConnectorUnregisterLocalMicrophoneEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterLocalMicrophoneFrameListener
Unregisters local microphone frame notifications.
Syntax
LmiBool VidyoConnectorUnregisterLocalMicrophoneFrameListener(VidyoConnector* c, const VidyoLocalMicrophone* localMicrophone)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterLocalMonitorEventListener
Unregisters local monitor event notifications.
Syntax
LmiBool VidyoConnectorUnregisterLocalMonitorEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterLocalMonitorFrameListener
Unregisters local monitor frame notifications.
Syntax
LmiBool VidyoConnectorUnregisterLocalMonitorFrameListener(VidyoConnector* c, const VidyoLocalMonitor* localMonitor)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterLocalSpeakerEventListener
Unregisters local speaker event notifications.
Syntax
LmiBool VidyoConnectorUnregisterLocalSpeakerEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterLocalWindowShareEventListener
Unregisters local window share event notifications.
Syntax
LmiBool VidyoConnectorUnregisterLocalWindowShareEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterLocalWindowShareFrameListener
Unregisters local window share frame notifications.
Syntax
LmiBool VidyoConnectorUnregisterLocalWindowShareFrameListener(VidyoConnector* c, const VidyoLocalWindowShare* localWindowShare)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterLogEventListener
Unregisters log event notifications.
Syntax
LmiBool VidyoConnectorUnregisterLogEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterMessageEventListener
Unregisters message event notifications.
Syntax
LmiBool VidyoConnectorUnregisterMessageEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterNetworkInterfaceEventListener
Unregisters network interface event notifications.
Syntax
LmiBool VidyoConnectorUnregisterNetworkInterfaceEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterParticipantEventListener
Unregisters participant event notifications.
Syntax
LmiBool VidyoConnectorUnregisterParticipantEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterRecorderInCallEventListener
Unregisters recorder in call event notifications.
Syntax
LmiBool VidyoConnectorUnregisterRecorderInCallEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterRemoteCameraEventListener
Unregisters remote camera event notifications.
Syntax
LmiBool VidyoConnectorUnregisterRemoteCameraEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterRemoteCameraFrameListener
Unregisters remote camera frame notifications.
Syntax
LmiBool VidyoConnectorUnregisterRemoteCameraFrameListener(VidyoConnector* c, const VidyoRemoteCamera* remoteCamera)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterRemoteMicrophoneEnergyListener
Unregisters remote microphone frame notifications.
Syntax
LmiBool VidyoConnectorUnregisterRemoteMicrophoneEnergyListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterRemoteMicrophoneEventListener
Unregisters remote microphone event notifications.
Syntax
LmiBool VidyoConnectorUnregisterRemoteMicrophoneEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterRemoteMicrophoneFrameListener
Unregisters remote microphone frame notifications.
Syntax
LmiBool VidyoConnectorUnregisterRemoteMicrophoneFrameListener(VidyoConnector* c, const VidyoRemoteMicrophone* remoteMicrophone)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterRemoteWindowShareEventListener
Unregisters remote window share event notifications.
Syntax
LmiBool VidyoConnectorUnregisterRemoteWindowShareEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterRemoteWindowShareFrameListener
Unregisters remote window share frame notifications.
Syntax
LmiBool VidyoConnectorUnregisterRemoteWindowShareFrameListener(VidyoConnector* c, const VidyoRemoteWindowShare* remoteWindowShare)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterResourceManagerEventListener
Unregisters resource manager event notifications.
Syntax
LmiBool VidyoConnectorUnregisterResourceManagerEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoConnector : VidyoConnectorUnregisterWebProxyEventListener
Unregisters web proxy event notifications.
Syntax
LmiBool VidyoConnectorUnregisterWebProxyEventListener(VidyoConnector* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE on failure. |
VidyoDevice
A wrapper class for Local and Remote devices.
Properties
Enumerations
VidyoDevice : VidyoDeviceAudioSignalType
Sets the type of the auido signal which determines how it is processed such as noise suppression, echo cancellation etc.
Syntax
VidyoDeviceAudioSignalType
Values
| Name |
Description |
| 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. |
VidyoDevice : VidyoDeviceState
Operational state of a device.
Syntax
VidyoDeviceState
Values
| Name |
Description |
| 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_InUse |
The device is in use by another application. |
| VIDYO_DEVICESTATE_Available |
The device that was previousely in use is now available. |
| 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. |
VidyoDevice : VidyoDeviceType
Device type.
Syntax
VidyoDeviceType
Values
| Name |
Description |
| 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. |
Methods
VidyoDevice : VidyoDeviceGetId
Gets the device id.
Syntax
const LmiString* VidyoDeviceGetId(const VidyoDevice* d)
Parameters
Returns
VidyoDevice : VidyoDeviceGetName
Gets the device name.
Syntax
const LmiString* VidyoDeviceGetName(const VidyoDevice* d)
Parameters
Returns
VidyoDevice : VidyoDeviceGetType
Gets the device type.
Syntax
VidyoDeviceType VidyoDeviceGetType(const VidyoDevice* d)
Parameters
Returns
VidyoAudioFrame
This object represents an audio frame.
Properties
| Name |
Type |
Description |
| bitsPerSample |
LmiUint |
Bits per sample of the audio data which is based on the data format (16 bits for in16, 32 bits for fl32). |
| data |
LmiVoidPtr |
Pointer to the frame’s payload. |
| discontinuity |
LmiBool |
Discontinuity has been detected. |
| discontinuityBitPresent |
LmiBool |
Discontinuity bit has been set. |
| elapsedTime |
LmiTime |
Elapsed time since the beginning of frame capture that is increased by the duration of each frame. |
| energy |
LmiInt |
Energy of the audio frame in dBFS (full scale). |
| energyBitPresent |
LmiBool |
Energy bit has been set. |
| format |
LmiString |
Format of the audio frame. |
| numberOfChannels |
LmiSizeT |
Number of channels. |
| numberOfSamples |
LmiSizeT |
Number of samples. |
| sampleRate |
LmiSizeT |
Number of samples per second. |
| size |
LmiSizeT |
Size in bytes of the audio frame object’s payload. |
| speech |
LmiBool |
Speech is detected in the frame. |
| speechBitPresent |
LmiBool |
Speech bit has been set. |
| timestamp |
LmiTime |
Wallclock timestamp associated with the creation of the audio frame object. |
Methods
VidyoAudioFrame : VidyoAudioFrameGetBitsPerSample
.
Syntax
LmiSizeT VidyoAudioFrameGetBitsPerSample(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetData
.
Syntax
LmiVoidPtr VidyoAudioFrameGetData(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetDiscontinuity
.
Syntax
LmiBool VidyoAudioFrameGetDiscontinuity(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetDiscontinuityBitPresent
.
Syntax
LmiBool VidyoAudioFrameGetDiscontinuityBitPresent(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetElapsedTime
.
Syntax
LmiTime VidyoAudioFrameGetElapsedTime(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetEnergy
.
Syntax
LmiInt VidyoAudioFrameGetEnergy(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetEnergyBitPresent
.
Syntax
LmiBool VidyoAudioFrameGetEnergyBitPresent(const VidyoAudioFrame* f)
Parameters
Returns
Gets the frame format.
Syntax
const LmiString* VidyoAudioFrameGetFormat(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetNumberOfChannels
.
Syntax
LmiSizeT VidyoAudioFrameGetNumberOfChannels(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetNumberOfSamples
.
Syntax
LmiSizeT VidyoAudioFrameGetNumberOfSamples(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetSampleRate
.
Syntax
LmiSizeT VidyoAudioFrameGetSampleRate(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetSize
.
Syntax
LmiSizeT VidyoAudioFrameGetSize(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetSpeech
.
Syntax
LmiBool VidyoAudioFrameGetSpeech(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetSpeechBitPresent
.
Syntax
LmiBool VidyoAudioFrameGetSpeechBitPresent(const VidyoAudioFrame* f)
Parameters
Returns
VidyoAudioFrame : VidyoAudioFrameGetTimestamp
.
Syntax
LmiTime VidyoAudioFrameGetTimestamp(const VidyoAudioFrame* f)
Parameters
Returns
VidyoLocalCamera
This object represents a camera on the local endpoint.
Properties
Enumerations
VidyoLocalCamera : VidyoLocalCameraPosition
Position of the camera.
Syntax
VidyoLocalCameraPosition
Values
| Name |
Description |
| VIDYO_LOCALCAMERAPOSITION_Unknown |
Position is unknown. |
| VIDYO_LOCALCAMERAPOSITION_Front |
Facing towards the screen. |
| VIDYO_LOCALCAMERAPOSITION_Back |
Facing away from the screen. |
VidyoLocalCamera : VidyoLocalCameraTradeOffProfile
Frame-rate and resolution tradeoff profile.
Syntax
VidyoLocalCameraTradeOffProfile
Values
| Name |
Description |
| VIDYO_LOCALCAMERATRADEOFFPROFILE_High |
High frame-rate, high resolution. |
| VIDYO_LOCALCAMERATRADEOFFPROFILE_Medium |
Balanced frame-rate and resolution. |
| VIDYO_LOCALCAMERATRADEOFFPROFILE_Low |
Low frame-rate, low resolution. |
Methods
VidyoLocalCamera : VidyoLocalCameraAllowRemoteCameraControl
Allows the PTZ conrol of the camera by remote participants.
Syntax
LmiBool VidyoLocalCameraAllowRemoteCameraControl(VidyoLocalCamera* c, LmiBool allow)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success. |
VidyoLocalCamera : VidyoLocalCameraControlPTZ
Send the PTZ Nudge commands to the local camera.
Syntax
LmiBool VidyoLocalCameraControlPTZ(VidyoLocalCamera* c, LmiInt pan, LmiInt tilt, LmiInt zoom)
Parameters
| Name |
Type |
Description |
| c |
VidyoLocalCamera* |
The VidyoLocalCamera object. |
| pan |
LmiInt |
Number of nudges to pan the camera. |
| tilt |
LmiInt |
Number of nudges to tilt the camera. |
| zoom |
LmiInt |
Number of nudges to zoom the camera. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE when the control command was sent, LMI_FALSE otherwise. |
VidyoLocalCamera : VidyoLocalCameraGetBacklightCompensation
Gets the backlight compensation state.
Syntax
LmiBool VidyoLocalCameraGetBacklightCompensation(VidyoLocalCamera* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
Backlight compensation state. |
VidyoLocalCamera : VidyoLocalCameraGetFramerateTradeOffProfile
Gets the frame rate v.s. video quality tradeoff profile.
Syntax
VidyoLocalCameraTradeOffProfile VidyoLocalCameraGetFramerateTradeOffProfile(VidyoLocalCamera* c)
Parameters
Returns
VidyoLocalCamera : VidyoLocalCameraGetId
Gets the unique ID of the camera.
Syntax
const LmiString* VidyoLocalCameraGetId(const VidyoLocalCamera* c)
Parameters
Returns
VidyoLocalCamera : VidyoLocalCameraGetName
Gets the name of the camera.
Syntax
const LmiString* VidyoLocalCameraGetName(const VidyoLocalCamera* c)
Parameters
Returns
VidyoLocalCamera : VidyoLocalCameraGetPosition
Gets the position of the camera.
Syntax
VidyoLocalCameraPosition VidyoLocalCameraGetPosition(const VidyoLocalCamera* c)
Parameters
Returns
VidyoLocalCamera : VidyoLocalCameraGetPreviewLabel
Gets the preview label of the camera.
Syntax
const LmiString* VidyoLocalCameraGetPreviewLabel(const VidyoLocalCamera* c)
Parameters
Returns
VidyoLocalCamera : VidyoLocalCameraGetResolutionTradeOffProfile
Gets the resolution v.s. video quality tradeoff profile.
Syntax
VidyoLocalCameraTradeOffProfile VidyoLocalCameraGetResolutionTradeOffProfile(VidyoLocalCamera* c)
Parameters
Returns
VidyoLocalCamera : VidyoLocalCameraIsControlDigital
Checks if the camera control to digital only.
Syntax
LmiBool VidyoLocalCameraIsControlDigital(const VidyoLocalCamera* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE is digital only mode is set, LMI_FALSE otherwise. |
VidyoLocalCamera : VidyoLocalCameraIsSuspended
Checks if the camera is suspended.
Syntax
LmiBool VidyoLocalCameraIsSuspended(const VidyoLocalCamera* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE is suspended, LMI_FALSE otherwise. |
VidyoLocalCamera : VidyoLocalCameraSetAspectRatioConstraint
Sets the aspect ratio constraint on the camera which will adjust local camera frames to match.
Syntax
LmiBool VidyoLocalCameraSetAspectRatioConstraint(VidyoLocalCamera* c, LmiUint aspectRatioWidth, LmiUint aspectRatioHeight)
Parameters
| Name |
Type |
Description |
| c |
VidyoLocalCamera* |
The VidyoLocalCamera object. |
| aspectRatioWidth |
LmiUint |
Width of the aspect ratio. |
| aspectRatioHeight |
LmiUint |
Height of the aspect ration. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success. |
VidyoLocalCamera : VidyoLocalCameraSetBacklightCompensation
Set the backlight compensation which improves the dynamic range of the image when the subject is dark but the background is bright.
Syntax
LmiBool VidyoLocalCameraSetBacklightCompensation(VidyoLocalCamera* c, LmiBool backlightCompensation)
Parameters
| Name |
Type |
Description |
| c |
VidyoLocalCamera* |
The VidyoLocalCamera object. |
| backlightCompensation |
LmiBool |
Compensate for the bright backlighting. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success. |
VidyoLocalCamera : VidyoLocalCameraSetControlDigital
Sets the camera control to digital only.
Syntax
void VidyoLocalCameraSetControlDigital(VidyoLocalCamera* c, LmiBool digital)
Parameters
Returns
VidyoLocalCamera : VidyoLocalCameraSetFramerateTradeOffProfile
Sets the frame rate v.s. video quality tradeoff profile.
Syntax
LmiBool VidyoLocalCameraSetFramerateTradeOffProfile(VidyoLocalCamera* c, VidyoLocalCameraTradeOffProfile profile)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success. |
VidyoLocalCamera : 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.
Syntax
LmiBool VidyoLocalCameraSetMaxConstraint(VidyoLocalCamera* c, LmiUint width, LmiUint height, LmiTime frameInterval)
Parameters
| Name |
Type |
Description |
| c |
VidyoLocalCamera* |
The VidyoLocalCamera object. |
| width |
LmiUint |
Maximum width. |
| height |
LmiUint |
Maximum height. |
| frameInterval |
LmiTime |
Maximum frame interval. Setting to 0 selects the fastest frame rate. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success. |
VidyoLocalCamera : VidyoLocalCameraSetNudgeTimes
Set the time delta that the camera moves left/right (pan), up/down (tilt), and/or in/out (zoom) for each nudge if the camera supports only start/stop (relative) behavior.
Syntax
LmiBool VidyoLocalCameraSetNudgeTimes(VidyoLocalCamera* c, LmiTime panTime, LmiTime tiltTime, LmiTime zoomTime)
Parameters
| Name |
Type |
Description |
| c |
VidyoLocalCamera* |
The VidyoLocalCamera object. |
| panTime |
LmiTime |
The time delta to pan the camera per nudge. |
| tiltTime |
LmiTime |
The time delta to tilt the camera per nudge. |
| zoomTime |
LmiTime |
The time delta to zoom the camera per nudge. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE when applied, LMI_FALSE otherwise. |
VidyoLocalCamera : VidyoLocalCameraSetPreviewLabel
Set the preview label of the camera.
Syntax
LmiBool VidyoLocalCameraSetPreviewLabel(VidyoLocalCamera* c, const LmiString* previewLabel)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE otherwise. |
VidyoLocalCamera : VidyoLocalCameraSetResolutionTradeOffProfile
Sets the resolution v.s. video quality trade off profile.
Syntax
LmiBool VidyoLocalCameraSetResolutionTradeOffProfile(VidyoLocalCamera* c, VidyoLocalCameraTradeOffProfile profile)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success. |
VidyoLocalCamera : VidyoLocalCameraSetTargetBitRate
Sets the target send bit rate for a local camera.
Syntax
void VidyoLocalCameraSetTargetBitRate(VidyoLocalCamera* c, LmiUint bitRate)
Parameters
| Name |
Type |
Description |
| c |
VidyoLocalCamera* |
The VidyoLocalCamera object. |
| bitRate |
LmiUint |
The target send bit rate in bits per second. |
Returns
VidyoLocalCamera : VidyoLocalCameraShowCameraControl
Shows camera control when rendering preview.
Syntax
LmiBool VidyoLocalCameraShowCameraControl(VidyoLocalCamera* c, LmiBool show)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success. |
VidyoLocalMicrophone
This object represents a microphone on the local endpoint.
Properties
Methods
VidyoLocalMicrophone : VidyoLocalMicrophoneGetId
Gets the unique ID of the microphone.
Syntax
const LmiString* VidyoLocalMicrophoneGetId(const VidyoLocalMicrophone* m)
Parameters
Returns
VidyoLocalMicrophone : VidyoLocalMicrophoneGetName
Gets the name of the microphone.
Syntax
const LmiString* VidyoLocalMicrophoneGetName(const VidyoLocalMicrophone* m)
Parameters
Returns
VidyoLocalMicrophone : VidyoLocalMicrophoneGetSignalType
Gets signal type of the microphone, which affects how the audio is processed.
Syntax
VidyoDeviceAudioSignalType VidyoLocalMicrophoneGetSignalType(VidyoLocalMicrophone* m)
Parameters
Returns
VidyoLocalMicrophone : VidyoLocalMicrophoneSetSignalType
Sets the signal type of the microhone which changes how the auido is processed.
Syntax
LmiBool VidyoLocalMicrophoneSetSignalType(VidyoLocalMicrophone* m, VidyoDeviceAudioSignalType signalType)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success. |
VidyoLocalMonitor
This object represents a monitor on the local endpoint.
Properties
Enumerations
VidyoLocalMonitor : VidyoLocalMonitorState
State of the monitor.
Syntax
VidyoLocalMonitorState
Values
| Name |
Description |
| 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. |
Methods
VidyoLocalMonitor : VidyoLocalMonitorGetId
Gets the unique ID of the monitor.
Syntax
const LmiString* VidyoLocalMonitorGetId(const VidyoLocalMonitor* m)
Parameters
Returns
VidyoLocalMonitor : VidyoLocalMonitorGetName
Gets the name of the monitor.
Syntax
const LmiString* VidyoLocalMonitorGetName(const VidyoLocalMonitor* m)
Parameters
Returns
VidyoLocalMonitor : VidyoLocalMonitorSetFrameInterval
Syntax
LmiBool VidyoLocalMonitorSetFrameInterval(VidyoLocalMonitor* m, LmiTime frameInterval)
Parameters
| Name |
Type |
Description |
| m |
VidyoLocalMonitor* |
The VidyoLocalMonitor object. |
| frameInterval |
LmiTime |
The interval in nanoseconds between consecutive frames. Default is 333333333 which is 3 frames per second. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE otherwise. |
VidyoLocalMonitor : VidyoLocalMonitorSetLowLatencyProfilebeta
Sets the low latency profile of the monitor which treats the stream as a regular video source. This prioritizes latency over quality.
Syntax
LmiBool VidyoLocalMonitorSetLowLatencyProfile(VidyoLocalMonitor* m, LmiBool profile)
Parameters
| Name |
Type |
Description |
| m |
VidyoLocalMonitor* |
The VidyoLocalMonitor object. |
| profile |
LmiBool |
Low latency profile toggle. Default is LMI_FALSE. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE otherwise. |
VidyoLocalSpeaker
This object represents a speaker on the local endpoint.
Properties
Methods
VidyoLocalSpeaker : VidyoLocalSpeakerGetId
Gets the unique ID of the speaker.
Syntax
const LmiString* VidyoLocalSpeakerGetId(const VidyoLocalSpeaker* s)
Parameters
Returns
VidyoLocalSpeaker : VidyoLocalSpeakerGetName
Gets the name of the speaker.
Syntax
const LmiString* VidyoLocalSpeakerGetName(const VidyoLocalSpeaker* s)
Parameters
Returns
VidyoLocalWindowShare
This object represents a window share on the local endpoint.
Properties
| Name |
Type |
Description |
| applicationName |
LmiString |
Name of the application that owns the window. |
| id |
LmiString |
Unique ID. |
| name |
LmiString |
Name of the window share. |
Enumerations
VidyoLocalWindowShare : VidyoLocalWindowShareState
State of the window share.
Syntax
VidyoLocalWindowShareState
Values
| Name |
Description |
| 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. |
Methods
VidyoLocalWindowShare : VidyoLocalWindowShareGetApplicationName
Gets the name of the application that owns the window.
Syntax
const LmiString* VidyoLocalWindowShareGetApplicationName(const VidyoLocalWindowShare* w)
Parameters
Returns
| Type |
Description |
| const LmiString* |
The name of the application that owns the window |
VidyoLocalWindowShare : VidyoLocalWindowShareGetId
Gets the unique ID of the window share.
Syntax
const LmiString* VidyoLocalWindowShareGetId(const VidyoLocalWindowShare* w)
Parameters
Returns
VidyoLocalWindowShare : VidyoLocalWindowShareGetName
Gets the name of the window share.
Syntax
const LmiString* VidyoLocalWindowShareGetName(const VidyoLocalWindowShare* w)
Parameters
Returns
VidyoLocalWindowShare : VidyoLocalWindowShareGetPreviewLabel
Gets the preview label of the window share.
Syntax
const LmiString* VidyoLocalWindowShareGetPreviewLabel(const VidyoLocalWindowShare* w)
Parameters
Returns
VidyoLocalWindowShare : VidyoLocalWindowShareGetProcessId
Gets the ID of the process that owns the window share.
Syntax
LmiUint VidyoLocalWindowShareGetProcessId(VidyoLocalWindowShare* w)
Parameters
Returns
| Type |
Description |
| LmiUint |
ID of the process that owns the window share. |
VidyoLocalWindowShare : VidyoLocalWindowShareGetProcessName
Syntax
const LmiString* VidyoLocalWindowShareGetProcessName(const VidyoLocalWindowShare* w)
Parameters
Returns
VidyoLocalWindowShare : VidyoLocalWindowShareGetUpdatedName
Retrieved the up to date name of the Window which might have changed since it was created.
Syntax
const LmiString* VidyoLocalWindowShareGetUpdatedName(const VidyoLocalWindowShare* w)
Parameters
Returns
VidyoLocalWindowShare : VidyoLocalWindowShareIsApplicationNameSet
Checks if the name of the application name is set.
Syntax
LmiBool VidyoLocalWindowShareIsApplicationNameSet(const VidyoLocalWindowShare* w)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE when the applicaiton name is set, LMI_FALSE otherwise. |
VidyoLocalWindowShare : VidyoLocalWindowShareIsNameSet
Checks if the name of the window share is set.
Syntax
LmiBool VidyoLocalWindowShareIsNameSet(const VidyoLocalWindowShare* w)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE when the window share name is set, LMI_FALSE otherwise. |
VidyoLocalWindowShare : VidyoLocalWindowShareSetFrameInterval
Sets the maximum frame interval that will be used to scrapte the window share
Syntax
LmiBool VidyoLocalWindowShareSetFrameInterval(VidyoLocalWindowShare* w, LmiTime frameInterval)
Parameters
| Name |
Type |
Description |
| w |
VidyoLocalWindowShare* |
The VidyoLocalWindowShare object. |
| frameInterval |
LmiTime |
The interval in nanoseconds between consecutive frames. Default is 333333333 which is 3 frames per second. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE otherwise. |
VidyoLocalWindowShare : VidyoLocalWindowShareSetLowLatencyProfilebeta
Sets the low latency profile of the window share which treats the stream as a regular video source. This prioritizes latency over quality.
Syntax
LmiBool VidyoLocalWindowShareSetLowLatencyProfile(VidyoLocalWindowShare* w, LmiBool profile)
Parameters
| Name |
Type |
Description |
| w |
VidyoLocalWindowShare* |
The VidyoLocalWindowShare object. |
| profile |
LmiBool |
Low latency profile toggle. Default is LMI_FALSE. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE otherwise. |
VidyoLocalWindowShare : VidyoLocalWindowShareSetPreviewLabel
Set the preview label of the window share.
Syntax
LmiBool VidyoLocalWindowShareSetPreviewLabel(VidyoLocalWindowShare* w, const LmiString* previewLabel)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success, LMI_FALSE otherwise. |
VidyoRemoteCamera
This object represents a camera which belongs to the remote participant.
Properties
Enumerations
VidyoRemoteCamera : VidyoRemoteCameraPosition
Position of the camera.
Syntax
VidyoRemoteCameraPosition
Values
| Name |
Description |
| VIDYO_REMOTECAMERAPOSITION_Unknown |
Position is unknown. |
| VIDYO_REMOTECAMERAPOSITION_Front |
Facing towards the screen. |
| VIDYO_REMOTECAMERAPOSITION_Back |
Facing away from the screen. |
Methods
VidyoRemoteCamera : VidyoRemoteCameraControlPTZ
Send the PTZ Nudge commands to the remote camera.
Syntax
LmiBool VidyoRemoteCameraControlPTZ(VidyoRemoteCamera* c, LmiInt pan, LmiInt tilt, LmiInt zoom)
Parameters
| Name |
Type |
Description |
| c |
VidyoRemoteCamera* |
The VidyoRemoteCamera object. |
| pan |
LmiInt |
Number of nudges to pan the camera. |
| tilt |
LmiInt |
Number of nudges to tilt the camera. |
| zoom |
LmiInt |
Number of nudges to zoom the camera. |
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE when the control command was sent, LMI_FALSE otherwise. |
VidyoRemoteCamera : VidyoRemoteCameraGetId
Gets the unique ID of the camera.
Syntax
const LmiString* VidyoRemoteCameraGetId(const VidyoRemoteCamera* c)
Parameters
Returns
VidyoRemoteCamera : VidyoRemoteCameraGetName
Gets the name of the camera.
Syntax
const LmiString* VidyoRemoteCameraGetName(const VidyoRemoteCamera* c)
Parameters
Returns
VidyoRemoteCamera : VidyoRemoteCameraGetPosition
Gets the position of the camera.
Syntax
VidyoRemoteCameraPosition VidyoRemoteCameraGetPosition(const VidyoRemoteCamera* c)
Parameters
Returns
VidyoRemoteCamera : VidyoRemoteCameraIsControllable
Checks if the remote camera is controllable.
Syntax
LmiBool VidyoRemoteCameraIsControllable(VidyoRemoteCamera* c)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE if controllable, LMI_FALSE otherwise. |
VidyoRemoteCamera : VidyoRemoteCameraShowCameraControl
Shows camera control when rendering remote camera.
Syntax
LmiBool VidyoRemoteCameraShowCameraControl(VidyoRemoteCamera* c, LmiBool show)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE on success. |
VidyoRemoteMicrophone
This object represents a microphone which belongs to the remote participant.
Properties
Methods
VidyoRemoteMicrophone : VidyoRemoteMicrophoneGetId
Gets the unique ID of the microphone.
Syntax
const LmiString* VidyoRemoteMicrophoneGetId(const VidyoRemoteMicrophone* m)
Parameters
Returns
VidyoRemoteMicrophone : VidyoRemoteMicrophoneGetName
Gets the name of the microphone.
Syntax
const LmiString* VidyoRemoteMicrophoneGetName(const VidyoRemoteMicrophone* m)
Parameters
Returns
VidyoRemoteMicrophone : VidyoRemoteMicrophoneGetSignalType
Gets signal type of the microphone, which affects how the audio is processed.
Syntax
VidyoDeviceAudioSignalType VidyoRemoteMicrophoneGetSignalType(const VidyoRemoteMicrophone* m)
Parameters
Returns
VidyoRemoteWindowShare
This object represents a window share which belongs to the remote participant.
Properties
Methods
VidyoRemoteWindowShare : VidyoRemoteWindowShareGetId
Gets the unique ID of the window share.
Syntax
const LmiString* VidyoRemoteWindowShareGetId(const VidyoRemoteWindowShare* w)
Parameters
Returns
VidyoRemoteWindowShare : VidyoRemoteWindowShareGetName
Gets the name of the window share.
Syntax
const LmiString* VidyoRemoteWindowShareGetName(const VidyoRemoteWindowShare* w)
Parameters
Returns
VidyoVideoFrame
This object represents a video frame.
Properties
| Name |
Type |
Description |
| data |
LmiVoidPtr |
Pointer to the frame’s payload. |
| dataCb |
LmiVoidPtr |
Pointer to the frame’s payload. |
| dataCr |
LmiVoidPtr |
Pointer to the frame’s payload. |
| dataY |
LmiVoidPtr |
Pointer to the frame’s payload. |
| elapsedTime |
LmiTime |
Elapsed time since the beginning of frame capture that is increased by the duration of each frame. |
| format |
LmiString |
Format of the video frame. |
| height |
LmiSizeT |
Height of the video frame. |
| heightCb |
LmiSizeT |
Height in bytes of the frame’s Cb pixel data. |
| heightCr |
LmiSizeT |
Height in bytes of the frame’s Cr pixel data. |
| heightY |
LmiSizeT |
Height in bytes of the frame’s Y pixel data. |
| offsetCb |
LmiSizeT |
Number of bytes from the plane’s payload to the start of the pixel data. |
| offsetCr |
LmiSizeT |
Number of bytes from the plane’s payload to the start of the pixel data. |
| offsetY |
LmiSizeT |
Number of bytes from the plane’s payload to the start of the pixel data. |
| pitchCb |
LmiSizeT |
Number of bytes between consecutive pixels in a row of the plane. |
| pitchCr |
LmiSizeT |
Number of bytes between consecutive pixels in a row of the plane. |
| pitchY |
LmiSizeT |
Number of bytes between consecutive pixels in a row of the plane. |
| size |
LmiSizeT |
Size in bytes of the frame’s payload. |
| sizeCb |
LmiSizeT |
Size in bytes of the plane’s payload. |
| sizeCr |
LmiSizeT |
Size in bytes of the plane’s payload. |
| sizeY |
LmiSizeT |
Size in bytes of the plane’s payload. |
| timestamp |
LmiTime |
Wallclock timestamp associated with the creation of the audio frame object. |
| width |
LmiSizeT |
Width of the video frame. |
| widthCb |
LmiSizeT |
Width in bytes of the frame’s Cb pixel data. |
| widthCr |
LmiSizeT |
Width in bytes of the frame’s Cr pixel data. |
| widthY |
LmiSizeT |
Width in bytes of the frame’s Y pixel data. |
Methods
VidyoVideoFrame : VidyoVideoFrameGetData
Syntax
LmiVoidPtr VidyoVideoFrameGetData(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetDataCb
Syntax
LmiVoidPtr VidyoVideoFrameGetDataCb(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetDataCr
Syntax
LmiVoidPtr VidyoVideoFrameGetDataCr(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetDataY
Syntax
LmiVoidPtr VidyoVideoFrameGetDataY(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetElapsedTime
Syntax
LmiTime VidyoVideoFrameGetElapsedTime(const VidyoVideoFrame* f)
Parameters
Returns
Gets the format of the frame.
Syntax
const LmiString* VidyoVideoFrameGetFormat(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetHeight
Gets the height of the frame.
Syntax
LmiSizeT VidyoVideoFrameGetHeight(const VidyoVideoFrame* f)
Parameters
Returns
| Type |
Description |
| LmiSizeT |
Height of the frame. |
VidyoVideoFrame : VidyoVideoFrameGetHeightCb
Syntax
LmiSizeT VidyoVideoFrameGetHeightCb(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetHeightCr
Syntax
LmiSizeT VidyoVideoFrameGetHeightCr(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetHeightY
Syntax
LmiSizeT VidyoVideoFrameGetHeightY(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetOffsetCb
Syntax
LmiSizeT VidyoVideoFrameGetOffsetCb(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetOffsetCr
Syntax
LmiSizeT VidyoVideoFrameGetOffsetCr(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetOffsetY
Syntax
LmiSizeT VidyoVideoFrameGetOffsetY(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetPitchCb
Syntax
LmiSizeT VidyoVideoFrameGetPitchCb(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetPitchCr
Syntax
LmiSizeT VidyoVideoFrameGetPitchCr(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetPitchY
Syntax
LmiSizeT VidyoVideoFrameGetPitchY(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetSize
Syntax
LmiSizeT VidyoVideoFrameGetSize(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetSizeCb
Syntax
LmiSizeT VidyoVideoFrameGetSizeCb(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetSizeCr
Syntax
LmiSizeT VidyoVideoFrameGetSizeCr(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetSizeY
Syntax
LmiSizeT VidyoVideoFrameGetSizeY(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetTimestamp
Syntax
LmiTime VidyoVideoFrameGetTimestamp(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetWidth
Gets the width of the frame.
Syntax
LmiSizeT VidyoVideoFrameGetWidth(const VidyoVideoFrame* f)
Parameters
Returns
| Type |
Description |
| LmiSizeT |
Width of the frame. |
VidyoVideoFrame : VidyoVideoFrameGetWidthCb
Syntax
LmiSizeT VidyoVideoFrameGetWidthCb(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetWidthCr
Syntax
LmiSizeT VidyoVideoFrameGetWidthCr(const VidyoVideoFrame* f)
Parameters
Returns
VidyoVideoFrame : VidyoVideoFrameGetWidthY
Syntax
LmiSizeT VidyoVideoFrameGetWidthY(const VidyoVideoFrame* f)
Parameters
Returns
VidyoChatMessage
Contains the text message and additional information about who sent it and when.
Properties
| Name |
Type |
Description |
| body |
LmiString |
The body of the VidyoChatMessage. |
| id |
LmiInt64 |
Unique ID of the VidyoChatMessage. |
| senderType |
VidyoChatMessageSenderType |
The type of the sender. |
| timestamp |
LmiTime |
The time when the message was created. |
| type |
VidyoChatMessageType |
The type of VidyoChatMessage. |
| userId |
LmiString |
Unique ID of a VidyoParticipant who sent the message or NULL depending on the VidyoChatMessageSenderType. |
Enumerations
VidyoChatMessage : VidyoChatMessageSenderType
Type of the VidyoChatMessage sender.
Syntax
VidyoChatMessageSenderType
Values
| Name |
Description |
| 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. |
VidyoChatMessage : VidyoChatMessageType
Type of a message. This type will depend on the content of the message or where it originated.
Syntax
VidyoChatMessageType
Values
| Name |
Description |
| 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. |
VidyoLogRecord
A record of one logged event.
Properties
Enumerations
VidyoLogRecord : VidyoLogLevel
An identifier for the level, or type, of a logged event. This indicates the degree of significance of the event.
Syntax
VidyoLogLevel
Values
| Name |
Description |
| 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. |
VidyoParticipant
This object represents a participant in the room or call.
Properties
Methods
VidyoParticipant : VidyoParticipantGetId
Gets the ID that is unique to the room or call only.
Syntax
const LmiString* VidyoParticipantGetId(const VidyoParticipant* p)
Parameters
Returns
VidyoParticipant : VidyoParticipantGetName
Gets the display name of the participant.
Syntax
const LmiString* VidyoParticipantGetName(const VidyoParticipant* p)
Parameters
Returns
VidyoParticipant : VidyoParticipantGetTrust
Syntax
VidyoParticipantTrust VidyoParticipantGetTrust(VidyoParticipant* p)
Parameters
Returns
VidyoParticipant : VidyoParticipantGetUserId
Gets the ID that is globally unique such as user@domain.
Syntax
const LmiString* VidyoParticipantGetUserId(const VidyoParticipant* p)
Parameters
Returns
| Type |
Description |
| const LmiString* |
ID that is globally unique such as user@domain. |
VidyoParticipant : VidyoParticipantIsHidden
Gets the hidden state of the participant.
Syntax
LmiBool VidyoParticipantIsHidden(const VidyoParticipant* p)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE if the participant is hidden, LMI_FALSE otherwise. |
VidyoParticipant : VidyoParticipantIsRecording
Gets the recording state of the participant.
Syntax
LmiBool VidyoParticipantIsRecording(const VidyoParticipant* p)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE if the participant is recording, LMI_FALSE otherwise. |
VidyoParticipant : VidyoParticipantIsSelectable
Gets the selectable state of the participant.
Syntax
LmiBool VidyoParticipantIsSelectable(const VidyoParticipant* p)
Parameters
Returns
| Type |
Description |
| LmiBool |
LMI_TRUE if the participant is selectable, LMI_FALSE otherwise. |
LmiInt64
Basic 64-bit integer type.
LmiVector
A parameterized vector container class.
Methods
LmiVector : Declare_LmiVector
Declare a parameterized vector container and its subtypes
Syntax
void Declare_LmiVector(Type T)
LmiVector : Define_LmiVector
Define a parameterized vector container and its subtypes
Syntax
void Define_LmiVector(Type T)
LmiVector : LmiVectorAssign
Copy one vector to another
Syntax
LmiVector(T_)* LmiVectorAssign(T_)(LmiVector(T_)* x, const LmiVector(T_)* y)
LmiVector : LmiVectorAt
Retrieve a pointer to the element of the vector at index n
Syntax
T_* LmiVectorAt(T_)(LmiVector(T_)* x, LmiVectorSizeType(T_) n)
LmiVector : LmiVectorAtConst
Retrieve a read-only pointer to the element of the vector at index n
Syntax
const T_* LmiVectorAtConst(T_)(const LmiVector(T_)* x, LmiVectorSizeType(T_) n)
LmiVector : LmiVectorBack
Retrieve a pointer to the last element of the vector
Syntax
T_* LmiVectorBack(T_)(LmiVector(T_)* x)
LmiVector : LmiVectorBackConst
Retrieve a read-only pointer to the last element of the vector
Syntax
const T_* LmiVectorBackConst(T_)(const LmiVector(T_)* x)
LmiVector : LmiVectorBegin
Gets an iterator to the first element in the vector
Syntax
LmiVectorIterator(T_) LmiVectorBegin(T_)(LmiVector(T_)* x)
LmiVector : LmiVectorBeginConst
Gets a read-only iterator to the first element in the vector
Syntax
LmiVectorConstIterator(T_) LmiVectorBeginConst(T_)(const LmiVector(T_)* x)
LmiVector : LmiVectorCapacity
Gets the number of elements for which memory has been allocated in the vector
Syntax
LmiVectorSizeType(T_) LmiVectorCapacity(T_)(const LmiVector(T_)* x)
LmiVector : LmiVectorClear
Erase all elements from the vector
Syntax
void LmiVectorClear(T_)(LmiVector(T_)* x)
LmiVector : LmiVectorConstructCopy
Construct a vector from another vector
Syntax
LmiVector(T_)* LmiVectorConstructCopy(T_)(LmiVector(T_)* x, const LmiVector(T_)* y)
LmiVector : LmiVectorConstructDefault
Construct an empty vector
Syntax
LmiVector(T_)* LmiVectorConstructDefault(T_)(LmiVector(T_)* x, LmiAllocator* a)
LmiVector : LmiVectorConstructN
Construct a vector and initialize the first n entries in the vector with copies of t
Syntax
LmiVector(T_)* LmiVectorConstructN(T_)(LmiVector(T_)* x, LmiVectorSizeType(T_) n, const T_* t, LmiAllocator* a)
LmiVector : LmiVectorConstructRange
Construct a vector and initialize it with the range specified
Syntax
LmiVector(T_)* LmiVectorConstructRange(T_)(LmiVector(T_)* x, LmiVectorConstIterator(T_) first, LmiVectorConstIterator(T_) last, LmiAllocator* a)
LmiVector : LmiVectorConstructRangeOther
Construct a vector from a range of another container type
Syntax
LmiVector(T_)* LmiVectorConstructRangeOther(T_, InputIterator_)(LmiVector(T_)* x, InputIterator_ first, InputIterator_ last, LmiAllocator* a)
LmiVector : LmiVectorDestruct
Destruct a vector
Syntax
void LmiVectorDestruct(T_)(LmiVector(T_)* x)
LmiVector : LmiVectorEmpty
Test whether or not a vector is empty
Syntax
LmiBool LmiVectorEmpty(T_)(const LmiVector(T_)* x)
LmiVector : LmiVectorEnd
Gets an iterator to the element one past the last element in the vector
Syntax
LmiVectorIterator(T_) LmiVectorEnd(T_)(LmiVector(T_)* x)
LmiVector : LmiVectorEndConst
Gets a read-only iterator to the element one past the last element in the vector
Syntax
LmiVectorConstIterator(T_) LmiVectorEndConst(T_)(const LmiVector(T_)* x)
LmiVector : LmiVectorEqual
Test two vectors for equality
Syntax
LmiBool LmiVectorEqual(T_)(const LmiVector(T_)* x, const LmiVector(T_)* y)
LmiVector : LmiVectorErase
Erase the element at a given position from the vector
Syntax
LmiVectorIterator(T_) LmiVectorErase(T_)(LmiVector(T_)* x, LmiVectorIterator(T_) pos)
LmiVector : LmiVectorEraseRange
Erase the elements in the range [first, last) from the vector
Syntax
LmiVectorIterator(T_) LmiVectorEraseRange(T_)(LmiVector(T_)* x, LmiVectorIterator(T_) first, LmiVectorIterator(T_) last)
LmiVector : LmiVectorFront
Retrieve a pointer to the first element of the vector
Syntax
T_* LmiVectorFront(T_)(LmiVector(T_)* x)
LmiVector : LmiVectorFrontConst
Retrieve a read-only pointer to the first element of the vector
Syntax
const T_* LmiVectorFrontConst(T_)(const LmiVector(T_)* x)
LmiVector : LmiVectorGetAllocator
Gets a pointer to the vector’s allocator
Syntax
LmiAllocator* LmiVectorGetAllocator(T_)(const LmiVector(T_)* x)
LmiVector : LmiVectorInsert
Insert t into a vector before pos
Syntax
LmiVectorIterator(T_) LmiVectorInsert(T_)(LmiVector(T_)* x, LmiVectorIterator(T_) pos, const T_* t)
LmiVector : LmiVectorInsertN
Insert n copies of t into a vector before pos
Syntax
LmiBool LmiVectorInsertN(T_)(LmiVector(T_)* x, LmiVectorIterator(T_) pos, LmiVectorSizeType(T_) n, const T_* t)
LmiVector : LmiVectorInsertRange
Insert the elements in the range [first, last) into a vector before pos
Syntax
LmiBool LmiVectorInsertRange(T_)(LmiVector(T_)* x, LmiVectorIterator(T_) pos, LmiVectorConstIterator(T_) first, LmiVectorConstIterator(T_) last)
LmiVector : LmiVectorLess
Test whether one vector is lexicographically less than another
Syntax
LmiBool LmiVectorLess(T_)(const LmiVector(T_)* x, const LmiVector(T_)* y)
LmiVector : LmiVectorMaxSize
Gets the maximum number of elements the vector could contain
Syntax
LmiVectorSizeType(T_) LmiVectorMaxSize(T_)(const LmiVector(T_)* x)
LmiVector : LmiVectorPopBack
Remove the last element from the vector
Syntax
void LmiVectorPopBack(T_)(LmiVector(T_)* x)
LmiVector : LmiVectorPushBack
Add an element to the end of the vector
Syntax
LmiBool LmiVectorPushBack(T_)(LmiVector(T_)* x, const T_* t)
LmiVector : LmiVectorRBegin
Gets a reverse iterator to the first element in the reversed vector
Syntax
LmiVectorReverseIterator(T_) LmiVectorRBegin(T_)(LmiVector(T_)* x)
LmiVector : LmiVectorRBeginConst
Gets a read-only reverse iterator to the first element in the reversed vector
Syntax
LmiVectorConstReverseIterator(T_) LmiVectorRBeginConst(T_)(const LmiVector(T_)* x)
LmiVector : LmiVectorREnd
Gets a reverse iterator to the element one past the last element in the reversed vector
Syntax
LmiVectorReverseIterator(T_) LmiVectorREnd(T_)(LmiVector(T_)* x)
LmiVector : LmiVectorREndConst
Gets a read-only reverse iterator to the element one past the last element in the reversed vector
Syntax
LmiVectorConstReverseIterator(T_) LmiVectorREndConst(T_)(const LmiVector(T_)* x)
LmiVector : LmiVectorReserve
Reserves memory capacity in the vector
Syntax
If capacity is less than or equal to LmiVectorCapacity(T) this call has no effect.LmiBool LmiVectorReserve(T_)(LmiVector(T_)* x, LmiVectorSizeType(T_) capacity)
LmiVector : LmiVectorResize
Resize a vector
Syntax
If the current size of the vector is less than n then additional copies of t are added to the end of the vector. If the current size of the vector is greater than n then the elements from index n to the end of the vector are erased.LmiBool LmiVectorResize(T_)(LmiVector(T_)* x, LmiVectorSizeType(T_) n, const T_* t)
LmiVector : LmiVectorSize
Gets the number of elements in the vector
Syntax
LmiVectorSizeType(T_) LmiVectorSize(T_)(const LmiVector(T_)* x)
LmiVector : LmiVectorSwap
Swap two vectors
Syntax
LmiBool LmiVectorSwap(T_)(LmiVector(T_)* x, LmiVector(T_)* y)
Types
LmiVectorConstIterator
The read-only iterator type of a vector.
Syntax
LmiVectorConstIterator
LmiVectorConstReverseIterator
The read-only reverse iterator type of a vector.
Syntax
LmiVectorConstReverseIterator
LmiVectorDifferenceType
The difference type of a vector. It is equivalent to the type LmiDistanceT.
Syntax
LmiVectorDifferenceType
LmiVectorIterator
The iterator type of a vector.
Syntax
LmiVectorIterator
LmiVectorReverseIterator
The reverse iterator type of a vector.
Syntax
LmiVectorReverseIterator
LmiVectorSizeType
The size type of a vector. It is equivalent to the type LmiSizeT.
Syntax
LmiVectorSizeType
LmiString
Class representing C strings. Interface largely based on C++’s std
Methods
LmiString : LmiStringAppend
Append the contents of one LmiString to another
Syntax
LmiString* LmiStringAppend(LmiString* x, const LmiString* str)
LmiString : LmiStringAppendCStr
Append a NUL-terminated C string to an LmiString
Syntax
LmiString* LmiStringAppendCStr(LmiString* x, const char* str)
LmiString : LmiStringAppendCStrLen
Append a C string of a given length to an LmiString
Syntax
LmiString* LmiStringAppendCStrLen(LmiString* x, const char* str, LmiSizeT n)
LmiString : LmiStringAppendChar
Append a single character to an LmiString
Syntax
LmiString* LmiStringAppendChar(LmiString* x, char c)
Append a printf-style formatted string to an LmiString
Syntax
LmiString* LmiStringAppendFormatted(LmiString* x, const char* fmt, ...)
LmiString : LmiStringAppendN
Append multiple copies of a character to an LmiString
Syntax
LmiString* LmiStringAppendN(LmiString* x, LmiSizeT n, char c)
LmiString : LmiStringAppendRange
Append a range of characters to a string
Syntax
LmiString* LmiStringAppendRange(LmiString* x, LmiStringConstIterator first, LmiStringConstIterator last)
LmiString : LmiStringAppendSubstring
Append a substring of one LmiString to another
Syntax
LmiString* LmiStringAppendSubstring(LmiString* x, const LmiString* str, LmiSizeT pos, LmiSizeT n)
LmiString : LmiStringAppendUcs4
Append the UTF8-encoded values of a UCS4-encoded wide C string to a string
Syntax
LmiString* LmiStringAppendUcs4(LmiString* x, const LmiWideChar* ucs4)
LmiString : LmiStringAppendUtf16
Append the UTF8-encoded values of a UTF16-encoded C string to a string
Syntax
LmiString* LmiStringAppendUtf16(LmiString* x, const LmiUint16* utf16)
Append a vprintf-style formatted string to an LmiString
Syntax
LmiString* LmiStringAppendVFormatted(LmiString* x, const char* fmt, va_list args)
LmiString : LmiStringAssign
Assign the value of one LmiString to another
Syntax
The previous data stored in the destination is overwritten.LmiString* LmiStringAssign(LmiString* x, const LmiString* y)
LmiString : LmiStringAssignCStr
Assign a NUL-terminated C string as the new value of an LmiString
Syntax
LmiString* LmiStringAssignCStr(LmiString* x, const char* str)
LmiString : LmiStringAssignCStrLen
Assign a C string of a given length as the new value of an LmiString
Syntax
LmiString* LmiStringAssignCStrLen(LmiString* x, const char* str, LmiSizeT n)
LmiString : LmiStringAssignChar
Assign a single character as the new value of an LmiString
Syntax
LmiString* LmiStringAssignChar(LmiString* x, char c)
Assign a printf-style formatted string as the new value of an LmiString
Syntax
LmiString* LmiStringAssignFormatted(LmiString* x, const char* fmt, ...)
LmiString : LmiStringAssignRange
Assign a range of characters as the new value of an LmiString
Syntax
LmiString* LmiStringAssignRange(LmiString* x, LmiStringConstIterator first, LmiStringConstIterator last)
LmiString : LmiStringAssignSubstring
Assign a substring of one LmiString as the new value of another
Syntax
LmiString* LmiStringAssignSubstring(LmiString* x, const LmiString* str, LmiSizeT pos, LmiSizeT n)
LmiString : LmiStringAssignUcs4
Assign a string to have the UTF8-encoded values of a UCS4-encoded wide C string
Syntax
LmiString* LmiStringAssignUcs4(LmiString* x, const LmiWideChar* ucs4)
LmiString : LmiStringAssignUtf16
Assign a string to have the UTF8-encoded values of a UTF16-encoded C string
Syntax
LmiString* LmiStringAssignUtf16(LmiString* x, const LmiUint16* utf16)
Assign a vprintf-style formatted string as the new value of an LmiString
Syntax
LmiString* LmiStringAssignVFormatted(LmiString* x, const char* fmt, va_list args)
LmiString : LmiStringAt
Get a pointer to the character stored at a specific position in a string
Syntax
char* LmiStringAt(LmiString* x, LmiSizeT n)
LmiString : LmiStringAtConst
Get a constant pointer to the character stored at a specific position in a string
Syntax
const char* LmiStringAtConst(const LmiString* x, LmiSizeT n)
LmiString : LmiStringBack
Return a pointer to the last character in a string
Syntax
char* LmiStringBack(LmiString* x)
LmiString : LmiStringBackConst
Return a pointer to the last character in a const string
Syntax
const char* LmiStringBackConst(const LmiString* x)
LmiString : LmiStringBegin
Get an iterator referring to the beginning of a string
Syntax
LmiStringIterator LmiStringBegin(LmiString* x)
LmiString : LmiStringBeginConst
Get an iterator referring to the beginning of a const string
Syntax
LmiStringConstIterator LmiStringBeginConst(const LmiString* x)
LmiString : LmiStringCStr
Get a NUL-terminated C string corresponding to the contents of a string
Syntax
const char* LmiStringCStr(const LmiString* x)
LmiString : LmiStringCapacity
Get the size of the allocated storage of an LmiString
Syntax
LmiSizeT LmiStringCapacity(const LmiString* x)
LmiString : LmiStringClear
Erase the contents of a string
Syntax
void LmiStringClear(LmiString* x)
LmiString : LmiStringCompare
Compare the values of two LmiStrings for ordering
Syntax
LmiInt LmiStringCompare(const LmiString* x, const LmiString* y)
LmiString : LmiStringCompareCStr
Compare the value of an LmiString with that of a C string for ordering
Syntax
LmiInt LmiStringCompareCStr(const LmiString* x, const char* y)
LmiString : LmiStringCompareCStrLen
Compare the value of an LmiString with that of a C string of a given length for ordering
Syntax
LmiInt LmiStringCompareCStrLen(const LmiString* x, const char* y, LmiSizeT ylen)
LmiString : LmiStringConstructCStr
Construct an LmiString based on a NUL-terminated C string
Syntax
LmiString* LmiStringConstructCStr(LmiString* x, const char* str, LmiAllocator* a)
LmiString : LmiStringConstructCStrLen
Construct an LmiString based on a C string of a given length
Syntax
LmiString* LmiStringConstructCStrLen(LmiString* x, const char* str, LmiSizeT len, LmiAllocator* a)
LmiString : LmiStringConstructCopy
Construct a copy of an LmiString
Syntax
LmiString* LmiStringConstructCopy(LmiString* x, const LmiString* y)
LmiString : LmiStringConstructDefault
Construct an empty LmiString
Syntax
LmiString* LmiStringConstructDefault(LmiString* x, LmiAllocator* a)
Construct an LmiString based on a printf-style formatted string
Syntax
LmiString* LmiStringConstructFormatted(LmiString* x, LmiAllocator* a, const char* fmt, ...)
LmiString : LmiStringConstructRange
Construct an LmiString based on a range of another LmiString
Syntax
LmiString* LmiStringConstructRange(LmiString* x, LmiStringConstIterator first, LmiStringConstIterator last, LmiAllocator* a)
LmiString : LmiStringConstructSubstring
Construct an LmiString based on a substring of another LmiString
Syntax
LmiString* LmiStringConstructSubstring(LmiString* x, const LmiString* str, LmiSizeT pos, LmiSizeT n, LmiAllocator* a)
LmiString : LmiStringConstructUcs4
Construct a string to have the UTF8-encoded values of a UCS4-encoded wide C string
Syntax
LmiString* LmiStringConstructUcs4(LmiString* x, const LmiWideChar* ucs4, LmiAllocator* a)
LmiString : LmiStringConstructUtf16
Construct a string to have the UTF8-encoded values of a UTF16-encoded C string
Syntax
LmiString* LmiStringConstructUtf16(LmiString* x, const LmiUint16* utf16, LmiAllocator* a)
Construct an LmiString based on a vprintf-style formatted string
Syntax
LmiString* LmiStringConstructVFormatted(LmiString* x, const char* fmt, va_list args, LmiAllocator* a)
LmiString : LmiStringData
Get a read-only buffer corresponding to the contents of a string
Syntax
const char* LmiStringData(const LmiString* x)
LmiString : LmiStringDestruct
Destruct an LmiString, freeing all associated storage
Syntax
void LmiStringDestruct(LmiString* x)
LmiString : LmiStringEmpty
Determine whether a string is empty
Syntax
LmiBool LmiStringEmpty(const LmiString* x)
LmiString : LmiStringEnd
Get an iterator referring to the end of a string
Syntax
LmiStringIterator LmiStringEnd(LmiString* x)
LmiString : LmiStringEndConst
Get an iterator referring to the end of a const string
Syntax
LmiStringConstIterator LmiStringEndConst(const LmiString* x)
LmiString : LmiStringEqual
Compare the values of two LmiStrings for equality
Syntax
LmiBool LmiStringEqual(const LmiString* x, const LmiString* y)
LmiString : LmiStringEqualCStr
Compare the value of an LmiString with that of a C string for equality
Syntax
LmiBool LmiStringEqualCStr(const LmiString* x, const char* y)
LmiString : LmiStringEqualCStrLen
Compare the value of an LmiString with that of a C string of a given length for equality
Syntax
LmiBool LmiStringEqualCStrLen(const LmiString* x, const char* y, LmiSizeT ylen)
LmiString : LmiStringErase
Remove a single character from a string
Syntax
LmiStringIterator LmiStringErase(LmiString* x, LmiStringIterator p)
LmiString : LmiStringEraseRange
Remove a range from a string
Syntax
LmiStringIterator LmiStringEraseRange(LmiString* x, LmiStringIterator b, LmiStringIterator e)
LmiString : LmiStringEraseSubstring
Remove a substring from a string
Syntax
LmiString* LmiStringEraseSubstring(LmiString* x, LmiSizeT pos, LmiSizeT n)
LmiString : LmiStringFind
Find a substring
Syntax
LmiSizeT LmiStringFind(const LmiString* x, const LmiString* y)
LmiString : LmiStringFindCStr
Find a substring
Syntax
LmiSizeT LmiStringFindCStr(const LmiString* x, const char* y)
LmiString : LmiStringFindCStrLen
Find a substring
Syntax
LmiSizeT LmiStringFindCStrLen(const LmiString* x, const char* y, LmiSizeT n)
LmiString : LmiStringFindFirstNotOf
Find first location in a string where one of the characters in a second string does not occur
Syntax
LmiSizeT LmiStringFindFirstNotOf(const LmiString* x, LmiSizeT pos, const LmiString* y)
LmiString : LmiStringFindFirstNotOfCStr
Find first location in a string where one of the characters in a C string does not occur
Syntax
LmiSizeT LmiStringFindFirstNotOfCStr(const LmiString* x, LmiSizeT pos, const char* y)
LmiString : LmiStringFindFirstNotOfCStrLen
Find first location in a string where one of the characters in a C string of a given length does not occur
Syntax
LmiSizeT LmiStringFindFirstNotOfCStrLen(const LmiString* x, LmiSizeT pos, const char* y, LmiSizeT n)
LmiString : LmiStringFindFirstNotOfChar
Find first location in a string where a given character does not occur
Syntax
LmiSizeT LmiStringFindFirstNotOfChar(const LmiString* x, LmiSizeT pos, char c)
LmiString : LmiStringFindFirstOf
Find first location in a string where one of the characters in a second string occurs
Syntax
LmiSizeT LmiStringFindFirstOf(const LmiString* x, LmiSizeT pos, const LmiString* y)
LmiString : LmiStringFindFirstOfCStr
Find first location in a string where one of the characters in a C string occurs
Syntax
LmiSizeT LmiStringFindFirstOfCStr(const LmiString* x, LmiSizeT pos, const char* y)
LmiString : LmiStringFindFirstOfCStrLen
Find first location in a string where one of the characters in a C string of a given length occurs
Syntax
LmiSizeT LmiStringFindFirstOfCStrLen(const LmiString* x, LmiSizeT pos, const char* y, LmiSizeT n)
LmiString : LmiStringFindFirstOfChar
Find first location in a string where a given character occurs
Syntax
LmiSizeT LmiStringFindFirstOfChar(const LmiString* x, LmiSizeT pos, char c)
LmiString : LmiStringFindLastNotOfCStrLen
Find last location in a string where one of the characters in a C string does not occur
Syntax
LmiSizeT LmiStringFindLastNotOfCStrLen(const LmiString* x, LmiSizeT pos, const char* y, LmiSizeT n)
LmiString : LmiStringFindLastNotOfChar
Find last location in a string where a given character does not occur
Syntax
LmiSizeT LmiStringFindLastNotOfChar(const LmiString* x, LmiSizeT pos, char c)
LmiString : LmiStringFindLastOfCStrLen
Find last location in a string where one of the characters in a C string of a given length occurs
Syntax
LmiSizeT LmiStringFindLastOfCStrLen(const LmiString* x, LmiSizeT pos, const char* y, LmiSizeT n)
LmiString : LmiStringFindLastOfChar
Find last location in a string where a given character occurs
Syntax
LmiSizeT LmiStringFindLastOfChar(const LmiString* x, LmiSizeT pos, char c)
LmiString : LmiStringFront
Return a pointer to the first character in a string
Syntax
char* LmiStringFront(LmiString* x)
LmiString : LmiStringFrontConst
Return a pointer to the first character in a const string
Syntax
const char* LmiStringFrontConst(const LmiString* x)
LmiString : LmiStringGetAllocator
Get the allocator of an LmiString
Syntax
LmiAllocator* LmiStringGetAllocator(const LmiString* x)
LmiString : LmiStringGetBuffer
Get a writeable buffer into which data can be written outside the control of the LmiString object
Syntax
char* LmiStringGetBuffer(LmiString* x)
LmiString : LmiStringHash
Hashes a string into an integer
Syntax
LmiSizeT LmiStringHash(const LmiString* x)
LmiString : LmiStringInsert
Insert a single character into a string
Syntax
LmiStringIterator LmiStringInsert(LmiString* x, LmiStringIterator pos, const char* c)
LmiString : LmiStringInsertCStr
Insert a NUL-terminated C string into an LmiString
Syntax
LmiString* LmiStringInsertCStr(LmiString* x, LmiSizeT pos, const char* str)
LmiString : LmiStringInsertCStrLen
Insert a C string of a given length into an LmiString
Syntax
LmiString* LmiStringInsertCStrLen(LmiString* x, LmiSizeT pos, const char* str, LmiSizeT n)
LmiString : LmiStringInsertChar
Insert a single character in an LmiString
Syntax
LmiString* LmiStringInsertChar(LmiString* x, LmiSizeT pos, char c)
Insert a printf-style formatted string into an LmiString
Syntax
LmiString* LmiStringInsertFormatted(LmiString* x, LmiSizeT pos, const char* fmt, ...)
LmiString : LmiStringInsertRange
Insert a range of characters into a string
Syntax
LmiBool LmiStringInsertRange(LmiString* x, LmiStringIterator pos, LmiStringConstIterator first, LmiStringConstIterator last)
LmiString : LmiStringInsertString
Insert the contents of one LmiString into another
Syntax
LmiString* LmiStringInsertString(LmiString* x, LmiSizeT pos, const LmiString* str)
LmiString : LmiStringInsertSubstring
Insert part of the content of one LmiString into another
Syntax
LmiString* LmiStringInsertSubstring(LmiString* x, LmiSizeT pos1, const LmiString* str, LmiSizeT pos2, LmiSizeT n)
Insert a vprintf-style formatted string into an LmiString
Syntax
LmiString* LmiStringInsertVFormatted(LmiString* x, LmiSizeT pos, const char* fmt, va_list args)
LmiString : LmiStringLength
Get the length of an LmiString
Syntax
LmiSizeT LmiStringLength(const LmiString* x)
LmiString : LmiStringLess
Compare the values of two LmiStrings for ordering
Syntax
LmiBool LmiStringLess(const LmiString* x, const LmiString* y)
LmiString : LmiStringMaxSize
Get the maximum supported length of an LmiString
Syntax
LmiSizeT LmiStringMaxSize(const LmiString* x)
LmiString : LmiStringPopBack
Pop a single character from the end of a string
Syntax
void LmiStringPopBack(LmiString* x)
LmiString : LmiStringPushBack
Push a single character onto the end of a string
Syntax
LmiBool LmiStringPushBack(LmiString* x, const char* c)
LmiString : LmiStringRBegin
Get a reverse iterator referring to the reversed beginning (end) of a string
Syntax
LmiStringReverseIterator LmiStringRBegin(LmiString* x)
LmiString : LmiStringRBeginConst
Get an iterator referring to the reversed beginning (end) of a const string
Syntax
LmiStringConstReverseIterator LmiStringRBeginConst(const LmiString* x)
LmiString : LmiStringREnd
Get an iterator referring to the reversed end (beginning) of a string
Syntax
LmiStringReverseIterator LmiStringREnd(LmiString* x)
LmiString : LmiStringREndConst
Get an iterator referring to the reversed end (beginning) of a const string
Syntax
LmiStringConstReverseIterator LmiStringREndConst(const LmiString* x)
LmiString : LmiStringReleaseBuffer
Release a writeable buffer previously acquired with LmiStringGetBuffer
Syntax
void LmiStringReleaseBuffer(LmiString* x, LmiSizeT buflen)
LmiString : LmiStringReplaceCStr
Replace part of an LmiString with a C string
Syntax
LmiString* LmiStringReplaceCStr(LmiString* x, LmiSizeT pos1, LmiSizeT n1, const char* str)
LmiString : LmiStringReplaceCStrLen
Replace part of an LmiString with a C string of a given length
Syntax
LmiString* LmiStringReplaceCStrLen(LmiString* x, LmiSizeT pos1, LmiSizeT n1, const char* str, LmiSizeT n2)
LmiString : LmiStringReplaceChar
Replace part of an LmiString with a single character
Syntax
LmiString* LmiStringReplaceChar(LmiString* x, LmiSizeT pos1, LmiSizeT n1, char c)
Replace part of an LmiString with a printf-style formatted string
Syntax
LmiString* LmiStringReplaceFormatted(LmiString* x, LmiSizeT pos, LmiSizeT n, const char* fmt, ...)
LmiString : LmiStringReplaceRange
Replace a range of an LmiString with a different range of string iterators
Syntax
LmiString* LmiStringReplaceRange(LmiString* x, LmiStringIterator i1, LmiStringIterator i2, LmiStringConstIterator j1, LmiStringConstIterator j2)
LmiString : LmiStringReplaceString
Replace part of an LmiString with another LmiString
Syntax
LmiString* LmiStringReplaceString(LmiString* x, LmiSizeT pos1, LmiSizeT n1, const LmiString* str)
LmiString : LmiStringReplaceSubstring
Replace part of an LmiString with part of another LmiString
Syntax
LmiString* LmiStringReplaceSubstring(LmiString* x, LmiSizeT pos1, LmiSizeT n1, const LmiString* str, LmiSizeT pos2, LmiSizeT n2)
Replace part of an LmiString with a vprintf-style formatted string
Syntax
LmiString* LmiStringReplaceVFormatted(LmiString* x, LmiSizeT pos, LmiSizeT n, const char* fmt, va_list args)
LmiString : LmiStringReserve
Reserve storage for a string
Syntax
LmiBool LmiStringReserve(LmiString* x, LmiSizeT res)
LmiString : LmiStringResize
Alters the length of an LmiString, either by truncating it or extending it
Syntax
LmiBool LmiStringResize(LmiString* x, LmiSizeT n, const char* c)
LmiString : LmiStringSize
Get the size of an LmiString
Syntax
LmiSizeT LmiStringSize(const LmiString* x)
LmiString : LmiStringSwap
Swap the values of two LmiStrings
Syntax
LmiBool LmiStringSwap(LmiString* x, LmiString* y)
LmiString : LmiStringWriteUtf16
Encode the contents of a string as UTF-16 into a buffer
Syntax
LmiBool LmiStringWriteUtf16(const LmiString* x, LmiUint16* output, LmiSizeT outputSize, LmiSizeT* outputLen)
Types
LmiStringConstIterator
The read-only iterator type of a string.
Syntax
LmiStringConstIterator
LmiStringConstReverseIterator
The read-only reverse iterator type of a string.
Syntax
LmiStringConstReverseIterator
LmiStringIterator
The iterator type of a string.
Syntax
LmiStringIterator
LmiStringReverseIterator
The reverse iterator type of a string.
Syntax
LmiStringReverseIterator
LmiInt
Basic integer type.
LmiUint
Basic unsigned integer type.
LmiBool
Boolean type.
LmiTime
A representation of time, counted as a nanoseconds.
LmiSizeT
The size of an object in memory.
LmiFloat64
Basic 64-bit double precision floating point type.
LmiUint8
Basic 8-bit unsigned integer type.
LmiUint32
Basic 32-bit unsigned integer type.
LmiVoidPtr
A generic object pointer.
LmiFloat32
Basic 32-bit single precision floating point type.
VidyoBandwidthSummaryStats
Staticstics for an endpoint rate shaper.
Properties
| Name |
Type |
Description |
| actualEncoderBitRate |
LmiSizeT |
Actual encoder bitrate. |
| availableBandwidth |
LmiSizeT |
Available bandwidth. |
| leakyBucketDelay |
LmiSizeT |
Leaky bucket delay. |
| retransmitBitRate |
LmiSizeT |
Bitrate used for retransmission. |
| targetEncoderBitRate |
LmiSizeT |
Target encoder bitrate. |
| totalTransmitBitRate |
LmiSizeT |
Total transmit bitrate. |
VidyoEndpointStats
Statistics for an endpoint.
Properties
VidyoLatencyTestDataStats
Staticstics for a latency test.
Properties
| Name |
Type |
Description |
| address |
LmiString |
Address of the latency test host. |
| latencyMs |
LmiUint |
Latency to the host in milliseconds. |
| latitude |
LmiFloat64 |
Latitude of the host. |
| longitude |
LmiFloat64 |
Longitude of the host. |
| name |
LmiString |
Name of the latency test host. |
| responseReceived |
LmiBool |
Response has been received from the host. |
VidyoLatencyTestStats
Staticstics for a latency test.
Properties
VidyoLocalMicrophoneStats
Staticstics for a local microphone.
Properties
VidyoLocalRendererStats
Statistics for a local renderer.
Properties
VidyoLocalRendererStreamStats
Statistics for a local renderer.
Properties
VidyoLocalSpeakerStats
Staticstics for a local speaker.
Properties
VidyoLocalSpeakerStreamStats
Staticstics for a local speaker.
Properties
| Name |
Type |
Description |
| bitsPerSample |
LmiUint |
Bits per sample. |
| delay |
LmiTime |
Audio delay in the stream jitter buffer. |
| format |
VidyoMediaFormat |
Audio format. |
| 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. |
| isActive |
LmiBool |
Active stream status. |
| lastEnergy |
LmiInt |
Last energy in dBFS of the stream. |
| lastPlayed |
LmiTime |
Last time audio was played from the stream. |
| lowThreshold |
LmiTime |
Low threshold of stream jitter buffer under which the stream will be gently padded to get into the proper range. |
| lowestThreshold |
LmiTime |
Lowest threshold of stream jitter buffer under which the stream will be agressively padded 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. |
| name |
LmiString |
Name. |
| numberOfChannels |
LmiUint |
Number of channels. |
| overrun |
LmiTime |
Ammount of time stream was over the maxThreshold. |
| played |
LmiTime |
Ammount of audio played by the stream. |
| sampleRate |
LmiUint |
Sample rate. |
| underrun |
LmiTime |
Ammount of time stream was in the empty but active state. |
VidyoLocalVideoSourceStats
Statistics for a local video source.
Properties
VidyoLogDataStats
Staticstics for a log function:line number.
Properties
| Name |
Type |
Description |
| name |
LmiString |
Function name and line number of the log record. |
| occurances |
LmiUint |
Number of occurances of this log record. |
VidyoLogStats
Staticstics of the endpoint logs.
Properties
Information about media connection transport.
| Name |
Type |
Description |
| addressType |
LmiString |
Address type. |
| componentType |
LmiString |
Transport component type. |
| connectionId |
LmiUint |
Connection ID. |
| connectionType |
LmiString |
Transport connection type. |
| externalLocalAddr |
LmiString |
External local address. |
| externalRemoteAddr |
LmiString |
External remote address. |
| interfaceName |
LmiString |
Interface name. |
| interfaceType |
LmiString |
Interface type. |
| internalLocalAddr |
LmiString |
Internal local address. |
| internalRemoteAddr |
LmiString |
Internal remote address. |
| transportPlugIn |
LmiString |
Transport plugin. |
VidyoNetworkInterfaceStats
Staticstics for a network interface.
Properties
| Name |
Type |
Description |
| isUp |
LmiBool |
State of the interface. |
| name |
LmiString |
Interface name. |
| type |
LmiString |
Interface type such as wifi or wired. |
VidyoParticipantGenerationStats
Staticstics for a participnat generation, ordered list of dynamic participants.
Properties
VidyoParticipantStats
Staticstics for a room.
Properties
VidyoRateShaperStats
Staticstics for an endpoint rate shaper.
Properties
| Name |
Type |
Description |
| delayNormal |
LmiUint |
Normal delay. |
| delayRetransmit |
LmiUint |
Retransmit delay. |
| dropNormal |
LmiUint |
Dropped normal. |
| packetsNormal |
LmiUint |
Normal packets. |
| packetsRetransmit |
LmiUint |
Retransmitted packets. |
VidyoRemoteMicrophoneStats
Staticstics for a remote microphone.
Properties
| Name |
Type |
Description |
| bitsPerSample |
LmiUint |
Bits per sample. |
| codecDtx |
LmiUint |
Codec DTX. |
| codecName |
LmiString |
Codec name. |
| codecQualitySetting |
LmiUint |
Codec quality setting. |
| id |
LmiString |
Id. |
| lastFrameMs |
LmiInt |
Milliseconds since last received frame. |
| localSpeakerStreams |
LmiVector(VidyoLocalSpeakerStreamStats) |
Vector of stats of local speaker streams. |
| name |
LmiString |
Name. |
| numberOfChannels |
LmiUint |
Number of channels. |
| receiveNetworkBitRate |
LmiSizeT |
Bandwidth of receive network. |
| receiveNetworkDelay |
LmiTime |
Delay in receive network. |
| receiveNetworkDroppedPackets |
LmiSizeT |
Dropped packets in receive network. |
| receiveNetworkJitter |
LmiUint |
Jitter in receive network. |
| receiveNetworkPacketsConcealed |
LmiSizeT |
Concealed packets in receive network. |
| receiveNetworkPacketsLost |
LmiSizeT |
Lost packets in receive network. |
| sampleRateMeasured |
LmiUint |
Measured sample rate. |
| sampleRateSet |
LmiUint |
Sample rate setting. |
VidyoRemoteRendererStreamStats
Statistics for a remote renderer.
Properties
| Name |
Type |
Description |
| codecFir |
LmiUint |
Codec FIR. |
| codecIFrames |
LmiUint |
Codec I frames. |
| codecLayers |
LmiUint |
Codec layers. |
| codecNacks |
LmiUint |
Codec nacks. |
| codecName |
LmiString |
Codec name. |
| 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. |
| height |
LmiSizeT |
Height determined by the operating point. |
| lastHeight |
LmiSizeT |
Height of the last frame received from the capturing device. |
| lastWidth |
LmiSizeT |
Width of the last frame received from the capturing device. |
| name |
LmiString |
Name. |
| sendNetworkBitRate |
LmiUint |
Send bitrate. |
| sendNetworkRtt |
LmiTime |
Round trip time of send network. |
| width |
LmiSizeT |
Width determined by the operating point. |
VidyoRemoteSpeakerStreamStats
Staticstics for a remote speaker.
Properties
| Name |
Type |
Description |
| bitsPerSample |
LmiUint |
Bits per sample. |
| codecDtx |
LmiUint |
Codec DTX. |
| codecName |
LmiString |
Codec name. |
| codecQualitySetting |
LmiUint |
Codec quality setting. |
| name |
LmiString |
Name. |
| numberOfChannels |
LmiUint |
Number of channels. |
| sampleRate |
LmiUint |
Sample rate. |
| sendNetworkBitRate |
LmiUint |
Send bitrate. |
| sendNetworkRtt |
LmiTime |
Round trip time of send network. |
VidyoRemoteVideoSourceStats
Statistics for a remote video source.
Properties
| Name |
Type |
Description |
| codecFir |
LmiSizeT |
Codec FIR. |
| codecIFrames |
LmiSizeT |
Codec I frames. |
| codecLayers |
LmiSizeT |
Codec layers. |
| codecNacks |
LmiSizeT |
Codec nacks. |
| codecName |
LmiString |
Codec name. |
| fpsDecoded |
LmiSizeT |
Frame rate of decoder output. |
| fpsDecoderInput |
LmiSizeT |
Frame rate at decoder input. |
| fpsRendered |
LmiSizeT |
Frame rate of renderer. |
| height |
LmiSizeT |
Height. |
| id |
LmiString |
Id. |
| lastFrameMs |
LmiInt |
Milliseconds since last received frame. |
| localRendererStreams |
LmiVector(VidyoLocalRendererStreamStats) |
Vector of stats of local renderer streams. |
| maxStreamFrameRate |
LmiUint |
Width. |
| maxStreamHeight |
LmiSizeT |
Width. |
| maxStreamWidth |
LmiSizeT |
Width. |
| name |
LmiString |
Name. |
| receiveNetworkBitRate |
LmiSizeT |
Source bitrate. |
| receiveNetworkPacketsConcealed |
LmiSizeT |
Number of packets concealed. |
| receiveNetworkPacketsLost |
LmiSizeT |
Number of lost packets. |
| receiveNetworkPacketsReordered |
LmiSizeT |
Number of packets reordered. |
| receiveNetworkRecoveredWithFec |
LmiSizeT |
Number of packets recovered with FEC. |
| showFrameRate |
LmiUint |
Width. |
| showHeight |
LmiSizeT |
Width. |
| showPixelRate |
LmiUint64 |
Width. |
| showState |
LmiString |
State of how the source is received from the server (on/off/auto). |
| showWidth |
LmiSizeT |
Width. |
| videoDeltaFromAudioMs |
LmiInt |
Last known delta between audio and video before de-jittering in milliseconds. Negative number means audio is behind video. |
| width |
LmiSizeT |
Width. |
VidyoRoomStats
Staticstics for a room.
Properties
| Name |
Type |
Description |
| availableDecodeBwPercent |
LmiUint |
Available Percent of the Bandwidth for the decoder. |
| availableDecodeCpuPercent |
LmiUint |
Available Percent of the CPU for the decoder. |
| availableEncodeBwPercent |
LmiUint |
Available Percent of the Bandwidth for the encoder. |
| availableEncodeCpuPercent |
LmiUint |
Available Percent of the CPU for the encoder. |
| bandwidthApp |
VidyoBandwidthSummaryStats |
Bandwidth summary statistics of application content. |
| bandwidthAudio |
VidyoBandwidthSummaryStats |
Bandwidth summary statistics of audio content. |
| bandwidthVideo |
VidyoBandwidthSummaryStats |
Bandwidth summary statistics of video content. |
| callId |
LmiString |
Unique ID every time media is started and stopped. |
| conferenceId |
LmiString |
ID conference on the reflector associated with this VidyoRoom. |
| cpuUsage |
LmiUint |
Current CPU usage. |
| currentBandwidthDecodePixelRate |
LmiUint64 |
Current Bandwidth decode pixel rate. |
| currentBandwidthEncodePixelRate |
LmiUint64 |
Current Bandwidth encode pixel rate. |
| currentCpuDecodePixelRate |
LmiUint64 |
Current CPU decode pixel rate. |
| currentCpuEncodePixelRate |
LmiUint64 |
Current CPU encode pixel rate. |
| id |
LmiString |
Room ID. |
| maxDecodePixelRate |
LmiUint64 |
Max decode pixel rate. |
| maxEncodePixelRate |
LmiUint64 |
Max encode pixel rate. |
| maxVideoSources |
LmiUint |
Maximum video sources allowed based on the minimum of configured and constrained by resource manager. |
| participantGenerationStats |
LmiVector(VidyoParticipantGenerationStats) |
Ordered list of generations (selected participants). |
| participantStats |
LmiVector(VidyoParticipantStats) |
Vector of stats of participants. |
| rateShaperApp |
VidyoRateShaperStats |
Rate shaper statistics of application content. |
| rateShaperAudio |
VidyoRateShaperStats |
Rate shaper statistics of audio content. |
| rateShaperVideo |
VidyoRateShaperStats |
Rate shaper statistics of video content. |
| receiveBitRateAvailable |
LmiUint64 |
Actual ABA receive bandwidth. |
| receiveBitRateTotal |
LmiUint64 |
Available ABA receive bandwidth. |
| reflectorId |
LmiString |
ID of the refector to which the media conneciton is established. |
| sendBitRateAvailable |
LmiUint64 |
Actual ABA send bandwidth. |
| sendBitRateTotal |
LmiUint64 |
Available ABA send bandwidth. |
| staticSources |
LmiUint |
Current ammount of static sources shown. |
| transportInformation |
LmiVector(VidyoMediaConnectionTransportInfo) |
Vector of media transport information. |
VidyoUserStats
Statistics for an user.
Properties
