forked from openlp/openlp
90 lines
2.9 KiB
Python
90 lines
2.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-2016 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 :mod:`remotes` plugin allows OpenLP to be controlled from another machine
|
|
over a network connection.
|
|
|
|
Routes:
|
|
|
|
``/``
|
|
Go to the web interface.
|
|
|
|
``/files/{filename}``
|
|
Serve a static file.
|
|
|
|
``/api/poll``
|
|
Poll to see if there are any changes. Returns a JSON-encoded dict of
|
|
any changes that occurred::
|
|
|
|
{"results": {"type": "controller"}}
|
|
|
|
Or, if there were no results, False::
|
|
|
|
{"results": False}
|
|
|
|
``/api/controller/{live|preview}/{action}``
|
|
Perform ``{action}`` on the live or preview controller. Valid actions
|
|
are:
|
|
|
|
``next``
|
|
Load the next slide.
|
|
|
|
``previous``
|
|
Load the previous slide.
|
|
|
|
``jump``
|
|
Jump to a specific slide. Requires an id return in a JSON-encoded
|
|
dict like so::
|
|
|
|
{"request": {"id": 1}}
|
|
|
|
``first``
|
|
Load the first slide.
|
|
|
|
``last``
|
|
Load the last slide.
|
|
|
|
``text``
|
|
Request the text of the current slide.
|
|
|
|
``/api/service/{action}``
|
|
Perform ``{action}`` on the service manager (e.g. go live). Data is
|
|
passed as a json-encoded ``data`` parameter. Valid actions are:
|
|
|
|
``next``
|
|
Load the next item in the service.
|
|
|
|
``previous``
|
|
Load the previews item in the service.
|
|
|
|
``jump``
|
|
Jump to a specific item in the service. Requires an id returned in
|
|
a JSON-encoded dict like so::
|
|
|
|
{"request": {"id": 1}}
|
|
|
|
``list``
|
|
Request a list of items in the service.
|
|
|
|
|
|
"""
|