![]() |
![]() |
![]() |
telepathy-glib Reference Manual | ![]() |
---|---|---|---|---|
Service-side media streaming helper interfacesService-side media streaming helper interfaces — media session and media stream |
#include <telepathy-glib/svc-media-interfaces.h> TpSvcMediaSessionHandler; TpSvcMediaSessionHandlerClass; void (*tp_svc_media_session_handler_error_impl) (TpSvcMediaSessionHandler *self, guint errno, const gchar *message, DBusGMethodInvocation *context); void tp_svc_media_session_handler_implement_error (TpSvcMediaSessionHandlerClass *klass, tp_svc_media_session_handler_error_impl impl); void tp_svc_media_session_handler_return_from_error (DBusGMethodInvocation *dbus_context); void (*tp_svc_media_session_handler_ready_impl) (TpSvcMediaSessionHandler *self, DBusGMethodInvocation *context); void tp_svc_media_session_handler_implement_ready (TpSvcMediaSessionHandlerClass *klass, tp_svc_media_session_handler_ready_impl impl); void tp_svc_media_session_handler_return_from_ready (DBusGMethodInvocation *dbus_context); void tp_svc_media_session_handler_emit_new_stream_handler (gpointer instance, const gchar *stream_handler, const guint id, const guint media_type, const guint direction); TpSvcMediaStreamHandler; TpSvcMediaStreamHandlerClass; void (*tp_svc_media_stream_handler_codec_choice_impl) (TpSvcMediaStreamHandler *self, guint codec_id, DBusGMethodInvocation *context); void tp_svc_media_stream_handler_implement_codec_choice (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_codec_choice_impl impl); void tp_svc_media_stream_handler_return_from_codec_choice (DBusGMethodInvocation *dbus_context); void (*tp_svc_media_stream_handler_error_impl) (TpSvcMediaStreamHandler *self, guint errno, const gchar *message, DBusGMethodInvocation *context); void tp_svc_media_stream_handler_implement_error (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_error_impl impl); void tp_svc_media_stream_handler_return_from_error (DBusGMethodInvocation *dbus_context); void (*tp_svc_media_stream_handler_native_candidates_prepared_impl) (TpSvcMediaStreamHandler *self, DBusGMethodInvocation *context); void tp_svc_media_stream_handler_implement_native_candidates_prepared (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_native_candidates_prepared_impl impl); void tp_svc_media_stream_handler_return_from_native_candidates_prepared (DBusGMethodInvocation *dbus_context); void (*tp_svc_media_stream_handler_new_active_candidate_pair_impl) (TpSvcMediaStreamHandler *self, const gchar *native_candidate_id, const gchar *remote_candidate_id, DBusGMethodInvocation *context); void tp_svc_media_stream_handler_implement_new_active_candidate_pair (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_new_active_candidate_pair_impl impl); void tp_svc_media_stream_handler_return_from_new_active_candidate_pair (DBusGMethodInvocation *dbus_context); void (*tp_svc_media_stream_handler_new_native_candidate_impl) (TpSvcMediaStreamHandler *self, const gchar *candidate_id, const GPtrArray *transports, DBusGMethodInvocation *context); void tp_svc_media_stream_handler_implement_new_native_candidate (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_new_native_candidate_impl impl); void tp_svc_media_stream_handler_return_from_new_native_candidate (DBusGMethodInvocation *dbus_context); void (*tp_svc_media_stream_handler_ready_impl) (TpSvcMediaStreamHandler *self, const GPtrArray *codecs, DBusGMethodInvocation *context); void tp_svc_media_stream_handler_implement_ready (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_ready_impl impl); void tp_svc_media_stream_handler_return_from_ready (DBusGMethodInvocation *dbus_context); void (*tp_svc_media_stream_handler_set_local_codecs_impl) (TpSvcMediaStreamHandler *self, const GPtrArray *codecs, DBusGMethodInvocation *context); void tp_svc_media_stream_handler_implement_set_local_codecs (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_set_local_codecs_impl impl); void tp_svc_media_stream_handler_return_from_set_local_codecs (DBusGMethodInvocation *dbus_context); void (*tp_svc_media_stream_handler_stream_state_impl) (TpSvcMediaStreamHandler *self, guint state, DBusGMethodInvocation *context); void tp_svc_media_stream_handler_implement_stream_state (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_stream_state_impl impl); void tp_svc_media_stream_handler_return_from_stream_state (DBusGMethodInvocation *dbus_context); void (*tp_svc_media_stream_handler_supported_codecs_impl) (TpSvcMediaStreamHandler *self, const GPtrArray *codecs, DBusGMethodInvocation *context); void tp_svc_media_stream_handler_implement_supported_codecs (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_supported_codecs_impl impl); void tp_svc_media_stream_handler_return_from_supported_codecs (DBusGMethodInvocation *dbus_context); void tp_svc_media_stream_handler_emit_add_remote_candidate (gpointer instance, const gchar *candidate_id, const GPtrArray *transports); void tp_svc_media_stream_handler_emit_close (gpointer instance); void tp_svc_media_stream_handler_emit_remove_remote_candidate (gpointer instance, const gchar *candidate_id); void tp_svc_media_stream_handler_emit_set_active_candidate_pair (gpointer instance, const gchar *native_candidate_id, const gchar *remote_candidate_id); void tp_svc_media_stream_handler_emit_set_remote_candidate_list (gpointer instance, const GPtrArray *remote_candidates); void tp_svc_media_stream_handler_emit_set_remote_codecs (gpointer instance, const GPtrArray *codecs); void tp_svc_media_stream_handler_emit_set_stream_playing (gpointer instance, const gboolean playing); void tp_svc_media_stream_handler_emit_set_stream_sending (gpointer instance, const gboolean sending); void tp_svc_media_stream_handler_emit_start_telephony_event (gpointer instance, const guchar event); void tp_svc_media_stream_handler_emit_stop_telephony_event (gpointer instance);
These interfaces (auto-generated from the telepathy spec) make it easier to export the objects used to implement TpSvcChannelTypeStreamedMedia, with the correct method and signal signatures, and emit signals from those objects.
typedef struct _TpSvcMediaSessionHandler TpSvcMediaSessionHandler;
Dummy typedef representing any implementation of this interface.
typedef struct _TpSvcMediaSessionHandlerClass TpSvcMediaSessionHandlerClass;
The class of TpSvcMediaSessionHandler.
void (*tp_svc_media_session_handler_error_impl) (TpSvcMediaSessionHandler *self, guint errno, const gchar *message, DBusGMethodInvocation *context);
Signature of an implementation of D-Bus method Error on interface org.freedesktop.Telepathy.Media.SessionHandler
self : |
The object implementing this interface |
errno : |
FIXME: document args in genginterface |
message : |
FIXME: document args in genginterface |
context : |
The D-Bus invocation context to use to return values or throw an error. |
void tp_svc_media_session_handler_implement_error (TpSvcMediaSessionHandlerClass *klass, tp_svc_media_session_handler_error_impl impl);
Register an implementation for the Error method in the vtable of an implementation of this interface. To be called from the interface init function.
klass : |
A class whose instances implement this interface |
impl : |
A callback used to implement the Error method |
void tp_svc_media_session_handler_return_from_error (DBusGMethodInvocation *dbus_context);
Return successfully by calling dbus_g_method_return (dbus_context
,
...). This inline function is just a type-safe wrapper for
dbus_g_method_return.
dbus_context : |
The D-Bus method invocation context |
void (*tp_svc_media_session_handler_ready_impl) (TpSvcMediaSessionHandler *self, DBusGMethodInvocation *context);
Signature of an implementation of D-Bus method Ready on interface org.freedesktop.Telepathy.Media.SessionHandler
self : |
The object implementing this interface |
context : |
The D-Bus invocation context to use to return values or throw an error. |
void tp_svc_media_session_handler_implement_ready (TpSvcMediaSessionHandlerClass *klass, tp_svc_media_session_handler_ready_impl impl);
Register an implementation for the Ready method in the vtable of an implementation of this interface. To be called from the interface init function.
klass : |
A class whose instances implement this interface |
impl : |
A callback used to implement the Ready method |
void tp_svc_media_session_handler_return_from_ready (DBusGMethodInvocation *dbus_context);
Return successfully by calling dbus_g_method_return (dbus_context
,
...). This inline function is just a type-safe wrapper for
dbus_g_method_return.
dbus_context : |
The D-Bus method invocation context |
void tp_svc_media_session_handler_emit_new_stream_handler (gpointer instance, const gchar *stream_handler, const guint id, const guint media_type, const guint direction);
Emit the NewStreamHandler D-Bus signal from instance
with the given arguments.
instance : |
An object implementing this interface |
stream_handler : |
FIXME: document args in genginterface |
id : |
FIXME: document args in genginterface |
media_type : |
FIXME: document args in genginterface |
direction : |
FIXME: document args in genginterface |
typedef struct _TpSvcMediaStreamHandler TpSvcMediaStreamHandler;
Dummy typedef representing any implementation of this interface.
typedef struct _TpSvcMediaStreamHandlerClass TpSvcMediaStreamHandlerClass;
The class of TpSvcMediaStreamHandler.
void (*tp_svc_media_stream_handler_codec_choice_impl) (TpSvcMediaStreamHandler *self, guint codec_id, DBusGMethodInvocation *context);
Signature of an implementation of D-Bus method CodecChoice on interface org.freedesktop.Telepathy.Media.StreamHandler
self : |
The object implementing this interface |
codec_id : |
FIXME: document args in genginterface |
context : |
The D-Bus invocation context to use to return values or throw an error. |
void tp_svc_media_stream_handler_implement_codec_choice (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_codec_choice_impl impl);
Register an implementation for the CodecChoice method in the vtable of an implementation of this interface. To be called from the interface init function.
klass : |
A class whose instances implement this interface |
impl : |
A callback used to implement the CodecChoice method |
void tp_svc_media_stream_handler_return_from_codec_choice (DBusGMethodInvocation *dbus_context);
Return successfully by calling dbus_g_method_return (dbus_context
,
...). This inline function is just a type-safe wrapper for
dbus_g_method_return.
dbus_context : |
The D-Bus method invocation context |
void (*tp_svc_media_stream_handler_error_impl) (TpSvcMediaStreamHandler *self, guint errno, const gchar *message, DBusGMethodInvocation *context);
Signature of an implementation of D-Bus method Error on interface org.freedesktop.Telepathy.Media.StreamHandler
self : |
The object implementing this interface |
errno : |
FIXME: document args in genginterface |
message : |
FIXME: document args in genginterface |
context : |
The D-Bus invocation context to use to return values or throw an error. |
void tp_svc_media_stream_handler_implement_error (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_error_impl impl);
Register an implementation for the Error method in the vtable of an implementation of this interface. To be called from the interface init function.
klass : |
A class whose instances implement this interface |
impl : |
A callback used to implement the Error method |
void tp_svc_media_stream_handler_return_from_error (DBusGMethodInvocation *dbus_context);
Return successfully by calling dbus_g_method_return (dbus_context
,
...). This inline function is just a type-safe wrapper for
dbus_g_method_return.
dbus_context : |
The D-Bus method invocation context |
void (*tp_svc_media_stream_handler_native_candidates_prepared_impl) (TpSvcMediaStreamHandler *self, DBusGMethodInvocation *context);
Signature of an implementation of D-Bus method NativeCandidatesPrepared on interface org.freedesktop.Telepathy.Media.StreamHandler
self : |
The object implementing this interface |
context : |
The D-Bus invocation context to use to return values or throw an error. |
void tp_svc_media_stream_handler_implement_native_candidates_prepared (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_native_candidates_prepared_impl impl);
Register an implementation for the NativeCandidatesPrepared method in the vtable of an implementation of this interface. To be called from the interface init function.
klass : |
A class whose instances implement this interface |
impl : |
A callback used to implement the NativeCandidatesPrepared method |
void tp_svc_media_stream_handler_return_from_native_candidates_prepared (DBusGMethodInvocation *dbus_context);
Return successfully by calling dbus_g_method_return (dbus_context
,
...). This inline function is just a type-safe wrapper for
dbus_g_method_return.
dbus_context : |
The D-Bus method invocation context |
void (*tp_svc_media_stream_handler_new_active_candidate_pair_impl) (TpSvcMediaStreamHandler *self, const gchar *native_candidate_id, const gchar *remote_candidate_id, DBusGMethodInvocation *context);
Signature of an implementation of D-Bus method NewActiveCandidatePair on interface org.freedesktop.Telepathy.Media.StreamHandler
self : |
The object implementing this interface |
native_candidate_id : |
FIXME: document args in genginterface |
remote_candidate_id : |
FIXME: document args in genginterface |
context : |
The D-Bus invocation context to use to return values or throw an error. |
void tp_svc_media_stream_handler_implement_new_active_candidate_pair (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_new_active_candidate_pair_impl impl);
Register an implementation for the NewActiveCandidatePair method in the vtable of an implementation of this interface. To be called from the interface init function.
klass : |
A class whose instances implement this interface |
impl : |
A callback used to implement the NewActiveCandidatePair method |
void tp_svc_media_stream_handler_return_from_new_active_candidate_pair (DBusGMethodInvocation *dbus_context);
Return successfully by calling dbus_g_method_return (dbus_context
,
...). This inline function is just a type-safe wrapper for
dbus_g_method_return.
dbus_context : |
The D-Bus method invocation context |
void (*tp_svc_media_stream_handler_new_native_candidate_impl) (TpSvcMediaStreamHandler *self, const gchar *candidate_id, const GPtrArray *transports, DBusGMethodInvocation *context);
Signature of an implementation of D-Bus method NewNativeCandidate on interface org.freedesktop.Telepathy.Media.StreamHandler
self : |
The object implementing this interface |
candidate_id : |
FIXME: document args in genginterface |
transports : |
FIXME: document args in genginterface |
context : |
The D-Bus invocation context to use to return values or throw an error. |
void tp_svc_media_stream_handler_implement_new_native_candidate (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_new_native_candidate_impl impl);
Register an implementation for the NewNativeCandidate method in the vtable of an implementation of this interface. To be called from the interface init function.
klass : |
A class whose instances implement this interface |
impl : |
A callback used to implement the NewNativeCandidate method |
void tp_svc_media_stream_handler_return_from_new_native_candidate (DBusGMethodInvocation *dbus_context);
Return successfully by calling dbus_g_method_return (dbus_context
,
...). This inline function is just a type-safe wrapper for
dbus_g_method_return.
dbus_context : |
The D-Bus method invocation context |
void (*tp_svc_media_stream_handler_ready_impl) (TpSvcMediaStreamHandler *self, const GPtrArray *codecs, DBusGMethodInvocation *context);
Signature of an implementation of D-Bus method Ready on interface org.freedesktop.Telepathy.Media.StreamHandler
self : |
The object implementing this interface |
codecs : |
FIXME: document args in genginterface |
context : |
The D-Bus invocation context to use to return values or throw an error. |
void tp_svc_media_stream_handler_implement_ready (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_ready_impl impl);
Register an implementation for the Ready method in the vtable of an implementation of this interface. To be called from the interface init function.
klass : |
A class whose instances implement this interface |
impl : |
A callback used to implement the Ready method |
void tp_svc_media_stream_handler_return_from_ready (DBusGMethodInvocation *dbus_context);
Return successfully by calling dbus_g_method_return (dbus_context
,
...). This inline function is just a type-safe wrapper for
dbus_g_method_return.
dbus_context : |
The D-Bus method invocation context |
void (*tp_svc_media_stream_handler_set_local_codecs_impl) (TpSvcMediaStreamHandler *self, const GPtrArray *codecs, DBusGMethodInvocation *context);
Signature of an implementation of D-Bus method SetLocalCodecs on interface org.freedesktop.Telepathy.Media.StreamHandler
self : |
The object implementing this interface |
codecs : |
FIXME: document args in genginterface |
context : |
The D-Bus invocation context to use to return values or throw an error. |
void tp_svc_media_stream_handler_implement_set_local_codecs (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_set_local_codecs_impl impl);
Register an implementation for the SetLocalCodecs method in the vtable of an implementation of this interface. To be called from the interface init function.
klass : |
A class whose instances implement this interface |
impl : |
A callback used to implement the SetLocalCodecs method |
void tp_svc_media_stream_handler_return_from_set_local_codecs (DBusGMethodInvocation *dbus_context);
Return successfully by calling dbus_g_method_return (dbus_context
,
...). This inline function is just a type-safe wrapper for
dbus_g_method_return.
dbus_context : |
The D-Bus method invocation context |
void (*tp_svc_media_stream_handler_stream_state_impl) (TpSvcMediaStreamHandler *self, guint state, DBusGMethodInvocation *context);
Signature of an implementation of D-Bus method StreamState on interface org.freedesktop.Telepathy.Media.StreamHandler
self : |
The object implementing this interface |
state : |
FIXME: document args in genginterface |
context : |
The D-Bus invocation context to use to return values or throw an error. |
void tp_svc_media_stream_handler_implement_stream_state (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_stream_state_impl impl);
Register an implementation for the StreamState method in the vtable of an implementation of this interface. To be called from the interface init function.
klass : |
A class whose instances implement this interface |
impl : |
A callback used to implement the StreamState method |
void tp_svc_media_stream_handler_return_from_stream_state (DBusGMethodInvocation *dbus_context);
Return successfully by calling dbus_g_method_return (dbus_context
,
...). This inline function is just a type-safe wrapper for
dbus_g_method_return.
dbus_context : |
The D-Bus method invocation context |
void (*tp_svc_media_stream_handler_supported_codecs_impl) (TpSvcMediaStreamHandler *self, const GPtrArray *codecs, DBusGMethodInvocation *context);
Signature of an implementation of D-Bus method SupportedCodecs on interface org.freedesktop.Telepathy.Media.StreamHandler
self : |
The object implementing this interface |
codecs : |
FIXME: document args in genginterface |
context : |
The D-Bus invocation context to use to return values or throw an error. |
void tp_svc_media_stream_handler_implement_supported_codecs (TpSvcMediaStreamHandlerClass *klass, tp_svc_media_stream_handler_supported_codecs_impl impl);
Register an implementation for the SupportedCodecs method in the vtable of an implementation of this interface. To be called from the interface init function.
klass : |
A class whose instances implement this interface |
impl : |
A callback used to implement the SupportedCodecs method |
void tp_svc_media_stream_handler_return_from_supported_codecs (DBusGMethodInvocation *dbus_context);
Return successfully by calling dbus_g_method_return (dbus_context
,
...). This inline function is just a type-safe wrapper for
dbus_g_method_return.
dbus_context : |
The D-Bus method invocation context |
void tp_svc_media_stream_handler_emit_add_remote_candidate (gpointer instance, const gchar *candidate_id, const GPtrArray *transports);
Emit the AddRemoteCandidate D-Bus signal from instance
with the given arguments.
instance : |
An object implementing this interface |
candidate_id : |
FIXME: document args in genginterface |
transports : |
FIXME: document args in genginterface |
void tp_svc_media_stream_handler_emit_close (gpointer instance);
Emit the Close D-Bus signal from instance
with the given arguments.
instance : |
An object implementing this interface |
void tp_svc_media_stream_handler_emit_remove_remote_candidate (gpointer instance, const gchar *candidate_id);
Emit the RemoveRemoteCandidate D-Bus signal from instance
with the given arguments.
instance : |
An object implementing this interface |
candidate_id : |
FIXME: document args in genginterface |
void tp_svc_media_stream_handler_emit_set_active_candidate_pair (gpointer instance, const gchar *native_candidate_id, const gchar *remote_candidate_id);
Emit the SetActiveCandidatePair D-Bus signal from instance
with the given arguments.
instance : |
An object implementing this interface |
native_candidate_id : |
FIXME: document args in genginterface |
remote_candidate_id : |
FIXME: document args in genginterface |
void tp_svc_media_stream_handler_emit_set_remote_candidate_list (gpointer instance, const GPtrArray *remote_candidates);
Emit the SetRemoteCandidateList D-Bus signal from instance
with the given arguments.
instance : |
An object implementing this interface |
remote_candidates : |
FIXME: document args in genginterface |
void tp_svc_media_stream_handler_emit_set_remote_codecs (gpointer instance, const GPtrArray *codecs);
Emit the SetRemoteCodecs D-Bus signal from instance
with the given arguments.
instance : |
An object implementing this interface |
codecs : |
FIXME: document args in genginterface |
void tp_svc_media_stream_handler_emit_set_stream_playing (gpointer instance, const gboolean playing);
Emit the SetStreamPlaying D-Bus signal from instance
with the given arguments.
instance : |
An object implementing this interface |
playing : |
FIXME: document args in genginterface |
void tp_svc_media_stream_handler_emit_set_stream_sending (gpointer instance, const gboolean sending);
Emit the SetStreamSending D-Bus signal from instance
with the given arguments.
instance : |
An object implementing this interface |
sending : |
FIXME: document args in genginterface |
void tp_svc_media_stream_handler_emit_start_telephony_event (gpointer instance, const guchar event);
Emit the StartTelephonyEvent D-Bus signal from instance
with the given arguments.
instance : |
An object implementing this interface |
event : |
FIXME: document args in genginterface |