![]() |
![]() |
![]() |
Farsight2 Reference Manual | ![]() |
---|---|---|---|---|
#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)
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.
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.
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. |
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. |
#define FS_ERROR (fs_error_quark ())
This quark is used to denote errors coming from Farsight objects
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, FS_ERROR_ALREADY_EXISTS } 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
#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 |