wocky-jingle-types

wocky-jingle-types

Properties

gchar * content-ns Read / Write
gchar * disposition Read / Write
gboolean locally-created Read
gchar * name Read / Write / Construct Only
guint senders Read / Write
WockyJingleSession * session Read / Write / Construct Only
guint state Read / Write
gchar * transport-ns Read / Write
WockySession * session Read / Write / Construct Only
guint media-type Read / Write / Construct Only
gboolean remote-mute Read / Write
guint dialect Read / Write
WockyJingleFactory * jingle-factory Read / Write / Construct Only
gboolean local-hold Read / Write
gboolean local-initiator Read / Write / Construct Only
WockyContact * peer-contact Read / Write / Construct Only
WockyPorter * porter Read / Write / Construct Only
gboolean remote-hold Read
gboolean remote-ringing Read
gchar * session-id Read / Write / Construct Only
guint state Read / Write
WockyJingleContent * content Read / Write / Construct Only
guint state Read / Write
gchar * transport-ns Read / Write / Construct Only
WockyJingleContent * content Read / Write / Construct Only
guint state Read / Write
gchar * transport-ns Read / Write / Construct Only
WockyJingleContent * content Read / Write / Construct Only
guint state Read / Write
gchar * transport-ns Read / Write / Construct Only

Signals

Types and Values

Object Hierarchy

    GEnum
    ╰── WockyJingleReason
    GObject
    ├── WockyJingleContent
       ╰── WockyJingleMediaRtp
    ├── WockyJingleFactory
    ├── WockyJingleSession
    ├── WockyJingleTransportGoogle
    ├── WockyJingleTransportIceUdp
    ╰── WockyJingleTransportRawUdp

Implemented Interfaces

WockyJingleTransportGoogle implements

WockyJingleTransportIceUdp implements

WockyJingleTransportRawUdp implements

Description

Functions

Types and Values

enum WockyJingleDialect

Members

WOCKY_JINGLE_DIALECT_ERROR

   

WOCKY_JINGLE_DIALECT_GTALK3

   

WOCKY_JINGLE_DIALECT_GTALK4

   

WOCKY_JINGLE_DIALECT_V015

   

WOCKY_JINGLE_DIALECT_V032

   

enum WockyJingleState

Possible states of a WockyJingleSession.

Members

WOCKY_JINGLE_STATE_PENDING_CREATED

on outgoing sessions, no offer has been sent to the peer yet.

 

WOCKY_JINGLE_STATE_PENDING_INITIATE_SENT

on outgoing sessions, we have sent the session-initiate and are awaiting the peer's acknowledgement.

 

WOCKY_JINGLE_STATE_PENDING_INITIATED

on outgoing sessions, the peer has received our session-initiate and we're waiting for them to accept; on incoming sessions, the peer is waiting for us to accept.

 

WOCKY_JINGLE_STATE_PENDING_ACCEPT_SENT

on incoming sessions, we have sent session-accept and are waiting for the peer to acknowledge it.

 

WOCKY_JINGLE_STATE_ACTIVE

the session is active.

 

WOCKY_JINGLE_STATE_ENDED

the session has ended. The “terminated” signal describes how the session ended.

 

enum WockyJingleAction

Members

WOCKY_JINGLE_ACTION_UNKNOWN

   

WOCKY_JINGLE_ACTION_CONTENT_ACCEPT

   

WOCKY_JINGLE_ACTION_CONTENT_ADD

   

WOCKY_JINGLE_ACTION_CONTENT_MODIFY

   

WOCKY_JINGLE_ACTION_CONTENT_REMOVE

   

WOCKY_JINGLE_ACTION_CONTENT_REPLACE

   

WOCKY_JINGLE_ACTION_CONTENT_REJECT

   

WOCKY_JINGLE_ACTION_SESSION_ACCEPT

   

WOCKY_JINGLE_ACTION_SESSION_INFO

   

WOCKY_JINGLE_ACTION_SESSION_INITIATE

   

WOCKY_JINGLE_ACTION_SESSION_TERMINATE

   

WOCKY_JINGLE_ACTION_TRANSPORT_INFO

   

WOCKY_JINGLE_ACTION_TRANSPORT_ACCEPT

   

WOCKY_JINGLE_ACTION_DESCRIPTION_INFO

   

WOCKY_JINGLE_ACTION_INFO

   

enum WockyJingleContentSenders

Members

WOCKY_JINGLE_CONTENT_SENDERS_NONE

   

WOCKY_JINGLE_CONTENT_SENDERS_INITIATOR

   

WOCKY_JINGLE_CONTENT_SENDERS_RESPONDER

   

WOCKY_JINGLE_CONTENT_SENDERS_BOTH

   

enum WockyJingleTransportType

Members

JINGLE_TRANSPORT_UNKNOWN

   

JINGLE_TRANSPORT_GOOGLE_P2P

   

JINGLE_TRANSPORT_RAW_UDP

   

JINGLE_TRANSPORT_ICE_UDP

   

enum WockyJingleTransportProtocol

Members

WOCKY_JINGLE_TRANSPORT_PROTOCOL_UDP

   

WOCKY_JINGLE_TRANSPORT_PROTOCOL_TCP

   

enum WockyJingleCandidateType

Members

WOCKY_JINGLE_CANDIDATE_TYPE_LOCAL

   

WOCKY_JINGLE_CANDIDATE_TYPE_STUN

   

WOCKY_JINGLE_CANDIDATE_TYPE_RELAY

   

enum WockyJingleReason

The reason for a Jingle action occurring—specifically, the reason for terminating a call. See XEP-0166 Jingle §7.4 for definitions of the codes.

Members

WOCKY_JINGLE_REASON_UNKNOWN

no known reason

 

WOCKY_JINGLE_REASON_ALTERNATIVE_SESSION

   

WOCKY_JINGLE_REASON_BUSY

   

WOCKY_JINGLE_REASON_CANCEL

   

WOCKY_JINGLE_REASON_CONNECTIVITY_ERROR

   

WOCKY_JINGLE_REASON_DECLINE

   

WOCKY_JINGLE_REASON_EXPIRED

   

WOCKY_JINGLE_REASON_FAILED_APPLICATION

   

WOCKY_JINGLE_REASON_FAILED_TRANSPORT

   

WOCKY_JINGLE_REASON_GENERAL_ERROR

   

WOCKY_JINGLE_REASON_GONE

   

WOCKY_JINGLE_REASON_INCOMPATIBLE_PARAMETERS

   

WOCKY_JINGLE_REASON_MEDIA_ERROR

   

WOCKY_JINGLE_REASON_SECURITY_ERROR

   

WOCKY_JINGLE_REASON_SUCCESS

   

WOCKY_JINGLE_REASON_TIMEOUT

   

WOCKY_JINGLE_REASON_UNSUPPORTED_APPLICATIONS

   

WOCKY_JINGLE_REASON_UNSUPPORTED_TRANSPORTS

   

WockyJingleCandidate

typedef struct {
  WockyJingleTransportProtocol protocol;
  WockyJingleCandidateType type;

  gchar *id;
  gchar *address;
  int port;
  int component;
  int generation;

  int preference;
  gchar *username;
  gchar *password;
  int network;
} WockyJingleCandidate;

WockyJingleContent

typedef struct _WockyJingleContent WockyJingleContent;

WockyJingleFactory

typedef struct _WockyJingleFactory WockyJingleFactory;

WockyJingleMediaRtp

typedef struct _WockyJingleMediaRtp WockyJingleMediaRtp;

WockyJingleSession

typedef struct _WockyJingleSession WockyJingleSession;

WockyJingleTransportGoogle

typedef struct _WockyJingleTransportGoogle WockyJingleTransportGoogle;

WockyJingleTransportIceUdp

typedef struct _WockyJingleTransportIceUdp WockyJingleTransportIceUdp;

WockyJingleTransportRawUdp

typedef struct _WockyJingleTransportRawUdp WockyJingleTransportRawUdp;

Property Details

The “content-ns” property

  “content-ns”               gchar *

Namespace identifying the content type.

Flags: Read / Write

Default value: NULL


The “disposition” property

  “disposition”              gchar *

Distinguishes between 'session' and other contents.

Flags: Read / Write

Default value: NULL


The “locally-created” property

  “locally-created”          gboolean

True if the content was created by the local client.

Flags: Read

Default value: FALSE


The “name” property

  “name”                     gchar *

A unique content name in the session.

Flags: Read / Write / Construct Only

Default value: NULL


The “senders” property

  “senders”                  guint

Valid senders for the stream.

Flags: Read / Write

Default value: 0


The “session” property

  “session”                  WockyJingleSession *

Jingle session object that owns this content.

Flags: Read / Write / Construct Only


The “state” property

  “state”                    guint

The current state that the content is in.

Flags: Read / Write

Default value: 0


The “transport-ns” property

  “transport-ns”             gchar *

Namespace identifying the transport type.

Flags: Read / Write

Default value: NULL


The “session” property

  “session”                  WockySession *

WockySession to listen for Jingle sessions on.

Flags: Read / Write / Construct Only


The “media-type” property

  “media-type”               guint

Media type.

Flags: Read / Write / Construct Only

Default value: 0


The “remote-mute” property

  “remote-mute”              gboolean

TRUE if the peer has muted this stream.

Flags: Read / Write

Default value: FALSE


The “dialect” property

  “dialect”                  guint

Jingle dialect used for this session.

Flags: Read / Write

Default value: 0


The “jingle-factory” property

  “jingle-factory”           WockyJingleFactory *

The Jingle factory which created this session.

Flags: Read / Write / Construct Only


The “local-hold” property

  “local-hold”               gboolean

TRUE if we've placed the peer on hold.

Flags: Read / Write

Default value: FALSE


The “local-initiator” property

  “local-initiator”          gboolean

Specifies if local end initiated the session.

Flags: Read / Write / Construct Only

Default value: TRUE


The “peer-contact” property

  “peer-contact”             WockyContact *

The WockyContact representing the other party in the session. Note that if this is a WockyBareContact (as opposed to a WockyResourceContact) the session is with the contact's bare JID.

Flags: Read / Write / Construct Only


The “porter” property

  “porter”                   WockyPorter *

The WockyPorter for the current connection.

Flags: Read / Write / Construct Only


The “remote-hold” property

  “remote-hold”              gboolean

TRUE if the peer has placed us on hold.

Flags: Read

Default value: FALSE


The “remote-ringing” property

  “remote-ringing”           gboolean

TRUE if the peer's client is ringing.

Flags: Read

Default value: FALSE


The “session-id” property

  “session-id”               gchar *

A unique session identifier used throughout all communication.

Flags: Read / Write / Construct Only

Default value: NULL


The “state” property

  “state”                    guint

The current state that the session is in.

Flags: Read / Write

Default value: 0


The “content” property

  “content”                  WockyJingleContent *

Jingle content object using this transport.

Flags: Read / Write / Construct Only


The “state” property

  “state”                    guint

Enum specifying the connection state of the transport.

Flags: Read / Write

Allowed values: <= 2

Default value: 0


The “transport-ns” property

  “transport-ns”             gchar *

Namespace identifying the transport type.

Flags: Read / Write / Construct Only

Default value: NULL


The “content” property

  “content”                  WockyJingleContent *

Jingle content object using this transport.

Flags: Read / Write / Construct Only


The “state” property

  “state”                    guint

Enum specifying the connection state of the transport.

Flags: Read / Write

Allowed values: <= 2

Default value: 0


The “transport-ns” property

  “transport-ns”             gchar *

Namespace identifying the transport type.

Flags: Read / Write / Construct Only

Default value: NULL


The “content” property

  “content”                  WockyJingleContent *

Jingle content object using this transport.

Flags: Read / Write / Construct Only


The “state” property

  “state”                    guint

Enum specifying the connection state of the transport.

Flags: Read / Write

Allowed values: <= 2

Default value: 0


The “transport-ns” property

  “transport-ns”             gchar *

Namespace identifying the transport type.

Flags: Read / Write / Construct Only

Default value: NULL

Signal Details

The “completed” signal

void
user_function (WockyJingleContent *wockyjinglecontent,
               gpointer            user_data)

Flags: Run Last


The “new-candidates” signal

void
user_function (WockyJingleContent *content,
               gpointer            candidates,
               gpointer            user_data)

Emitted when new candidates are received from the peer.

Parameters

content

the content

 

candidates

a GList of new candidates.

[type GList][element-type WockyJingleCandidate]

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “new-share-channel” signal

void
user_function (WockyJingleContent *wockyjinglecontent,
               gchar              *arg1,
               guint               arg2,
               gpointer            user_data)

Flags: Run Last


The “ready” signal

void
user_function (WockyJingleContent *wockyjinglecontent,
               gpointer            user_data)

Flags: Has Details


The “removed” signal

void
user_function (WockyJingleContent *wockyjinglecontent,
               gpointer            user_data)

Flags: Has Details


The “new-session” signal

void
user_function (WockyJingleFactory *wockyjinglefactory,
               WockyJingleSession *arg1,
               gboolean            arg2,
               gpointer            user_data)

Flags: Run Last


The “query-cap” signal

gboolean
user_function (WockyJingleFactory *wockyjinglefactory,
               WockyContact       *arg1,
               gchar              *arg2,
               gpointer            user_data)

Flags: Run Last


The “remote-media-description” signal

void
user_function (WockyJingleMediaRtp *content,
               gpointer             md,
               gpointer             user_data)

Emitted when the remote media description is received or subsequently updated.

Parameters

content

the RTP content

 

md

a WockyJingleMediaDescription

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “about-to-initiate” signal

void
user_function (WockyJingleSession *wockyjinglesession,
               gpointer            user_data)

Flags: Run Last


The “content-rejected” signal

void
user_function (WockyJingleSession *wockyjinglesession,
               GObject            *arg1,
               guint               arg2,
               gchar              *arg3,
               gpointer            user_data)

Flags: Run Last


The “new-content” signal

void
user_function (WockyJingleSession *wockyjinglesession,
               GObject            *arg1,
               gpointer            user_data)

Flags: Run Last


The “query-cap” signal

gboolean
user_function (WockyJingleSession *wockyjinglesession,
               WockyContact       *arg1,
               gchar              *arg2,
               gpointer            user_data)

Flags: Run Last


The “remote-state-changed” signal

void
user_function (WockyJingleSession *wockyjinglesession,
               gpointer            user_data)

Flags: Run Last


The “terminated” signal

void
user_function (WockyJingleSession *session,
               gboolean            locally_terminated,
               guint               reason,
               gchar              *text,
               gpointer            user_data)

Emitted when the session ends, just after “state” moves to WOCKY_JINGLE_STATE_ENDED.

Parameters

session

the session

 

locally_terminated

TRUE if the session ended due to a call to wocky_jingle_session_terminate(); FALSE if the peer ended the session.

 

reason

a WockyJingleReason describing why the session terminated

 

text

a possibly-NULL human-readable string describing why the session terminated

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “new-candidates” signal

void
user_function (WockyJingleTransportGoogle *wockyjingletransportgoogle,
               gpointer                    arg1,
               gpointer                    user_data)

Flags: Run Last


The “new-candidates” signal

void
user_function (WockyJingleTransportIceUdp *wockyjingletransporticeudp,
               gpointer                    arg1,
               gpointer                    user_data)

Flags: Run Last


The “new-candidates” signal

void
user_function (WockyJingleTransportRawUdp *wockyjingletransportrawudp,
               gpointer                    arg1,
               gpointer                    user_data)

Flags: Run Last