telepathy-farstream Reference Manual: TfContent

TfContent

TfContent — Represent the Content of a channel handled by TfChannel

Functions

GstIterator *	tf_content_iterate_src_pads ()
void	tf_content_error ()
void	tf_content_error_literal ()
void	tf_content_receiving_failed ()
void	tf_content_receiving_failed_literal ()
void	tf_content_sending_failed ()
void	tf_content_sending_failed_literal ()

Types and Values

	TfContent
	TfContentClass

Object Hierarchy

Description

Objects of this class allow the user to handle the media side of a Telepathy channel handled by TfChannel.

This object is created by the TfChannel and the user is notified of its creation by the “content-added” signal. In the callback for this signal, the user should connect to the “src-pad-added” signal.

Functions

tf_content_iterate_src_pads ()

GstIterator *
tf_content_iterate_src_pads (TfContent *content,
                             guint *handles,
                             guint handle_count);

Provides a iterator that can be used to iterate through all of the src pads that are are used to receive from a group of Telepathy handles.

Parameters

content	a TfContent
handles	a 0 terminated array of guint representing Telepathy handles
handle_count	the numner of handles in `handles`

Returns

a GstIterator

tf_content_error ()

void
tf_content_error (TfContent *content,
                  const gchar *message_format,
                  ...);

Send a fatal streaming error to the Content to the CM, the effect is most likely that the content will be removed.

Parameters

content	a TfContent
message_format	error Message with printf style formatting
...	Parameters to insert into the `message_format` string

tf_content_error_literal ()

void
tf_content_error_literal (TfContent *content,
                          const gchar *message);

Send a fatal streaming error to the Content to the CM, the effect is most likely that the content will be removed.

Rename to: tf_content_error

Parameters

content	a TfContent
message	error Message

tf_content_receiving_failed ()

void
tf_content_receiving_failed (TfContent *content,
                             guint *handles,
                             guint handle_count,
                             const gchar *message_format,
                             ...);

Informs the Connection Manager that receiving has failed for this content. This is a transient error and it may or not not end the Content and the call.

If handles are not specific, it assumes that it is valid for all handles.

Parameters

content	a TfContent
handles	an array of guint representing Telepathy handles, may be `NULL`
handle_count	the numner of handles in `handles`
message_format	Message with printf style formatting
...	Parameters to insert into the `message_format` string

tf_content_receiving_failed_literal ()

void
tf_content_receiving_failed_literal (TfContent *content,
                                     guint *handles,
                                     guint handle_count,
                                     const gchar *message);

Informs the Connection Manager that receiving has failed for this content. This is a transient error and it may or not not end the Content and the call.

If handles are not specific, it assumes that it is valid for all handles.

Rename to: tf_content_receiving_failed

Parameters

content	a TfContent
handles	an array of guint representing Telepathy handles, may be `NULL`
handle_count	the numner of handles in `handles`
message	The error message

tf_content_sending_failed ()

void
tf_content_sending_failed (TfContent *content,
                           const gchar *message_format,
                           ...);

Informs the Connection Manager that sending has failed for this content. This is a transient error and it may or not not end the Content and the call.

Parameters

content	a TfContent
message_format	Message with printf style formatting
...	Parameters to insert into the `message_format` string

tf_content_sending_failed_literal ()

void
tf_content_sending_failed_literal (TfContent *content,
                                   const gchar *message);

Informs the Connection Manager that sending has failed for this content. This is a transient error and it may or not not end the Content and the call.

Rename to: tf_content_sending_failed

Parameters

content	a TfContent
message	The error message

Types and Values

TfContent

typedef struct _TfContent TfContent;

This structure is private, this class is not subclassable.

TfContentClass

typedef struct _TfContentClass TfContentClass;

This structure is private, this class is not subclassable.