Mercurial > pidgin.yaz
comparison libpurple/media.h @ 26415:4143990b5c09
Add documentation for a few media functions.
author | Mike Ruprecht <maiku@soc.pidgin.im> |
---|---|
date | Sat, 21 Mar 2009 07:53:22 +0000 |
parents | 89002b47a0df |
children | 775920086761 |
comparison
equal
deleted
inserted
replaced
26414:89002b47a0df | 26415:4143990b5c09 |
---|---|
675 * @param level The level to set the volume to. | 675 * @param level The level to set the volume to. |
676 */ | 676 */ |
677 void purple_media_set_output_volume(PurpleMedia *media, const gchar *session_id, | 677 void purple_media_set_output_volume(PurpleMedia *media, const gchar *session_id, |
678 const gchar *participant, double level); | 678 const gchar *participant, double level); |
679 | 679 |
680 /** | |
681 * Sets a video output window for the given session/stream. | |
682 * | |
683 * @param media The media instance to set the output window on. | |
684 * @param session_id The session to set the output window on. | |
685 * @param participant Optionally, the participant to set the output window on. | |
686 * @param window_id The window id use for embedding the video in. | |
687 * | |
688 * @return An id to reference the output window. | |
689 */ | |
680 gulong purple_media_set_output_window(PurpleMedia *media, | 690 gulong purple_media_set_output_window(PurpleMedia *media, |
681 const gchar *session_id, const gchar *participant, | 691 const gchar *session_id, const gchar *participant, |
682 gulong window_id); | 692 gulong window_id); |
683 | 693 |
694 /** | |
695 * Removes all output windows from a given media session. | |
696 * | |
697 * @param media The instance to remove all output windows from. | |
698 */ | |
684 void purple_media_remove_output_windows(PurpleMedia *media); | 699 void purple_media_remove_output_windows(PurpleMedia *media); |
685 | 700 |
701 /** | |
702 * Gets the tee from a given session/stream. | |
703 * | |
704 * @param media The instance to get the tee from. | |
705 * @param session_id The id of the session to get the tee from. | |
706 * @param participant Optionally, the participant of the stream to get the tee from. | |
707 * | |
708 * @return The GstTee element from the chosen session/stream. | |
709 */ | |
686 GstElement *purple_media_get_tee(PurpleMedia *media, | 710 GstElement *purple_media_get_tee(PurpleMedia *media, |
687 const gchar *session_id, const gchar *participant); | 711 const gchar *session_id, const gchar *participant); |
688 | 712 |
689 #ifdef __cplusplus | 713 #ifdef __cplusplus |
690 } | 714 } |