summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMurray Cumming <murrayc@openismus.com>2012-09-10 13:53:12 +0200
committerMurray Cumming <murrayc@murrayc.com>2012-09-24 12:10:21 +0200
commit1f169464c0d977225df8d25b94979a719fe5f9dc (patch)
treec4ecd8635a6c416b876e97bde53ea4cfe763628a /src
parent5da4a434d34388641b6880d077be00d774cb3154 (diff)
downloadrygel-1f169464c0d977225df8d25b94979a719fe5f9dc.tar.gz
renderer: Simple documentation
Diffstat (limited to 'src')
-rw-r--r--src/librygel-renderer/rygel-media-player.vala4
-rw-r--r--src/librygel-renderer/rygel-media-renderer-plugin.vala4
-rw-r--r--src/librygel-renderer/rygel-playbin-player.vala4
-rw-r--r--src/librygel-renderer/rygel-playbin-plugin.vala4
4 files changed, 16 insertions, 0 deletions
diff --git a/src/librygel-renderer/rygel-media-player.vala b/src/librygel-renderer/rygel-media-player.vala
index c139cfb8..b50e03d0 100644
--- a/src/librygel-renderer/rygel-media-player.vala
+++ b/src/librygel-renderer/rygel-media-player.vala
@@ -1,6 +1,7 @@
/*
* Copyright (C) 2008 OpenedHand Ltd.
* Copyright (C) 2009,2010 Nokia Corporation.
+ * Copyright (C) 2012 Intel Corporation.
*
* Author: Jorn Baayen <jorn@openedhand.com>
* Zeeshan Ali (Khattak) <zeeshanak@gnome.org>
@@ -23,6 +24,9 @@
using Gst;
+/**
+ * Interface for mapping AVTransport:2 methods to the specific implementation.
+ */
public interface Rygel.MediaPlayer : GLib.Object {
public abstract string playback_state { owned get; set; }
public abstract string? uri { owned get; set; }
diff --git a/src/librygel-renderer/rygel-media-renderer-plugin.vala b/src/librygel-renderer/rygel-media-renderer-plugin.vala
index 549d95bf..d9cc8b60 100644
--- a/src/librygel-renderer/rygel-media-renderer-plugin.vala
+++ b/src/librygel-renderer/rygel-media-renderer-plugin.vala
@@ -1,5 +1,6 @@
/*
* Copyright (C) 2008,2010 Nokia Corporation.
+ * Copyright (C) 2012 Intel Corporation.
*
* Author: Zeeshan Ali (Khattak) <zeeshanak@gnome.org>
* <zeeshan.ali@nokia.com>
@@ -21,6 +22,9 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
+/**
+ * Base class for every Rygel UPnP renderer plugin.
+ */
public class Rygel.MediaRendererPlugin : Rygel.Plugin {
private static const string MEDIA_RENDERER_DESC_PATH =
BuildConfig.DATA_DIR +
diff --git a/src/librygel-renderer/rygel-playbin-player.vala b/src/librygel-renderer/rygel-playbin-player.vala
index 65c03ca4..5ddd81d1 100644
--- a/src/librygel-renderer/rygel-playbin-player.vala
+++ b/src/librygel-renderer/rygel-playbin-player.vala
@@ -2,6 +2,7 @@
* Copyright (C) 2008 OpenedHand Ltd.
* Copyright (C) 2009,2010,2011,2012 Nokia Corporation.
* Copyright (C) 2012 Openismus GmbH
+ * Copyright (C) 2012 Intel Corporation.
*
* Author: Jorn Baayen <jorn@openedhand.com>
* Zeeshan Ali (Khattak) <zeeshanak@gnome.org>
@@ -26,6 +27,9 @@
using Gst;
using GUPnP;
+/**
+ * Implementation of RygelMediaPlayer for GStreamer.
+ */
public class Rygel.Playbin.Player : GLib.Object, Rygel.MediaPlayer {
private const string TRANSFER_MODE_STREAMING = "Streaming";
private const string TRANSFER_MODE_INTERACTIVE = "Interactive";
diff --git a/src/librygel-renderer/rygel-playbin-plugin.vala b/src/librygel-renderer/rygel-playbin-plugin.vala
index caac9ceb..89501570 100644
--- a/src/librygel-renderer/rygel-playbin-plugin.vala
+++ b/src/librygel-renderer/rygel-playbin-plugin.vala
@@ -2,6 +2,7 @@
* Copyright (C) 2008 Zeeshan Ali (Khattak) <zeeshanak@gnome.org>.
* Copyright (C) 2008 Nokia Corporation.
* Copyright (C) 2012 Openismus GmbH.
+ * Copyright (C) 2012 Intel Corporation.
*
* Author: Zeeshan Ali (Khattak) <zeeshanak@gnome.org>
* <zeeshan.ali@nokia.com>
@@ -27,6 +28,9 @@
using Rygel;
using Gee;
+/**
+ * Implementation of RygelMediaRendererPlugin for GStreamer.
+ */
public class Rygel.Playbin.Plugin : Rygel.MediaRendererPlugin {
public const string NAME = "Playbin";