| Home | Trees | Indices | Help |
|
|---|
|
|
object --+
|
skypekit.Cached --+
|
skypekit.Object --+
|
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.
| Instance Methods | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Inherited from Inherited from Inherited from |
|||
| Static Methods | |||
|
|||
|
Inherited from |
|||
| Class Variables | |
event_handlers =
|
|
propid2label =
|
|
module_id = 19
|
|
RANK = Recognized values for the P_RANK property. |
|
TEXT_STATUS = Recognized values for the P_TEXT_STATUS property. |
|
VOICE_STATUS = Recognized values for the P_VOICE_STATUS property. |
|
VIDEO_STATUS = Recognized values for the P_VIDEO_STATUS property. |
|
DTMF = DTMF_0 |
|
P_CONVO_ID = 930
|
|
P_IDENTITY = 931
|
|
P_RANK = 932
|
|
P_REQUESTED_RANK = 933
|
|
P_TEXT_STATUS = 934
|
|
P_VOICE_STATUS = 935
|
|
P_VIDEO_STATUS = 936
|
|
P_LIVE_IDENTITY = 943
|
|
P_LIVE_PRICE_FOR_ME = 938
|
|
P_LIVE_FWD_IDENTITIES = 948
|
|
P_LIVE_START_TIMESTAMP = 939
|
|
P_SOUND_LEVEL = 941
|
|
P_DEBUGINFO = 942
|
|
P_LAST_VOICE_ERROR = 947
|
|
P_QUALITY_PROBLEMS = 949
|
|
P_LIVE_TYPE = 950
|
|
P_LIVE_COUNTRY = 951
|
|
P_TRANSFERRED_BY = 952
|
|
P_TRANSFERRED_TO = 953
|
|
P_ADDER = 954
|
|
|
Inherited from |
|
| Instance Variables | |
|
Inherited from |
| Properties | |
|
convo_id [ALL] ID of corresponding conversation. |
|
|
identity [ALL] skypename OR pstn_number OR namespace:identity |
|
|
rank [ALL] Participant::RANK |
|
|
requested_rank Not set (should be: requested Participant::RANK, higher than the current one) |
|
|
text_status [ALL] the typing indicator |
|
|
voice_status [ALL] voice status |
|
|
video_status [ALL] video status |
|
|
live_identity [ALL] identity that was used to establish current live session with that participant (can be different from participant identity) |
|
|
live_price_for_me [OTHERS] 'price_per_minute_float currency' - eg '0.01 EUR'. |
|
|
live_fwd_identities [OTHERS] list of identities where the live session is being forwarded (if they are disclosed), space separated |
|
|
live_start_timestamp [ALL] time of joining the live session |
|
|
sound_level [ALL] current 'loudness' level when SPEAKING (0..10) |
|
|
debuginfo [OTHERS] call (audio and video) debug info |
|
|
last_voice_error [OTHERS] |
|
|
quality_problems [ALL] space separated tokens values: CPU_INUSE CPU_SLOW CPU_HIGH HIGH_ECHO HIGH_NOISE MUTED_INPUT LOW_INPUT MUTED_INPUT_ACTIVITY FW_STRONG FW_BAD NOT_UDP CALL_BW_LOW RECORD_ERROR + values in video debug info |
|
|
live_type [ALL] participant type during livesession as specified in IDENTITYTYPE |
|
|
live_country [OTHERS] participant livesession country code - used for emergency calls only atm |
|
|
transferred_by [OTHERS] Transferor identity (transferee side) |
|
|
transferred_to [OTHERS] Identity of recipient of transfer (transferor side, caller side) |
|
|
adder [ALL] Identity of the user who added this participant to the conversation, type: Sid::String |
|
|
Inherited from |
|
| Method Details |
actual constructor
|
str(x)
|
Checks whether the current user can set this Participant's conversation privileges to the specified RANK. This enables you to gray out or disable in your UI all the unavailable options for Participant::SetRankTo method. Arguments:
Return values:
|
Sets Participant's conversation privileges to the given RANK Arguments:
|
Initiates live conversation attempt with Participant. Arguments:
|
Sets LIVE_IDENTITY property, an alternate identity to use when ringing, such as a PSTN. Arguments:
|
Retrieves a reference to the Video object that corresponds to the Participant. It can be either local video - you can check if this participant's name (P_IDENTITY property) matches the name of the currently logged in account (P_SKYPENAME property) or incoming video from a remote participant. Note that for GetVideo to be successful, the video has to be available for that participant. This can be checked for by examining Participant VIDEO_STATUS property - once it becomes VIDEO_AVAILABLE - you can use GetVideo to obtain the Video object. Return values:
|
Removes this participant from the current live session. Note that this does not remove the participant from conversation (for this, use Participant::Retire). It only removes participant from live state. |
Forcibly removes this participant from conversation. This method is for removing other people from conversations (for example: as administrative punishment for flooding conversation with spam messages). For local user to leave a conversation, use Conversation::RetireFrom instead. |
This event gets fired on receiving a DTMF signal sent by Participant. Note that this event will only fire if the Participant is also using a Skype client. Skype audio library does not monitor incoming voice streams for dial tones. DTMF events are propagated to remote participants via data channel. Incoming DTMF tones transmitted from, for example, mobile phones, will not cause this event to fire. In case of incoming DTMF signals from Skype clients, DTMF tones are also inserted into the audio stream. You don't have to inject those into local audio playback yourself. Return values:
|
| Class Variable Details |
propid2label
|
RANKRecognized values for the P_RANK property. The P_RANK controls participant's privileges in the conversation. See Participant::CanSetRankTo and Participant::SetRankTo methods.
|
TEXT_STATUSRecognized values for the P_TEXT_STATUS property. The P_TEXT_STATUS property has two uses. Firstly, you can use it to implement typing indicators in your UI, to notify the local user that an incoming chat message from this Participant is imminent. To set the P_TEXT_STATUS value, so that remote client UIs can display the local user's typing indicator in their UI, use Conversation::SetMyTextStatusTo method. Transmission of P_TEXT_STATUS updates to remote participants of conversations is controlled via SETUPKEY_DISABLE_CHAT_ACTIVITY_INDICATION setup key. Secondly, the TEXT_NA value enables you to detect participants who are running clients with no chat capability.
|
VOICE_STATUSRecognized values for the P_VOICE_STATUS property.
|
VIDEO_STATUSRecognized values for the P_VIDEO_STATUS property. This property applies to Participant's video send capability, not capability to receive video.
|
DTMF
|
| Property Details |
convo_id[ALL] ID of corresponding conversation. Here and below, [ALL] tag indicates that the property has meaning and is set in context of all participants in the conversation. [OTHERS] tag has meaning only for participants who are not the local user.
|
identity[ALL] skypename OR pstn_number OR namespace:identity
|
rank[ALL] Participant::RANK
|
requested_rankNot set (should be: requested Participant::RANK, higher than the current one)
|
text_status[ALL] the typing indicator
|
voice_status[ALL] voice status
|
video_status[ALL] video status
|
live_identity[ALL] identity that was used to establish current live session with that participant (can be different from participant identity)
|
live_price_for_me[OTHERS] 'price_per_minute_float currency' - eg '0.01 EUR'. Note that this property obtains value only after the participant goes into live state. It cannot be used to display call rates before the call starts.
|
live_fwd_identities[OTHERS] list of identities where the live session is being forwarded (if they are disclosed), space separated
|
live_start_timestamp[ALL] time of joining the live session
|
sound_level[ALL] current 'loudness' level when SPEAKING (0..10)
|
debuginfo[OTHERS] call (audio and video) debug info
|
last_voice_error[OTHERS]
|
quality_problems[ALL] space separated tokens values: CPU_INUSE CPU_SLOW CPU_HIGH HIGH_ECHO HIGH_NOISE MUTED_INPUT LOW_INPUT MUTED_INPUT_ACTIVITY FW_STRONG FW_BAD NOT_UDP CALL_BW_LOW RECORD_ERROR + values in video debug info
|
live_type[ALL] participant type during livesession as specified in IDENTITYTYPE
|
live_country[OTHERS] participant livesession country code - used for emergency calls only atm
|
transferred_by[OTHERS] Transferor identity (transferee side)
|
transferred_to[OTHERS] Identity of recipient of transfer (transferor side, caller side)
|
adder[ALL] Identity of the user who added this participant to the conversation, type: Sid::String
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Fri Mar 16 16:40:37 2012 | http://epydoc.sourceforge.net |