![]() |
![]() |
![]() |
Wocky Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
struct WockyJingleSessionClass; void wocky_jingle_session_accept (WockyJingleSession *sess
); void wocky_jingle_session_acknowledge_iq (WockyJingleSession *self
,WockyStanza *stanza
); WockyJingleContent * wocky_jingle_session_add_content (WockyJingleSession *sess
,WockyJingleMediaType mtype
,WockyJingleContentSenders senders
,const char *name
,const gchar *content_ns
,const gchar *transport_ns
); gboolean wocky_jingle_session_can_modify_contents (WockyJingleSession *sess
); gboolean wocky_jingle_session_defines_action (WockyJingleSession *sess
,WockyJingleAction action
); const gchar * wocky_jingle_session_detect (WockyStanza *stanza
,WockyJingleAction *action
,WockyJingleDialect *dialect
); GType wocky_jingle_session_get_content_type (WockyJingleSession *Param1
); GList * wocky_jingle_session_get_contents (WockyJingleSession *sess
); WockyJingleDialect wocky_jingle_session_get_dialect (WockyJingleSession *sess
); WockyJingleFactory * wocky_jingle_session_get_factory (WockyJingleSession *self
); const gchar * wocky_jingle_session_get_initiator (WockyJingleSession *sess
); WockyContact * wocky_jingle_session_get_peer_contact (WockyJingleSession *self
); const gchar * wocky_jingle_session_get_peer_jid (WockyJingleSession *sess
); const gchar * wocky_jingle_session_get_peer_resource (WockyJingleSession *sess
); WockyPorter * wocky_jingle_session_get_porter (WockyJingleSession *self
); const gchar * wocky_jingle_session_get_reason_name (WockyJingleReason reason
); gboolean wocky_jingle_session_get_remote_hold (WockyJingleSession *sess
); gboolean wocky_jingle_session_get_remote_ringing (WockyJingleSession *sess
); const gchar * wocky_jingle_session_get_sid (WockyJingleSession *sess
); WockyJingleSession * wocky_jingle_session_new (WockyJingleFactory *factory
,WockyPorter *porter
,const gchar *session_id
,gboolean local_initiator
,WockyContact *peer
,WockyJingleDialect dialect
,gboolean local_hold
); WockyStanza * wocky_jingle_session_new_message (WockyJingleSession *sess
,WockyJingleAction action
,WockyNode **sess_node
); gboolean wocky_jingle_session_parse (WockyJingleSession *sess
,WockyJingleAction action
,WockyStanza *stanza
,GError **error
); gboolean wocky_jingle_session_peer_has_cap (WockyJingleSession *self
,const gchar *cap_or_quirk
); void wocky_jingle_session_remove_content (WockyJingleSession *sess
,WockyJingleContent *c
); void wocky_jingle_session_send (WockyJingleSession *sess
,WockyStanza *stanza
); void wocky_jingle_session_set_local_hold (WockyJingleSession *sess
,gboolean held
); gboolean wocky_jingle_session_terminate (WockyJingleSession *sess
,WockyJingleReason reason
,const gchar *text
,GError **error
);
void wocky_jingle_session_accept (WockyJingleSession *sess
);
For incoming calls, accepts the call. For outgoing calls, indicates that the initial contents for the call have been created and the offer can be sent to the peer.
The acceptance or offer will only be signalled to the peer once all contents
are ready (as returned by wocky_jingle_content_is_ready()
). For an RTP
session with WockyJingleMediaRtp contents, this translates to a media
description and transport candidates having been provided to all contents.
|
the session. |
void wocky_jingle_session_acknowledge_iq (WockyJingleSession *self
,WockyStanza *stanza
);
WockyJingleContent * wocky_jingle_session_add_content (WockyJingleSession *sess
,WockyJingleMediaType mtype
,WockyJingleContentSenders senders
,const char *name
,const gchar *content_ns
,const gchar *transport_ns
);
Adds a content to the session. Once it has its codecs and transport
candidates filled in, it will be signalled to the peer (either as part of
the session-initiate, if it has not been sent yet, or as a content-add if
sess
has already been initiated).
Legal values for content_ns
and transport_ns
depend on the Jingle dialect
in use for this session (and in some cases on mtype
); sensible values
depend on the peer's capabilities.
|
the session |
|
what kind of media will be exchanged on the content |
|
which directions media should initially flow in. |
|
a descriptive name to use for the content; this is typically not shown to users. [allow-none] |
|
the namespace to use for the content's description |
|
the namespace of the media transport to use for the call |
Returns : |
the new content, which is guaranteed not to be NULL . [transfer none]
|
gboolean wocky_jingle_session_can_modify_contents
(WockyJingleSession *sess
);
gboolean wocky_jingle_session_defines_action (WockyJingleSession *sess
,WockyJingleAction action
);
const gchar * wocky_jingle_session_detect (WockyStanza *stanza
,WockyJingleAction *action
,WockyJingleDialect *dialect
);
GType wocky_jingle_session_get_content_type
(WockyJingleSession *Param1
);
GList * wocky_jingle_session_get_contents (WockyJingleSession *sess
);
WockyJingleDialect wocky_jingle_session_get_dialect (WockyJingleSession *sess
);
WockyJingleFactory * wocky_jingle_session_get_factory (WockyJingleSession *self
);
const gchar * wocky_jingle_session_get_initiator (WockyJingleSession *sess
);
WockyContact * wocky_jingle_session_get_peer_contact
(WockyJingleSession *self
);
const gchar * wocky_jingle_session_get_peer_jid (WockyJingleSession *sess
);
const gchar * wocky_jingle_session_get_peer_resource
(WockyJingleSession *sess
);
WockyPorter * wocky_jingle_session_get_porter (WockyJingleSession *self
);
const gchar * wocky_jingle_session_get_reason_name
(WockyJingleReason reason
);
gboolean wocky_jingle_session_get_remote_hold
(WockyJingleSession *sess
);
gboolean wocky_jingle_session_get_remote_ringing
(WockyJingleSession *sess
);
const gchar * wocky_jingle_session_get_sid (WockyJingleSession *sess
);
WockyJingleSession * wocky_jingle_session_new (WockyJingleFactory *factory
,WockyPorter *porter
,const gchar *session_id
,gboolean local_initiator
,WockyContact *peer
,WockyJingleDialect dialect
,gboolean local_hold
);
WockyStanza * wocky_jingle_session_new_message (WockyJingleSession *sess
,WockyJingleAction action
,WockyNode **sess_node
);
gboolean wocky_jingle_session_parse (WockyJingleSession *sess
,WockyJingleAction action
,WockyStanza *stanza
,GError **error
);
gboolean wocky_jingle_session_peer_has_cap (WockyJingleSession *self
,const gchar *cap_or_quirk
);
void wocky_jingle_session_remove_content (WockyJingleSession *sess
,WockyJingleContent *c
);
void wocky_jingle_session_send (WockyJingleSession *sess
,WockyStanza *stanza
);
A shorthand for sending a Jingle IQ without waiting for the reply.
|
a session |
|
a stanza, of which this function will take ownership. [transfer full] |
void wocky_jingle_session_set_local_hold (WockyJingleSession *sess
,gboolean held
);
gboolean wocky_jingle_session_terminate (WockyJingleSession *sess
,WockyJingleReason reason
,const gchar *text
,GError **error
);
Ends a session.
If called for an outgoing session which has not yet been signalled to the
peer (perhaps because wocky_jingle_session_accept()
has not been called, or
codecs or candidates have not been provided), the session will quietly
terminate without the peer hearing anything about it.
If called for an already-terminated session, this is a no-op.
|
the session |
|
the reason the session should be terminated |
|
human-readable information about why the session terminated. [allow-none] |
|
Unused, because this function never fails. |
Returns : |
TRUE . |