|
pidgin 2.14.4
|
Media API. More...
#include "media/candidate.h"#include "media/codec.h"#include "media/enum-types.h"#include "glibcompat.h"#include <glib.h>#include <glib-object.h>#include "signals.h"#include "util.h"Go to the source code of this file.
Macros | |
| #define | PURPLE_TYPE_MEDIA (purple_media_get_type()) |
| #define | PURPLE_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA, PurpleMedia)) |
| #define | PURPLE_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA, PurpleMediaClass)) |
| #define | PURPLE_IS_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA)) |
| #define | PURPLE_IS_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA)) |
| #define | PURPLE_MEDIA_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA, PurpleMediaClass)) |
Typedefs | |
| typedef struct _PurpleMedia | PurpleMedia |
| An opaque structure representing a media call. | |
Functions | |
| GType | purple_media_get_type (void) |
| Gets the media class's GType. | |
| GList * | purple_media_get_session_ids (PurpleMedia *media) |
| Gets a list of session IDs. | |
| PurpleAccount * | purple_media_get_account (PurpleMedia *media) |
| Gets the PurpleAccount this media session is on. | |
| gpointer | purple_media_get_prpl_data (PurpleMedia *media) |
| Gets the prpl data from the media session. | |
| void | purple_media_set_prpl_data (PurpleMedia *media, gpointer prpl_data) |
| Sets the prpl data on the media session. | |
| void | purple_media_error (PurpleMedia *media, const gchar *error,...) |
| Signals an error in the media session. | |
| void | purple_media_end (PurpleMedia *media, const gchar *session_id, const gchar *participant) |
| Ends all streams that match the given parameters. | |
| void | purple_media_stream_info (PurpleMedia *media, PurpleMediaInfoType type, const gchar *session_id, const gchar *participant, gboolean local) |
| Signals different information about the given stream. | |
| G_GNUC_BEGIN_IGNORE_DEPRECATIONS void | purple_media_set_params (PurpleMedia *media, guint num_params, GParameter *params) |
| Sets various optional parameters of the media call. | |
| G_GNUC_END_IGNORE_DEPRECATIONS const gchar ** | purple_media_get_available_params (PurpleMedia *media) |
| Gets the list of optional parameters supported by the media backend. | |
| gboolean | purple_media_param_is_supported (PurpleMedia *media, const gchar *param) |
| Checks if given optional parameter is supported by the media backend. | |
| G_GNUC_BEGIN_IGNORE_DEPRECATIONS gboolean | purple_media_add_stream (PurpleMedia *media, const gchar *sess_id, const gchar *who, PurpleMediaSessionType type, gboolean initiator, const gchar *transmitter, guint num_params, GParameter *params) |
| Adds a stream to a session. | |
| G_GNUC_END_IGNORE_DEPRECATIONS PurpleMediaSessionType | purple_media_get_session_type (PurpleMedia *media, const gchar *sess_id) |
| Gets the session type from a session. | |
| struct _PurpleMediaManager * | purple_media_get_manager (PurpleMedia *media) |
| Gets the PurpleMediaManager this media session is a part of. | |
| GList * | purple_media_get_codecs (PurpleMedia *media, const gchar *sess_id) |
| Gets the codecs from a session. | |
| void | purple_media_add_remote_candidates (PurpleMedia *media, const gchar *sess_id, const gchar *participant, GList *remote_candidates) |
| Adds remote candidates to the stream. | |
| GList * | purple_media_get_local_candidates (PurpleMedia *media, const gchar *sess_id, const gchar *participant) |
| Gets the local candidates from a stream. | |
| GList * | purple_media_get_active_local_candidates (PurpleMedia *media, const gchar *sess_id, const gchar *participant) |
| Gets the active local candidates for the stream. | |
| GList * | purple_media_get_active_remote_candidates (PurpleMedia *media, const gchar *sess_id, const gchar *participant) |
| Gets the active remote candidates for the stream. | |
| gboolean | purple_media_set_remote_codecs (PurpleMedia *media, const gchar *sess_id, const gchar *participant, GList *codecs) |
| Sets remote candidates from the stream. | |
| gboolean | purple_media_candidates_prepared (PurpleMedia *media, const gchar *session_id, const gchar *participant) |
| Returns whether or not the candidates for set of streams are prepared. | |
| gboolean | purple_media_set_send_codec (PurpleMedia *media, const gchar *sess_id, PurpleMediaCodec *codec) |
| Sets the send codec for the a session. | |
| gboolean | purple_media_set_encryption_parameters (PurpleMedia *media, const gchar *sess_id, const gchar *cipher, const gchar *auth, const gchar *key, gsize key_len) |
| Sets the encryption parameters of our media in the session. | |
| gboolean | purple_media_set_decryption_parameters (PurpleMedia *media, const gchar *sess_id, const gchar *participant, const gchar *cipher, const gchar *auth, const gchar *key, gsize key_len) |
| Sets the decryption parameters for a session participant's media. | |
| gboolean | purple_media_set_require_encryption (PurpleMedia *media, const gchar *sess_id, const gchar *participant, gboolean require_encryption) |
| Sets whether a session participant's media requires encryption. | |
| gboolean | purple_media_codecs_ready (PurpleMedia *media, const gchar *sess_id) |
| Gets whether a session's codecs are ready to be used. | |
| gboolean | purple_media_set_send_rtcp_mux (PurpleMedia *media, const gchar *sess_id, const gchar *participant, gboolean send_rtcp_mux) |
| Sets the rtcp-mux option for the stream. | |
| gboolean | purple_media_is_initiator (PurpleMedia *media, const gchar *sess_id, const gchar *participant) |
| Gets whether the local user is the conference/session/stream's initiator. | |
| gboolean | purple_media_accepted (PurpleMedia *media, const gchar *sess_id, const gchar *participant) |
| Gets whether a streams selected have been accepted. | |
| void | purple_media_set_input_volume (PurpleMedia *media, const gchar *session_id, double level) |
| Sets the input volume of all the selected sessions. | |
| void | purple_media_set_output_volume (PurpleMedia *media, const gchar *session_id, const gchar *participant, double level) |
| Sets the output volume of all the selected streams. | |
| gulong | purple_media_set_output_window (PurpleMedia *media, const gchar *session_id, const gchar *participant, gulong window_id) |
| Sets a video output window for the given session/stream. | |
| void | purple_media_remove_output_windows (PurpleMedia *media) |
| Removes all output windows from a given media session. | |
| gboolean | purple_media_send_dtmf (PurpleMedia *media, const gchar *session_id, gchar dtmf, guint8 volume, guint16 duration) |
| Sends a DTMF signal out-of-band. | |
Media API.
Definition in file media.h.
| #define PURPLE_IS_MEDIA | ( | obj | ) | (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA)) |
| #define PURPLE_IS_MEDIA_CLASS | ( | klass | ) | (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA)) |
| #define PURPLE_MEDIA | ( | obj | ) | (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA, PurpleMedia)) |
| #define PURPLE_MEDIA_CLASS | ( | klass | ) | (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA, PurpleMediaClass)) |
| #define PURPLE_MEDIA_GET_CLASS | ( | obj | ) | (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA, PurpleMediaClass)) |
| #define PURPLE_TYPE_MEDIA (purple_media_get_type()) |
| typedef struct _PurpleMedia PurpleMedia |
| gboolean purple_media_accepted | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | participant | ||
| ) |
Gets whether a streams selected have been accepted.
| media | The media object to find the session in. |
| sess_id | The session id of the session to check. |
| participant | The participant to check. |
TRUE The selected streams have been accepted, or FALSE otherwise.| void purple_media_add_remote_candidates | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | participant, | ||
| GList * | remote_candidates | ||
| ) |
Adds remote candidates to the stream.
| media | The media object to find the session in. |
| sess_id | The session id of the session find the stream in. |
| participant | The name of the remote user to add the candidates for. |
| remote_candidates | The remote candidates to add. |
| G_GNUC_BEGIN_IGNORE_DEPRECATIONS gboolean purple_media_add_stream | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | who, | ||
| PurpleMediaSessionType | type, | ||
| gboolean | initiator, | ||
| const gchar * | transmitter, | ||
| guint | num_params, | ||
| GParameter * | params | ||
| ) |
Adds a stream to a session.
It only adds a stream to one audio session or video session as the sess_id must be unique between sessions.
| media | The media object to find the session in. |
| sess_id | The session id of the session to add the stream to. |
| who | The name of the remote user to add the stream for. |
| type | The type of stream to create. |
| initiator | Whether or not the local user initiated the stream. |
| transmitter | The transmitter to use for the stream. |
| num_params | The number of parameters to pass to Farsight. |
| params | The parameters to pass to Farsight. |
TRUE The stream was added successfully, FALSE otherwise.| gboolean purple_media_candidates_prepared | ( | PurpleMedia * | media, |
| const gchar * | session_id, | ||
| const gchar * | participant | ||
| ) |
Returns whether or not the candidates for set of streams are prepared.
| media | The media object to find the remote user in. |
| session_id | The session id of the session to check. |
| participant | The remote user to check for. |
TRUE All streams for the given session_id/participant combination have candidates prepared, FALSE otherwise.| gboolean purple_media_codecs_ready | ( | PurpleMedia * | media, |
| const gchar * | sess_id | ||
| ) |
Gets whether a session's codecs are ready to be used.
| media | The media object to find the session in. |
| sess_id | The session id of the session to check. |
TRUE The codecs are ready, or FALSE otherwise.| void purple_media_end | ( | PurpleMedia * | media, |
| const gchar * | session_id, | ||
| const gchar * | participant | ||
| ) |
Ends all streams that match the given parameters.
| media | The media object with which to end streams. |
| session_id | The session to end streams on. |
| participant | The participant to end streams with. |
| void purple_media_error | ( | PurpleMedia * | media, |
| const gchar * | error, | ||
| ... | |||
| ) |
Signals an error in the media session.
| media | The media object to set the state on. |
| error | The format of the error message to send in the signal. |
| ... | The arguments to plug into the format. |
| PurpleAccount * purple_media_get_account | ( | PurpleMedia * | media | ) |
Gets the PurpleAccount this media session is on.
| media | The media session to retrieve the account from. |
| GList * purple_media_get_active_local_candidates | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | participant | ||
| ) |
Gets the active local candidates for the stream.
| media | The media object to find the session in. |
| sess_id | The session id of the session to find the stream in. |
| participant | The name of the remote user to get the active candidate from. |
| GList * purple_media_get_active_remote_candidates | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | participant | ||
| ) |
Gets the active remote candidates for the stream.
| media | The media object to find the session in. |
| sess_id | The session id of the session to find the stream in. |
| participant | The name of the remote user to get the remote candidate from. |
| G_GNUC_END_IGNORE_DEPRECATIONS const gchar ** purple_media_get_available_params | ( | PurpleMedia * | media | ) |
Gets the list of optional parameters supported by the media backend.
The list is owned by the PurpleMedia internals and should NOT be freed.
| media | The media object |
| GList * purple_media_get_codecs | ( | PurpleMedia * | media, |
| const gchar * | sess_id | ||
| ) |
Gets the codecs from a session.
| media | The media object to find the session in. |
| sess_id | The session id of the session to get the codecs from. |
| GList * purple_media_get_local_candidates | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | participant | ||
| ) |
Gets the local candidates from a stream.
| media | The media object to find the session in. |
| sess_id | The session id of the session to find the stream in. |
| participant | The name of the remote user to get the candidates from. |
| struct _PurpleMediaManager * purple_media_get_manager | ( | PurpleMedia * | media | ) |
Gets the PurpleMediaManager this media session is a part of.
| media | The media object to get the manager instance from. |
| gpointer purple_media_get_prpl_data | ( | PurpleMedia * | media | ) |
Gets the prpl data from the media session.
| media | The media session to retrieve the prpl data from. |
| GList * purple_media_get_session_ids | ( | PurpleMedia * | media | ) |
Gets a list of session IDs.
| media | The media session from which to retrieve session IDs. |
| G_GNUC_END_IGNORE_DEPRECATIONS PurpleMediaSessionType purple_media_get_session_type | ( | PurpleMedia * | media, |
| const gchar * | sess_id | ||
| ) |
Gets the session type from a session.
| media | The media object to find the session in. |
| sess_id | The session id of the session to get the type from. |
| GType purple_media_get_type | ( | void | ) |
Gets the media class's GType.
| gboolean purple_media_is_initiator | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | participant | ||
| ) |
Gets whether the local user is the conference/session/stream's initiator.
| media | The media instance to find the session in. |
| sess_id | The session id of the session to check. |
| participant | The participant of the stream to check. |
| gboolean purple_media_param_is_supported | ( | PurpleMedia * | media, |
| const gchar * | param | ||
| ) |
Checks if given optional parameter is supported by the media backend.
| media | The media object |
| param | name of parameter |
TRUE if backend recognizes the parameter, FALSE otherwise.| void purple_media_remove_output_windows | ( | PurpleMedia * | media | ) |
Removes all output windows from a given media session.
| media | The instance to remove all output windows from. |
| gboolean purple_media_send_dtmf | ( | PurpleMedia * | media, |
| const gchar * | session_id, | ||
| gchar | dtmf, | ||
| guint8 | volume, | ||
| guint16 | duration | ||
| ) |
Sends a DTMF signal out-of-band.
| media | The media instance to send a DTMF signal to. |
| sess_id | The session id of the session to send the DTMF signal on. |
| dtmf | The character representing the DTMF in the range [0-9#*A-D]. |
| volume | The power level expressed in dBm0 after dropping the sign in the range of 0 to 63. A larger value represents a lower volume. |
| duration | The duration of the tone in milliseconds. |
| gboolean purple_media_set_decryption_parameters | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | participant, | ||
| const gchar * | cipher, | ||
| const gchar * | auth, | ||
| const gchar * | key, | ||
| gsize | key_len | ||
| ) |
Sets the decryption parameters for a session participant's media.
| media | The media object to find the session in. |
| sess_id | The session id of the session to set parameters of. |
| participant | The participant of the session to set parameters of. |
| cipher | The cipher to use to decrypt media coming from this session's participant. |
| auth | The algorithm to use for authentication of the media coming from the session's participant. |
| key | The decryption key. |
| key_len | Byte length of the decryption key. |
| gboolean purple_media_set_encryption_parameters | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | cipher, | ||
| const gchar * | auth, | ||
| const gchar * | key, | ||
| gsize | key_len | ||
| ) |
Sets the encryption parameters of our media in the session.
| media | The media object to find the session in. |
| sess_id | The session id of the session to set parameters of. |
| cipher | The cipher to use to encrypt our media in the session. |
| auth | The algorithm to use to compute authentication codes for our media frames. |
| key | The encryption key. |
| key_len | Byte length of the encryption key. |
| void purple_media_set_input_volume | ( | PurpleMedia * | media, |
| const gchar * | session_id, | ||
| double | level | ||
| ) |
Sets the input volume of all the selected sessions.
| media | The media object the sessions are in. |
| session_id | The session to select (if any). |
| level | The level to set the volume to. |
| void purple_media_set_output_volume | ( | PurpleMedia * | media, |
| const gchar * | session_id, | ||
| const gchar * | participant, | ||
| double | level | ||
| ) |
Sets the output volume of all the selected streams.
| media | The media object the streams are in. |
| session_id | The session to limit the streams to (if any). |
| participant | The participant to limit the streams to (if any). |
| level | The level to set the volume to. |
| gulong purple_media_set_output_window | ( | PurpleMedia * | media, |
| const gchar * | session_id, | ||
| const gchar * | participant, | ||
| gulong | window_id | ||
| ) |
Sets a video output window for the given session/stream.
| media | The media instance to set the output window on. |
| session_id | The session to set the output window on. |
| participant | Optionally, the participant to set the output window on. |
| window_id | The window id use for embedding the video in. |
| G_GNUC_BEGIN_IGNORE_DEPRECATIONS void purple_media_set_params | ( | PurpleMedia * | media, |
| guint | num_params, | ||
| GParameter * | params | ||
| ) |
Sets various optional parameters of the media call.
Currently supported are:
| media | The media object to set the parameters on. |
| num_params | The number of parameters to pass |
| params | Array of GParameter to pass |
| void purple_media_set_prpl_data | ( | PurpleMedia * | media, |
| gpointer | prpl_data | ||
| ) |
Sets the prpl data on the media session.
| media | The media session to set the prpl data on. |
| prpl_data | The data to set on the media session. |
| gboolean purple_media_set_remote_codecs | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | participant, | ||
| GList * | codecs | ||
| ) |
Sets remote candidates from the stream.
| media | The media object to find the session in. |
| sess_id | The session id of the session find the stream in. |
| participant | The name of the remote user to set the candidates from. |
| codecs | The list of remote codecs to set. |
TRUE The codecs were set successfully, or FALSE otherwise.| gboolean purple_media_set_require_encryption | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | participant, | ||
| gboolean | require_encryption | ||
| ) |
Sets whether a session participant's media requires encryption.
| media | The media object to find the session in. |
| sess_id | The id of the session to set parameters of. |
| participant | The participant of the session to set parameters of. |
| require_encryption | TRUE if the media requires encryption. |
| gboolean purple_media_set_send_codec | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| PurpleMediaCodec * | codec | ||
| ) |
Sets the send codec for the a session.
| media | The media object to find the session in. |
| sess_id | The session id of the session to set the codec for. |
| codec | The codec to set the session to stream. |
TRUE The codec was successfully changed, or FALSE otherwise.| gboolean purple_media_set_send_rtcp_mux | ( | PurpleMedia * | media, |
| const gchar * | sess_id, | ||
| const gchar * | participant, | ||
| gboolean | send_rtcp_mux | ||
| ) |
Sets the rtcp-mux option for the stream.
| media | The media object to find the session in. |
| sess_id | The session id of the session find the stream in. |
| participant | The name of the remote user to set the rtcp-mux for. @paran send_rtcp_mux Whether to enable the rtcp-mux option |
TRUE RTCP-Mux was set successfully, or FALSE otherwise.| void purple_media_stream_info | ( | PurpleMedia * | media, |
| PurpleMediaInfoType | type, | ||
| const gchar * | session_id, | ||
| const gchar * | participant, | ||
| gboolean | local | ||
| ) |
Signals different information about the given stream.
| media | The media instance to containing the stream to signal. |
| type | The type of info being signaled. |
| session_id | The id of the session of the stream being signaled. |
| participant | The participant of the stream being signaled. |
| local | TRUE if the info originated locally, FALSE if on the remote end. |