| Home | Trees | Indices | Help |
|
|---|
|
|
object --+
|
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.
| Instance Methods | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Inherited from |
|||
| Class Variables | |
module_id = 0
|
|
event_handlers =
|
|
SETUPKEY_DB_STORAGE_QUOTA_KB =
|
|
IDENTITYTYPE = UNRECOGNIZED |
|
NORMALIZERESULT = IDENTITY_OK |
|
TRANSFER_SENDFILE_ERROR = sync failure reasons when starting a transfer |
|
SETUPKEY_DISABLED_CODECS =
|
|
SETUPKEY_DISABLE_AEC =
|
|
SETUPKEY_DISABLE_NOISE_SUPPRESSOR =
|
|
SETUPKEY_DISABLE_AGC =
|
|
SETUPKEY_DISABLE_DIGITAL_NEAR_END_AGC =
|
|
SETUPKEY_DISABLE_DIGITAL_FAR_END_AGC =
|
|
SETUPKEY_BEAMFORMER_MIC_SPACING =
|
|
SETUPKEY_DISABLE_AUDIO_DEVICE_PROBING =
|
|
PREPARESOUNDRESULT = PREPARESOUND_SUCCESS |
|
AUDIODEVICE_CAPABILITIES = HAS_VIDEO_CAPTURE |
|
OPERATING_MEDIA = OM_UNKNOWN |
|
SETUPKEY_FT_AUTOACCEPT =
|
|
SETUPKEY_FT_SAVEPATH =
|
|
SETUPKEY_FT_INCOMING_LIMIT =
|
|
SETUPKEY_IDLE_TIME_FOR_AWAY =
|
|
SETUPKEY_IDLE_TIME_FOR_NA =
|
|
VALIDATERESULT = A value of this type can be returned by one of the following methods (of Skype class): ValidateAvatar, ValidateProfileString, ValidatePassword. |
|
SETUPKEY_PORT =
|
|
SETUPKEY_HTTPS_PROXY_ENABLE =
|
|
SETUPKEY_HTTPS_PROXY_ADDR =
|
|
SETUPKEY_HTTPS_PROXY_USER =
|
|
SETUPKEY_HTTPS_PROXY_PWD =
|
|
SETUPKEY_SOCKS_PROXY_ENABLE =
|
|
SETUPKEY_SOCKS_PROXY_ADDR =
|
|
SETUPKEY_SOCKS_PROXY_USER =
|
|
SETUPKEY_SOCKS_PROXY_PWD =
|
|
SETUPKEY_LOCALADDRESS =
|
|
SETUPKEY_DISABLE_PORT80 =
|
|
SETUPKEY_DISABLE_UDP =
|
|
PROXYTYPE = HTTPS_PROXY |
|
APP2APP_STREAMS = ALL_STREAMS |
|
| Properties | |
|
Inherited from |
| Method Details |
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
|
No description available. Return values:
|
returns the runtime version as a string Return values:
|
Takes TYPE argument (TYPE comes from ContactGroup class) and returns reference to the corresponding hardwired contact group. For example (C++): skype->GetHardwiredContactGroup(ContactGroup::ONLINE_BUDDIES, GroupRef) would return the list of all contacts that are currently online. Arguments:
Return values:
|
Returns a list of custom contact group references, i.e. all contact groups that are not hardwired. Return values:
|
Creates a new empty contact group object and returns a reference to it. The group will then show up in the custom group list that you can get with Skype class GetCustomContactGroups method. Existing contacts can be added to the new group with ContactGroup class AddContact method and a custom name can be given to it with GiveDisplayName method. Note that no check is made for existing of displaynames with the same name - if you wish to force uniqueness in custom group names you will have to check that yourself before creating the group. Return values:
|
No description available. Return values:
|
analyzes the identity for contact type Arguments:
Return values:
|
Returns a Contact object reference. If a matching contact is not found in the existing contact list, a new Contact object will be created. Note that if you pass in a phone number in the identity argument, the type for the newly created Contact will be automatically set to Contact::PSTN (Contact::SKYPE otherwise). Arguments:
Return values:
|
No description available. Arguments:
Return values:
|
This takes skypename or a phone number string as argument and returns corresponding identity type (SKYPE, SKYPE_MYSELF, PSTN, etc.) Arguments:
Return values:
|
compares two identities to see if they match Arguments:
Return values:
|
This method is deprecated. Use ValidateProfileString method instead. Arguments:
Return values:
|
NormalizePSTNWithCountry checks if the phone number starts with + if it doesn't, it prefixes the output with +XXX (where XXX is the country code). It also converts letters to numbers based on the standard phone keypad, so that the phone number string 212CALLME1 with country code 372 (Estonia) would be normalized to +3722122255631. If the method cannot normalize the phone number (because it's too long, too short, etc.), it returns an error code in &result. Arguments:
Return values:
|
This contact has appeared online. display alert Return values:
|
This contact has gone offline. display alert Return values:
|
list of (min,max) pairs Return values:
|
Creates a blank contact search object, in which you can add your custom search terms. For more information how asynchronous contact search works, see ContactSearch class details. Return values:
|
searches skypenames, aliases, fullnames, emails. false if not valid Arguments:
Return values:
|
searches skypenames and aliases. returns 0 or 1 results. false if not valid Arguments:
Return values:
|
Creates a new empty conversation object and returns a reference to it. Return values:
|
Returns reference tp conversation object by conversation ID string (equivalent of old chat ID). NB! ID here is that of conversation, rather than skypename of dialog partner. If you want to retrieve a conversation object with any particular person, then Skype class GetConversationByParticipants method is what you are looking for. Arguments:
Return values:
|
myself not included Arguments:
Return values:
|
Retrieves a Conversation object by Public Conversation BLOB. Public conversation blobs are globally unique conversation IDs that provide a method for joining conversation without explicitly being added to the conversation by someone already in it. Programmatically, a Conversation BLOB can be retrieved with Conversation::GetJoinBlob method. In Skype desktop clients, the BLOB can be retrieved by typing "/get uri" in a conversation. The conversation can then be joined by people who have somehow received that BLOB. Arguments:
Return values:
|
Returns a list of Conversation objects by Conversation::LIST_TYPE filter. Arguments:
Return values:
|
This event gets fired when a Conversation item is added or removed from the list specified in the type argument. The primary use of this event is to detect creation of new Conversation objects. It can also be used for detecting occurance of live sessions - by monitoring added = true in Conversation::LIVE_CONVERSATIONS. Note that this method is not entirely sufficient for detecting live session termination (added = false and type = Conversation::LIVE_CONVERSATIONS). When the live session goes down, the default behaviour is that the Conversation object remains in the LIVE_CONVERSATIONS list for approximately 10 seconds. When another live session comes up within the same Conversation, the OnConversationListChange event will not fire - because the conversation was already in that list. There are two ways of getting around that. Firstly you can have all the conversations referenced at all times and then monitor Conversation::P_LOCAL_LIVESTATUS property changes, in which case you can pick up incoming live sessions from there. Alternatively, you can remove the delay between live session termination and conversation's removal from the LIVE_CONVERSATIONS list. This delay is controlled by the SETUPKEY_RECENTLY_LIVE_TIMEOUT setup key. To remove the delay, use Skype::SetInt(SETUPKEY_RECENTLY_LIVE_TIMEOUT, 0). Note that this setup key is account-based. You will need to have an account logged in in order to modify its value. Return values:
|
Retrieves a Message object by the P_GUID property (globally unique ID, same for all the participants of the conversation, in which this message occured). Arguments:
Return values:
|
Returns all messages of the given type, the most recent POSTED_EMOTE or POSTED_TEXT of each conversation. Arguments:
Return values:
|
No description available. Return values:
|
This method returns a table in form of two string lists of equal length and an uint argument that returns the count of items i both lists. The first list contains video recording device handles and the second list descriptive names of those devices. NB! This method requires videortphost to be running, otherwise it will return empty lists. Return values:
|
Queries whether the given video device has a specific Video::VIDEO_DEVICE_CAPABILITY. Use Skype::GetAvailableVideoDevices method to retrieve sstring lists with available deviceName and devicePath values. Arguments:
|
No description available. Arguments:
|
No description available. Arguments:
Return values:
|
Avaible to Video Engines using the Video RTP API Arguments:
Return values:
|
No description available. Arguments:
Return values:
|
Takes audio data that comes from the sound argument and mixes it into playback or notification device, depending on the value passed in the useCallOutDevice argument. The sound argument contains the audio data in in follwing format: first 4 bytes of the binary contain the sample rate, followed by 16 bit (mono) samples. The soundid argument is an arbitrary ID that you can pass in and then later use as an argument for Skype class PlayStop method. To mix the audio into playback device stream, set useCallOutDevice to true, to mic it into notification stream, set useCallOutDevice to false. Arguments:
|
No description available. Arguments:
Return values:
|
Stops playback of the soundfile. The argument is the same ID you passed in the Skype class StartPlayback method. Arguments:
|
No description available. Arguments:
|
This method returns a table in form of three string lists of equal lengths. The first list contains audio output device handles ('hw:0,0', 'hw:0,1', etc.) The second list contains descriptive names of those devices (Ensoniq AudioPCI etc.) The third list contains device product IDs. Note that the values in these lists depend on which audio engine you are running (SAL, PCM, RTP). Return values:
|
This method returns a table in form of three string lists of equal length. The first list contains audio recording device handles ('hw:0,0', 'hw:0,1', etc.) The second list contains descriptive names of those devices (Ensoniq AudioPCI etc.) The third list contains device product IDs. Note that the values in these lists depend on which audio engine you are running (SAL, PCM, RTP). Return values:
|
Sets audio devices given in arguments as active audio devices. This command selects all three devices - microphone, playback and the notification channel. Valid input values for this method come from the first string list you get back from Skype class GetAvailableOutputDevices (handleList). Arguments:
|
The uint argument returns AUDIODEVICE_CAPABILITIES (declared in Skype class) Arguments:
Return values:
|
Returns current audio stream volume for both playback and microphone streams. Useful for displaying visual audio indicators in you UI. See also Skype class OnNrgLevelsChange callback that gets fired each time the these values are changed. Return values:
|
NB! This command only works if its implemented in external audiohost (RTP or PCM host). The command can be is used for passing custom commands from client UI to the audio implementation. Arguments:
Return values:
|
Returns value of audio playback volume setting (0..100). Return values:
|
This method is for setting speaker volume. It will set the level for Skype digital gain control. Skype audio library will not control gain of audio device itself. Arguments:
|
Returns value of microphone volume setting (0..100). It will return the analog gain of audio device set by Skype AGC. For real-time microphone volume, use GetNrgLevels method or OnNrgLevelsChange callback (both are methods of Skype class). Return values:
|
This method is for setting the microphone volume level. This does not work when Skype AGC (Automatic Gain Control) is enabled, which it is by default. It is currently impossible to disable AGC, so for now this method is here for purpose of future compatibility. Arguments:
|
Returns true in &muted argument if the currently selected playback device is muted. Return values:
|
Returns true in &muted argument if the currently selected microphone is muted. Return values:
|
Sets currently selected playback device mute status according to argument. Arguments:
|
Sets currently selected microphone mute status according to argument. Arguments:
|
This callback gets fired when the audio strength changes in either playback or recording audio streams. Useful for providing visual indicators of audio activity in your UI. |
No description available. Arguments:
|
creates an CONFIRMATION_CODE_REQUEST SMS message Arguments:
Return values:
|
creates an CONFIRMATION_CODE_REQUEST SMS message Arguments:
Return values:
|
creates an OUTGOING/COMPOSING SMS message Return values:
|
Retrieves an Account object by Skype name (identity). This should normally be one of the first method calls after Skype object initialization. Nearly all the other methods require successful account login in order to work properly. The list of accounts that have been used on the local machine/database can be retrieved with Skype::GetExistingAccounts method. If a matching identity is not found, a new Account object is created. This object can then be used to populate requred fields and then use Account::Register method for new account creation. This method returns false on error. Arguments:
Return values:
|
Returns a list of possible profiles used before on this machine Return values:
|
return most recently used account that has pwd saved. empty string if none Return values:
|
suggest a nice skypename to go with given fullname Arguments:
Return values:
|
No description available. Arguments:
Return values:
|
This method should be used for validating skypenames before registering new accounts, if the propKey is set to SKYPENAME (Contact class) and forRegistration argument is set to true. If the forRegistration argument is false, only string length check is applied. It is also useful to probe, what the size limits are, for each string property (e.g. 300 characters for moodmessage) Arguments:
Return values:
|
This method is for pre-validating account passwords before account creation or password change. The result will return either VALIDATED_OK or one of many possible reasons the password is unacceptable (too short, too simple, etc.) Arguments:
Return values:
|
No description available. Return values:
|
This is used for retrieving local setup keys of type string. For more information, see Defines section in the skype-embedded_2.h Arguments:
Return values:
|
This is used for retrieving local setup keys of type int. For more information, see Defines section in the skype-embedded_2.h Arguments:
Return values:
|
This is used for retrieving local setup keys of type binary. For more information, see Defines section in the skype-embedded_2.h Arguments:
Return values:
|
This is used for setting local setup keys of type string. For more information, see Defines section in the skype-embedded_2.h Arguments:
|
This is used for setting local setup keys of type int. For more information, see Defines section in the skype-embedded_2.h Arguments:
|
This is used for setting local setup keys of type binary. For more information, see Defines section in the skype-embedded_2.h Arguments:
|
Returns true if the given setup key is defined in local setup. For more information, see Defines section in the skype-embedded_2.h Arguments:
Return values:
|
No description available. Arguments:
|
No description available. Arguments:
Return values:
|
Returns two string lists. First of them will contain list of two-letter language codes (ISO 639-1) The second list contains names of corresponding languages. Return values:
|
Returns three string lists and one int array, containing 2-letter country code, country name, dialing prefix and example dial string (not available for all items). This method does currently return 0 for South Georgia and the South Sandwich Islands. Return values:
|
Returns 2-letter country code based on PSTN number. The input argument has to be without + in from of it - '37212345678' will return 'ee' while '+37212345678' will return an empty string. Arguments:
Return values:
|
App2AppCreate method constructs a local instance of an App2App application. App2App applications are not abstracted in the SkypeKit API as a separate class. Rather, they can be created with App2AppCreate, supplying their name as ID, and then connected to remote parties using App2AppConnect method. App2App portion of the SkypeKit API enables you to implement arbitrary data exchange protocols between Skype clients. Basically, if you are ever tempted to use conversation chat messages for something other than actual human-readable chat - you should consider using your own custom App2App protocol instead. The downside of App2App is that all the participants need to be running a client that supports the same App2App application. Although, it is possible to have one side using a custom SkypeKit client and another side using Skype desktop client - App2App is supported in both, in case of desktop client via Public API - you are still limited to remote side running something that can recognize your protocol and react to connection attempts from your side. To establish connection between each other, all participants need to create their local instances of the application (with the same ID, and then connect to each other. More than one App2App applications can be active in a local client at the same time. Also, more than two clients can be connected with the same application. Once connection is established, you can choose between two communication methods - datagrams and stream read/write methods. Overall, there are not much principal difference between the two. Datagram packet size is limited to 1500 bytes and stream packet size to 32 KB of payload data. Implementation-wise, datagrams are probably somewhat easier to deal with. Arguments:
Return values:
|
Disconnects and deletes the App2App application. Arguments:
Return values:
|
The App2AppConnect connect result does not mean the connection was immediately established. It will return Ok even if the remote party was offline. The actual connection will be established when both parties have fired App2AppConnect with the same application name, at eachother. At that point, OnApp2AppStreamListChange event will fire for both local and remote party (with listType argument set to ALL_STREAMS) and you can start exchanging data, using either App2App datagrams or App2AppRead App2AppWrite methods. Arguments:
Return values:
|
Disconnects an App2App stream. This is different from App2AppDelete command in that it enables you to disconnect remote parties selectively - in case there are more than two participants in the App2App stream pool. Arguments:
Return values:
|
Sends a stream packet to the remote party specified in the stream argument. The max size of stream write packet is 32KB. After calling this method, OnApp2AppStreamListChange will fire for both parties. In local ssytem with listType set to SENDING_STREAMS and on remote system with listType set to RECEIVED_STREAMS. This event can be used to read received packets out of the stream. Arguments:
Return values:
|
Sends a datagram to the remote party specified in the stream argument. The max size of datagram payload is 1500 bytes. Arguments:
Return values:
|
Reads data from the specified stream. This method should be called from the OnApp2AppStreamListChange event callback, when this callback gets fired with listType argument set to RECEIVED_STREAMS. Arguments:
Return values:
|
App2AppGetConnectableUsers returns a list of currently online contacts. It does not return a list of contacts who have an app2app application running. There is currently no way of querying whether an application has been launched on the remote side - other than trying to connect to the remote side and waiting for timeout. NB! if you use App2AppGetConnectableUsers immediately after login - then the online presence of your contact list has not yet updated itself - so this method will most likely return either an empty list or a list with echo123 in it. Arguments:
Return values:
|
Takes application ID and list type filter and returns a stringlist with streamID's that pass the filter. Arguments:
Return values:
|
This event gets fired on incoming app2app datagram. Return values:
|
In context of datagrams, this event will fire when:
|
| Class Variable Details |
event_handlers
|
IDENTITYTYPE
|
NORMALIZERESULT
|
TRANSFER_SENDFILE_ERRORsync failure reasons when starting a transfer
|
SETUPKEY_DISABLE_DIGITAL_NEAR_END_AGC
|
SETUPKEY_DISABLE_DIGITAL_FAR_END_AGC
|
SETUPKEY_BEAMFORMER_MIC_SPACING
|
SETUPKEY_DISABLE_AUDIO_DEVICE_PROBING
|
PREPARESOUNDRESULT
|
AUDIODEVICE_CAPABILITIES
|
OPERATING_MEDIA
|
VALIDATERESULTA value of this type can be returned by one of the following methods (of Skype class): ValidateAvatar, ValidateProfileString, ValidatePassword.
|
PROXYTYPE
|
APP2APP_STREAMS
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Fri Mar 16 16:40:37 2012 | http://epydoc.sourceforge.net |