[This is preliminary documentation and subject to change.]
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This documentation is applicable to PlayOn versions 3.3 and greater.
To create a plugin for PlayOn, you must create a .NET 2.0 assembly with classes that derive from the following base clases:
| Class | Description |
|---|---|
| AdCollection | Collection of AdItems |
| AdItem | An advertisement item that can be shown at a specific time. |
| DirectorAttribute | Player Director metadata. |
| MediaItem | A generic media item referencing videos, music or pictures, including advertisements. |
| PlaybackCollection | Collection of items to be played. |
| PlaybackDescriptor | Contains the media items and meta information about how to perform a playback operation. |
| PlaybackItem | A peice of media that can be played possibly with advertisements. |
| Plugin | Base plugin class providing quick access to common host methods and services. |
| PluginDirector | Directs a flash or silverlight player. |
| PluginDirector.PlayerBounds | Describes the bounds of the player to locate. |
| PluginHost | Provides common services to Plugin instances. |
| PluginImage | Providers an adapter for the System.Drawing.Image class that is serializable and supports loading directly from different sources. |
| PluginInfo | Describes meta information about a Plugin |
| PluginOptions | Provides options for plugins that will automatically be loaded and saved when needed. |
| PluginProvider | Provides access to media items from various devices. |
| PluginSettings | Specifies PlayOn Settings related information to the host. |
| ProviderAttribute | Metata information for Plugin Providers. |
| RegistryService | Provides access to the registry for plugins. |
| ScriptDirector | Script overridable PluginDirector. |
| ScriptProvider | Script overridable PluginProvider. |
| ServiceCollection | Provides a collection of services. |
| SettingsAttribute | Contains meta information about a Plugin. |
| VirtualAudioFile | An audio file that can exist in the virtual file system. |
| VirtualFileSystem | Provides a hierarchical collection of folders and media items that users can browse. |
| VirtualFolder | A folder that can exist in the virtual file system. |
| VirtualImageFile | An image file that can exist in the virtual file system. |
| VirtualVideoFile | A video file that can exist in the virtual file system. |
| Enumeration | Description |
|---|---|
| MediaFormat | Format of the media specified. |
| Quality | Quality level set by the user or automatically determined based on performance. |