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_async().

Since 0.17.5

tp_call_content_media_description_get_object_path ()

const gchar *       tp_call_content_media_description_get_object_path
                                                        (TpCallContentMediaDescription *self);

Since 0.17.5

tp_call_content_media_description_get_remote_contact ()

TpHandle            tp_call_content_media_description_get_remote_contact
                                                        (TpCallContentMediaDescription *self);

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.

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);

Add an SSRC to the list of SSRCs that a contact will send from. A SSRC is a synchronization source in RTP, it is the identifier for a continuous stream of packets following the same timeline.

Since 0.17.5

tp_call_content_media_description_add_rtp_header_extension ()

void                tp_call_content_media_description_add_rtp_header_extension
                                                        (TpCallContentMediaDescription *self,
                                                         guint id,
                                                         TpMediaStreamDirection direction,
                                                         const gchar *uri,
                                                         const gchar *parameters);

Add an element to the "header-extensions" property.

Implement TP_IFACE_CALL_CONTENT_MEDIA_DESCRIPTION_INTERFACE_RTP_HEADER_EXTENSIONS interface.

Since 0.17.6

tp_call_content_media_description_add_rtcp_feedback_message ()

void                tp_call_content_media_description_add_rtcp_feedback_message
                                                        (TpCallContentMediaDescription *self,
                                                         guint codec_identifier,
                                                         const gchar *type,
                                                         const gchar *subtype,
                                                         const gchar *parameters);

Add a message for a given codec. This ensures codec_identifier is in the "feedback-messages" map. The rtcp-minimum-interval is set to G_MAXUINT and can then be changed using tp_call_content_media_description_set_rtcp_feedback_minimum_interval().

Implement TP_IFACE_CALL_CONTENT_MEDIA_DESCRIPTION_INTERFACE_RTCP_FEEDBACK interface.

Since 0.17.6

tp_call_content_media_description_set_rtcp_feedback_minimum_interval ()

void                tp_call_content_media_description_set_rtcp_feedback_minimum_interval
                                                        (TpCallContentMediaDescription *self,
                                                         guint codec_identifier,
                                                         guint rtcp_minimum_interval);

Set the minimum interval for a given codec. This ensures codec_identifier is in the "feedback-messages" map. The messages can then be added using tp_call_content_media_description_add_rtcp_feedback_message().

Implement TP_IFACE_CALL_CONTENT_MEDIA_DESCRIPTION_INTERFACE_RTCP_FEEDBACK interface.

Since 0.17.6

tp_call_content_media_description_set_does_avpf ()

void                tp_call_content_media_description_set_does_avpf
                                                        (TpCallContentMediaDescription *self,
                                                         gboolean does_avpf);

Implement properties for TP_IFACE_CALL_CONTENT_MEDIA_DESCRIPTION_INTERFACE_RTCP_FEEDBACK interface

Since 0.17.6

tp_call_content_media_description_set_rtcp_extended_reports ()

void                tp_call_content_media_description_set_rtcp_extended_reports
                                                        (TpCallContentMediaDescription *self,
                                                         guint loss_rle_max_size,
                                                         guint duplicate_rle_max_size,
                                                         guint packet_receipt_times_max_size,
                                                         guint dlrr_max_size,
                                                         TpRCPTXRRTTMode rtt_mode,
                                                         TpRTCPXRStatisticsFlags statistics_flags,
                                                         gboolean enable_metrics);

Implement TP_IFACE_CALL_CONTENT_MEDIA_DESCRIPTION_INTERFACE_RTCP_EXTENDED_REPORTS interface.

Since 0.17.6

tp_call_content_media_description_add_rtcp_extended_reports_interface ()

void                tp_call_content_media_description_add_rtcp_extended_reports_interface
                                                        (TpCallContentMediaDescription *self);

Adds the RTCPExtendedReports interface to the list of supported interfaces

Since 0.17.6

tp_call_content_media_description_add_rtcp_feedback_interface ()

void                tp_call_content_media_description_add_rtcp_feedback_interface
                                                        (TpCallContentMediaDescription *self);

Adds the RTCPFeedback interface to the list of supported interfaces

Since 0.17.6

tp_call_content_media_description_add_rtp_header_extensions_interface ()

void                tp_call_content_media_description_add_rtp_header_extensions_interface
                                                        (TpCallContentMediaDescription *self);

Adds the RTPHeaderExtensions interface to the list of supported interfaces

Since 0.17.6

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 "dlrr-max-size" property

  "dlrr-max-size"            guint                 : Read

If non-zero, enable Receiver Reference Time and Delay since Last Receiver Report Blocks (for estimating Round Trip Times between non-senders and other parties in the call. The value of this integer represents the max-size of report blocks, as specified in RFC 3611 section 5.1. MAXUINT32 is used to indicate that there is no limit.

Default value: 0

Since 0.17.6

The "does-avpf" property

  "does-avpf"                gboolean              : Read

TRUE if the remote contact supports Audio-Visual Profile Feedback (AVPF), otherwise FALSE.

Default value: FALSE

Since 0.17.6

The "duplicate-rle-max-size" property

  "duplicate-rle-max-size"   guint                 : Read

If non-zero, enable Duplicate Run-Length-Encoded Report Blocks. The value of this integer represents the max-size of report blocks, as specified in RFC 3611 section 5.1. MAXUINT32 is used to indicate that there is no limit.

Default value: 0

Since 0.17.6

The "enable-metrics" property

  "enable-metrics"           gboolean              : Read

Whether to enable VoIP Metrics Report Blocks. These blocks are of a fixed size.

Default value: FALSE

Since 0.17.6

The "feedback-messages" property

  "feedback-messages"        GHashTable_guint+GValueArray_guint+GPtrArray_GValueArray_gchararray+gchararray+gchararray____*  : Read

A map of remote feedback codec properties that are supported.

Since 0.17.6

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 "header-extensions" property

  "header-extensions"        GPtrArray_GValueArray_guint+guint+gchararray+gchararray__*  : Read

A list of remote header extensions which are supported.

Since 0.17.6

The "interfaces" property

  "interfaces"               GStrv                 : Read

Additional interfaces implemented by this object.

Since 0.17.5

The "loss-rle-max-size" property

  "loss-rle-max-size"        guint                 : Read

If non-zero, enable Loss Run Length Encoded Report Blocks. The value of this integer represents the max-size of report blocks, as specified in RFC 3611 section 5.1. MAXUINT32 is used to indicate that there is no limit.

Default value: 0

Since 0.17.6

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 "packet-receipt-times-max-size" property

  "packet-receipt-times-max-size" guint                 : Read

If non-zero, enable Packet Receipt Times Report Blocks. The value of this integer represents the max-size of report blocks, as specified in RFC 3611 section 5.1. MAXUINT32 is used to indicate that there is no limit.

Default value: 0

Since 0.17.6

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 "rtt-mode" property

  "rtt-mode"                 guint                 : Read

Who is allowed to send Delay since Last Receiver Reports. Value from TpRCPTXRRTTMode.

Default value: 0

Since 0.17.6

The "ssrcs" property

  "ssrcs"                    GHashTable_guint+GArray_guint__*  : Read

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

Since 0.17.5

The "statistics-flags" property

  "statistics-flags"         guint                 : Read

Which fields SHOULD be included in the statistics summary report blocks that are sent, and whether to send VoIP Metrics Report Blocks. There can be zero or more flags set. Value from TpRTCPXRStatisticsFlags.

Default value: 0

Since 0.17.6