This version (2014/04/14 11:52) is a draft.
Approvals: 0/1

MP3Plugin

Plugin for processing MP3 files.

  • Processes files with extensions: .mp3
    Perl regular expression: (?i)\.mp3$

The following table lists all of the configuration options available for MP3Plugin.

OptionDescriptionValue
MP3Plugin Options
process_exp A perl regular expression to match against filenames. Matching filenames will be processed by this plugin. For example, using '(?i).html?\$' matches all documents ending in .htm or .html (case-insensitive). Default: (?i)\.mp3$
assoc_images Use Google image search to locate images related to MP3 file based on ID3 Title and Artist metadata.
applet_metadata Used to store [applet] metadata for each document that contains the necessary HTML for an MP3 audio player applet to play that file.
metadata_fields Comma separated list of metadata fields to extract (assuming present) in an MP3 file. Use \"*\" to extract all the fields. Default: Title,Artist,Genre
file_rename_method The method to be used in renaming the copy of the imported file and associated files. Default: base64
List
Options Inherited from BasePlugin
process_exp A perl regular expression to match against filenames. Matching filenames will be processed by this plugin. For example, using '(?i).html?\$' matches all documents ending in .htm or .html (case-insensitive).
no_blocking Don't do any file blocking. Any associated files (e.g. images in a web page) will be added to the collection as documents in their own right.
block_exp Files matching this regular expression will be blocked from being passed to any later plugins in the list.
store_original_file Save the original source document as an associated file. Note this is already done for files like PDF, Word etc. This option is only useful for plugins that don't already store a copy of the original file.
associate_ext Causes files with the same root filename as the document being processed by the plugin AND a filename extension from the comma separated list provided by this argument to be associated with the document being processed rather than handled as a separate list.
associate_tail_re A regular expression to match filenames against to find associated files. Used as a more powerful alternative to associate_ext.
OIDtype The method to use when generating unique identifiers for each document. Default: auto
List
OIDmetadata Specifies the metadata element that hold's the document's unique identifier, for use with -OIDtype=assigned. Default: dc.Identifier
no_cover_image Do not look for a prefix.jpg file (where prefix is the same prefix as the file being processed) to associate as a cover image.
filename_encoding The encoding of the source file filenames. Default: auto
List
file_rename_method The method to be used in renaming the copy of the imported file and associated files. Default: url
List

file_rename_method option values

ValueDescription
urlUse url encoding in renaming imported files and associated files.
base64Use base64 encoding in renaming imported files and associated files.
noneDon't rename imported files and associated files.