media.h File Reference

Media API. More...

#include <glib.h>
#include <glib-object.h>
#include "signals.h"
#include "util.h"

Include dependency graph for media.h:

This graph shows which files directly or indirectly include this file:


Defines
#define	PURPLE_TYPE_MEDIA_CANDIDATE (purple_media_candidate_get_type())
#define	PURPLE_MEDIA_CANDIDATE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_CANDIDATE, PurpleMediaCandidate))
#define	PURPLE_MEDIA_CANDIDATE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_CANDIDATE, PurpleMediaCandidate))
#define	PURPLE_IS_MEDIA_CANDIDATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_CANDIDATE))
#define	PURPLE_IS_MEDIA_CANDIDATE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_CANDIDATE))
#define	PURPLE_MEDIA_CANDIDATE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_CANDIDATE, PurpleMediaCandidate))
#define	PURPLE_TYPE_MEDIA_CODEC (purple_media_codec_get_type())
#define	PURPLE_MEDIA_CODEC(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_CODEC, PurpleMediaCodec))
#define	PURPLE_MEDIA_CODEC_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_CODEC, PurpleMediaCodec))
#define	PURPLE_IS_MEDIA_CODEC(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_CODEC))
#define	PURPLE_IS_MEDIA_CODEC_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_CODEC))
#define	PURPLE_MEDIA_CODEC_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_CODEC, PurpleMediaCodec))
#define	PURPLE_TYPE_MEDIA_SESSION_TYPE (purple_media_session_type_get_type())
#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))
#define	PURPLE_TYPE_MEDIA_CANDIDATE_TYPE (purple_media_candidate_type_get_type())
#define	PURPLE_TYPE_MEDIA_NETWORK_PROTOCOL (purple_media_network_protocol_get_type())
#define	PURPLE_MEDIA_TYPE_STATE (purple_media_state_changed_get_type())
#define	PURPLE_MEDIA_TYPE_INFO_TYPE (purple_media_info_type_get_type())
Typedefs
typedef struct _PurpleMedia	PurpleMedia
	An opaque structure representing a media call.
typedef struct _PurpleMediaCandidate	PurpleMediaCandidate
	An opaque structure representing a network candidate (IP Address and port pair).
typedef struct _PurpleMediaCodec	PurpleMediaCodec
	An opaque structure representing an audio or video codec.
Enumerations
enum	PurpleMediaCaps { PURPLE_MEDIA_CAPS_NONE = 0, PURPLE_MEDIA_CAPS_AUDIO = 1, PURPLE_MEDIA_CAPS_AUDIO_SINGLE_DIRECTION = 1 << 1, PURPLE_MEDIA_CAPS_VIDEO = 1 << 2, PURPLE_MEDIA_CAPS_VIDEO_SINGLE_DIRECTION = 1 << 3, PURPLE_MEDIA_CAPS_AUDIO_VIDEO = 1 << 4, PURPLE_MEDIA_CAPS_MODIFY_SESSION = 1 << 5, PURPLE_MEDIA_CAPS_CHANGE_DIRECTION = 1 << 6 }
	Media caps.
enum	PurpleMediaSessionType { PURPLE_MEDIA_NONE = 0, PURPLE_MEDIA_RECV_AUDIO = 1 << 0, PURPLE_MEDIA_SEND_AUDIO = 1 << 1, PURPLE_MEDIA_RECV_VIDEO = 1 << 2, PURPLE_MEDIA_SEND_VIDEO = 1 << 3, PURPLE_MEDIA_AUDIO = PURPLE_MEDIA_RECV_AUDIO \| PURPLE_MEDIA_SEND_AUDIO, PURPLE_MEDIA_VIDEO = PURPLE_MEDIA_RECV_VIDEO \| PURPLE_MEDIA_SEND_VIDEO }
	Media session types.
enum	PurpleMediaState { PURPLE_MEDIA_STATE_NEW = 0, PURPLE_MEDIA_STATE_CONNECTED, PURPLE_MEDIA_STATE_END }
	Media state-changed types.
enum	PurpleMediaInfoType { PURPLE_MEDIA_INFO_HANGUP = 0, PURPLE_MEDIA_INFO_ACCEPT, PURPLE_MEDIA_INFO_REJECT, PURPLE_MEDIA_INFO_MUTE, PURPLE_MEDIA_INFO_UNMUTE, PURPLE_MEDIA_INFO_PAUSE, PURPLE_MEDIA_INFO_UNPAUSE, PURPLE_MEDIA_INFO_HOLD, PURPLE_MEDIA_INFO_UNHOLD }
	Media info types.
enum	PurpleMediaCandidateType { PURPLE_MEDIA_CANDIDATE_TYPE_HOST, PURPLE_MEDIA_CANDIDATE_TYPE_SRFLX, PURPLE_MEDIA_CANDIDATE_TYPE_PRFLX, PURPLE_MEDIA_CANDIDATE_TYPE_RELAY, PURPLE_MEDIA_CANDIDATE_TYPE_MULTICAST }
enum	PurpleMediaComponentType { PURPLE_MEDIA_COMPONENT_NONE = 0, PURPLE_MEDIA_COMPONENT_RTP = 1, PURPLE_MEDIA_COMPONENT_RTCP = 2 }
enum	PurpleMediaNetworkProtocol { PURPLE_MEDIA_NETWORK_PROTOCOL_UDP, PURPLE_MEDIA_NETWORK_PROTOCOL_TCP }
Functions
GType	purple_media_session_type_get_type (void)
	Gets the media session type's GType.
GType	purple_media_candidate_type_get_type (void)
	Gets the media candidate type's GType.
GType	purple_media_network_protocol_get_type (void)
	Gets the media network protocol's GType.
GType	purple_media_get_type (void)
	Gets the media class's GType.
GType	purple_media_state_changed_get_type (void)
	Gets the type of the state-changed enum.
GType	purple_media_info_type_get_type (void)
	Gets the type of the info type enum.
GType	purple_media_candidate_get_type (void)
	Gets the type of the media candidate structure.
PurpleMediaCandidate *	purple_media_candidate_new (const gchar foundation, guint component_id, PurpleMediaCandidateType type, PurpleMediaNetworkProtocol proto, const gchar ip, guint port)
	Creates a PurpleMediaCandidate instance.
GList *	purple_media_candidate_list_copy (GList *candidates)
	Copies a GList of PurpleMediaCandidate and its contents.
void	purple_media_candidate_list_free (GList *candidates)
	Frees a GList of PurpleMediaCandidate and its contents.
gchar *	purple_media_candidate_get_foundation (PurpleMediaCandidate *candidate)
guint	purple_media_candidate_get_component_id (PurpleMediaCandidate *candidate)
gchar *	purple_media_candidate_get_ip (PurpleMediaCandidate *candidate)
guint16	purple_media_candidate_get_port (PurpleMediaCandidate *candidate)
gchar *	purple_media_candidate_get_base_ip (PurpleMediaCandidate *candidate)
guint16	purple_media_candidate_get_base_port (PurpleMediaCandidate *candidate)
PurpleMediaNetworkProtocol	purple_media_candidate_get_protocol (PurpleMediaCandidate *candidate)
guint32	purple_media_candidate_get_priority (PurpleMediaCandidate *candidate)
PurpleMediaCandidateType	purple_media_candidate_get_candidate_type (PurpleMediaCandidate *candidate)
gchar *	purple_media_candidate_get_username (PurpleMediaCandidate *candidate)
gchar *	purple_media_candidate_get_password (PurpleMediaCandidate *candidate)
guint	purple_media_candidate_get_ttl (PurpleMediaCandidate *candidate)
GType	purple_media_codec_get_type (void)
	Gets the type of the media codec structure.
PurpleMediaCodec *	purple_media_codec_new (int id, const char *encoding_name, PurpleMediaSessionType media_type, guint clock_rate)
	Creates a new PurpleMediaCodec instance.
guint	purple_media_codec_get_id (PurpleMediaCodec *codec)
gchar *	purple_media_codec_get_encoding_name (PurpleMediaCodec *codec)
guint	purple_media_codec_get_clock_rate (PurpleMediaCodec *codec)
guint	purple_media_codec_get_channels (PurpleMediaCodec *codec)
GList *	purple_media_codec_get_optional_parameters (PurpleMediaCodec *codec)
gchar *	purple_media_codec_to_string (const PurpleMediaCodec *codec)
	Creates a string representation of the codec.
void	purple_media_codec_add_optional_parameter (PurpleMediaCodec codec, const gchar name, const gchar *value)
	Adds an optional parameter to the codec.
void	purple_media_codec_remove_optional_parameter (PurpleMediaCodec codec, PurpleKeyValuePair param)
	Removes an optional parameter from the codec.
PurpleKeyValuePair *	purple_media_codec_get_optional_parameter (PurpleMediaCodec codec, const gchar name, const gchar *value)
	Gets an optional parameter based on the values given.
GList *	purple_media_codec_list_copy (GList *codecs)
	Copies a GList of PurpleMediaCodec and its contents.
void	purple_media_codec_list_free (GList *codecs)
	Frees a GList of PurpleMediaCodec and its contents.
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.
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.
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.
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_codecs_ready (PurpleMedia media, const gchar sess_id)
	Gets whether a session's codecs are ready to be used.
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.

Detailed Description

Media API.

Definition in file media.h.

Typedef Documentation

typedef struct _PurpleMedia PurpleMedia

An opaque structure representing a media call.

Definition at line 63 of file media.h.

typedef struct _PurpleMediaCandidate PurpleMediaCandidate

An opaque structure representing a network candidate (IP Address and port pair).

Definition at line 65 of file media.h.

typedef struct _PurpleMediaCodec PurpleMediaCodec

An opaque structure representing an audio or video codec.

Definition at line 67 of file media.h.

Function Documentation

gboolean purple_media_accepted	(	PurpleMedia *	media,
		const gchar *	sess_id,
		const gchar *	participant
	)

Gets whether a streams selected have been accepted.

Parameters:

	media	The media object to find the session in.
	sess_id	The session id of the session to check.
	participant	The participant to check.

Returns:: TRUE The selected streams have been accepted, or FALSE otherwise.

Since:: 2.6.0

void purple_media_add_remote_candidates	(	PurpleMedia *	media,
		const gchar *	sess_id,
		const gchar *	participant,
		GList *	remote_candidates
	)

Adds remote candidates to the stream.

Parameters:

	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.

Since:: 2.6.0

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.

Parameters:

	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.

Returns:: TRUE The stream was added successfully, FALSE otherwise.

Since:: 2.6.0

GType purple_media_candidate_get_type ( void )

Gets the type of the media candidate structure.

Returns:: The media canditate's GType

Since:: 2.6.0

GList* purple_media_candidate_list_copy ( GList * candidates )

Copies a GList of PurpleMediaCandidate and its contents.

Parameters:

candidates

The list of candidates to be copied.

Returns:: The copy of the GList.

Since:: 2.6.0

void purple_media_candidate_list_free ( GList * candidates )

Frees a GList of PurpleMediaCandidate and its contents.

Parameters:

candidates

The list of candidates to be freed.

Since:: 2.6.0

PurpleMediaCandidate* purple_media_candidate_new	(	const gchar *	foundation,
		guint	component_id,
		PurpleMediaCandidateType	type,
		PurpleMediaNetworkProtocol	proto,
		const gchar *	ip,
		guint	port
	)

Creates a PurpleMediaCandidate instance.

Parameters:

	foundation	The foundation of the candidate.
	component_id	The component this candidate is for.
	type	The type of candidate.
	proto	The protocol this component is for.
	ip	The IP address of this component.
	port	The network port.

Returns:: The newly created PurpleMediaCandidate instance.

Since:: 2.6.0

GType purple_media_candidate_type_get_type ( void )

Gets the media candidate type's GType.

Returns:: The media candidate type's GType.

Since:: 2.6.0

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.

Parameters:

	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.

Returns:: TRUE All streams for the given session_id/participant combination have candidates prepared, FALSE otherwise.

Since:: 2.6.0

void purple_media_codec_add_optional_parameter	(	PurpleMediaCodec *	codec,
		const gchar *	name,
		const gchar *	value
	)

Adds an optional parameter to the codec.

Parameters:

	codec	The codec to add the parameter to.
	name	The name of the parameter to add.
	value	The value of the parameter to add.

Since:: 2.6.0

PurpleKeyValuePair* purple_media_codec_get_optional_parameter	(	PurpleMediaCodec *	codec,
		const gchar *	name,
		const gchar *	value
	)

Gets an optional parameter based on the values given.

Parameters:

	codec	The codec to find the parameter in.
	name	The name of the parameter to search for.
	value	The value to search for or NULL.

Returns:: The value found or NULL.

Since:: 2.6.0

GType purple_media_codec_get_type ( void )

Gets the type of the media codec structure.

Returns:: The media codec's GType

Since:: 2.6.0

GList* purple_media_codec_list_copy ( GList * codecs )

Copies a GList of PurpleMediaCodec and its contents.

Parameters:

codecs

The list of codecs to be copied.

Returns:: The copy of the GList.

Since:: 2.6.0

void purple_media_codec_list_free ( GList * codecs )

Frees a GList of PurpleMediaCodec and its contents.

Parameters:

codecs

The list of codecs to be freed.

Since:: 2.6.0

PurpleMediaCodec* purple_media_codec_new	(	int	id,
		const char *	encoding_name,
		PurpleMediaSessionType	media_type,
		guint	clock_rate
	)

Creates a new PurpleMediaCodec instance.

Parameters:

	id	Codec identifier.
	encoding_name	Name of the media type this encodes.
	media_type	PurpleMediaSessionType of this codec.
	clock_rate	The clock rate this codec encodes at, if applicable.

Returns:: The newly created PurpleMediaCodec.

Since:: 2.6.0

void purple_media_codec_remove_optional_parameter	(	PurpleMediaCodec *	codec,
		PurpleKeyValuePair *	param
	)

Removes an optional parameter from the codec.

Parameters:

	codec	The codec to remove the parameter from.
	param	A pointer to the parameter to remove.

Since:: 2.6.0

gchar* purple_media_codec_to_string ( const PurpleMediaCodec * codec )

Creates a string representation of the codec.

Parameters:

codec

The codec to create the string of.

Returns:: The new string representation.

Since:: 2.6.0

gboolean purple_media_codecs_ready	(	PurpleMedia *	media,
		const gchar *	sess_id
	)

Gets whether a session's codecs are ready to be used.

Parameters:

	media	The media object to find the session in.
	sess_id	The session id of the session to check.

Returns:: TRUE The codecs are ready, or FALSE otherwise.

Since:: 2.6.0

void purple_media_end	(	PurpleMedia *	media,
		const gchar *	session_id,
		const gchar *	participant
	)

Ends all streams that match the given parameters.

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.

Since:: 2.6.0

void purple_media_error	(	PurpleMedia *	media,
		const gchar *	error,
			...
	)

Signals an error in the media session.

Parameters:

	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.

Since:: 2.6.0

PurpleAccount* purple_media_get_account ( PurpleMedia * media )

Gets the PurpleAccount this media session is on.

Parameters:

media

The media session to retrieve the account from.

Returns:: The account retrieved.

Since:: 2.6.0

GList* purple_media_get_codecs	(	PurpleMedia *	media,
		const gchar *	sess_id
	)

Gets the codecs from a session.

Parameters:

	media	The media object to find the session in.
	sess_id	The session id of the session to get the codecs from.

Returns:: The retreieved codecs.

Since:: 2.6.0

GList* purple_media_get_local_candidates	(	PurpleMedia *	media,
		const gchar *	sess_id,
		const gchar *	participant
	)

Gets the local candidates from a stream.

Parameters:

	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.

Since:: 2.6.0

struct _PurpleMediaManager* purple_media_get_manager ( PurpleMedia * media ) [read]

Gets the PurpleMediaManager this media session is a part of.

Parameters:

media

The media object to get the manager instance from.

Returns:: The PurpleMediaManager instance retrieved.

Since:: 2.6.0

gpointer purple_media_get_prpl_data ( PurpleMedia * media )

Gets the prpl data from the media session.

Parameters:

media

The media session to retrieve the prpl data from.

Returns:: The prpl data retrieved.

Since:: 2.6.0

GList* purple_media_get_session_ids ( PurpleMedia * media )

Gets a list of session IDs.

Parameters:

media

The media session from which to retrieve session IDs.

Returns:: GList of session IDs. The caller must free the list.

Since:: 2.6.0

PurpleMediaSessionType purple_media_get_session_type	(	PurpleMedia *	media,
		const gchar *	sess_id
	)

Gets the session type from a session.

Parameters:

	media	The media object to find the session in.
	sess_id	The session id of the session to get the type from.

Returns:: The retreived session type.

Since:: 2.6.0

GType purple_media_get_type ( void )

Gets the media class's GType.

Returns:: The media class's GType.

Since:: 2.6.0

GType purple_media_info_type_get_type ( void )

Gets the type of the info type enum.

Returns:: The info type enum's GType

Since:: 2.6.0

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.

Parameters:

	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.

Returns:: TRUE if the local user is the stream's initator, else FALSE.

Since:: 2.6.0

GType purple_media_network_protocol_get_type ( void )

Gets the media network protocol's GType.

Returns:: The media network protocol's GType.

Since:: 2.6.0

void purple_media_remove_output_windows ( PurpleMedia * media )

Removes all output windows from a given media session.

Parameters:

media

The instance to remove all output windows from.

Since:: 2.6.0

GType purple_media_session_type_get_type ( void )

Gets the media session type's GType.

Returns:: The media session type's GType.

Since:: 2.6.0

void purple_media_set_input_volume	(	PurpleMedia *	media,
		const gchar *	session_id,
		double	level
	)

Sets the input volume of all the selected sessions.

Parameters:

	media	The media object the sessions are in.
	session_id	The session to select (if any).
	level	The level to set the volume to.

Since:: 2.6.0

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.

Parameters:

	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.

Since:: 2.6.0

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.

Parameters:

	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.

Returns:: An id to reference the output window.

Since:: 2.6.0

void purple_media_set_prpl_data	(	PurpleMedia *	media,
		gpointer	prpl_data
	)

Sets the prpl data on the media session.

Parameters:

	media	The media session to set the prpl data on.
	prpl_data	The data to set on the media session.

Since:: 2.6.0

gboolean purple_media_set_remote_codecs	(	PurpleMedia *	media,
		const gchar *	sess_id,
		const gchar *	participant,
		GList *	codecs
	)

Sets remote candidates from the stream.

Parameters:

	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.

Returns:: TRUE The codecs were set successfully, or FALSE otherwise.

Since:: 2.6.0

gboolean purple_media_set_send_codec	(	PurpleMedia *	media,
		const gchar *	sess_id,
		PurpleMediaCodec *	codec
	)

Sets the send codec for the a session.

Parameters:

	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.

Returns:: TRUE The codec was successfully changed, or FALSE otherwise.

Since:: 2.6.0

GType purple_media_state_changed_get_type ( void )

Gets the type of the state-changed enum.

Returns:: The state-changed enum's GType

Since:: 2.6.0

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.

Parameters:

	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.

Since:: 2.6.0

Context Navigation

media.h File Reference

Defines

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Function Documentation