Enumerated type constants
[Types and constants]

Enumerations

Variables

const int Tpy::NUM_CALL_STATES
const int Tpy::NUM_CALL_STATE_CHANGE_REASONS
const int Tpy::NUM_CONTENT_REMOVAL_REASONS
const int Tpy::NUM_CALL_CONTENT_DISPOSITIONS
const int Tpy::NUM_CALL_CONTENT_PACKETIZATION_TYPES
const int Tpy::NUM_SENDING_STATES
const int Tpy::NUM_STREAM_TRANSPORT_TYPES

Detailed Description

Types generated from the specification representing enumerated types ie. types the values of which are mutually exclusive integral constants.

Enumeration Type Documentation

enum Tpy::CallState

Enumerated type generated from the specification.

The state of a call, as a whole.

The allowed transitions are:

Pending_Initiator → Pending_Receiver (for outgoing calls, when <tp:member-ref>Accept</tp:member-ref> is called)
Pending_Receiver → Accepted (for incoming calls, when <tp:member-ref>Accept</tp:member-ref> is called; for outgoing calls to a contact, when the remote contact accepts the call; for joining a conference call, when the local user successfully joins the conference)
Accepted → Pending_Receiver (when transferred to another contact)
any state → Ended (when the call is terminated normally, or when an error occurs)

Clients MAY consider unknown values from this enum to be an error - additional values will not be defined after the Call specification is declared to be stable.

Enumerator:

CallStateUnknown	The call state is not known. This call state MUST NOT appear as a value of the CallState property, but MAY be used by client code to represent calls whose state is as yet unknown.
CallStatePendingInitiator	The initiator of the call hasn't accepted the call yet. This state only makes sense for outgoing calls, where it means that the local user has not yet sent any signalling messages to the remote user(s), and will not do so until Accept is called.
CallStatePendingReceiver	The receiver (the contact being called) hasn't accepted the call yet.
CallStateAccepted	The contact being called has accepted the call.
CallStateEnded	The call has ended, either via normal termination or an error.
_CallStatePadding

enum Tpy::CallStateChangeReason

Enumerated type generated from the specification.

A simple representation of the reason for a change in the call's state, which may be used by simple clients, or used as a fallback when the DBus_Reason member of a Call_State_Reason struct is not understood.

Enumerator:

CallStateChangeReasonUnknown	We just don't know. Unknown values of this enum SHOULD also be treated like this.
CallStateChangeReasonUserRequested	The change was requested by the contact indicated by the Actor member of a <tp:type>Call_State_Reason</tp:type> struct. If the Actor is the local user, the DBus_Reason SHOULD be the empty string. If the Actor is a remote user, the DBus_Reason SHOULD be the empty string if the call was terminated normally, but MAY be a non-empty error name to indicate error-like call termination reasons (call rejected as busy, kicked from a conference by a moderator, etc.).
CallStateChangeReasonForwarded	The call was forwarded. If known, the handle of the contact the call was forwarded to will be indicated by the Actor member of a <tp:type>Call_State_Reason</tp:type> struct.
CallStateChangeReasonNoAnswer	The <tp:member-ref>CallState</tp:member-ref> changed from <tp:type>Call_State</tp:type>_Pending_Receiver to <tp:type>Call_State</tp:type>_Ended because the initiator ended the call before the receiver accepted it. With an incoming call this state change reason signifies a missed call.
_CallStateChangeReasonPadding

enum Tpy::ContentRemovalReason

Enumerated type generated from the specification.

A representation of the reason for a content to be removed, which may be used by simple clients, or used as a fallback when the DBus_Reason is not understood. This enum will be extended with future reasons as and when appropriate, so clients SHOULD keep up to date with its values, but also be happy to fallback to the Unknown value when an unknown value is encountered.

Enumerator:

ContentRemovalReasonUnknown	We just don't know. Unknown values of this enum SHOULD also be treated like this.
ContentRemovalReasonUserRequested	The local user requests that this content is removed from the call.
ContentRemovalReasonError	There is an error with the content which means that it has to be removed from the call.
ContentRemovalReasonUnsupported	Some aspect of the content is unsupported so has to be removed from the call.
_ContentRemovalReasonPadding

enum Tpy::CallContentDisposition

Enumerated type generated from the specification.

The disposition of this content, which defines whether to automatically start sending data on the streams when Call.DRAFT is called on the channel.

Enumerator:

CallContentDispositionNone	The content has no specific disposition
CallContentDispositionInitial	The content was initially part of the call. When <tp:dbus-ref namespace="ofdT.Channel.Type.Call.DRAFT">Accept</tp:dbus-ref> is called on the channel, all streams of this content with <tp:dbus-ref namespace="ofdT.Call.Stream.DRAFT">LocalSendingState</tp:dbus-ref> set to <tp:type>Sending_State</tp:type>_Pending_Send will be moved to <tp:type>Sending_State</tp:type>_Sending as if <tp:dbus-ref namespace="ofdT.Call.Stream.DRAFT">SetSending</tp:dbus-ref> (True) had been called.
_CallContentDispositionPadding

enum Tpy::CallContentPacketizationType

Enumerated type generated from the specification.

A packetization method that can be used for a content.

Enumerator:

CallContentPacketizationTypeRTP	Real-time Transport Protocol, as documented by RFC 3550.
CallContentPacketizationTypeRaw	Raw media.
CallContentPacketizationTypeMSNWebcam	MSN webcam. This is the video-only one-way type which was used in earlier versions of WLM. Although no longer used, modern WLM clients still support the MSN webcam protocol.
_CallContentPacketizationTypePadding

enum Tpy::SendingState

Enumerated type generated from the specification.

Enum indicating whether a contact is sending media.

Enumerator:

SendingStateNone	The contact is not sending media and has not been asked to do so.
SendingStatePendingSend	The contact has been asked to start sending media.
SendingStateSending	The contact is sending media.
SendingStatePendingStopSending	The contact has been asked to stop sending media.
_SendingStatePadding

enum Tpy::StreamTransportType

Enumerated type generated from the specification.

A transport that can be used for streaming.

Enumerator:

StreamTransportTypeUnknown	The stream transport type is unknown or not applicable (for streams that do not have a configurable transport).
StreamTransportTypeRawUDP	Raw UDP, with or without STUN. All streaming clients are assumed to support this transport, so there is no handler capability token for it in the Call.DRAFT interface. [This corresponds to "none" or "stun" in the old Media.StreamHandler interface.]
StreamTransportTypeICE	Interactive Connectivity Establishment, as defined by RFC 5245. Note that this value covers ICE-UDP only. [This corresponds to "ice-udp" in the old Media.StreamHandler interface.]
StreamTransportTypeGTalkP2P	Google Talk peer-to-peer connectivity establishment, as implemented by libjingle 0.3. [This corresponds to "gtalk-p2p" in the old Media.StreamHandler interface.]
StreamTransportTypeWLM2009	The transport used by Windows Live Messenger 2009 or later, which resembles ICE draft 19. [This corresponds to "wlm-2009" in the old Media.StreamHandler interface.]
StreamTransportTypeSHM	Shared memory transport, as implemented by the GStreamer shmsrc and shmsink plugins.
StreamTransportTypeMulticast	Multicast transport.
_StreamTransportTypePadding