#include "SidPlatform.hpp"#include "sidg_Skyperefs.hpp"#include "sidg_msgs_Skype.hpp"
Include dependency graph for skype-embedded_2.h:
This graph shows which files directly or indirectly include this file:Go to the source code of this file.
Classes | |
| class | ContactGroup |
| Collects and manages Contacts related by type, status, or some other arbitrary criteria. More... | |
| class | Contact |
| Address book entry. Encapsulates methods like GetType, GetIdentity, GetAvatar, SendAuthRequest, OpenConversation etc. Single contact can have additional phone numbers attached to it (ASSIGNED_PHONE1 .. ASSIGNED_PHONE3). Note that in the context of a conversation, Contacts are represented by Participant objects. More... | |
| class | ContactSearch |
| This class encapsulates functionality for looking up contacts on the Skype network. Contacts can be searched by portion of their name, e-mail address, language preferences, etc. More... | |
| class | Participant |
| Conversation participant class. Instances of this class represent contacts when in the context of conversations. Amongst others, this class has a Ring method for requesting live status with the target contact. This class also holds typing indicator property and access rights for the contact in context of public conversations. . More... | |
| class | Conversation |
| The Conversation class encapsulates all types of communication possible with Skype client. Instant messaging, calls, video calls, file transfers, SMS, screen sharing - all take place within the context of a Conversation. Contacts are represented in Conversation as Participant objects. This also applies to contacts of PSTN type. All events in a conversation are represented as Message objects. . More... | |
| class | Message |
| Events in a conversation context are expressed as Messages. It is therefore useful to think of Message objects as events, rather than specifically text chat messages. More... | |
| class | Video |
| This class contains basic video control functionality for live conversations with video. Basically, Video objects represent specific Participant's video state in a live Conversation. The Video class can represent both local (outgoing) and remote (incoming) video streams. Note that as of SkypeKit SDK version 3.2, this class no longer handles video rendering in the UI. More... | |
| class | Voicemail |
| Wrapper class that includes voicemail-specific methods and properties. More... | |
| class | Sms |
| Wrapper class that includes SMS-specific properties and methods, such as P_BODY and GetTargetPrice. Instantiate SMS instances using Skype::CreateOutgoingSms; post SMS messages to a Conversation using Conversation::PostSMS. More... | |
| class | Transfer |
| Transfer in this context refers to transferring (sending/receiving) files among Skype Contacts, not transferring a call to another Skype or PSTN Contact. This class includes file transfer-specific properties and methods, such as FILESIZE, BYTESPERSECOND, Pause and Resume. Recipients of these file transfers must explicitly accept (or decline) any incoming transfer. More... | |
| class | Account |
| Represents a local account. Encapsulates methods for Skype account creation, login and logout as well as account profile setting properties. NB! Unlike all the other SkypeKit classes, most of the Account class properties are actually read-write. More... | |
| class | Skype |
| The main class that exposes Skype-related functionality to your application. Currently the SDK only supports one Skype class instance per runtime. Note that most of the Skype class methods will fail until you have successfully logged in with an account. For more information on constructing a Skype object and the login sequence, see first tutorial example. . More... | |
Defines | |
| #define | __EA(a) #a |
| #define | SETUPKEY_ENABLE_BIRTHDAY_NOTIFICATION "Lib/Conversation/EnableBirthday" |
| #define | SETUPKEY_INBOX_UPDATE_TIMEOUT "Lib/Conversation/InboxUpdateTimeout" |
| #define | SETUPKEY_RECENTLY_LIVE_TIMEOUT "Lib/Conversation/RecentlyLiveTimeout" |
| #define | SETUPKEY_DISABLE_CHAT "Lib/Chat/DisableChat" |
| #define | SETUPKEY_DISABLE_CHAT_HISTORY "Lib/Message/DisableHistory" |
| #define | SETUPKEY_CHAT_HISTORY_DAYS "Lib/Chat/HistoryDays" |
| #define | SETUPKEY_CHATDB_LIMIT_KB "Lib/Chat/ChatDBLimitKb" |
| #define | SETUPKEY_DISABLE_CHAT_ACTIVITY_INDICATION "Lib/Chat/DisableActivityIndication" |
| #define | SETUPKEY_CALL_NOANSWER_TIMEOUT "Lib/Call/NoAnswerTimeout" |
| #define | SETUPKEY_CALL_SEND_TO_VM "Lib/Call/SendToVM" |
| #define | SETUPKEY_CALL_APPLY_CF "Lib/Call/ApplyCF" |
| #define | SETUPKEY_CALL_EMERGENCY_COUNTRY "Lib/Call/EmergencyCountry" |
| #define | SETUPKEY_VIDEO_DEVICE "Lib/Video/Device" |
| #define | SETUPKEY_VIDEO_DEVICE_PATH "Lib/Video/DevicePath" |
| #define | SETUPKEY_VIDEO_AUTOSEND "Lib/Video/AutoSend" |
| #define | SETUPKEY_VIDEO_DISABLE "*Lib/Video/Disable" |
| #define | SETUPKEY_VIDEO_RECVPOLICY "Lib/Video/RecvPolicy" |
| #define | SETUPKEY_VIDEO_ADVERTPOLICY "Lib/Video/AdvertPolicy" |
| #define | SETUPKEY_DB_STORAGE_QUOTA_KB "*Lib/DbManager/StorageQuotaKb" |
| #define | SETUPKEY_DISABLED_CODECS "*Lib/Audio/DisableCodecs" |
| #define | SETUPKEY_DISABLE_AEC "*Lib/Audio/DisableAEC" |
| #define | SETUPKEY_DISABLE_NOISE_SUPPRESSOR "*Lib/Audio/DisableNS" |
| #define | SETUPKEY_DISABLE_AGC "*Lib/Audio/DisableAGC" |
| #define | SETUPKEY_DISABLE_DIGITAL_NEAR_END_AGC "*Lib/Audio/DisableDigitalNearEndAGC" |
| #define | SETUPKEY_DISABLE_DIGITAL_FAR_END_AGC "*Lib/Audio/DisableDigitalFarEndAGC" |
| #define | SETUPKEY_BEAMFORMER_MIC_SPACING "*Lib/Audio/BeamformerMicSpacing" |
| #define | SETUPKEY_DISABLE_AUDIO_DEVICE_PROBING "*Lib/QualityMonitor/DisableAudioDeviceProbing" |
| #define | SETUPKEY_FT_AUTOACCEPT "Lib/FileTransfer/AutoAccept" |
| #define | SETUPKEY_FT_SAVEPATH "Lib/FileTransfer/SavePath" |
| #define | SETUPKEY_FT_INCOMING_LIMIT "Lib/FileTransfer/IncomingLimit" |
| #define | SETUPKEY_IDLE_TIME_FOR_AWAY "Lib/Account/IdleTimeForAway" |
| #define | SETUPKEY_IDLE_TIME_FOR_NA "Lib/Account/IdleTimeForNA" |
| #define | SETUPKEY_PORT "*Lib/Connection/Port" |
| #define | SETUPKEY_HTTPS_PROXY_ENABLE "*Lib/Connection/HttpsProxy/Enable" |
| #define | SETUPKEY_HTTPS_PROXY_ADDR "*Lib/Connection/HttpsProxy/Addr" |
| #define | SETUPKEY_HTTPS_PROXY_USER "*Lib/Connection/HttpsProxy/User" |
| #define | SETUPKEY_HTTPS_PROXY_PWD "*Lib/Connection/HttpsProxy/Pwd" |
| #define | SETUPKEY_SOCKS_PROXY_ENABLE "*Lib/Connection/SocksProxy/Enable" |
| #define | SETUPKEY_SOCKS_PROXY_ADDR "*Lib/Connection/SocksProxy/Addr" |
| #define | SETUPKEY_SOCKS_PROXY_USER "*Lib/Connection/SocksProxy/User" |
| #define | SETUPKEY_SOCKS_PROXY_PWD "*Lib/Connection/SocksProxy/Pwd" |
| #define | SETUPKEY_LOCALADDRESS "*Lib/Connection/LocalAddress" |
| #define | SETUPKEY_DISABLE_PORT80 "*Lib/Connection/DisablePort80" |
| #define | SETUPKEY_DISABLE_UDP "*Lib/Connection/DisableUDP" |
Enumerations | |
| enum | TRANSFER_SENDFILE_ERROR { TRANSFER_OPEN_SUCCESS = 0, TRANSFER_BAD_FILENAME, TRANSFER_OPEN_FAILED, TRANSFER_TOO_MANY_PARALLEL } |
| #define __EA | ( | a | ) | #a |
Definition at line 9 of file skype-embedded_2.h.
| #define SETUPKEY_BEAMFORMER_MIC_SPACING "*Lib/Audio/BeamformerMicSpacing" |
Setupkey SETUPKEY_BEAMFORMER_MIC_SPACING type:string
Space-separated array of 1 (in case of 2 microphones) or 2 (in case of 4 microphones) integers. SAL beamforming currently only supports 2 and 4-microphone configurations. The values represent the spacing between microphones (in millimeters).
In case of 2-microphone setup, Only the first value is used.
In case of 4-microphone setup, The first value is the distance between inner pair of microphones. The second value is the distance between inner pair of microphones and the outer pair. Like this:
Let the microphones be on straight line, A B C D.
Microphones B and C form the inner pair, while A and D form the outer pair.
The first value in the setup string would be distance between B and C.
The second value would be distance between A and B (which is the same as distance between C and D).
With 4-mic setup, you will need to use two channels. The inner pair should go to one channel (left) and the outer pair should go to another (right).
This setup key is machine-specific and affects all local accounts.
Definition at line 3353 of file skype-embedded_2.h.
| #define SETUPKEY_CALL_APPLY_CF "Lib/Call/ApplyCF" |
Setupkey SETUPKEY_CALL_APPLY_CF type:int
Enables/disables call forwarding.
Definition at line 1125 of file skype-embedded_2.h.
| #define SETUPKEY_CALL_EMERGENCY_COUNTRY "Lib/Call/EmergencyCountry" |
Setupkey SETUPKEY_CALL_EMERGENCY_COUNTRY type:string
Country code for emergency calls
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 1128 of file skype-embedded_2.h.
| #define SETUPKEY_CALL_NOANSWER_TIMEOUT "Lib/Call/NoAnswerTimeout" |
Setupkey SETUPKEY_CALL_NOANSWER_TIMEOUT type:int default value:"15"
Timeout in seconds after which the incoming live session will stop ringing (and if possible, proceed to voicemail or call forward).
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 1119 of file skype-embedded_2.h.
| #define SETUPKEY_CALL_SEND_TO_VM "Lib/Call/SendToVM" |
Setupkey SETUPKEY_CALL_SEND_TO_VM type:int
Autoforwarding of incoming calls to voicemail.
Definition at line 1122 of file skype-embedded_2.h.
| #define SETUPKEY_CHAT_HISTORY_DAYS "Lib/Chat/HistoryDays" |
Setupkey SETUPKEY_CHAT_HISTORY_DAYS type:int
Time limit for keeping local chat message history.
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 1110 of file skype-embedded_2.h.
| #define SETUPKEY_CHATDB_LIMIT_KB "Lib/Chat/ChatDBLimitKb" |
Setupkey SETUPKEY_CHATDB_LIMIT_KB type:int default value:"0" Use this key to limit the size of the chat db. Value is in KB. By default there is no limit. A minimum of 16 MB is recommended.
Definition at line 1113 of file skype-embedded_2.h.
| #define SETUPKEY_DB_STORAGE_QUOTA_KB "*Lib/DbManager/StorageQuotaKb" |
Setupkey SETUPKEY_DB_STORAGE_QUOTA_KB type:int default value:"0"
Use this key to limit the size of the main.db file. Value is in KB. Quota are disabled by default.
This setup key is machine-specific and affects all local accounts.
Definition at line 3090 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLE_AEC "*Lib/Audio/DisableAEC" |
Setupkey SETUPKEY_DISABLE_AEC type:boolean
Disables Skype echo canceller
This setup key is machine-specific and affects all local accounts.
Definition at line 3338 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLE_AGC "*Lib/Audio/DisableAGC" |
Setupkey SETUPKEY_DISABLE_AGC type:boolean Disables Skype automatic gain controller
This setup key is machine-specific and affects all local accounts.
Definition at line 3344 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLE_AUDIO_DEVICE_PROBING "*Lib/QualityMonitor/DisableAudioDeviceProbing" |
Setupkey SETUPKEY_DISABLE_AUDIO_DEVICE_PROBING type:boolean
Disables audio devices probing
This setup key is machine-specific and affects all local accounts.
Definition at line 3356 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLE_CHAT "Lib/Chat/DisableChat" |
Setupkey SETUPKEY_DISABLE_CHAT type:int Disables chat (for voice only clients).
This setup key is machine-specific and affects all local accounts.
Definition at line 1104 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLE_CHAT_ACTIVITY_INDICATION "Lib/Chat/DisableActivityIndication" |
Setupkey SETUPKEY_DISABLE_CHAT_ACTIVITY_INDICATION type:int
Enables/disables transmitting typing indicator signals to othe participants of conversations.
Definition at line 1116 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLE_CHAT_HISTORY "Lib/Message/DisableHistory" |
Setupkey SETUPKEY_DISABLE_CHAT_HISTORY type:int
Disables storage of chat history.
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 1107 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLE_DIGITAL_FAR_END_AGC "*Lib/Audio/DisableDigitalFarEndAGC" |
Setupkey SETUPKEY_DISABLE_DIGITAL_FAR_END_AGC type:boolean
Disables Skype digital far-end gain controller
This setup key is machine-specific and affects all local accounts.
Definition at line 3350 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLE_DIGITAL_NEAR_END_AGC "*Lib/Audio/DisableDigitalNearEndAGC" |
Setupkey SETUPKEY_DISABLE_DIGITAL_NEAR_END_AGC type:boolean
Disables Skype digital near-end gain controller
This setup key is machine-specific and affects all local accounts.
Definition at line 3347 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLE_NOISE_SUPPRESSOR "*Lib/Audio/DisableNS" |
Setupkey SETUPKEY_DISABLE_NOISE_SUPPRESSOR type:boolean
Disables Skype noise suppressor
This setup key is machine-specific and affects all local accounts.
Definition at line 3341 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLE_PORT80 "*Lib/Connection/DisablePort80" |
Setupkey SETUPKEY_DISABLE_PORT80 type:int
1 disables listening of alternative ports (80, 443)
This setup key is machine-specific and affects all local accounts.
Definition at line 3636 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLE_UDP "*Lib/Connection/DisableUDP" |
Setupkey SETUPKEY_DISABLE_UDP type:int
1 disables UDP port binding. should be set before connect
This setup key is machine-specific and affects all local accounts.
Definition at line 3639 of file skype-embedded_2.h.
| #define SETUPKEY_DISABLED_CODECS "*Lib/Audio/DisableCodecs" |
Setupkey SETUPKEY_DISABLED_CODECS type:string
Space-separated array of disabled codecs
This setup key is machine-specific and affects all local accounts.
Definition at line 3335 of file skype-embedded_2.h.
| #define SETUPKEY_ENABLE_BIRTHDAY_NOTIFICATION "Lib/Conversation/EnableBirthday" |
Setupkey SETUPKEY_ENABLE_BIRTHDAY_NOTIFICATION type:int default value:"1"
Enables/disables birthday notification messages.
Definition at line 1095 of file skype-embedded_2.h.
| #define SETUPKEY_FT_AUTOACCEPT "Lib/FileTransfer/AutoAccept" |
Setupkey SETUPKEY_FT_AUTOACCEPT type:int
Controls file transfer auto-accept.
Definition at line 3532 of file skype-embedded_2.h.
| #define SETUPKEY_FT_INCOMING_LIMIT "Lib/FileTransfer/IncomingLimit" |
Setupkey SETUPKEY_FT_INCOMING_LIMIT type:uint
Number of simultaneous incoming file transfers (per user). Value 0 means no limitation.
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 3538 of file skype-embedded_2.h.
| #define SETUPKEY_FT_SAVEPATH "Lib/FileTransfer/SavePath" |
Setupkey SETUPKEY_FT_SAVEPATH type:string
Full local path to save incoming file transfers (used for AutoAccept feature)
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 3535 of file skype-embedded_2.h.
| #define SETUPKEY_HTTPS_PROXY_ADDR "*Lib/Connection/HttpsProxy/Addr" |
Setupkey SETUPKEY_HTTPS_PROXY_ADDR type:string
name:port of HTTP proxy server
This setup key is machine-specific and affects all local accounts.
Definition at line 3612 of file skype-embedded_2.h.
| #define SETUPKEY_HTTPS_PROXY_ENABLE "*Lib/Connection/HttpsProxy/Enable" |
Setupkey SETUPKEY_HTTPS_PROXY_ENABLE type:int
Set to 0 for automatic proxy detect, 1 to use proxy config below
This setup key is machine-specific and affects all local accounts.
Definition at line 3609 of file skype-embedded_2.h.
| #define SETUPKEY_HTTPS_PROXY_PWD "*Lib/Connection/HttpsProxy/Pwd" |
Setupkey SETUPKEY_HTTPS_PROXY_PWD type:string
HTTPS proxy server password (base64 encoded)
This setup key is machine-specific and affects all local accounts.
Definition at line 3618 of file skype-embedded_2.h.
| #define SETUPKEY_HTTPS_PROXY_USER "*Lib/Connection/HttpsProxy/User" |
Setupkey SETUPKEY_HTTPS_PROXY_USER type:string
HTTPS proxy server username
This setup key is machine-specific and affects all local accounts.
Definition at line 3615 of file skype-embedded_2.h.
| #define SETUPKEY_IDLE_TIME_FOR_AWAY "Lib/Account/IdleTimeForAway" |
Setupkey SETUPKEY_IDLE_TIME_FOR_AWAY type:int
Number of seconds since the last keyboard or mouse activity, after which the online status of currently logged in account should be set to AWAY. See Account::SetAvailability method for more information.
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 3541 of file skype-embedded_2.h.
| #define SETUPKEY_IDLE_TIME_FOR_NA "Lib/Account/IdleTimeForNA" |
Setupkey SETUPKEY_IDLE_TIME_FOR_NA type:int
The Contact::AVAILABILITY.NOT_AVAILABLE online status has been deprecated. This setup key is no longer in use.
Definition at line 3544 of file skype-embedded_2.h.
| #define SETUPKEY_INBOX_UPDATE_TIMEOUT "Lib/Conversation/InboxUpdateTimeout" |
Setupkey SETUPKEY_INBOX_UPDATE_TIMEOUT type:int
Timeout in seconds, how old the Conversation::P_INBOX_TIMESTAMP has to be for it to be re-sorted in the inbox.
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 1098 of file skype-embedded_2.h.
| #define SETUPKEY_LOCALADDRESS "*Lib/Connection/LocalAddress" |
Setupkey SETUPKEY_LOCALADDRESS type:string
local interface to listen to
This setup key is machine-specific and affects all local accounts.
Definition at line 3633 of file skype-embedded_2.h.
| #define SETUPKEY_PORT "*Lib/Connection/Port" |
Setupkey SETUPKEY_PORT type:int
Suggested port number (lib will *try* to use that)
This setup key is machine-specific and affects all local accounts.
Definition at line 3606 of file skype-embedded_2.h.
| #define SETUPKEY_RECENTLY_LIVE_TIMEOUT "Lib/Conversation/RecentlyLiveTimeout" |
Setupkey SETUPKEY_RECENTLY_LIVE_TIMEOUT type:int default value:"20"
The number of seconds a formerly live conversation will remain the Conversation::LIVE_CONVERSATIONS filter. Note that while the conversation remains in Conversation::LIVE_CONVERSATIONS filter, Skype::OnConversationListChange events will not fire if there is another call coming up within the same conversation. Seeting this key to 0 will cause conversations to exit the Conversation::LIVE_CONVERSATIONS list immediately, after live state drops.
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 1101 of file skype-embedded_2.h.
| #define SETUPKEY_SOCKS_PROXY_ADDR "*Lib/Connection/SocksProxy/Addr" |
Setupkey SETUPKEY_SOCKS_PROXY_ADDR type:string
name:port of SOCKS proxy server
This setup key is machine-specific and affects all local accounts.
Definition at line 3624 of file skype-embedded_2.h.
| #define SETUPKEY_SOCKS_PROXY_ENABLE "*Lib/Connection/SocksProxy/Enable" |
Setupkey SETUPKEY_SOCKS_PROXY_ENABLE type:int
Set to non-zero to enable socks proxy support
This setup key is machine-specific and affects all local accounts.
Definition at line 3621 of file skype-embedded_2.h.
| #define SETUPKEY_SOCKS_PROXY_PWD "*Lib/Connection/SocksProxy/Pwd" |
Setupkey SETUPKEY_SOCKS_PROXY_PWD type:string
SOCKS proxy server password (base64 encoded)
This setup key is machine-specific and affects all local accounts.
Definition at line 3630 of file skype-embedded_2.h.
| #define SETUPKEY_SOCKS_PROXY_USER "*Lib/Connection/SocksProxy/User" |
Setupkey SETUPKEY_SOCKS_PROXY_USER type:string
SOCKS proxy server username
This setup key is machine-specific and affects all local accounts.
Definition at line 3627 of file skype-embedded_2.h.
| #define SETUPKEY_VIDEO_ADVERTPOLICY "Lib/Video/AdvertPolicy" |
Setupkey SETUPKEY_VIDEO_ADVERTPOLICY type:string default value:"contacts"
noone | contacts | everyone
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 1863 of file skype-embedded_2.h.
| #define SETUPKEY_VIDEO_AUTOSEND "Lib/Video/AutoSend" |
Setupkey SETUPKEY_VIDEO_AUTOSEND type:int
Setting this to 1 starts sending video automatically when call starts
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 1854 of file skype-embedded_2.h.
| #define SETUPKEY_VIDEO_DEVICE "Lib/Video/Device" |
Setupkey SETUPKEY_VIDEO_DEVICE type:string
Selected video device name
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 1848 of file skype-embedded_2.h.
| #define SETUPKEY_VIDEO_DEVICE_PATH "Lib/Video/DevicePath" |
Setupkey SETUPKEY_VIDEO_DEVICE_PATH type:string
Currently selected video device path.
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 1851 of file skype-embedded_2.h.
| #define SETUPKEY_VIDEO_DISABLE "*Lib/Video/Disable" |
Setupkey SETUPKEY_VIDEO_DISABLE type:int
Setting this to 1 disables all video functionality.
This setup key is machine-specific and affects all local accounts.
Definition at line 1857 of file skype-embedded_2.h.
| #define SETUPKEY_VIDEO_RECVPOLICY "Lib/Video/RecvPolicy" |
Setupkey SETUPKEY_VIDEO_RECVPOLICY type:string default value:"contacts"
noone | contacts | callpolicy
This is account-specific setup key. It can only be used while an account is logged in.
Definition at line 1860 of file skype-embedded_2.h.
sync failure reasons when starting a transfer
| TRANSFER_OPEN_SUCCESS | |
| TRANSFER_BAD_FILENAME | |
| TRANSFER_OPEN_FAILED | |
| TRANSFER_TOO_MANY_PARALLEL |
Definition at line 789 of file skype-embedded_2.h.
(c) Skype Technologies S.A. Confidential/Proprietary
Last updated: Fri Mar 16 2012