SkypeKit Setup Keys

In addition to object properties, there is a list of Skype setup options that can be either store typical client configuration options or to modify behaviour of SkypeKit runtime.

The values of setup options can be retrieved with Skype::GetInt, Skype::GetStr and Skype::GetBin methods. These methods take a string input argument - the setup key, and return the value.

The list of setup keys can be found in the Defines section of the skype-embedded_2.h

For example, lets consider the auto-away timer. To retrieve the value, you can:

int awayTime;
skype->GetInt(SETUPKEY_IDLE_TIME_FOR_AWAY, awayTime);
printf("away time: %d\n", awayTime);

..and to set the value we can use Skype::SetInt method:

awayTime = 20;
skype->SetInt(SETUPKEY_IDLE_TIME_FOR_AWAY, awayTime);

Note that setting this value does not in itself cause the account online status to automatically change in 20 seconds. This setup option only enables you to store this value. Keeping track of keyboard and mouse events and updating Account::P_AVAILABILITY property when the user has been quiet for 20 seconds is the job of client.

Also note that getting and setting this property will only work after you have an account logged in. This setup option can have different values for different accounts in the local database.

Some other setup keys are machine-based and affect all the accounts in the local database.

For example, this:

skype->SetInt(SETUPKEY_DISABLE_AEC, disableAEC);

disables echo cancellation in the SkypeKit runtime regardless of whether an account is logged in or not. Also note that unlike with auto-away timer, in this case the feature being controlled resides in the runtime rather than client. So, switching this setup option will actually work without you needing to implement it in your client.


 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

(c) Skype Technologies S.A. Confidential/Proprietary

Last updated: Fri Jan 27 2012