mirror of https://gitlab.com/openlp/openlp.git
119 lines
4.9 KiB
Python
119 lines
4.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
|
|
|
|
###############################################################################
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
# --------------------------------------------------------------------------- #
|
|
# Copyright (c) 2008-2019 OpenLP Developers #
|
|
# --------------------------------------------------------------------------- #
|
|
# This program is free software; you can redistribute it and/or modify it #
|
|
# under the terms of the GNU General Public License as published by the Free #
|
|
# Software Foundation; version 2 of the License. #
|
|
# #
|
|
# This program is distributed in the hope that it will be useful, but WITHOUT #
|
|
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or #
|
|
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for #
|
|
# more details. #
|
|
# #
|
|
# You should have received a copy of the GNU General Public License along #
|
|
# with this program; if not, write to the Free Software Foundation, Inc., 59 #
|
|
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
|
|
###############################################################################
|
|
"""
|
|
The Media plugin
|
|
"""
|
|
import logging
|
|
|
|
from openlp.core.state import State
|
|
from openlp.core.api.http import register_endpoint
|
|
from openlp.core.common.i18n import translate
|
|
from openlp.core.ui.icons import UiIcons
|
|
from openlp.core.lib import build_icon
|
|
from openlp.core.lib.plugin import Plugin, StringContent
|
|
from openlp.plugins.media.endpoint import api_media_endpoint, media_endpoint
|
|
from openlp.plugins.media.lib.mediaitem import MediaMediaItem
|
|
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
# Some settings starting with "media" are in core, because they are needed for core functionality.
|
|
__default_settings__ = {
|
|
'media/media files': [],
|
|
'media/last directory': None
|
|
}
|
|
|
|
|
|
class MediaPlugin(Plugin):
|
|
"""
|
|
The media plugin adds the ability to playback audio and video content.
|
|
"""
|
|
log.info('{name} MediaPlugin loaded'.format(name=__name__))
|
|
|
|
def __init__(self):
|
|
super(MediaPlugin, self).__init__('media', __default_settings__, MediaMediaItem)
|
|
self.weight = -6
|
|
self.icon_path = UiIcons().video
|
|
self.icon = build_icon(self.icon_path)
|
|
# passed with drag and drop messages
|
|
self.dnd_id = 'Media'
|
|
register_endpoint(media_endpoint)
|
|
register_endpoint(api_media_endpoint)
|
|
State().add_service(self.name, self.weight, requires='mediacontroller', is_plugin=True)
|
|
State().update_pre_conditions(self.name, self.check_pre_conditions())
|
|
|
|
def initialise(self):
|
|
"""
|
|
Override the inherited initialise() method in order to upgrade the media before trying to load it
|
|
"""
|
|
super().initialise()
|
|
|
|
def app_startup(self):
|
|
"""
|
|
Override app_startup() in order to do nothing
|
|
"""
|
|
pass
|
|
|
|
@staticmethod
|
|
def about():
|
|
"""
|
|
Return the about text for the plugin manager
|
|
"""
|
|
about_text = translate('MediaPlugin', '<strong>Media Plugin</strong>'
|
|
'<br />The media plugin provides playback of audio and video.')
|
|
return about_text
|
|
|
|
def set_plugin_text_strings(self):
|
|
"""
|
|
Called to define all translatable texts of the plugin
|
|
"""
|
|
# Name PluginList
|
|
self.text_strings[StringContent.Name] = {
|
|
'singular': translate('MediaPlugin', 'Media', 'name singular'),
|
|
'plural': translate('MediaPlugin', 'Media', 'name plural')
|
|
}
|
|
# Name for MediaDockManager, SettingsManager
|
|
self.text_strings[StringContent.VisibleName] = {
|
|
'title': translate('MediaPlugin', 'Media', 'container title')
|
|
}
|
|
# Middle Header Bar
|
|
tooltips = {
|
|
'load': translate('MediaPlugin', 'Load new media.'),
|
|
'import': '',
|
|
'new': translate('MediaPlugin', 'Add new media.'),
|
|
'edit': translate('MediaPlugin', 'Edit the selected media.'),
|
|
'delete': translate('MediaPlugin', 'Delete the selected media.'),
|
|
'preview': translate('MediaPlugin', 'Preview the selected media.'),
|
|
'live': translate('MediaPlugin', 'Send the selected media live.'),
|
|
'service': translate('MediaPlugin', 'Add the selected media to the service.')
|
|
}
|
|
self.set_plugin_ui_text_strings(tooltips)
|
|
|
|
def finalise(self):
|
|
"""
|
|
Time to tidy up on exit.
|
|
"""
|
|
log.info('Media Finalising')
|
|
self.media_controller.finalise()
|
|
Plugin.finalise(self)
|