INSTALLING THE ADD-ONS
Important Note: For those who have been installing the version from GitHub, you will need to manually remove the
script.cinemavision directory from your
userdata\addon_data directory. If you do not do this before running the add-on, it will likely not work correctly.
Stable Releases
Follow these steps to install CinemaVision from the Kodi Repository:
- Settings
- Add-ons
- Get Add-ons
- Install from Repository
- Program Add-ons
- CinemaVision
- Install
Follow these steps to install CinemaVision Launcher from the Kodi Repository:
- Settings
- Add-ons
- Get Add-ons
- Install from Repository
- Context Menu Add-ons
- CinemaVision Launcher
- Install
Development Releases
If you'd like to help us test new features and iron out the bugs, follow these steps to install CinemaVision:
- Download the latest release from the CinemaVision website
- Open Kodi
- Settings
- Add-ons
- Get Add-ons
- Install from zip file
- Browse to the zip file that you downloaded from the CinemaVision website
- Install the zip file
If you'd like to help us test new features and iron out the bugs, follow these steps to install CinemaVision Launcher:
- Download the latest release from the CinemaVision website
- Open Kodi
- Settings
- Add-ons
- Get Add-ons
- Install from zip file
- Browse to the zip file that you downloaded from the CinemaVision website
- Install the zip file
UNINSTALLING THE ADD-ONS
Important Note: If for some reason you need/want to force an uninstall of the old version of CinemaVision, you must first uninstall the CinemaVision Launcher if you have that installed.
Using Kodi Add-on Manager
Uninstall CinemaVision
Uninstall CinemaVision Launcher- Settings
- Add-ons
- My Add-ons
- Program Add-ons
- CinemaVision Launcher
- Uninstall
Uninstall Manually
Delete CinemaVision Add-ons & Data (Windows)- Close Kodi
- Browse to your userdata\addon_data directory
- Delete the context.cinemavision directory if it exists
- Delete the script.cinemavision directory if it exists
- Browse to your userdata\addon_data directory
- Browse up two directory levels
- Browse to the addons directory
- Delete the context.cinemavision directory if it exists
- Delete the script.cinemavision directory if it exists
Delete CinemaVision Add-ons & Data (OpenELEC)- Settings
- Appearance
- File lists
- Enable Allow file renaming and deletion
- Enable Show hidden files and directories
- Hit the Backspace button on your keyboard until you are at the main menu
- Settings
- File manager
- Browse to STORAGE
- Browse to the .kodi directory
- Browse to the addons directory
- Delete the context.cinemavision directory if it exists
- Delete the script.cinemavision directory if it exists
- Browse up one level
- Browse to the userdata directory
- Browse to the addon_data directory
- Delete the context.cinemavision directory if it exists
- Delete the script.cinemavision directory if it exists
- Hit the Backspace button on your keyboard until you are at the main menu
- Settings
- Appearance
- File lists
- Disable Allow file renaming and deletion
- Disable Show hidden files and directories
DISABLING THE ADD-ONS
Disable CinemaVision- Settings
- Add-ons
- My Add-ons
- CinemaVision
- Disable
Disable CinemaVision Launcher- Settings
- Add-ons
- My Add-ons
- CinemaVision Launcher
- Disable
CONFIGURING THE ADD-ONS
Register for free on the CinemaVision website to view our
Guide for
How to Configure CinemaVision, and much more.
Adding & Updating Content
Any time you add new content to the CinemaVision content directories, you need to update content in order for CinemaVision to catalog that new content and make it available for use.
- Settings
- Add-ons
- My Add-ons
- Program Add-ons
- CinemaVision
- Configure
- General
- Update Content
Excluding Content
Exclude a directory Add
_Exclude to the beginning of the directory name.
Exclude a file Add
._Exclude to the end of the extension.
CONFIGURING THE EXPERIENCE
CinemaVision comes with default 2D and 3D sequences built in, but you may want to create a custom sequence to fit your needs and change your preshow. Here's an explanation of each module to get you started.
Register for free on the CinemaVision website to view our
Guide for
Understanding CinemaVision Modules & Sequences, and much more.
Action Module
This module will broadcast a command to your home automation solution, a script, an add-on, or an application installed on your HTPC. It currently works with any home automation solution that has a RESTful API, or can be manipulated using HTTP calls or Python scripts.
Audio Format Bumper Module
This module will detect the audio codec of your feature presentation and play the appropriate audio format bumpers for that audio codec.
Command Module
This module will allow you to customize your sequence using conditional statements, which can be used to have the add-on automatically jump forwards, or backwards in the sequence without any user interaction.
Feature Module
This module represents your queued feature presentation. If this module does not exist in your sequence, the feature(s) you select
will not play.
Trailer Module
This module will allow you to customize the number, quality, and source of trailers to be shown.
Trivia Module
This module will allow you to customize your trivia slideshow.
Video Bumper Module
This module will allow you to play any supported video file, as well as any stream from
this list of websites. While a large number of streaming websites are included, we will currently only address issues with larger streaming sites such as YouTube and Vimeo.
PLAYING THE EXPERIENCE
Launching CinemaVision from Inside the Add-on
Install the CinemaVision Add-on from the Kodi Repository using the instructions above. Queue a Movie or TV Show to play, and then follow these instructions:
- Settings
- Add-ons
- My Add-ons
- Program Add-ons
- CinemaVision
- Launch
- Hit C to open the Context Menu
- Play
Launching CinemaVision from the Movie Information Screen
This method requires your skin to have built-in support for CinemaVision. Install the CinemaVision Add-on from the Kodi Repository using the instructions above, and then follow these instructions:
- Browse to the Movie that you want to play using CinemaVision.
- Bring up the Movie Information screen.
- Press I on the keyboard.
- Or press C on the keyboard to bring up the Context Menu, and then choose Movie Information.
- Find the button labeled CinemaVision, and click it.
Launching CinemaVision from the Context Menu
Install the CinemaVision Add-on from the Kodi Repository using the instructions above, and then
install the CinemaVision Launcher Add-on from the Kodi Repository using the instructions above.
- Either queue several movies, or put the focus on the single movie you'd like to play.
- Hit C to open the Context Menu.
- Select CinemaVision.
HOTKEYS
When Editing the Sequence
C Opens the Context Menu within the add-on.
Escape When editing the settings of a module,
exit to Sequence without saving changes.
Backspace When editing the settings of a module,
exit to Sequence saving changes.
During Trivia Image Playback
Up Arrow This performs a
big skip (3 sets of slides) backwards through queued trivia slides.
Down Arrow This performs a
big skip (3 sets of slides) forwards through queued trivia slides.
Left Arrow This performs a
single skip (1 single slide) backwards through queued trivia slides.
Right Arrow This performs a
single skip (1 single slide) forwards through queued trivia slides.
Page Up Single Press This will initiate a fade out of the music, and trivia to gradually skip to the next module in the sequence.
Page Up Double Press This will immediately skip to the next module in the sequence without a gradual fade.
Page Down This will initiate a skip backwards through modules in the sequence.
Space Pause trivia & music playback.
During Sequence & Trivia Video Playback
Page Up Skip forwards through trivia video slides, or modules in the sequence.
Page Down Skip backwards through trivia video slides, or modules in the sequence.
SKIN INTEGRATION & DEVELOPER INFORMATION
Players with CinemaVision Integration
Kodi VideoPlayer: The standard Kodi player, new in Kodi version 17.
DSPlayer: The team behind DSPlayer, a DirectShow-based media player for Kodi, has modified the player to work with CinemaVision!
Players without CinemaVision Integration
HiMedia Wrapper: The HiMedia team will need to modify their wrapper to work properly with Kodi add-ons.
Skins with CinemaVision Integration
This is a list of the skins that have integrated the CinemaVision add-on. This will require
no work on the part of an end-user, and should be seamless once the CinemaVision add-on has been installed.
If you're a skinner and you've integrated CinemaVision into your skin, please let us know so we can add you to the list!
Software with CinemaVision Integration
This is a list of the software that has integrated in some way with the CinemaVision add-on. This will require
no work on the part of an end-user, and should be seamless once the CinemaVision add-on has been installed.
If you're a developer and you've integrated CinemaVision into your software, please let us know so we can add you to the list!
How to Integrate CinemaVision
We recommend that you add a button to your skins
DialogVideoInfo.xml file. The button code below should work, and of course you'll want to change the ID (listed as
00 below) of the button so that it doesn't conflict with another button in your skin.
PHP Code:
<control type="button" id="00">
<description>CinemaVision</description>
<include>ButtonInfoDialogsCommonValues</include>
<label>CinemaVision</label>
<onclick>Dialog.Close(MovieInformation)</onclick>
<onclick>RunScript(script.cinemavision,experience)</onclick>
<visible>System.HasAddon(script.cinemavision) + [Stringcompare(ListItem.DBType,movie) | Stringcompare(ListItem.DBType,tvshow) | Stringcompare(ListItem.DBType,season) | Stringcompare(ListItem.DBType,episode)]</visible>
</control>
How to Suppress the Busy Dialog & Pop-ups
While both of these things do improve the experience while CinemaVision is running, please keep in mind that your users will not know what's happening when a video is buffering, for example. Use these options at your discretion.
These options should be added as a direct child of the <window> tag in the XML file. If you're unsure of where in the files to add the code, add it on the line before the <controls> tag. If you know what you're doing, add it where ever you need it to be.
We recommend that you add the option to suppress the busy dialog to your skins
DialogBusy.xml file. To suppress the busy dialog when CinemaVision is running, add the following to the DialogBusy.xml file:
PHP Code:
<visible>IsEmpty(Window(Home).Property(script.cinemavision.running))</visible>
We also recommend that you add the option to suppress pop-up notifications to your skins
DialogKaiToast.xml file. To suppress pop-up notifications while CinemaVision is running, add the following to the DialogKaiToast.xml file:
PHP Code:
<visible>IsEmpty(Window(Home).Property(script.cinemavision.running))</visible>
We
do not recommend that you add the option to suppress your buffering dialog as this also suppresses the information and seek bar that is seen when you pause your content. If you want to do this despite our objection, here's how. To suppress the buffering, content information, and seek bar dialogs add the following to your skins
DialogSeekBar.xml file:
PHP Code:
<visible>IsEmpty(Window(Home).Property(script.cinemavision.running))</visible>
Methods for Running CinemaVision
These methods will determine the type of content, and pass that to CinemaVision for processing. Hopefully this saves some work for the developers.
RunScript(script.cinemavision,experience) This will launch CinemaVision using the default sequence.
- This method reads from the Kodi playlist, falling back to the current selection.
RunScript(script.cinemavision,selection) This will use the ID from the current ListItem to launch CinemaVision.
- This method forces the selection, ignoring the Kodi playlist.
RunScript(script.cinemavision,movieid=<id>[|<id>|<id>|...]) This will allow you to specify the movie ID when launching CinemaVision.
- Use this if you are not getting the ID via ListItem.DBID within the selected container.
RunScript(script.cinemavision,episodeid=<id>[|<id>|<id>|...]) This will allow you to specify the episode ID when launching CinemaVision.
- Use this if you are not getting the ID via ListItem.DBID within the selected container.
RunScript(script.cinemavision,dbtype=$INFO[ListItem.DBType],dbid=$INFO[ListItem.DBID])- This method will launch Cinemavision to play the media specified using the default sequence..
RunScript(script.cinemavision,[experience,selection,movieid,episodeid],nodialog) Using the
nodialog switch will suppress the Queue Dialog when launching CinemaVision.
CinemaVision Properties
CinemaVision Running Status
This property returns a value of
True if CinemaVision is running.
PHP Code:
!IsEmpty(Window(Home).Property(script.cinemavision.running))
CinemaVision Module Status
This property returns the
type of the module
running currently in the sequence. (i.e. video, trivia, feature, trailer, audioformat)
PHP Code:
Window(Home).Property(script.cinemavision.module.current)
This property returns the
name of the module
running currently in the sequence.
PHP Code:
Window(Home).Property(script.cinemavision.module.current.name)
This property returns the
type of the module
running next in the sequence. (i.e. video, trivia, feature, trailer, audioformat)
PHP Code:
Window(Home).Property(script.cinemavision.module.next)
This property returns the
name of the module
running currently in the sequence.
PHP Code:
Window(Home).Property(script.cinemavision.module.next.name)
CinemaVision Feature Status
This property returns the
title of the feature
running next in the sequence.
PHP Code:
Window(Home).Property(script.cinemavision.feature.next.title)
This property returns the
Database Type of the feature
running next in the sequence. (i.e. movie, tvshow)
PHP Code:
Window(Home).Property(script.cinemavision.feature.next.dbtype)
This property returns the
Database ID of the feature
running next in the sequence.
PHP Code:
Window(Home).Property(script.cinemavision.feature.next.dbid)
This property returns the
path of the feature
running next in the sequence.
PHP Code:
Window(Home).Property(script.cinemavision.feature.next.path)
iOS, Android, and Other Kodi Remotes
We have come up with our best practices for adding CinemaVision support to your remote software. First, here's a quick overview of how CinemaVision works:
When CinemaVision is launched, it get's the list of videos from the Kodi video playlist or, if that is empty, it checks for a selected ListItem to get video info. If enabled, it then displays the list of those videos for the user to edit. When the user selects Play, this list is used when generating the video sequence. The CinemaVision add-on does not really use a playlist, rather it gets the movies from the Kodi playlist.
Best Practices
From the remote, you should add the content to the Kodi playlist and then display a dialog similar to the add-on's dialog for editing the Kodi playlist. We have added the ability to pass a list of multiple movie IDs and episode IDs. When building a list of multiple IDs, you would keep that list of IDs on the remote rather than passing them one at a time to the add-on.
Launching CinemaVision from a Remote via JSON
Code:
{"jsonrpc": "2.0", "method": "Addons.ExecuteAddon", "params": { "addonid": "script.cinemavision", "params": ["experience"]}, "id": 1}