Documentation updates for 1.0.5

docs/app-config.md

@@ -1,43 +1,121 @@
 <h1>Preferences</h1>
 
-App configuration Preferences are currently required to load the CSV file location through the `edu.nebraska.ImageViewer.dataURL` preferences key. All available keys are shown here: <br />
-
+App configuration Preferences are currently required to load the CSV file location through the `edu.nebraska.ImageViewer.dataURL` preferences key. All available keys are shown here:
+***
 **`edu.nebraska.ImageViewer.dataURL`** ***(required)*** <br />
-URL of the CSV file containing image information. There is no default option for this key and the App will not function as built without this value loaded. <br />
-<br />
+URL of the CSV file containing image information. There is no default option for this key and the App will not function as built without this value loaded. Your CSV file must be available over https.
+```xml
+<key>edu.nebraska.ImageViewer.dataURL</key>
+<string>https://link.to.preferences.csv</string>
+```
+***
+
 **`edu.nebraska.ImageViewer.imageTimer`** (optional) <br />
 Time (in seconds) of the image timer default. Image display time length is specified in the CSV file but will default to this option if nothing is entered in the file. <br />
-<br />
+```xml
+<key>edu.nebraska.ImageViewer.imageTimer</key>
+<integer>10</integer>
+```
+***
+
 **`edu.nebraska.ImageViewer.airplayViewHide`** (optional) <br />
-Boolean value set to false be default, override with a `true` value to hide the floating AirPlay box. <br />
-<br />
+Boolean value set to `false` by default, override with a `true` value to hide the floating AirPlay box. <br />
+```xml
+<key>edu.nebraska.ImageViewer.airplayViewHide</key>
+</true>
+```
+***
+
+**`edu.nebraska.ImageViewer.airplayViewHideOnVideo`** (optional) <br />
+Boolean value set to `false` by default, override with a `true` value to hide the floating AirPlay box only when a video is shown. <br />
+```xml
+<key>edu.nebraska.ImageViewer.airplayViewHideOnVideo</key>
+</true>
+```
+***
+
 **`edu.nebraska.ImageViewer.airplayViewTimer`** (optional) <br />
 Time (in seconds) between movements of the AirPlay box. The default time is set to `33` seconds. <br />
-<br />
+```xml
+<key>edu.nebraska.ImageViewer.airplayViewTimer</key>
+<integer>25</integer>
+```
+***
+
 **`edu.nebraska.ImageViewer.dataCheckTimer`** (optional) <br />
 Time (in seconds) between checks for updates in the CSV file. The default time is set to `180` seconds. <br />
-<br />
+```xml
+<key>edu.nebraska.ImageViewer.dataCheckTimer</key>
+<integer>180</integer>
+```
+***
+
 **`edu.nebraska.ImageViewer.defaultBackground`** (optional) <br />
 This value can be set to `DefaultBackgroundNoLogo` in order to remove the MDM Image Viewer logo from the default background image. <br />
-<br />
+```xml
+<key>edu.nebraska.ImageViewer.defaultBackground</key>
+<string>DefaultBackgroundNoLogo</string>
+```
+***
+
 **`edu.nebraska.ImageViewer.airplayDescription`** (optional) <br />
 Change the value of the description within the Airplay box. The default value is: `Wirelessly send what's on your iOS device or computer to this display using AirPlay. Learn more at help.apple.com/appletv.`  <br />
-<br />
+```xml
+<key>edu.nebraska.ImageViewer.airplayDescription</key>
+<string>Wirelessly send what's on your iOS device or computer to this display using AirPlay. Learn more at help.apple.com/appletv.</string>
+```
+***
+
 **`edu.nebraska.ImageViewer.airplaySubtitle`** (optional) <br />
 Change the value of the subtitle within the Airplay box. The default value is: `CHOOSE THIS APPLE TV`  <br />
-<br />
+```xml
+<key>edu.nebraska.ImageViewer.airplayDescription</key>
+<string>CHOOSE THIS APPLE TV</string>
+```
+***
+
 **`edu.nebraska.ImageViewer.airplayViewPositionX`** (optional) <br />
 Set the default position of the Airplay box on the 'X' axis. This should be a value between `0` and `1920`. The default value is `1354`.  <br />
-<br />
+```xml
+<key>edu.nebraska.ImageViewer.airplayViewPositionX</key>
+<integer>1354</integer>
+```
+***
+
 **`edu.nebraska.ImageViewer.airplayViewPositionY`** (optional) <br />
 Set the default position of the Airplay box on the 'Y' axis. This should be a value between `0` and `1080`. The default value is `638`.  <br />
-<br />
+```xml
+<key>edu.nebraska.ImageViewer.airplayViewPositionY</key>
+<integer>638</integer>
+```
+***
+
 **`edu.nebraska.ImageViewer.airplayViewMovement`** (optional) <br />
 The the movement behavior of the Airplay box. The following options are applicable:  <br />
 * `Fade` (Default) - Airiplay box fades out of one location on the screen and into another location.
 * `Slide` - Airplay box slides from one location on the screen to another.
 * `Inactive` - Airplay box has no movement and is left in the default position. Use with airplayViewPositionX and airplayViewPositionY to set the inactive locaiton on the screen.
-<br />
+```xml
+<key>edu.nebraska.ImageViewer.airplayViewMovement</key>
+<string>Fade</string>
+```
+***
+
+**`edu.nebraska.ImageViewer.playVideosInFull`** (optional) <br />
+Boolean value set to `false` by default. Videos will follow the "Duration" value set in the playlist file unless overridden with a `true` value in which case, the video will show in its entirety. <br />
+```xml
+<key>edu.nebraska.ImageViewer.playVideosInFull</key>
+</true>
+```
+***
+
+**`edu.nebraska.ImageViewer.playVideosWithAudio`** (optional) <br />
+Boolean value set to `false` by default, override with a `true` value to allow videos to play their audio. <br />
+```xml
+<key>edu.nebraska.ImageViewer.playVideosWithAudio</key>
+</true>
+```
+***
 
 
 <h3>Sample App Config:</h3>

docs/index.md

@@ -6,6 +6,8 @@
 
 Exhibit, previously known as "MDM Image Viewer", is a managed screensaver App for tvOS and a great alternative for conference rooms and public spaces where managed Apple TVs are locked to Conference Room Display mode. With Exhibit, you can customize the Apple TVs in your collaborative spaces by displaying curated images and videos to your users. The App also displays an AirPlay box similar to Conference Room Display mode so users can easily identify the device.
 
+Exhibit is available for download from the [tvOS App Store](https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=1439027089&mt=8).
+
 <h3>Features:</h3>
 
 * Run the App in single App mode and automate your processes for a zero-touch deployment.
@@ -18,7 +20,12 @@ Exhibit, previously known as "MDM Image Viewer", is a managed screensaver App fo
 * A Mobile Device Management (MDM) solution such as Jamf.
 * App Deployment through an MDM with required Managed App Config.
 
+<h3>Video Support (Beta):</h3>
+Video support for .mp4 videos has been added in version 1.0.5. There are several limitations when using this feature.
 
+- Offline caching is not available for videos. Exhibit currently uses Nuke for image caching but the ability to cache video does not exist in this framework nor does it exist in other frameworks due to limitations in tvOS.
+- High speed internet connection is recommended as loading video files is more network intensive than loading images. We do not suggest relying on Wi-Fi for video playback unless tested thoroughly.
+- If playback issues arise, try limiting the size of your individual video files.
 
 <h3>Sample Screenshot:<h3>
 <img src="https://github.com/qharouff/mdm-image-viewer/blob/master/Assets/screenshot_example.png?raw=true" width="650">

docs/playlist.md

@@ -5,10 +5,10 @@ The CSV file liked in the managed preferences should show values including a hea
 | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
 | Test Image | https://example.com/image.png | 0:00:10 | 1:00:00 | 1/1/18 0:00 | 12/31/99 23:59 | yes |
 
-`Name` - Name of the image. This value is strictly for reference. <br />
-`URL` - Web location of the image file. <br />
-`Duration` - Length of time to display the particular image in `H:MM:SS` format. <br />
+`Name` - Name of the media. This value is strictly for reference. <br />
+`URL` - Web location of the image or video file. <br />
+`Duration` - Length of time to display the particular media in `H:MM:SS` format. <br />
 `UpdateInterval` - *Currently Unused* <br />
-`StartOn` - Date and time to begin showing the specified image in the playlist in `M/d/yy H:mm` format. <br />
-`EndBy` - Date and time to stop showing the specified image in the playlist in `M/d/yy H:mm` format. <br />
+`StartOn` - Date and time to begin showing the specified media in the playlist in `M/d/yy H:mm` format. <br />
+`EndBy` - Date and time to stop showing the specified media in the playlist in `M/d/yy H:mm` format. <br />
 `Cache` - *Currently Unused* <br />

docs/release-notes.md

@@ -1,3 +1,19 @@
+## Version 1.0.5
+**(Dec 17, 2019)**
+
+**Changes**
+* Added support for video playback for `.mp4` videos.
+* Current image types supported: `.jpg` `.jpeg` `.png`.
+* Added several video related Managed App Config options (see below).
+
+**New Managed App Config Preferences**
+
+* `edu.nebraska.ImageViewer.airplayViewHideOnVideo` - Set to `true` to hide the AirPlay box only on videos.
+* `edu.nebraska.ImageViewer.playVideosInFull` - Set to `true` to ignore the playlist instructions and play videos in their entirety.
+* `edu.nebraska.ImageViewer.playVideosWithAudio` - Set to `true` to allow audio playback.
+
+***
+
 ## Version 1.0.4
 **(Dec 4, 2019)**