Author: duncan
Date: Sun Oct 14 11:27:08 2007
New Revision: 9979
Log:
Updated doc strings for plugins -l
Modified:
branches/rel-1/freevo/src/audio/plugins/logger.py
branches/rel-1/freevo/src/plugins/joy.py
branches/rel-1/freevo/src/plugins/mixer.py
branches/rel-1/freevo/src/plugins/ossmixer.py
branches/rel-1/freevo/src/plugins/screensaver/__init__.py
branches/rel-1/freevo/src/tv/plugins/irsend_echostar.py
branches/rel-1/freevo/src/tv/plugins/ivtv_record.py
branches/rel-1/freevo/src/tv/plugins/view_line_in.py
branches/rel-1/freevo/src/tv/plugins/view_recordings.py
branches/rel-1/freevo/src/video/plugins/xine.py
Modified: branches/rel-1/freevo/src/audio/plugins/logger.py
==============================================================================
--- branches/rel-1/freevo/src/audio/plugins/logger.py (original)
+++ branches/rel-1/freevo/src/audio/plugins/logger.py Sun Oct 14 11:27:08 2007
@@ -40,6 +40,10 @@
class PluginInterface(plugin.DaemonPlugin):
+ """
+ Sqlite Play Counter
+ """
+
def __init__(self):
plugin.DaemonPlugin.__init__(self)
self.plugin_name = 'audio.logger'
Modified: branches/rel-1/freevo/src/plugins/joy.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/joy.py (original)
+++ branches/rel-1/freevo/src/plugins/joy.py Sun Oct 14 11:27:08 2007
@@ -45,6 +45,13 @@
rc = rc.get_singleton()
class PluginInterface(plugin.DaemonPlugin):
+ """
+ A joystick control plugin for Freevo
+
+ To use this plugin make sure that your joystick is already working
properly and
+ then configure JOY_DEV and JOY_CMDS in your local_conf.py. You will also
need
+ to have plugin.activate('joy') in your config as well.
+ """
def __init__(self):
self.device_name = ''
Modified: branches/rel-1/freevo/src/plugins/mixer.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/mixer.py (original)
+++ branches/rel-1/freevo/src/plugins/mixer.py Sun Oct 14 11:27:08 2007
@@ -44,6 +44,10 @@
def i32(x): return (x&0x80000000L and -2*0x40000000 or 0) + int(x&0x7fffffff)
class PluginInterface(plugin.DaemonPlugin):
+ """
+ Mixer for Freevo
+ """
+
# These magic numbers were determined by writing a C-program using the
# macros in /usr/include/linux/... and printing the values.
# They seem to work on my machine. XXX Is there a real python interface?
Modified: branches/rel-1/freevo/src/plugins/ossmixer.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/ossmixer.py (original)
+++ branches/rel-1/freevo/src/plugins/ossmixer.py Sun Oct 14 11:27:08 2007
@@ -13,7 +13,6 @@
# http://www.python.org/doc/current/lib/mixer-device-objects.html
#
# And to activate:
-#
# plugin.remove('mixer')
# plugin.activate('ossmixer')
#
@@ -57,6 +56,17 @@
class PluginInterface(plugin.DaemonPlugin):
+ """
+ The OSS mixer interface for Freevo
+
+ Last note, here is the documentation again:
+ http://www.python.org/doc/current/lib/mixer-device-objects.html
+
+ And to activate:
+ plugin.remove('mixer')
+ plugin.activate('ossmixer')
+ """
+
SOUND_MIXER_LINE = 7
SOUND_MASK_LINE = 64
Modified: branches/rel-1/freevo/src/plugins/screensaver/__init__.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/screensaver/__init__.py (original)
+++ branches/rel-1/freevo/src/plugins/screensaver/__init__.py Sun Oct 14
11:27:08 2007
@@ -52,7 +52,9 @@
class PluginInterface(plugin.DaemonPlugin):
"""
+ Yet another Freevo Screensaver
"""
+
def __init__(self):
plugin.DaemonPlugin.__init__(self)
self.event_listener = True
Modified: branches/rel-1/freevo/src/tv/plugins/irsend_echostar.py
==============================================================================
--- branches/rel-1/freevo/src/tv/plugins/irsend_echostar.py (original)
+++ branches/rel-1/freevo/src/tv/plugins/irsend_echostar.py Sun Oct 14
11:27:08 2007
@@ -1,36 +1,11 @@
# -*- coding: iso-8859-1 -*-
# -----------------------------------------------------------------------
# irsend_echostar.py - Send IR commands to an echostar receiver used by
-# Dish and ExpressVu sattelite service. Tested
-# using a homebrew infrared transmitter.
+# Dish and ExpressVu sattelite service. Tested
+# using a homebrew infrared transmitter.
# -----------------------------------------------------------------------
# $Id$
#
-# Notes: The echostar boxes and lirc don't play naturally together so
-# we do things outside of (most) of the lirc space and talk to
-# the device.
-# This module borrows logic and code from jvc_send.c Which
-# is Copyright 2002 Karl Bongers, [EMAIL PROTECTED] and Copyright
-# 2002 Pyroman, webvcrplus.
-#
-# This modules is very young and will be changing to have functions
-# to perform specific tasks and used remotes and codes from your
-# lircd.conf.
-#
-# Notes from jvc_send.c:
-# Send codes for weird Dish networks box that uses JVC_4700 at
-# 57600 modulation/carrier frequency.
-# Requires multiple back to back signals with accurate
-# timing between signals.
-#
-# Send JVC_4700 signals, try to send out exactly
-# as they come in. lircd/lirc_serial handling gives inaccurate
-# signal lengths between 16 bit blocks. The signal we see
-# coming in is back-to-back packets, that is what we
-# try to duplicate.
-#
-# lirc_serial.o must be loaded and setup correctly, see LIRC project.
-#
# Todo:
#
# -----------------------------------------------------------------------
@@ -67,6 +42,30 @@
class PluginInterface(plugin.Plugin):
+ """
+ Send IR commands to an echostar receiver used by Dish and ExpressVu
sattelite
+ service. Tested using a homebrew infrared transmitter.
+
+ The echostar boxes and lirc don't play naturally together so we do things
+ outside of (most) of the lirc space and talk to the device. This module
+ borrows logic and code from jvc_send.c Which is Copyright 2002 Karl
Bongers,
+ [EMAIL PROTECTED] and Copyright 2002 Pyroman, webvcrplus.
+
+ This modules is very young and will be changing to have functions to
perform
+ specific tasks and used remotes and codes from your lircd.conf.
+
+ Notes from jvc_send.c: Send codes for weird Dish networks box that uses
+ JVC_4700 at 57600 modulation/carrier frequency. Requires multiple back to
back
+ signals with accurate timing between signals.
+
+ Send JVC_4700 signals, try to send out exactly as they come in.
+ lircd/lirc_serial handling gives inaccurate signal lengths between 16 bit
+ blocks. The signal we see coming in is back-to-back packets, that is what
we
+ try to duplicate.
+
+ lirc_serial.o must be loaded and setup correctly, see LIRC project.
+ """
+
MODULATION_FREQ = 57600
## 0 to 100, where 100=strongest?
Modified: branches/rel-1/freevo/src/tv/plugins/ivtv_record.py
==============================================================================
--- branches/rel-1/freevo/src/tv/plugins/ivtv_record.py (original)
+++ branches/rel-1/freevo/src/tv/plugins/ivtv_record.py Sun Oct 14 11:27:08 2007
@@ -51,6 +51,10 @@
class PluginInterface(plugin.Plugin):
+ """
+ A plugin to record tv using an ivtv based card
+ """
+
def __init__(self):
plugin.Plugin.__init__(self)
plugin.register(Recorder(), plugin.RECORD)
Modified: branches/rel-1/freevo/src/tv/plugins/view_line_in.py
==============================================================================
--- branches/rel-1/freevo/src/tv/plugins/view_line_in.py (original)
+++ branches/rel-1/freevo/src/tv/plugins/view_line_in.py Sun Oct 14
11:27:08 2007
@@ -35,7 +35,9 @@
class PluginInterface(plugin.Plugin):
"""
+ View the line in in VCR mode
"""
+
def __init__(self):
"""
normal plugin init, but sets _type to 'mainmenu_tv'
Modified: branches/rel-1/freevo/src/tv/plugins/view_recordings.py
==============================================================================
--- branches/rel-1/freevo/src/tv/plugins/view_recordings.py (original)
+++ branches/rel-1/freevo/src/tv/plugins/view_recordings.py Sun Oct 14
11:27:08 2007
@@ -34,7 +34,9 @@
class PluginInterface(plugin.Plugin):
"""
+ View the TV recordings directory
"""
+
def __init__(self):
"""
normal plugin init, but sets _type to 'mainmenu_tv'
Modified: branches/rel-1/freevo/src/video/plugins/xine.py
==============================================================================
--- branches/rel-1/freevo/src/video/plugins/xine.py (original)
+++ branches/rel-1/freevo/src/video/plugins/xine.py Sun Oct 14 11:27:08 2007
@@ -51,9 +51,15 @@
class PluginInterface(plugin.Plugin):
- '''
+ """
Xine plugin for the video player.
- '''
+
+ Activate this plugin by putting plugin.activate('video.xine') in your
+ local_conf.py. Than xine will be used for DVDs when you SELECT the item.
When
+ you select a title directly in the menu, this plugin won't be used and the
+ default player (mplayer) will be used. You need xine-ui >= 0.9.22 to use
this.
+ """
+
def __init__(self):
plugin.Plugin.__init__(self)
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Freevo-cvslog mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/freevo-cvslog
