TpCallContentMediaDescription

TpCallContentMediaDescription — implementation of TpSvcCallContentMediaDescription

Synopsis

#include <telepathy-glib/telepathy-glib.h>

                    TpCallContentMediaDescription;
struct              TpCallContentMediaDescriptionClass;
TpCallContentMediaDescription * tp_call_content_media_description_new
                                                        (TpDBusDaemon *dbus_daemon,
                                                         const gchar *object_path,
                                                         TpHandle remote_contact,
                                                         gboolean has_remote_information,
                                                         gboolean further_negotiation_required);
const gchar *       tp_call_content_media_description_get_object_path
                                                        (TpCallContentMediaDescription *self);
TpHandle            tp_call_content_media_description_get_remote_contact
                                                        (TpCallContentMediaDescription *self);
void                tp_call_content_media_description_append_codec
                                                        (TpCallContentMediaDescription *self,
                                                         guint identifier,
                                                         const gchar *name,
                                                         guint clock_rate,
                                                         guint channels,
                                                         gboolean updated,
                                                         GHashTable *parameters);
void                tp_call_content_media_description_add_ssrc
                                                        (TpCallContentMediaDescription *self,
                                                         TpHandle contact,
                                                         guint ssrc);

Object Hierarchy

  GObject
   +----TpCallContentMediaDescription

Implemented Interfaces

TpCallContentMediaDescription implements TpSvcCallContentMediaDescription and TpSvcDBusProperties.

Properties

  "codecs"                   GPtrArray_GValueArray_guint+gchararray+guint+guint+gboolean+GHashTable_gchararray+gchararray___*  : Read
  "dbus-daemon"              TpDBusDaemon*         : Read / Write / Construct Only
  "further-negotiation-required" gboolean              : Read / Write / Construct Only
  "has-remote-information"   gboolean              : Read / Write / Construct Only
  "interfaces"               GStrv                 : Read
  "object-path"              gchar*                : Read / Write / Construct Only
  "remote-contact"           guint                 : Read / Write / Construct Only
  "ssrcs"                    GHashTable_guint+GArray_guint__*  : Read

Description

This class is used to negociate the media description used with a remote contact. To be used with TpBaseMediaCallContent implementations.

Details

TpCallContentMediaDescription

typedef struct _TpCallContentMediaDescription TpCallContentMediaDescription;

A class for media content description

Since 0.17.5


struct TpCallContentMediaDescriptionClass

struct TpCallContentMediaDescriptionClass {
};

The class structure for TpCallContentMediaDescription

Since 0.17.5


tp_call_content_media_description_new ()

TpCallContentMediaDescription * tp_call_content_media_description_new
                                                        (TpDBusDaemon *dbus_daemon,
                                                         const gchar *object_path,
                                                         TpHandle remote_contact,
                                                         gboolean has_remote_information,
                                                         gboolean further_negotiation_required);

Create a new TpCallContentMediaDescription object. More information can be added after construction using tp_call_content_media_description_append_codec() and tp_call_content_media_description_add_ssrc().

Once all information has been filled, the media description can be offered using tp_base_media_call_content_offer_media_description().

dbus_daemon :

value of "dbus-daemon" property

object_path :

value of "object-path" property

remote_contact :

value of "remote-contact" property

has_remote_information :

value of "has_remote_information" property

further_negotiation_required :

value of "further_negotiation_required" property

Returns :

a new TpCallContentMediaDescription.

Since 0.17.5


tp_call_content_media_description_get_object_path ()

const gchar *       tp_call_content_media_description_get_object_path
                                                        (TpCallContentMediaDescription *self);

self :

a TpCallContentMediaDescription

Returns :

the value of "object-path"

Since 0.17.5


tp_call_content_media_description_get_remote_contact ()

TpHandle            tp_call_content_media_description_get_remote_contact
                                                        (TpCallContentMediaDescription *self);

self :

a TpCallContentMediaDescription

Returns :

the value of "remote-contact"

Since 0.17.5


tp_call_content_media_description_append_codec ()

void                tp_call_content_media_description_append_codec
                                                        (TpCallContentMediaDescription *self,
                                                         guint identifier,
                                                         const gchar *name,
                                                         guint clock_rate,
                                                         guint channels,
                                                         gboolean updated,
                                                         GHashTable *parameters);

Add description for a supported codec.

self :

a TpCallContentMediaDescription

identifier :

if you use this API, you know what it is about

name :

if you use this API, you know what it is about

clock_rate :

if you use this API, you know what it is about

channels :

if you use this API, you know what it is about

updated :

if you use this API, you know what it is about

parameters :

if you use this API, you know what it is about

Since 0.17.5


tp_call_content_media_description_add_ssrc ()

void                tp_call_content_media_description_add_ssrc
                                                        (TpCallContentMediaDescription *self,
                                                         TpHandle contact,
                                                         guint ssrc);

if you use this API, you know what it is about

self :

a TpCallContentMediaDescription

contact :

if you use this API, you know what it is about

ssrc :

if you use this API, you know what it is about

Since 0.17.5

Property Details

The "codecs" property

  "codecs"                   GPtrArray_GValueArray_guint+gchararray+guint+guint+gboolean+GHashTable_gchararray+gchararray___*  : Read

GPtrArray{codecs GValueArray}. A list of codecs the remote contact supports.

Since 0.17.5


The "dbus-daemon" property

  "dbus-daemon"              TpDBusDaemon*         : Read / Write / Construct Only

The connection to the DBus daemon owning the CM.

Since 0.17.5


The "further-negotiation-required" property

  "further-negotiation-required" gboolean              : Read / Write / Construct Only

TRUE if the MediaDescription contains remote information.

Default value: FALSE

Since 0.17.5


The "has-remote-information" property

  "has-remote-information"   gboolean              : Read / Write / Construct Only

True if the MediaDescription contains remote information.

Default value: FALSE


The "interfaces" property

  "interfaces"               GStrv                 : Read

Additional interfaces implemented by this object.

Since 0.17.5


The "object-path" property

  "object-path"              gchar*                : Read / Write / Construct Only

The D-Bus object path used for this object on the bus.

Default value: NULL

Since 0.17.5


The "remote-contact" property

  "remote-contact"           guint                 : Read / Write / Construct Only

The contact TpHandle that this media description applies to.

Default value: 0

Since 0.17.5


The "ssrcs" property

  "ssrcs"                    GHashTable_guint+GArray_guint__*  : Read

GHashTable{contact TpHandle, GArray{uint}} A map of contacts to SSRCs.

Since 0.17.5

See Also

TpBaseMediaCallContent