Enums

Details

class Farstream.CandidateType(value)

Bases: GObject.GEnum

An enum for the type of candidate used/reported

HOST = 0

A host candidate (local)

SRFLX = 1

A server reflexive candidate.

PRFLX = 2

A peer reflexive candidate

RELAY = 3

An relay candidate

MULTICAST = 4

A multicast address

class Farstream.ComponentType(value)

Bases: GObject.GEnum

This enum contains the component IDs defined in ICE-19

NONE = 0

Use this when specifying a component is innapropriate

RTP = 1

This component is for RTP data

RTCP = 2

This component is for RTCP control

class Farstream.DTMFEvent(value)

Bases: GObject.GEnum

An enum that represents the different DTMF event that can be sent to a Farstream.Session. The values corresponds those those defined in RFC 4733 The rest of the possibles values are in the IANA registry at: http://www.iana.org/assignments/audio-telephone-event-registry

0 = 0
_0 = 0
1 = 1
_1 = 1
STAR = 10
POUND = 11
A = 12
B = 13
C = 14
D = 15
2 = 2
_2 = 2
3 = 3
_3 = 3
4 = 4
_4 = 4
5 = 5
_5 = 5
6 = 6
_6 = 6
7 = 7
_7 = 7
8 = 8
_8 = 8
9 = 9
_9 = 9
class Farstream.DTMFMethod(value)

Bases: GObject.GEnum

An enum that represents the different ways a DTMF event can be sent

RTP_RFC4733 = 1

Send as a special payload type defined by RFC 4733 (which obsoletes RFC 2833)

SOUND = 2

Send as tones as in-band audio sound

class Farstream.Error(value)

Bases: GObject.GEnum

This is the enum of error numbers that will come either on the “error” signal, from the Gst Bus or for error in the FS_ERROR domain in GErrors

classmethod quark()
Return type:int
CONSTRUCTION = 1

Error constructing some of the sub-elements, this probably denotes an error in the installation of the gstreamer elements. It is a fatal error.

INVALID_ARGUMENTS = 100

Invalid arguments to the function, this is a programming error and should not be reported to the user

NETWORK = 101

A network related error, this should probably be reported to the user.

NOT_IMPLEMENTED = 102

The optional functionality is not implemented by this plugin.

NEGOTIATION_FAILED = 103

The codec negotiation has failed, this means that there are no common codecs between the local and remote codecs.

UNKNOWN_CODEC = 104

Data is received on an unknown codec, this most likely denotes an error on the remote side, the buffers will be ignored. It can safely be ignored in most cases (but may result in a call with no media received).

NO_CODECS = 105

There are no codecs detected for that media type.

NO_CODECS_LEFT = 106

All of the codecs have been disabled by the codec preferences, one should try less strict codec preferences.

CONNECTION_FAILED = 107

Could not connect to the to remote party.

DISPOSED = 108

The object has been disposed.

ALREADY_EXISTS = 109

The object already exists

INTERNAL = 2

An internal error happened in Farstream, it may be in an inconsistent state. The object from which this error comes should be discarded.

class Farstream.MediaType(value)

Bases: GObject.GEnum

Enum used to signify the media type of a codec or stream.

classmethod to_string(media_type)
Parameters:media_type (Farstream.MediaType) – A media type
Returns:a static string representing the media type
Return type:str

Gives a user-printable string representing the media type

AUDIO = 0

A media type that encodes audio.

VIDEO = 1

A media type that encodes video.

APPLICATION = 2

A media type for application data.

LAST = 2

Largest valid Farstream.MediaType

class Farstream.NetworkProtocol(value)

Bases: GObject.GEnum

An enum for the base IP protocol

UDP = 0

A UDP based protocol

TCP = 1

A TCP based protocol, will listen for incoming connections

TCP_PASSIVE = 1

A TCP based protocol, will listen for incoming connections

TCP_ACTIVE = 2

A TCP based protocol, will attempt to open an outbound connection

TCP_SO = 3

A TCP based protocol, will listen for incoming connections and attempt an outbound connection at the same time as the peer (Simultanuous-Open)

class Farstream.StreamState(value)

Bases: GObject.GEnum

These are the possible states of a stream, a simple multicast stream could only be in “disconnected” or “ready” state. An stream using an ICE transmitter would use all of these.

FAILED = 0

connectivity checks have been completed, but connectivity was not established

DISCONNECTED = 1

no activity scheduled

GATHERING = 2

gathering local candidates

CONNECTING = 3

establishing connectivity

CONNECTED = 4

at least one working candidate pair

READY = 5

ICE concluded, candidate pair selection is now final