documentation/manual/source/projector.rst

358 lines
14 KiB
ReStructuredText
Raw Normal View History

2014-10-07 19:47:03 +00:00
.. _projector:
========================
Projector Remote Control
========================
The Projector Manager allows you to remotely control a network-connected
projector that conforms to the Japan Business Machine and Information System
2014-10-29 02:45:55 +00:00
Association (JBMIA) PJLink specification. Available in OpenLP v2.2.
2014-11-10 23:06:23 +00:00
.. _projector_settings:
2014-10-29 02:45:55 +00:00
Projector Settings
------------------
The available projector options can be changed using the main settings menu by
2014-11-11 17:18:44 +00:00
going to :guilabel:`Settings` -> :guilabel:`Configure OpenLP` -> :guilabel:`Projectors` tab.
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_settings_tab|
2014-10-29 02:45:55 +00:00
The options available are:
Connect to projectors on startup : Check if you want to attempt to connect
to all projectors when OpenLP starts
Socket timeout (seconds): Time in seconds to wait for the projector connection.
Available options are 2 to 10 seconds.
Poll timeout (seconds): How often to poll the projector for status information.
2014-11-10 23:06:23 +00:00
Available options are 2 to 60 seconds. For quicker response on the status icons,
set to a lower value. If you have network congestion, you may need to use a higher
value.
2014-10-29 02:45:55 +00:00
Source select dialog interface: Select whether you want all video source options
on one dialog page or to use tabs to consolidate the inputs based on video group.
2014-11-11 17:18:44 +00:00
Once you are satisfied with the settings, click on the :guilabel:`OK` button, otherwise click
on the :guilabel:`Cancel` button to ignore changes and close the dialog.
2014-10-07 19:47:03 +00:00
2014-11-10 23:06:23 +00:00
.. _projector_manager:
2014-10-07 19:47:03 +00:00
Projector Manager
-----------------
The Projector Manager is the interface to controlling your projector(s). It is
located on the bottom-right corner of OpenLP just below the Theme Manager.
2014-11-10 23:06:23 +00:00
|projector_manager|
2014-10-07 19:47:03 +00:00
2014-10-29 02:45:55 +00:00
The icons on the Projector Manager tab will depend on projector entries as well
as how many projectors are selected at once.
A list of possible projector icons are:
2014-10-07 19:47:03 +00:00
2014-11-10 23:06:23 +00:00
|projector_new| **New Projector:**
Choosing this option will open the "Create New Projector" dialog so you can enter
a new projector item.
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_edit| **Edit Projector:**
When you have selected a projector item, this option will open the "Edit Projector"
dialog so you can make changes to that projector item.
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_source| **Select Projector Input:**
When you have selected a projector item and it is connected and power is ON, this
option will give you a dialog that allows you to select the video source the
projector will use.
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_delete| **Delete Projector:**
When you have selected a projector item, this option will allow you to delete
the projector item from the Projector manager list.
2014-10-09 22:24:59 +00:00
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_info| **Projector Information:**
When you have selected a projector item and it is connected to the projector, this
option will give you an information box with extra information about the projector.
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_connect| **Connect to Projector:**
When you have selected a projector item, this option will allow you to connect to
the projector.
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_connect_tiled| **Connect to Multiple Projectors:**
When you have multiple projector items selected, this option will allow to to
connect to multiple projectors at once.
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_disconnect| **Disconnect from Projector:**
When you have a projector item selected, this option will allow you to disconnect
from the projector.
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_disconnect_tiled| **Disconnect from Multiple Projectors:**
2014-11-11 16:27:33 +00:00
When you have multiple projector items selected, this option will allow to
2014-11-10 23:06:23 +00:00
disconnect from multiple projectors at once.
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_power_on| **Power On Projector:**
When you have selected a projector item and it is connected, this option will allow
you to turn the projector to "Power ON".
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_power_on_tiled| **Power On Multiple Projectors:**
When you have selected multiple projector items and they are connected, this option will allow
you to turn the projectors to "Power ON".
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_power_off| **Power Off Projector:**
When you have selected a projector item and it is connected, this option will allow
you to turn the projector to "Power STANDBY".
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_power_off_tiled| **Power Off Multiple Projectors:**
When you have selected multiple projector items and they are connected, this option will allow
you to turn the projectors to "Power STANDBY".
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_blank| **Blank Projector Screen:**
When you have a projector item selected and it is powered ON, this option will allow
you to blank the projector screen so no video is shown.
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_blank_tiled| **Blank All Projector Screens:**
When you have multiple projector items selected and they are powered ON, this option will allow
you to blank the projector screens so no video is shown.
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_show| **Show Projector Screen:**
When you have a projector item selected and it is powered ON, this option will allow
you to unblank the projector screen so video is shown.
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_show_tiled| **Show All Projector Screens:**
When you have multiple projector items selected and they are powered ON, this option will allow
you to unblank the projector screens so video is shown.
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
.. _projector_add:
2014-10-07 19:47:03 +00:00
Adding a Projector
------------------
2014-11-11 16:27:33 +00:00
To add a new projector, click on the :guilabel:`Add New Projector` icon on the Projector
2014-10-29 02:45:55 +00:00
Manager tab bar. You will be given an input dialog box like the below image.
2014-10-07 19:47:03 +00:00
2014-11-10 23:06:23 +00:00
|projector_add_new|
2014-10-07 19:47:03 +00:00
2014-10-29 02:45:55 +00:00
The required information are "IP Address", "Port Number", and "Name" entries.
The port number is already set with the default PJLink port.
2014-10-07 19:47:03 +00:00
2014-10-29 02:45:55 +00:00
The "PIN" entry is only needed if the projector you are connecting to has the
PJLink PIN set. Be careful, since most projectors have a separate entry for
the PJLink PIN, any other network PIN or password, as well as a separate entry
for any HTML access name/password settings (if the projector has HTML webpage
access). The PIN setting here is ONLY used if the projector has a "PJLink access
code" or "PJLink PIN" setting.
2014-10-07 19:47:03 +00:00
2014-11-11 16:27:33 +00:00
For information on what the fields are, you can click on :guilabel:`Help` button for some information
about what is expected for each field.
Once you are done entering the new information, click on :guilabel:`Save` to save the entry
and add it to the projector manager list. If you decide to not add a new entry, click the
:guilabel:`Cancel` button to close the dialog without saving.
Congratulations, you now have your first projector entry in the list and ready for control.
2014-10-07 19:47:03 +00:00
2014-11-10 23:06:23 +00:00
|projector_manager_list|
2014-10-09 22:24:59 +00:00
2014-10-29 02:45:55 +00:00
When you have multiple projector entries selected, the projector manager toolbar
will change to the following:
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_item_multiple_selection|
2014-10-07 19:47:03 +00:00
2014-10-29 02:45:55 +00:00
Once you select a projector, the icons will also change based on the status of
the projector.
2014-10-07 19:47:03 +00:00
2014-11-10 23:06:23 +00:00
.. _projector_view:
2014-10-07 19:47:03 +00:00
2014-11-10 23:06:23 +00:00
View Projector Information
--------------------------
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
After you have a projector item added and it's connected, you can view the current status of the projector
2014-11-11 16:27:33 +00:00
by clicking on the :guilabel:`View Projector Information` icon. You will see a pop-up box that looks
similar to the following: (NOTE: Example information only - the information you see will depend on the
projector that you are connected to)
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_item_view|
2014-10-07 19:47:03 +00:00
2014-11-10 23:06:23 +00:00
.. _projector_status:
2014-10-07 19:47:03 +00:00
2014-11-10 23:06:23 +00:00
Projector Status Icons
----------------------
2014-10-07 19:47:03 +00:00
2014-11-10 23:06:23 +00:00
The icons next to the projector entry in the projector manager list give you a
quick visual status of the projector.
2014-10-07 19:47:03 +00:00
2014-11-10 23:06:23 +00:00
The icons you will see for the projector are:
2014-10-07 19:47:03 +00:00
2014-11-10 23:06:23 +00:00
|projector_item_disconnect| Projector is disconnected
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_item_connect| Attempting to connect to projector
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_not_connected_error| There was an error connecting to projector
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_item_off| The projector power is OFF (Standby)
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_item_warmup| The projector is warming up
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_item_on| The projector is on
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_item_cooldown| The projector is cooling down before power off (standby)
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_item_error| The projector is reporting an error
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
.. _projector_menu:
2014-10-09 22:24:59 +00:00
Projector Menus
---------------
2014-11-11 16:27:33 +00:00
The projector menu items will vary depending on what the status is of the selected projector.
The icons/options available are the same as described above in the icon description section.
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
.. _projector_menu_initial:
2014-10-09 22:24:59 +00:00
Initial Menu
~~~~~~~~~~~~
When you first enter a projector or when you first start OpenLP, you will select
from the following menu items:
2014-11-10 23:06:23 +00:00
|projector_item_not_connected_menu|
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
.. _projector_menu_connected_standby:
2014-10-09 22:24:59 +00:00
2014-10-29 02:45:55 +00:00
Projector Connected in Standby Mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2014-10-09 22:24:59 +00:00
Once the projector has been connected, and if the projector is not powered on,
you get the below menu list:
2014-11-10 23:06:23 +00:00
|projector_item_connected_off|
.. _projector_menu_connected_warmup:
2014-10-29 02:45:55 +00:00
Projector Connected in Warmup Mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Once the projector is in warming up, you will see the following menu:
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_item_connected_warmup_menu|
.. _projector_menu_connected_on:
2014-10-09 22:24:59 +00:00
2014-10-29 02:45:55 +00:00
Projector Connected and Power On
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Once the projector is on, you will see the following menu:
2014-10-09 22:24:59 +00:00
2014-11-10 23:06:23 +00:00
|projector_item_power_on_menu|
.. _projector_menu_connected_cooldown:
2014-10-09 22:24:59 +00:00
2014-10-29 02:45:55 +00:00
Projector Connected and in Cooldown Mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When the projector is cooling down, you will see the following menu:
2014-11-10 23:06:23 +00:00
|projector_item_cooldown_menu|
.. _projector_video_source:
2014-10-29 02:45:55 +00:00
2014-10-29 03:19:08 +00:00
Video Source Options
--------------------
The video source options allow you to tell the projector to change it's video
source input, as well as allowing you to personalize what the video settings
options.
2014-11-10 23:06:23 +00:00
.. _projector_video_source_select:
2014-10-29 02:45:55 +00:00
Video Source Input Select Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2014-10-09 22:24:59 +00:00
2014-10-29 02:45:55 +00:00
If you want to change the video source the projector uses, click on the
2014-11-11 16:27:33 +00:00
:guilabel:`Select Source` option, then select from the pop-up window which video source
you want to use. You can access the :guilabel:`Select Source` option from either the
projector manager toolbar or from the right-click pop-up menu.
2014-10-09 22:24:59 +00:00
2014-11-11 16:27:33 +00:00
You have an option of setting two different styles for the video source window.
The default option is all entries on one radio button dialog. The other option
2014-10-29 02:45:55 +00:00
is to have the selections grouped by type. This option is available in the
2014-11-11 16:27:33 +00:00
:guilabel:`Settings` -> :guilabel:`Configure OpenLP` -> :guilabel:`Projectors` tab under
the "Source Select dialog interface" option.
2014-10-29 02:45:55 +00:00
2014-11-11 02:30:12 +00:00
NOTE: These images are examples only - what options you will have will vary
2014-10-29 02:45:55 +00:00
depending on the projector you have. These images show the default PJLink text.
2014-11-10 23:06:23 +00:00
|projector_source_select_single| |projector_source_select_tabbed|
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
.. _projector_video_source_edit:
2014-10-29 02:45:55 +00:00
Video Source Input Edit Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2014-11-10 23:06:23 +00:00
When you want to customize how the video source select text looks, click on the
2014-11-11 16:27:33 +00:00
:guilabel:`Edit Input Source` icon in the right-click menu. This will
2014-11-10 23:06:23 +00:00
bring up the source edit dialog box.
2014-11-11 16:27:33 +00:00
NOTE: These images are examples only - what options you will have will vary
2014-11-10 23:06:23 +00:00
depending on the projector you have. These images show the default PJLink text.
2014-10-29 02:45:55 +00:00
2014-11-10 23:06:23 +00:00
|projector_source_edit_single| |projector_source_edit_tabbed|
2014-10-29 02:45:55 +00:00
2014-12-18 21:03:38 +00:00
Once you are satisfied, you can click on the :guilabel:`OK` button to save the changes,
2014-11-11 16:27:33 +00:00
or click on the :guilabel:`Cancel` button to discard these changes and continue to use
2014-10-29 02:45:55 +00:00
the previously saved user-defined text (or the PJLink defaults if you have no
previously saved user-defined text).
2014-11-11 16:27:33 +00:00
If you don't like the changes, the :guilabel:`Reset` button will reset the text back to
2014-10-29 02:45:55 +00:00
the previously saved text (or PJLink defaults if you have no previously saved
user-defined text) and allow you to continue editing.
2014-10-07 19:47:03 +00:00
2014-11-11 16:27:33 +00:00
If you _really_ don't like the text, you can select the :guilabel:`Discard` button and
2014-10-29 02:45:55 +00:00
remove all entries from the database. WARNING: This will delete _all_ of the
user-defined entries for this projector in the database and return them to the
PJLink defaults.
2014-11-10 23:06:23 +00:00
.. These are all the image templates that are used in this page.
.. |PROJECTOR_ADD_NEW| image:: pics/projector_add_new.png
.. |PROJECTOR_BLANK| image:: pics/projector_blank.png
.. |PROJECTOR_BLANK_TILED| image:: pics/projector_blank_tiled.png
.. |PROJECTOR_CONNECT| image:: pics/projector_connect.png
.. |PROJECTOR_CONNECT_TILED| image:: pics/projector_connect_tiled.png
.. |PROJECTOR_DELETE| image:: pics/custom_delete.png
.. |PROJECTOR_DISCONNECT| image:: pics/projector_disconnect.png
.. |PROJECTOR_DISCONNECT_TILED| image:: pics/projector_disconnect_tiled.png
.. |PROJECTOR_EDIT| image:: pics/general_edit.png
.. |PROJECTOR_INFO| image:: pics/system_about.png
.. |PROJECTOR_ITEM_CONNECTED_OFF| image:: pics/projector_item_connected_off.png
.. |PROJECTOR_ITEM_CONNECTED_WARMUP_MENU| image:: pics/projector_item_connected_warmup.png
.. |PROJECTOR_ITEM_CONNECT| image:: pics/projector_item_connect.png
.. |PROJECTOR_ITEM_COOLDOWN| image:: pics/projector_cooldown.png
.. |PROJECTOR_ITEM_COOLDOWN_MENU| image:: pics/projector_item_connected_cooldown.png
.. |PROJECTOR_ITEM_DISCONNECT| image:: pics/projector_item_disconnect.png
.. |PROJECTOR_ITEM_ERROR| image:: pics/projector_error.png
.. |PROJECTOR_ITEM_MULTIPLE_SELECTION| image:: pics/projector_multiple_selection.png
.. |PROJECTOR_ITEM_NOT_CONNECTED_MENU| image:: pics/projector_item_not_connected.png
.. |PROJECTOR_ITEM_OFF| image:: pics/projector_off.png
.. |PROJECTOR_ITEM_ON| image:: pics/projector_on.png
.. |PROJECTOR_ITEM_POWER_ON_MENU| image:: pics/projector_item_power_on.png
.. |PROJECTOR_ITEM_VIEW| image:: pics/projector_item_view.png
.. |PROJECTOR_ITEM_WARMUP| image:: pics/projector_warmup.png
.. |PROJECTOR_MANAGER| image:: pics/projector_manager.png
.. |PROJECTOR_MANAGER_LIST| image:: pics/projector_manager_list.png
.. |PROJECTOR_NEW| image:: pics/projector_new.png
.. |PROJECTOR_NOT_CONNECTED_ERROR| image:: pics/projector_not_connected_error.png
.. |PROJECTOR_POWER_OFF| image:: pics/projector_power_off.png
.. |PROJECTOR_POWER_OFF_TILED| image:: pics/projector_power_off_tiled.png
.. |PROJECTOR_POWER_ON| image:: pics/projector_power_on.png
.. |PROJECTOR_POWER_ON_TILED| image:: pics/projector_power_on_tiled.png
.. |PROJECTOR_SETTINGS_TAB| image:: pics/projector_settings_tab.png
.. |PROJECTOR_SHOW| image:: pics/projector_show.png
.. |PROJECTOR_SHOW_TILED| image:: pics/projector_show_tiled.png
.. |PROJECTOR_SOURCE_EDIT_SINGLE| image:: pics/projector_source_edit_single.png
.. |PROJECTOR_SOURCE_EDIT_TABBED| image:: pics/projector_source_edit_tabbed.png
.. |PROJECTOR_SOURCE| image:: pics/projector_hdmi.png
.. |PROJECTOR_SOURCE_SELECT_SINGLE| image:: pics/projector_source_select_single.png
.. |PROJECTOR_SOURCE_SELECT_TABBED| image:: pics/projector_source_select_tabbed.png