File: pymod_plugin.rst

package info (click to toggle)
eyed3 0.9.7-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,380 kB
  • sloc: python: 13,282; makefile: 411; sh: 69
file content (49 lines) | stat: -rw-r--r-- 1,133 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
pymod - Use simple python modules as eyeD3 plugins
==================================================

.. {{{cog
.. cog.out(cog_pluginHelp("pymod"))
.. }}}

*Imports a Python module file and calls its functions for the the various plugin events.*

Names
-----
pymod 

Description
-----------

If no module if provided a file named eyeD3mod.py in the current working directory is
imported. If any of the following methods exist they still be invoked:

def audioFile(audio_file):
    """Invoked for every audio file that is encountered. The ``audio_file``
    is of type ``eyed3.core.AudioFile``; currently this is the concrete type
    ``eyed3.mp3.Mp3AudioFile``."""
    pass

def audioDir(d, audio_files, images):
    """This function is invoked for any directory (``d``) that contains audio
    (``audio_files``) or image (``images``) media."""
    pass

def done():
    """This method is invoke before successful exit."""
    pass


Options
-------
.. code-block:: text

    -m MODULE, --module MODULE
                          The Python module module to invoke. The default is ./eyeD3mod.py


.. {{{end}}}

Example
-------

TODO