Plugin Skype

From VoxCommando
Jump to: navigation, search

More information on control of Skype.

---

Go to the main Plugins page.

Go to the complete Plugin List.


Plugin Description

Commands to perform various actions with Skype, including placing voice calls, sending text messages, answering, hanging up, etc.

Actions for the Skype plugin

Answer

Skype.Answer
Attempts to answer an incoming call immediately.

Connect

Skype.Connect
Establishes a link with Skype and enables Skype events to be generated. Skype will be started if it is not already running.

* Note this will create a connection between VoxCommando and Skype. It is not used to connect to a conversation.

EndCall

Skype.EndCall
Ends the current call. (Hang up).

CallContact

Skype.CallContact
Place a Skype call to contact named <Target>

The <Target> parameter can be a Skype contact name or a phone number. To call a phone you must have Skype credit.

  • Parameters: 1
  1. Target : Skype ID or phone number [string]

SendText

Skype.SendText
Send a text <Message> string to a skype contact.

  • Parameters: 2
  1. To : Skype contact name to send the message to [string]
  2. Message : The text of the message (body) to send. [string]

SetStatus

Skype.SetStatus
Sets your Skype status to <string>

valid values are:

Offline, Online, Away, NotAvailable, DoNotDisturb, Invisible, LoggedOut, SkypeMe

  • Parameters: 1
  1. String : <string> [string]

Settings

GetAudioIn

Skype.Settings.GetAudioIn
Returns the name of the currently active audio recording device.

GetAudioOut

Skype.Settings.GetAudioOut
Returns the name of the currently active audio playback (output) device.

GetRinger

Skype.Settings.GetRinger
Returns the name of the currently active audio device used to play ringtones.

GetVideoIn

Skype.Settings.GetVideoIn
Returns the name of the currently active video recording device.

SetAEC

Skype.Settings.SetAEC
Enable or disable AEC (Acoustic Echo Cancellation)

  • Parameters: 1
  1. AecState : True to enable AEC [boolean]

SetAGC

Skype.Settings.SetAGC
Enable or disable AGC (Automatic Gain Control)

  • Parameters: 1
  1. AgcState : True to enable AGC [boolean]

SetAutoAway

Skype.Settings.SetAutoAway
Enable or disable AutoAway mode.

  • Parameters: 1
  1. AutoAwayState : True to enable AutoAway mode [boolean]

SetAvatar

Skype.Settings.SetAvatar
Sets your Skype avatar image to the image file found at <ImagePath>.

  • Parameters: 1
  1. ImagePath : Path to image file [string]

SetAudioIn

Skype.Settings.SetAudioIn
Sets the active audio recording device to the device whose full name is <DeviceName>.

  • Parameters: 1
  1. DeviceName : The full name of the audio input device to select. [string]

SetAudioOut

Skype.Settings.SetAudioOut
Sets the active audio playback (output) device to the device whose full name is <DeviceName>.

  • Parameters: 1
  1. DeviceName : The full name of the audio input device to select. [string]

SetRinger

Skype.Settings.SetRinger
Sets the active audio device used to play ringtones to the device whose full name is <DeviceName>.

  • Parameters: 1
  1. DeviceName : The full name of the audio input device to select. [string]

SetVideoIn

Skype.Settings.SetVideoIn
Sets the active video recording device to the device whose full name is <DeviceName>.

  • Parameters: 1
  1. DeviceName : The full name of the video input device to select. [string]

GetUserInfo

Skype.GetUserInfo
infoType can be one of the following:
aliases
birthday
buddystatus
displayname
fullname
isblocked
lastonline
moodtext
onlinestatus
phonehome
phonemobile
phoneoffice
sex
speeddial
timezone

  • Parameters: 2
  1. SkypeID : the handle of user to get information with [string]
  2. InfoType : What information to get [string]

GetUsers

Skype.GetUsers
Returns a list of contact with matching <Status>.
Contact returned as MATCHES.
<Status> can be on of the following:
Any
Online
Offline
SkypeOut
NotAvailable
Away
DoNotDisturb

  • Parameters: 1
  1. Status : Get a list of contacts with matching status [string]