telepathy-glib API Reference Manual | ||||
---|---|---|---|---|
Top | Description |
Channel Call stream interfacesChannel Call stream interfaces — client-side wrappers for call streams |
Synopsis
#include <telepathy-glib/telepathy-glib-dbus.h> TpProxyPendingCall * tp_cli_call_stream_call_request_receiving (TpCallStream *proxy
,gint timeout_ms
,guint in_Contact
,gboolean in_Receive
,tp_cli_call_stream_callback_for_request_receiving callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
); TpProxyPendingCall * tp_cli_call_stream_call_set_sending (TpCallStream *proxy
,gint timeout_ms
,gboolean in_Send
,tp_cli_call_stream_callback_for_set_sending callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
); void (*tp_cli_call_stream_callback_for_request_receiving) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_callback_for_set_sending) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
); TpProxySignalConnection * tp_cli_call_stream_connect_to_local_sending_state_changed (TpCallStream *proxy
,tp_cli_call_stream_signal_callback_local_sending_state_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
); TpProxySignalConnection * tp_cli_call_stream_connect_to_remote_members_changed (TpCallStream *proxy
,tp_cli_call_stream_signal_callback_remote_members_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
); void (*tp_cli_call_stream_signal_callback_local_sending_state_changed) (TpCallStream *proxy
,guint arg_State
,const GValueArray *arg_Reason
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_signal_callback_remote_members_changed) (TpCallStream *proxy
,GHashTable *arg_Updates
,GHashTable *arg_Identifiers
,const GArray *arg_Removed
,const GValueArray *arg_Reason
,gpointer user_data
,GObject *weak_object
); TpProxyPendingCall * tp_cli_call_stream_interface_media_call_add_candidates (TpCallStream *proxy
,gint timeout_ms
,const GPtrArray *in_Candidates
,tp_cli_call_stream_interface_media_callback_for_add_candidates callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
); TpProxyPendingCall * tp_cli_call_stream_interface_media_call_complete_receiving_state_change (TpCallStream *proxy
,gint timeout_ms
,guint in_State
,tp_cli_call_stream_interface_media_callback_for_complete_receiving_state_change callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
); TpProxyPendingCall * tp_cli_call_stream_interface_media_call_complete_sending_state_change (TpCallStream *proxy
,gint timeout_ms
,guint in_State
,tp_cli_call_stream_interface_media_callback_for_complete_sending_state_change callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
); TpProxyPendingCall * tp_cli_call_stream_interface_media_call_fail (TpCallStream *proxy
,gint timeout_ms
,const GValueArray *in_Reason
,tp_cli_call_stream_interface_media_callback_for_fail callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
); TpProxyPendingCall * tp_cli_call_stream_interface_media_call_finish_initial_candidates (TpCallStream *proxy
,gint timeout_ms
,tp_cli_call_stream_interface_media_callback_for_finish_initial_candidates callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
); TpProxyPendingCall * tp_cli_call_stream_interface_media_call_report_receiving_failure (TpCallStream *proxy
,gint timeout_ms
,guint in_Reason
,const gchar *in_Error
,const gchar *in_Message
,tp_cli_call_stream_interface_media_callback_for_report_receiving_failure callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
); TpProxyPendingCall * tp_cli_call_stream_interface_media_call_report_sending_failure (TpCallStream *proxy
,gint timeout_ms
,guint in_Reason
,const gchar *in_Error
,const gchar *in_Message
,tp_cli_call_stream_interface_media_callback_for_report_sending_failure callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
); TpProxyPendingCall * tp_cli_call_stream_interface_media_call_set_credentials (TpCallStream *proxy
,gint timeout_ms
,const gchar *in_Username
,const gchar *in_Password
,tp_cli_call_stream_interface_media_callback_for_set_credentials callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_callback_for_add_candidates) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_callback_for_complete_receiving_state_change) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_callback_for_complete_sending_state_change) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_callback_for_fail) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_callback_for_finish_initial_candidates) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_callback_for_report_receiving_failure) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_callback_for_report_sending_failure) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_callback_for_set_credentials) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
); TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_endpoints_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_endpoints_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
); TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_ice_restart_requested (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_ice_restart_requested callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
); TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_local_candidates_added (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_local_candidates_added callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
); TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_local_credentials_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_local_credentials_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
); TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_receiving_state_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_receiving_state_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
); TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_relay_info_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_relay_info_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
); TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_sending_state_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_sending_state_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
); TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_server_info_retrieved (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_server_info_retrieved callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
); TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_stun_servers_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_stun_servers_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
); void (*tp_cli_call_stream_interface_media_signal_callback_endpoints_changed) (TpCallStream *proxy
,const GPtrArray *arg_Endpoints_Added
,const GPtrArray *arg_Endpoints_Removed
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_signal_callback_ice_restart_requested) (TpCallStream *proxy
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_signal_callback_local_candidates_added) (TpCallStream *proxy
,const GPtrArray *arg_Candidates
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_signal_callback_local_credentials_changed) (TpCallStream *proxy
,const gchar *arg_Username
,const gchar *arg_Password
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_signal_callback_receiving_state_changed) (TpCallStream *proxy
,guint arg_State
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_signal_callback_relay_info_changed) (TpCallStream *proxy
,const GPtrArray *arg_Relay_Info
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_signal_callback_sending_state_changed) (TpCallStream *proxy
,guint arg_State
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_signal_callback_server_info_retrieved) (TpCallStream *proxy
,gpointer user_data
,GObject *weak_object
); void (*tp_cli_call_stream_interface_media_signal_callback_stun_servers_changed) (TpCallStream *proxy
,const GPtrArray *arg_Servers
,gpointer user_data
,GObject *weak_object
);
Details
tp_cli_call_stream_call_request_receiving ()
TpProxyPendingCall * tp_cli_call_stream_call_request_receiving (TpCallStream *proxy
,gint timeout_ms
,guint in_Contact
,gboolean in_Receive
,tp_cli_call_stream_callback_for_request_receiving callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
);
Start a RequestReceiving method call.
<p>Request that a remote contact stops or starts sending on this stream.</p> <p>The <tp:member-ref>CanRequestReceiving</tp:member-ref> property defines whether the protocol allows the local user to request the other side start sending on this stream.</p>
|
the TpProxy |
|
the timeout in milliseconds, or -1 to use the default |
|
Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Contact from which sending is requested</p> (TpContactHandle) |
|
Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>If true, request that the given contact starts to send media. If false, request that the given contact stops sending media.</p> |
|
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking |
|
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
|
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
|
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : |
a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
tp_cli_call_stream_call_set_sending ()
TpProxyPendingCall * tp_cli_call_stream_call_set_sending (TpCallStream *proxy
,gint timeout_ms
,gboolean in_Send
,tp_cli_call_stream_callback_for_set_sending callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
);
Start a SetSending method call.
Set the stream to start or stop sending media from the local user to other contacts.
|
the TpProxy |
|
the timeout in milliseconds, or -1 to use the default |
|
Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>If True, the <tp:member-ref>LocalSendingState</tp:member-ref> should change to <tp:value-ref type="Sending_State">Sending</tp:value-ref>, if it isn't already.</p> <p>If False, the <tp:member-ref>LocalSendingState</tp:member-ref> should change to <tp:value-ref type="Sending_State">None</tp:value-ref>, if it isn't already.</p> |
|
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking |
|
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
|
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
|
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : |
a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
tp_cli_call_stream_callback_for_request_receiving ()
void (*tp_cli_call_stream_callback_for_request_receiving) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
);
Signature of the callback called when a RequestReceiving method call succeeds or fails.
|
the proxy on which the call was made |
|
NULL on success, or an error on failure |
|
user-supplied data |
|
user-supplied object |
tp_cli_call_stream_callback_for_set_sending ()
void (*tp_cli_call_stream_callback_for_set_sending) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
);
Signature of the callback called when a SetSending method call succeeds or fails.
|
the proxy on which the call was made |
|
NULL on success, or an error on failure |
|
user-supplied data |
|
user-supplied object |
tp_cli_call_stream_connect_to_local_sending_state_changed ()
TpProxySignalConnection * tp_cli_call_stream_connect_to_local_sending_state_changed (TpCallStream *proxy
,tp_cli_call_stream_signal_callback_local_sending_state_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
);
Connect a handler to the signal LocalSendingStateChanged.
<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> Emitted when <tp:member-ref>LocalSendingState</tp:member-ref> changes.
|
A TpCallStream or subclass |
|
Callback to be called when the signal is received |
|
User-supplied data for the callback |
|
Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL
|
|
A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected |
|
If not NULL , used to raise an error if NULL is
returned |
Returns : |
a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or
NULL if the proxy does not have the desired interface
or has become invalid. |
tp_cli_call_stream_connect_to_remote_members_changed ()
TpProxySignalConnection * tp_cli_call_stream_connect_to_remote_members_changed (TpCallStream *proxy
,tp_cli_call_stream_signal_callback_remote_members_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
);
Connect a handler to the signal RemoteMembersChanged.
<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> Emitted when <tp:member-ref>RemoteMembers</tp:member-ref> changes.
|
A TpCallStream or subclass |
|
Callback to be called when the signal is received |
|
User-supplied data for the callback |
|
Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL
|
|
A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected |
|
If not NULL , used to raise an error if NULL is
returned |
Returns : |
a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or
NULL if the proxy does not have the desired interface
or has become invalid. |
tp_cli_call_stream_signal_callback_local_sending_state_changed ()
void (*tp_cli_call_stream_signal_callback_local_sending_state_changed) (TpCallStream *proxy
,guint arg_State
,const GValueArray *arg_Reason
,gpointer user_data
,GObject *weak_object
);
Represents the signature of a callback for the signal LocalSendingStateChanged.
|
The proxy on which tp_cli_call_stream_connect_to_local_sending_state_changed()
was called |
|
The new value of <tp:member-ref>LocalSendingState</tp:member-ref>. (TpSendingState) |
|
A structured reason for the change. |
|
User-supplied data |
|
User-supplied weakly referenced object |
tp_cli_call_stream_signal_callback_remote_members_changed ()
void (*tp_cli_call_stream_signal_callback_remote_members_changed) (TpCallStream *proxy
,GHashTable *arg_Updates
,GHashTable *arg_Identifiers
,const GArray *arg_Removed
,const GValueArray *arg_Reason
,gpointer user_data
,GObject *weak_object
);
Represents the signature of a callback for the signal RemoteMembersChanged.
|
The proxy on which tp_cli_call_stream_connect_to_remote_members_changed()
was called |
|
A mapping from channel-specific handles to their updated sending state, whose keys include at least the members who were added, and the members whose states changed. |
|
<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> The identifiers of the contacts in the <var>Updates</var> map. |
|
The channel-specific handles that were removed from the keys of the <tp:member-ref>RemoteMembers</tp:member-ref> property, as a result of the contact leaving this stream |
|
A structured reason for the change. |
|
User-supplied data |
|
User-supplied weakly referenced object |
tp_cli_call_stream_interface_media_call_add_candidates ()
TpProxyPendingCall * tp_cli_call_stream_interface_media_call_add_candidates (TpCallStream *proxy
,gint timeout_ms
,const GPtrArray *in_Candidates
,tp_cli_call_stream_interface_media_callback_for_add_candidates callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
);
Start a AddCandidates method call.
Add candidates to the <tp:member-ref>LocalCandidates</tp:member-ref> property and signal them to the remote contact(s). Note that connection managers MAY delay the sending of candidates until <tp:member-ref>FinishInitialCandidates</tp:member-ref> is called.
|
the TpProxy |
|
the timeout in milliseconds, or -1 to use the default |
|
Used to pass an 'in' argument: The candidates to be added. |
|
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking |
|
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
|
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
|
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : |
a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
tp_cli_call_stream_interface_media_call_complete_receiving_state_change ()
TpProxyPendingCall * tp_cli_call_stream_interface_media_call_complete_receiving_state_change (TpCallStream *proxy
,gint timeout_ms
,guint in_State
,tp_cli_call_stream_interface_media_callback_for_complete_receiving_state_change callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
);
Start a CompleteReceivingStateChange method call.
<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Called in response to <tp:member-ref>ReceivingStateChanged</tp:member-ref>(Pending_*, *) to indicate that the media state has successfully progressed from Pending_{Start, Stop, Pause} to the corresponding non-pending state.</p>
|
the TpProxy |
|
the timeout in milliseconds, or -1 to use the default |
|
Used to pass an 'in' argument: The new (non-pending) value of ReceivingState. (TpStreamFlowState) |
|
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking |
|
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
|
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
|
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : |
a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
tp_cli_call_stream_interface_media_call_complete_sending_state_change ()
TpProxyPendingCall * tp_cli_call_stream_interface_media_call_complete_sending_state_change (TpCallStream *proxy
,gint timeout_ms
,guint in_State
,tp_cli_call_stream_interface_media_callback_for_complete_sending_state_change callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
);
Start a CompleteSendingStateChange method call.
<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Called in response to <tp:member-ref>SendingStateChanged</tp:member-ref>(Pending_*, *) to indicate that the media state has successfully progressed from Pending_{Start, Stop, Pause} to the corresponding non-pending state.</p>
|
the TpProxy |
|
the timeout in milliseconds, or -1 to use the default |
|
Used to pass an 'in' argument: The new (non-pending) value of SendingState. (TpStreamFlowState) |
|
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking |
|
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
|
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
|
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : |
a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
tp_cli_call_stream_interface_media_call_fail ()
TpProxyPendingCall * tp_cli_call_stream_interface_media_call_fail (TpCallStream *proxy
,gint timeout_ms
,const GValueArray *in_Reason
,tp_cli_call_stream_interface_media_callback_for_fail callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
);
Start a Fail method call.
Signal an unrecoverable error for this stream, and remove it. If all streams are removed from a content, then it will also be removed.
|
the TpProxy |
|
the timeout in milliseconds, or -1 to use the default |
|
Used to pass an 'in' argument: A structured reason for stream removal. |
|
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking |
|
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
|
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
|
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : |
a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
tp_cli_call_stream_interface_media_call_finish_initial_candidates ()
TpProxyPendingCall * tp_cli_call_stream_interface_media_call_finish_initial_candidates (TpCallStream *proxy
,gint timeout_ms
,tp_cli_call_stream_interface_media_callback_for_finish_initial_candidates callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
);
Start a FinishInitialCandidates method call.
This indicates to the CM that the initial batch of candidates has been added, and should now be processed/sent to the remote side. <tp:rationale> Protocols supporting Raw UDP SHOULD wait for FinishInitialCandidates, and then set the lowest priority candidate as the Raw UDP candidate. </tp:rationale>
|
the TpProxy |
|
the timeout in milliseconds, or -1 to use the default |
|
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking |
|
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
|
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
|
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : |
a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
tp_cli_call_stream_interface_media_call_report_receiving_failure ()
TpProxyPendingCall * tp_cli_call_stream_interface_media_call_report_receiving_failure (TpCallStream *proxy
,gint timeout_ms
,guint in_Reason
,const gchar *in_Error
,const gchar *in_Message
,tp_cli_call_stream_interface_media_callback_for_report_receiving_failure callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
);
Start a ReportReceivingFailure method call.
<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> Can be called at any point to indicate a failure in the incoming portion of the stream.
|
the TpProxy |
|
the timeout in milliseconds, or -1 to use the default |
|
Used to pass an 'in' argument: (Undocumented) (TpCallStateChangeReason) |
|
Used to pass an 'in' argument: (Undocumented) |
|
Used to pass an 'in' argument: (Undocumented) |
|
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking |
|
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
|
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
|
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : |
a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
tp_cli_call_stream_interface_media_call_report_sending_failure ()
TpProxyPendingCall * tp_cli_call_stream_interface_media_call_report_sending_failure (TpCallStream *proxy
,gint timeout_ms
,guint in_Reason
,const gchar *in_Error
,const gchar *in_Message
,tp_cli_call_stream_interface_media_callback_for_report_sending_failure callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
);
Start a ReportSendingFailure method call.
<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> Can be called at any point to indicate a failure in the outgoing portion of the stream.
|
the TpProxy |
|
the timeout in milliseconds, or -1 to use the default |
|
Used to pass an 'in' argument: (Undocumented) (TpCallStateChangeReason) |
|
Used to pass an 'in' argument: (Undocumented) |
|
Used to pass an 'in' argument: (Undocumented) |
|
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking |
|
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
|
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
|
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : |
a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
tp_cli_call_stream_interface_media_call_set_credentials ()
TpProxyPendingCall * tp_cli_call_stream_interface_media_call_set_credentials (TpCallStream *proxy
,gint timeout_ms
,const gchar *in_Username
,const gchar *in_Password
,tp_cli_call_stream_interface_media_callback_for_set_credentials callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
);
Start a SetCredentials method call.
<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Used to set the username fragment and password for streams that have global credentials.</p>
|
the TpProxy |
|
the timeout in milliseconds, or -1 to use the default |
|
Used to pass an 'in' argument: The username to use when authenticating on the stream. |
|
Used to pass an 'in' argument: The password to use when authenticating on the stream. |
|
called when the method call succeeds or fails;
may be NULL to make a "fire and forget" call with no
reply tracking |
|
user-supplied data passed to the callback;
must be NULL if callback is NULL
|
|
called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULL if callback is NULL
|
|
If not NULL , a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be NULL if
callback is NULL
|
Returns : |
a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid. |
tp_cli_call_stream_interface_media_callback_for_add_candidates ()
void (*tp_cli_call_stream_interface_media_callback_for_add_candidates) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
);
Signature of the callback called when a AddCandidates method call succeeds or fails.
|
the proxy on which the call was made |
|
NULL on success, or an error on failure |
|
user-supplied data |
|
user-supplied object |
tp_cli_call_stream_interface_media_callback_for_complete_receiving_state_change ()
void (*tp_cli_call_stream_interface_media_callback_for_complete_receiving_state_change) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
);
Signature of the callback called when a CompleteReceivingStateChange method call succeeds or fails.
|
the proxy on which the call was made |
|
NULL on success, or an error on failure |
|
user-supplied data |
|
user-supplied object |
tp_cli_call_stream_interface_media_callback_for_complete_sending_state_change ()
void (*tp_cli_call_stream_interface_media_callback_for_complete_sending_state_change) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
);
Signature of the callback called when a CompleteSendingStateChange method call succeeds or fails.
|
the proxy on which the call was made |
|
NULL on success, or an error on failure |
|
user-supplied data |
|
user-supplied object |
tp_cli_call_stream_interface_media_callback_for_fail ()
void (*tp_cli_call_stream_interface_media_callback_for_fail) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
);
Signature of the callback called when a Fail method call succeeds or fails.
|
the proxy on which the call was made |
|
NULL on success, or an error on failure |
|
user-supplied data |
|
user-supplied object |
tp_cli_call_stream_interface_media_callback_for_finish_initial_candidates ()
void (*tp_cli_call_stream_interface_media_callback_for_finish_initial_candidates) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
);
Signature of the callback called when a FinishInitialCandidates method call succeeds or fails.
|
the proxy on which the call was made |
|
NULL on success, or an error on failure |
|
user-supplied data |
|
user-supplied object |
tp_cli_call_stream_interface_media_callback_for_report_receiving_failure ()
void (*tp_cli_call_stream_interface_media_callback_for_report_receiving_failure) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
);
Signature of the callback called when a ReportReceivingFailure method call succeeds or fails.
|
the proxy on which the call was made |
|
NULL on success, or an error on failure |
|
user-supplied data |
|
user-supplied object |
tp_cli_call_stream_interface_media_callback_for_report_sending_failure ()
void (*tp_cli_call_stream_interface_media_callback_for_report_sending_failure) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
);
Signature of the callback called when a ReportSendingFailure method call succeeds or fails.
|
the proxy on which the call was made |
|
NULL on success, or an error on failure |
|
user-supplied data |
|
user-supplied object |
tp_cli_call_stream_interface_media_callback_for_set_credentials ()
void (*tp_cli_call_stream_interface_media_callback_for_set_credentials) (TpCallStream *proxy
,const GError *error
,gpointer user_data
,GObject *weak_object
);
Signature of the callback called when a SetCredentials method call succeeds or fails.
|
the proxy on which the call was made |
|
NULL on success, or an error on failure |
|
user-supplied data |
|
user-supplied object |
tp_cli_call_stream_interface_media_connect_to_endpoints_changed ()
TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_endpoints_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_endpoints_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
);
Connect a handler to the signal EndpointsChanged.
Emitted when the <tp:member-ref>Endpoints</tp:member-ref> property changes.
|
A TpCallStream or subclass |
|
Callback to be called when the signal is received |
|
User-supplied data for the callback |
|
Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL
|
|
A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected |
|
If not NULL , used to raise an error if NULL is
returned |
Returns : |
a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or
NULL if the proxy does not have the desired interface
or has become invalid. |
tp_cli_call_stream_interface_media_connect_to_ice_restart_requested ()
TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_ice_restart_requested (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_ice_restart_requested callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
);
Connect a handler to the signal ICERestartRequested.
Emitted when the remote side requests an ICE restart (e.g. third party call control, when the remote endpoint changes). The streaming implementation should call <tp:member-ref>SetCredentials</tp:member-ref> again.
|
A TpCallStream or subclass |
|
Callback to be called when the signal is received |
|
User-supplied data for the callback |
|
Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL
|
|
A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected |
|
If not NULL , used to raise an error if NULL is
returned |
Returns : |
a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or
NULL if the proxy does not have the desired interface
or has become invalid. |
tp_cli_call_stream_interface_media_connect_to_local_candidates_added ()
TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_local_candidates_added (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_local_candidates_added callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
);
Connect a handler to the signal LocalCandidatesAdded.
Emitted when local candidates are added to the <tp:member-ref>LocalCandidates</tp:member-ref> property.
|
A TpCallStream or subclass |
|
Callback to be called when the signal is received |
|
User-supplied data for the callback |
|
Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL
|
|
A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected |
|
If not NULL , used to raise an error if NULL is
returned |
Returns : |
a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or
NULL if the proxy does not have the desired interface
or has become invalid. |
tp_cli_call_stream_interface_media_connect_to_local_credentials_changed ()
TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_local_credentials_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_local_credentials_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
);
Connect a handler to the signal LocalCredentialsChanged.
Emitted when the value of <tp:member-ref>LocalCredentials</tp:member-ref> changes to a non-empty value. This should only happen when the streaming implementation calls <tp:member-ref>SetCredentials</tp:member-ref>, so this signal is mostly useful for debugging.
|
A TpCallStream or subclass |
|
Callback to be called when the signal is received |
|
User-supplied data for the callback |
|
Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL
|
|
A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected |
|
If not NULL , used to raise an error if NULL is
returned |
Returns : |
a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or
NULL if the proxy does not have the desired interface
or has become invalid. |
tp_cli_call_stream_interface_media_connect_to_receiving_state_changed ()
TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_receiving_state_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_receiving_state_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
);
Connect a handler to the signal ReceivingStateChanged.
Change notification for <tp:member-ref>ReceivingState</tp:member-ref>.
|
A TpCallStream or subclass |
|
Callback to be called when the signal is received |
|
User-supplied data for the callback |
|
Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL
|
|
A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected |
|
If not NULL , used to raise an error if NULL is
returned |
Returns : |
a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or
NULL if the proxy does not have the desired interface
or has become invalid. |
tp_cli_call_stream_interface_media_connect_to_relay_info_changed ()
TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_relay_info_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_relay_info_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
);
Connect a handler to the signal RelayInfoChanged.
Emitted when the value of <tp:member-ref>RelayInfo</tp:member-ref> changes.
|
A TpCallStream or subclass |
|
Callback to be called when the signal is received |
|
User-supplied data for the callback |
|
Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL
|
|
A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected |
|
If not NULL , used to raise an error if NULL is
returned |
Returns : |
a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or
NULL if the proxy does not have the desired interface
or has become invalid. |
tp_cli_call_stream_interface_media_connect_to_sending_state_changed ()
TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_sending_state_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_sending_state_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
);
Connect a handler to the signal SendingStateChanged.
Change notification for <tp:member-ref>SendingState</tp:member-ref>. Note that this information is duplicated onto the Stream interface, so that UIs can ignore the Media interface, and streaming implementations can ignore everything but the media interface.
|
A TpCallStream or subclass |
|
Callback to be called when the signal is received |
|
User-supplied data for the callback |
|
Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL
|
|
A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected |
|
If not NULL , used to raise an error if NULL is
returned |
Returns : |
a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or
NULL if the proxy does not have the desired interface
or has become invalid. |
tp_cli_call_stream_interface_media_connect_to_server_info_retrieved ()
TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_server_info_retrieved (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_server_info_retrieved callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
);
Connect a handler to the signal ServerInfoRetrieved.
<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Signals that the initial information about STUN and Relay servers has been retrieved, i.e. the <tp:member-ref>HasServerInfo</tp:member-ref> property is now true.</p>
|
A TpCallStream or subclass |
|
Callback to be called when the signal is received |
|
User-supplied data for the callback |
|
Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL
|
|
A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected |
|
If not NULL , used to raise an error if NULL is
returned |
Returns : |
a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or
NULL if the proxy does not have the desired interface
or has become invalid. |
tp_cli_call_stream_interface_media_connect_to_stun_servers_changed ()
TpProxySignalConnection * tp_cli_call_stream_interface_media_connect_to_stun_servers_changed (TpCallStream *proxy
,tp_cli_call_stream_interface_media_signal_callback_stun_servers_changed callback
,gpointer user_data
,GDestroyNotify destroy
,GObject *weak_object
,GError **error
);
Connect a handler to the signal STUNServersChanged.
Emitted when the value of <tp:member-ref>STUNServers</tp:member-ref> changes.
|
A TpCallStream or subclass |
|
Callback to be called when the signal is received |
|
User-supplied data for the callback |
|
Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL
|
|
A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected |
|
If not NULL , used to raise an error if NULL is
returned |
Returns : |
a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or
NULL if the proxy does not have the desired interface
or has become invalid. |
tp_cli_call_stream_interface_media_signal_callback_endpoints_changed ()
void (*tp_cli_call_stream_interface_media_signal_callback_endpoints_changed) (TpCallStream *proxy
,const GPtrArray *arg_Endpoints_Added
,const GPtrArray *arg_Endpoints_Removed
,gpointer user_data
,GObject *weak_object
);
Represents the signature of a callback for the signal EndpointsChanged.
|
The proxy on which tp_cli_call_stream_interface_media_connect_to_endpoints_changed()
was called |
|
Endpoints that were added. |
|
Endpoints that no longer exist. |
|
User-supplied data |
|
User-supplied weakly referenced object |
tp_cli_call_stream_interface_media_signal_callback_ice_restart_requested ()
void (*tp_cli_call_stream_interface_media_signal_callback_ice_restart_requested) (TpCallStream *proxy
,gpointer user_data
,GObject *weak_object
);
Represents the signature of a callback for the signal ICERestartRequested.
|
The proxy on which tp_cli_call_stream_interface_media_connect_to_ice_restart_requested()
was called |
|
User-supplied data |
|
User-supplied weakly referenced object |
tp_cli_call_stream_interface_media_signal_callback_local_candidates_added ()
void (*tp_cli_call_stream_interface_media_signal_callback_local_candidates_added) (TpCallStream *proxy
,const GPtrArray *arg_Candidates
,gpointer user_data
,GObject *weak_object
);
Represents the signature of a callback for the signal LocalCandidatesAdded.
|
The proxy on which tp_cli_call_stream_interface_media_connect_to_local_candidates_added()
was called |
|
Candidates that have been added. |
|
User-supplied data |
|
User-supplied weakly referenced object |
tp_cli_call_stream_interface_media_signal_callback_local_credentials_changed ()
void (*tp_cli_call_stream_interface_media_signal_callback_local_credentials_changed) (TpCallStream *proxy
,const gchar *arg_Username
,const gchar *arg_Password
,gpointer user_data
,GObject *weak_object
);
Represents the signature of a callback for the signal LocalCredentialsChanged.
|
The proxy on which tp_cli_call_stream_interface_media_connect_to_local_credentials_changed()
was called |
|
(Undocumented) |
|
(Undocumented) |
|
User-supplied data |
|
User-supplied weakly referenced object |
tp_cli_call_stream_interface_media_signal_callback_receiving_state_changed ()
void (*tp_cli_call_stream_interface_media_signal_callback_receiving_state_changed) (TpCallStream *proxy
,guint arg_State
,gpointer user_data
,GObject *weak_object
);
Represents the signature of a callback for the signal ReceivingStateChanged.
|
The proxy on which tp_cli_call_stream_interface_media_connect_to_receiving_state_changed()
was called |
|
The new value of ReceivingState. (TpStreamFlowState) |
|
User-supplied data |
|
User-supplied weakly referenced object |
tp_cli_call_stream_interface_media_signal_callback_relay_info_changed ()
void (*tp_cli_call_stream_interface_media_signal_callback_relay_info_changed) (TpCallStream *proxy
,const GPtrArray *arg_Relay_Info
,gpointer user_data
,GObject *weak_object
);
Represents the signature of a callback for the signal RelayInfoChanged.
|
The proxy on which tp_cli_call_stream_interface_media_connect_to_relay_info_changed()
was called |
|
(Undocumented) |
|
User-supplied data |
|
User-supplied weakly referenced object |
tp_cli_call_stream_interface_media_signal_callback_sending_state_changed ()
void (*tp_cli_call_stream_interface_media_signal_callback_sending_state_changed) (TpCallStream *proxy
,guint arg_State
,gpointer user_data
,GObject *weak_object
);
Represents the signature of a callback for the signal SendingStateChanged.
|
The proxy on which tp_cli_call_stream_interface_media_connect_to_sending_state_changed()
was called |
|
The new value of SendingState. (TpStreamFlowState) |
|
User-supplied data |
|
User-supplied weakly referenced object |
tp_cli_call_stream_interface_media_signal_callback_server_info_retrieved ()
void (*tp_cli_call_stream_interface_media_signal_callback_server_info_retrieved) (TpCallStream *proxy
,gpointer user_data
,GObject *weak_object
);
Represents the signature of a callback for the signal ServerInfoRetrieved.
|
The proxy on which tp_cli_call_stream_interface_media_connect_to_server_info_retrieved()
was called |
|
User-supplied data |
|
User-supplied weakly referenced object |
tp_cli_call_stream_interface_media_signal_callback_stun_servers_changed ()
void (*tp_cli_call_stream_interface_media_signal_callback_stun_servers_changed) (TpCallStream *proxy
,const GPtrArray *arg_Servers
,gpointer user_data
,GObject *weak_object
);
Represents the signature of a callback for the signal STUNServersChanged.
|
The proxy on which tp_cli_call_stream_interface_media_connect_to_stun_servers_changed()
was called |
|
(Undocumented) |
|
User-supplied data |
|
User-supplied weakly referenced object |