FsConference

FsConference — Interface for farsight conference elements

Synopsis


#include <gst/farsight/fs-conference-iface.h>

                    FsConference;
FsSession*          fs_conference_new_session           (FsConference *conference,
                                                         FsMediaType media_type,
                                                         GError **error);
FsParticipant*      fs_conference_new_participant       (FsConference *conference,
                                                         const gchar *cname,
                                                         GError **error);
#define             FS_ERROR
enum                FsError;
#define             FS_ERROR_IS_FATAL                   (error)

Object Hierarchy

  GInterface
   +----FsConference

Prerequisites

FsConference requires GstImplementsInterface, GstObject and GstElement.

Known Implementations

FsConference is implemented by FsBaseConference.

Description

This interface is implemented by the FsBaseConference base class element. A Farsight conference is a conversation space that takes place between 2 or more participants. Each conference must have one or more Farsight sessions that are associated to the conference participants. Different protocols simply need to derive from the FsBaseConference class and don't need to implement this interface directly.

This will communicate asynchronous events to the user through GstMessage of type GST_MESSAGE_ELEMENT sent over the GstBus.

The "farsight-error" message

"src-object"       GObject           The object (FsConference, FsSession or FsStream) that emitted the error
"error-no"         FsError           The Error number
"error-msg"        gchar*            The error message
"debug-msg"        gchar*            The debug string

The message is sent on asynchronous errors.

Details

FsConference

typedef struct _FsConference FsConference;

Opaque FsConference data structure.

fs_conference_new_session ()

FsSession*          fs_conference_new_session           (FsConference *conference,
                                                         FsMediaType media_type,
                                                         GError **error);

Create a new Farsight session for the given conference.

conference : FsConference interface of a GstElement
media_type : FsMediaType of the new session
error : location of a GError, or NULL if no error occured
Returns : the new FsSession that has been created. The FsSession must be unref'd by the user when closing the session.

fs_conference_new_participant ()

FsParticipant*      fs_conference_new_participant       (FsConference *conference,
                                                         const gchar *cname,
                                                         GError **error);

Create a new Farsight Participant for the type of the given conference.

conference : FsConference interface of a GstElement
cname : The cname of the participant
error : location of a GError, or NULL if no error occured
Returns : the new FsParticipant that has been created. The FsParticipant is owned by the user and he must unref it when he is done with it.

FS_ERROR

#define FS_ERROR (fs_error_quark ())

This quark is used to denote errors coming from Farsight objects

enum FsError

typedef enum {
  FS_ERROR_CONSTRUCTION = 1,
  FS_ERROR_INTERNAL,
  FS_ERROR_INVALID_ARGUMENTS = 100,
  FS_ERROR_NETWORK,
  FS_ERROR_NOT_IMPLEMENTED,
  FS_ERROR_NEGOTIATION_FAILED,
  FS_ERROR_UNKNOWN_CODEC,
  FS_ERROR_UNKNOWN_CNAME,
  FS_ERROR_NO_CODECS,
  FS_ERROR_NO_CODECS_LEFT,
  FS_ERROR_CONNECTION_FAILED,
  FS_ERROR_DISPOSED,
} FsError;

This is the enum of error numbers that will come either on the "error" signal, from the Gst Bus or for error in the FS_ERROR domain in GErrors

FS_ERROR_CONSTRUCTION Error constructing some of the sub-elements, this probably denotes an error in the installation of the gstreamer elements. It is a fatal error.
FS_ERROR_INTERNAL An internal error happened in Farsight, it may be in an inconsistent state. The object from which this error comes should be discarded.
FS_ERROR_INVALID_ARGUMENTS Invalid arguments to the function, this is a programming error and should not be reported to the user
FS_ERROR_NETWORK A network related error, this should probably be reported to the user.
FS_ERROR_NOT_IMPLEMENTED The optional functionality is not implemented by this plugin.
FS_ERROR_NEGOTIATION_FAILED The codec negotiation has failed, this means that there are no common codecs between the local and remote codecs.
FS_ERROR_UNKNOWN_CODEC Data is received on an unknown codec, this most likely denotes an error on the remote side, the buffers will be ignored. It can safely be ignored in most cases (but may result in a call with no media received).
FS_ERROR_UNKNOWN_CNAME Data was received for an unknown cname.
FS_ERROR_NO_CODECS There are no codecs detected for that media type.
FS_ERROR_NO_CODECS_LEFT All of the codecs have been disabled by the codec preferences, one should try less strict codec preferences.
FS_ERROR_CONNECTION_FAILED Could not connect to the to remote party.
FS_ERROR_DISPOSED The object has been disposed.

FS_ERROR_IS_FATAL()

#define             FS_ERROR_IS_FATAL(error)

Tells the programmer if an error if fatal or not, if it returns TRUE, the error is fatal, and the object that created it should be discarded. It returns FALSE otherwise.

error : a FsError
Generated by GTK-Doc V1.10