rhythmbox插件开发笔记1：简介&入门

2022-06-18 03:17:45

rhythmbox是gnome下一款开源的音乐播放软件。ubuntu和fedora的桌面环境中均默认安装了rhythmbox。

rhythmbox架构非常灵活，几乎所有地方都可以用插件来修改。用户想实现什么功能，都可以通过插件来

实现。

为了方便开发第三方插件，官网提供了详细的插件开发教材。但是，它已经过时了：rhythmbox升级到2.99

的时候，修改了很多API(我猜是为了对应gnome3?? python3???)。这次蛋疼的不向下兼容的升级导致很多

旧的插件都不能用了，有的插件开发者为了对应rhythmbox3只得为rhythmbox2和3建立了不同的开发分支。

将基于版本2的rhythmbox开发的插件“移植”到版本3上的方法是通过xxx_rb3compat.py。

rhythmbox的插件主要由c和python开发。用c开发需要很丰富的GObject-based C背景知识，很显然为没有，

所以我尝试的方法是使用python开发。下面介绍使用python开发rhythmbox plugin（rhythmbox 版本>=2.99）

的具体方法。以我尝试开发的插件xiami为例

首先说插件的安装

一般来说，使用python开发的rhythmbox插件不需要安装，只需将代码文件和配置文件放到指定的文件夹，并且

按照一定的规则命名文件，插件就能被自动识别（和vim插件类似）。

插件可以放在三个地方

a /usr/share/lib/rhythmbox/plugins 一般情况下除了官方插件，不要把插件放到这里

b $HOME//.local/share/rhythmbox/plugins（这里和版本2的路径不同）

c 为了用c开发插件的开发者使用的路径，这里不做介绍

最基本的插件由两类文件组成：后缀名为py的源代码文件和后缀名为plugin(或者是rb-plugin)的配置文件

a配置文件。在$HOME//.local/share/rhythmbox/plugins/xiami文件夹下新建文件xiami.plugin

 [Plugin]

 Loader=python3

 Module=xiami

 IAge=2

 Name=RB Plugin For xiami

 Name[zh_CN]=虾米插件

 Description=This is a RB Plugin for xiami,still in test

 Description[zh_CN]=虾米的RB插件，还在测试中

 Authors=Liu Peng <solo_o@foxmail.com>

 Copyright=2014@s0_0s

 Website=http://fingerliu.github.io

这里需要注意的地方有三个，Loader这里和2.99以前的版本不同，貌似如果写python会导致无法加载插件；Module设定为你插件的名字，一般和文件夹名一致；IAge设定为2。

b源代码。在$HOME//.local/share/rhythmbox/plugins/xiami文件夹下新建文件xiami.py

这里和2.99版本以前也不相同。以前可以将文件命名为__init__.py，现在貌似必须命名为Module名(因为用了python3??)

 from gi.repository import GObject, RB, Peas

 import gettext

 gettext.install('rhythmbox',RB.locale_dir())

 class xiami (GObject.Object, Peas.Activatable):

         __gtype_name = 'xiamiPlugin'

         object = GObject.property(type=GObject.Object)

         def __init__(self):

                 GObject.Object.__init__(self)

         def do_activate(self):

                 print ("Hello I am XiaMi")

                 shell = self.object

                 db = shell.props.db

                 model = RB.RhythmDBQueryModel.new_empty(db)

                 self.source = GObject.new(xiamiSource, shell=shell, name=_("XiaMi"), query_model=model)

                 self.source.setup()

                 group = RB.DisplayPageGroup.get_by_id("library")

                 shell.append_display_page(self.source, group)

         def do_deactivate(self):

                 print("deactivating XiaMi plugin")

                 self.source.delete_thyself()

                 self.source = None

 class xiamiSource(RB.Source):

         def __init__(self,**kwargs):

                 super(xiamiSource,self).__init__(kwargs)

         def setup(self):

                 shell = self.props.shell

                 songs = RB.EntryView(db=shell.props.db,shell_player=shell.props.shell_player,is_drag_source=False,is_drag_dest=False)

                songs.append_column(RB.EntryViewColumn.TITLE,True)

                 songs.set_model(self.props.query_model)

                 songs.show_all()

                 self.pack_start(songs,expand=True,fill=True,padding=-0)

 GObject.type_register(xiamiSource)