Package Skype4Py :: Module settings :: Class Settings
[frames] | no frames]

Class Settings

source code

object --+
         |
        Settings

Represents Skype settings. Access using skype.Skype.Settings.
Instance Methods
 
__init__(self, Skype)
__init__.
source code
 
Avatar(self, Id=1, Set=None)
Sets user avatar picture from file.
source code
 
LoadAvatarFromFile(self, Filename, AvatarId=1)
Loads user avatar picture from file.
source code
 
ResetIdleTimer(self)
Reset Skype idle timer.
source code
str or None
RingTone(self, Id=1, Set=None)
Returns/sets a ringtone.
source code
bool
RingToneStatus(self, Id=1, Set=None)
Enables/disables a ringtone.
source code
 
SaveAvatarToFile(self, Filename, AvatarId=1)
Saves user avatar picture to file.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
bool AEC
Automatic echo cancellation state.
bool AGC
Automatic gain control state.
unicode AudioIn
Name of an audio input device.
unicode AudioOut
Name of an audio output device.
bool AutoAway
Auto away status.
str Language
Language of the Skype client as an ISO code.
bool PCSpeaker
PCSpeaker status.
unicode Ringer
Name of a ringer device.
unicode VideoIn
Name of a video input device.

Inherited from object: __class__

Method Details

__init__(self, Skype)
(Constructor)

source code 
__init__.
Parameters:
Overrides: object.__init__

Avatar(self, Id=1, Set=None)

source code 
Sets user avatar picture from file.
Parameters:
  • Id (int) - Optional avatar Id.
  • Set (str) - New avatar file name.

Deprecated: Use LoadAvatarFromFile instead.

LoadAvatarFromFile(self, Filename, AvatarId=1)

source code 
Loads user avatar picture from file.
Parameters:
  • Filename (str) - Name of the avatar file.
  • AvatarId (int) - Optional avatar Id.

RingTone(self, Id=1, Set=None)

source code 
Returns/sets a ringtone.
Parameters:
  • Id (int) - Ringtone Id
  • Set (str) - Path to new ringtone or None if the current path should be queried.
Returns: str or None
Current path if Set=None, None otherwise.

RingToneStatus(self, Id=1, Set=None)

source code 
Enables/disables a ringtone.
Parameters:
  • Id (int) - Ringtone Id
  • Set (bool) - True/False if the ringtone should be enabled/disabled or None if the current status should be queried.
Returns: bool
Current status if Set=None, None otherwise.

SaveAvatarToFile(self, Filename, AvatarId=1)

source code 
Saves user avatar picture to file.
Parameters:
  • Filename (str) - Destination path.
  • AvatarId (int) - Avatar Id

Property Details

AEC

Automatic echo cancellation state.
Get Method:
_GetAEC(self)
Set Method:
_SetAEC(self, Value)
Type:
bool

Warning: Starting with Skype for Windows 3.6, this property has no effect. It can still be set for backwards compatibility reasons.

AGC

Automatic gain control state.
Get Method:
_GetAGC(self)
Set Method:
_SetAGC(self, Value)
Type:
bool

Warning: Starting with Skype for Windows 3.6, this property has no effect. It can still be set for backwards compatibility reasons.

AudioIn

Name of an audio input device.
Get Method:
_GetAudioIn(self)
Set Method:
_SetAudioIn(self, Value)
Type:
unicode

AudioOut

Name of an audio output device.
Get Method:
_GetAudioOut(self)
Set Method:
_SetAudioOut(self, Value)
Type:
unicode

AutoAway

Auto away status.
Get Method:
_GetAutoAway(self)
Set Method:
_SetAutoAway(self, Value)
Type:
bool

Language

Language of the Skype client as an ISO code.
Get Method:
_GetLanguage(self)
Set Method:
_SetLanguage(self, Value)
Type:
str

PCSpeaker

PCSpeaker status.
Get Method:
_GetPCSpeaker(self)
Set Method:
_SetPCSpeaker(self, Value)
Type:
bool

Ringer

Name of a ringer device.
Get Method:
_GetRinger(self)
Set Method:
_SetRinger(self, Value)
Type:
unicode

VideoIn

Name of a video input device.
Get Method:
_GetVideoIn(self)
Set Method:
_SetVideoIn(self, Value)
Type:
unicode