comparison libpurple/media.h @ 25720:551a462b346a

Changed PurpleMediaStreamType to PurpleMediaSessionType.
author Mike Ruprecht <maiku@soc.pidgin.im>
date Sat, 09 Aug 2008 03:51:42 +0000
parents b8a73b6dc0a4
children 89d873e217c1
comparison
equal deleted inserted replaced
25719:1aa383ee5fc8 25720:551a462b346a
65 PURPLE_MEDIA_SEND_AUDIO = 1 << 1, 65 PURPLE_MEDIA_SEND_AUDIO = 1 << 1,
66 PURPLE_MEDIA_RECV_VIDEO = 1 << 2, 66 PURPLE_MEDIA_RECV_VIDEO = 1 << 2,
67 PURPLE_MEDIA_SEND_VIDEO = 1 << 3, 67 PURPLE_MEDIA_SEND_VIDEO = 1 << 3,
68 PURPLE_MEDIA_AUDIO = PURPLE_MEDIA_RECV_AUDIO | PURPLE_MEDIA_SEND_AUDIO, 68 PURPLE_MEDIA_AUDIO = PURPLE_MEDIA_RECV_AUDIO | PURPLE_MEDIA_SEND_AUDIO,
69 PURPLE_MEDIA_VIDEO = PURPLE_MEDIA_RECV_VIDEO | PURPLE_MEDIA_SEND_VIDEO 69 PURPLE_MEDIA_VIDEO = PURPLE_MEDIA_RECV_VIDEO | PURPLE_MEDIA_SEND_VIDEO
70 } PurpleMediaStreamType; 70 } PurpleMediaSessionType;
71 71
72 #ifdef USE_VV 72 #ifdef USE_VV
73 73
74 /** The media class */ 74 /** The media class */
75 struct _PurpleMediaClass 75 struct _PurpleMediaClass
99 /** @name Media Utility Functions */ 99 /** @name Media Utility Functions */
100 /**************************************************************************/ 100 /**************************************************************************/
101 /*@{*/ 101 /*@{*/
102 102
103 /** 103 /**
104 * Converts a PurpleMediaStreamType to an FsMediaType. 104 * Converts a PurpleMediaSessionType to an FsMediaType.
105 * 105 *
106 * @param type The type to derive FsMediaType from 106 * @param type The type to derive FsMediaType from
107 * 107 *
108 * @return The FsMediaType derived from type 108 * @return The FsMediaType derived from type
109 */ 109 */
110 FsMediaType purple_media_to_fs_media_type(PurpleMediaStreamType type); 110 FsMediaType purple_media_to_fs_media_type(PurpleMediaSessionType type);
111 111
112 /** 112 /**
113 * Converts a PurpleMediaStreamType to an FsStreamDirection. 113 * Converts a PurpleMediaSessionType to an FsStreamDirection.
114 * 114 *
115 * @param type The type to derive FsMediaType from 115 * @param type The type to derive FsMediaType from
116 * 116 *
117 * @return The FsMediaDirection derived from type 117 * @return The FsMediaDirection derived from type
118 */ 118 */
119 FsStreamDirection purple_media_to_fs_stream_direction(PurpleMediaStreamType type); 119 FsStreamDirection purple_media_to_fs_stream_direction(PurpleMediaSessionType type);
120 120
121 /** 121 /**
122 * Converts an FsMediaType and FsStreamDirection into a PurpleMediaStreamType. 122 * Converts an FsMediaType and FsStreamDirection into a PurpleMediaSessionType.
123 * 123 *
124 * @param type The type used to construct PurpleMediaStreamType 124 * @param type The type used to construct PurpleMediaSessionType
125 * @param direction The direction used to construct PurpleMediaStreamType 125 * @param direction The direction used to construct PurpleMediaSessionType
126 * 126 *
127 * @return The PurpleMediaStreamType constructed 127 * @return The PurpleMediaSessionType constructed
128 */ 128 */
129 PurpleMediaStreamType purple_media_from_fs(FsMediaType type, FsStreamDirection direction); 129 PurpleMediaSessionType purple_media_from_fs(FsMediaType type, FsStreamDirection direction);
130 130
131 /*@}*/ 131 /*@}*/
132 132
133 /** 133 /**
134 * Combines all the separate session types into a single PurpleMediaStreamType. 134 * Combines all the separate session types into a single PurpleMediaSessionType.
135 * 135 *
136 * @param media The media session to retrieve session types from. 136 * @param media The media session to retrieve session types from.
137 * 137 *
138 * @return Combined type. 138 * @return Combined type.
139 */ 139 */
140 PurpleMediaStreamType purple_media_get_overall_type(PurpleMedia *media); 140 PurpleMediaSessionType purple_media_get_overall_type(PurpleMedia *media);
141 141
142 /** 142 /**
143 * Gets a list of session names. 143 * Gets a list of session names.
144 * 144 *
145 * @param media The media session to retrieve session names from. 145 * @param media The media session to retrieve session names from.
380 * @param transmitter The transmitter to use for the stream. 380 * @param transmitter The transmitter to use for the stream.
381 * 381 *
382 * @return @c TRUE The stream was added successfully, @c FALSE otherwise. 382 * @return @c TRUE The stream was added successfully, @c FALSE otherwise.
383 */ 383 */
384 gboolean purple_media_add_stream(PurpleMedia *media, const gchar *sess_id, const gchar *who, 384 gboolean purple_media_add_stream(PurpleMedia *media, const gchar *sess_id, const gchar *who,
385 PurpleMediaStreamType type, const gchar *transmitter); 385 PurpleMediaSessionType type, const gchar *transmitter);
386 386
387 /** 387 /**
388 * Removes a stream from a session. 388 * Removes a stream from a session.
389 * 389 *
390 * @param media The media object to find the session in. 390 * @param media The media object to find the session in.
399 * @param media The media object to find the session in. 399 * @param media The media object to find the session in.
400 * @param sess_id The session id of the session to get the type from. 400 * @param sess_id The session id of the session to get the type from.
401 * 401 *
402 * @return The retreived session type. 402 * @return The retreived session type.
403 */ 403 */
404 PurpleMediaStreamType purple_media_get_session_type(PurpleMedia *media, const gchar *sess_id); 404 PurpleMediaSessionType purple_media_get_session_type(PurpleMedia *media, const gchar *sess_id);
405 405
406 /** 406 /**
407 * Gets the negotiated codecs from a session. 407 * Gets the negotiated codecs from a session.
408 * 408 *
409 * @param media The media object to find the session in. 409 * @param media The media object to find the session in.