Util

Extends BinaryWriter to add additional data types, handle null strings and simplify use with ISerializable.

Static method to initialise the writer with a suitable MemoryStream.

Writes a string to the buffer. Overrides the base implementation so it can cope with nulls.

Writes a byte array to the buffer. Overrides the base implementation to send the length of the array which is needed when it is retrieved.

Writes a char array to the buffer. Overrides the base implementation to sends the length of the array which is needed when it is read.

Writes a DateTime to the buffer.

summary>

Writes an ArrayList to the buffer.

Writes a NameValueCollection to the buffer.

Writes an arbitrary object to the buffer. Useful where we have something of type "object" and don't know how to treat it. This works out the best method to use to write to the buffer.

Adds the SerializationWriter buffer to the SerializationInfo at the end of GetObjectData().

Extends BinaryReader to add additional data types, handle null strings and simplify use with ISerializable.

Static method to take a SerializationInfo object (an input to an ISerializable constructor) and produce a SerializationReader from which serialized objects can be read.

Reads a string from the buffer. Overrides the base implementation so it can cope with nulls.

Reads a byte array from the buffer, handling nulls and the array length.

Reads a char array from the buffer, handling nulls and the array length.

Reads a DateTime from the buffer.

Reads an ArrayList from the buffer.

Reads a NameValueCollection from the buffer.

Reads an object which was added to the buffer by WriteObject.

Manages property configuration tables. This class is little more than a simplified wrapper to a standard .NET Hashtable.

Returns a Hashtable of properties from the given StreamReader.

Loads a Hashtbale of properties from the given filename.

The name of the file to load from.

Returns the object for the given name, or the default value if none exists.

The name of the property to query. The default value for the property if none exists. The object value for the given name, or the default value if none exists.

Returns the string value for the given name, or the default value if none exists.

The name of the property to query. The default value for the property if none exists. The string value for the given name, or the default value if none exists.

Main interface for content provider plugins.

A given plugin must contain one and only one class that implements this interface. This class is able to provide metadata for hierarchical folder and video stream information suitable for display on a DLNA-compliant media renderer.

Returns a Payload for the given ID and request parameters.

This method is the main function for returning hierarchical metadata for folders and items. The Payload object that is returned must contain the appropriate metadata result from the query itself, as well as any potential SharedMediaFileInfo and SharedMediaFolderInfo objects. The ID requested, as provided from a previous GetSharedMedia query. Indicator whether children items should be included in the Payload. The starting index for items that should be included in the Payload. The total maximum count of items to be returned in the Payload. A Payload object that matches the requested query.

Resolves a given SharedMediaFileInfo if further logic is required to obtain the media URL or to include advertisement URL's, and returns XML information about these URL's.

The main video URL must include a "type" param that is either "wmp" (for Windows Media Player) or "fp" (for Flash Player) to indicate what type of player is used to display the given source media. The optional "startTime" param indicates a start time for the source media, in 100-nanoseconds. Note that the "startTime" param only works when the "type" is "wmp". Advertisments must include the timestamp in 100-nanoseconds for when they should be shown, relative to the main media playback, and also include a "type" parameter. The XML format is as follows:

The "type" parameter must be one of either "wmp" or "fp". The 100-nanoseconds parameters must be non-negative numerical values, and are expressed as seconds * 10^7. The SharedMediaFileInfo object that should be resolved. The XML description of URL's for video playback.

Sets the given IPlayOnHost for this plugin.

This method is guaranteed to be called once and only once, immediately after the plugin is instantiated. This gives all plugins the opportunity to initialize their state, and to query for custom properties via IPlayOnHost.Properties. The host object should be cached by the plugin instance for future reference. The IPlayOnHost instance that owns this plugin.

Returns the human-readable name of this plugin.

The name of this plugin.

Returns a unique ID for this provider, no longer than 24 characters.

The ID for a plugin should preferably be a combination of the unique domain namespace for the creator of the plugin and the human-readable name of the plugin, in all lower case and without spaces, and with a maximum of 24 characters. This ID must be prepended to all media and folder ID's, followed by a hyphen, and postpended with GUID's, as in pluginname-guid. Note that since the suggested plugin ID's are human readable, there is always a risk of name clashes with other plugins, so be sure to choose an ID that you are confident is "unique", but no longer than 24 characters. A plugin named "My Plugin" created by "example.com" could have a root level ID of "example.myplugin", and all sub-items and sub-folders with ID's as "example.myplugin-GUID". The string ID for this root level plugin, no longer than 24 characters.

Returns an Image icon for this content provider.

The image must be 78 x 78 pixels. PNG format images are preferred. This image will be potentially displayed by client media devices as the root folder for this plugin, if such display is possible for the given device. The Image for this plugin.

Main interface for content provider plugins to specify PlayOn Settings components and logic.

Returns whether the indicated login parameters work successfully.

Is never invoked unless IPlayOnProviderSettings.RequiresLogin is also true. If successful, the values will be encrypted and stored locally on the PC, and returned via the IPlayOnHost.Properties field as "username" and "password". The username or email address to login with. The password to login with. true if the login test works, false otherwise.

Checks to see if an update is available for the given plugin (presumably online).

This function should check (presumably somewhere online) to see if a newer version of the plugin is available for download. If so, it should return a URL to navigate to in the user's browser for upgrade instructions, or null if no update is available or required. Note that this method will be called every time PlayOn Settings is opened. It is the responsibility of this plugin to moderate any web requests that may otherwise overwhelm a web server with version check requests. A string value of a URL to browse to for download instructions; otherwise null

Allows a plugin to show a custom configuration window to set custom string value options.

Allows a plugin to show its own separate configuration window, and make changes to a NameValueCollection of keys and values, which will be cached and can be queried later through IPlayOnHost.Properties. When HasOptions returns true, an "Options" button will be available for this plugin in PlayOn Settings. When pressed, the button will invoke this function to retrieve a custom Control that will be displayed in a modal dialog for the user. This custom Control can initialize based on the arbitrary values in the options parameter. Any changes that the user makes through the user interface must then be reflected directly in the options reference, such that they can then be cached by PlayOn. It is critical that the supplied System.EventHandler be invoked whenever the user makes any relevant changes in the custom Control, so that an Apply/Save button can be appropriately enabled. IMPORTANT: The key names "username" and "password" are reserved and must not be used or modified through this method. Instead, these login parameters are used in the TestLogin method. A NameValueCollection of options as cached by PlayOn, and that can be modified through the custom Control. Any changes made by the user on the custom Control must be applied to this collection, so that PlayOn can cache the values. An EventHandler that should be invoked whenever changes are made by the user on the custom Control. This EventHandler is used to indicate to PlayOn Settings that changes have occurred, so that an Apply/Save button can be appropriately enabled. A Control that has configurable options that the user can adjust.

Returns an Image icon for this content provider.

The image must be minimum 48 x 48 pixels. PNG format images are preferred. The Image for this plugin, to be displayed in PlayOn Settings.

Returns an HTTP link to the provider's homepage.

This property should return an HTTP link without the prepended "http://". A string value URL link for this plugin provider.

Returns the display name that will show in the plugin tab of PlayOn Settings.

A string value for the name of this plugin provider.

Returns a unique ID used for caching and identifying the settings for this plugin.

The settings ID should be a GUID, to avoid name clashes with other plugins. This ID is only used for caching optional settings for the plugin, and is never displayed to the user. The string ID for the settings for this plugin.

Returns a text description that will show in the plugin tab of PlayOn Settings.

The description value should be a maximum of approximately 20 words. A string value description for this plugin.

Returns whether a login control should be displayed.

A plugin is optionally able to include account login information. If this property returns true then a login user control with test button will be displayed automatically on the configuration pane for this plugin in PlayOn Settings. IPlayOnProviderSettings.TestLogin true if this plugin should include an account login user control, false otherwise.

Returns whether this plugin has custom configurable options.

A plugin is optionally able to have arbitrary custom options in a separate window. If this property returns true then an "Options" button will be visible and enabled in PlayOn Settings for this plugin. When the user presses this button, the IPlayOnProviderSettings.ConfigureOptions method will be invoked. IPlayOnProviderSettings.ConfigureOptions true if this plugin has custom configurable options, false otherwise.

Main interface that hosts a content provider plugin.

Instructs the PlayOn host to log the given message for debugging purposes.

Writes to a file in the MediaMall application directory as the name of the plugin with a .log extension. The string value message to log.

Returns the maximum allowed bitrate (in kbps) for online video sources, as determined by the PlayOn host.

This property can be used for a plugin to determine which source media streams are appropriate for the given bandwidth and processing capabilities of the PC. The value 0 indicates there is no detected maximum. The maximum allowed bitrate in kbps as determined by the host. If there is no maximum, 0 is returned.

Returns arbitrary string properties that are bound to a hosted plugin.

The values returned in this field are those which can be set through IPlayOnProviderSettings.ConfigureOptions in PlayOn Settings. In addition, if the plugin has login data, these values will also be returned, keyed as "username" and "password". A NameValueCollection with keyed properties.

Manages keys for RSA cryptography.

Creates a new instance based on the given RSA pulbic key values in XML format

The XML-based key parameters

Creates a new instance based on the given modulus and exponent.

The RSA modulus The RSA exponent

Encrypts the given plaintext and returns the encrypted byte[]. Throws System.Security.Cryptography.CryptographicException

Returns the RSA exponent.

Returns the RSA modulus.

Utility class for easily extracting XML data from XML strings.

Returns the first SimpleElement within the given XML by the given tag name.

The XML string The tag name to search for

Parses XML.

Creates a new instance.

Returns the root SimpleElement from the given XmlTextReader.

XML tag.

Initializes a new instance with the given tag name.

Returns the value for the given attribute name.

Sets the value for the given attribute name.

The tag name.

The internal text within the tags.

SimpleElements collection of all children.

List of string based attributes on this tag.

Returns the full inner XML within this tag, if any.

Collection for SimpleElement instances.

Adds a new SimpleElement instance to the collection.

Returns the SimpleElement instance at the given index.

Converts this collection to an object[] array.

Contains arbitrary items in a list that can be sent between applications.

This is the main object that is used to return lists of SharedMediaFileInfo and SharedMediaFolderInfo instances, based on queries made through IPlayOnProvider.GetSharedMedia().

Initializes a new instance from deserialization.

Initializes a new instance with the given title and the given ArrayList of AbstractSharedMediaInfo objects.

The unique ID for this payload. The unique ID for the owner that represents this payload. The name for this payload. The total number of matching items for this payload. May be larger than the count of actual items in the embedded ArrayList. The ICollection of items for this payload. true if this payload represents a container, false otherwise.

Initializes a new instance with the given title and the given ArrayList of AbstractSharedMediaInfo objects.

The unique ID for this payload. The unique ID for the owner that represents this payload. The name for this payload. The total number of matching items for this payload. May be larger than the count of actual items in the embedded ICollection. The ICollection of items for this payload. true if this payload represents a container, false otherwise. The UPnP class (upnp:class) for this Payload and its items, or null for default.

Serializes this instance.

The List of AbstractSharedMediaInfo items contained in this instance.

Gets the ID of this Payload.

Gets the optional parent ID of this instance.

The display title of this instance.

The UPnP class for this instance.

This field is used to construct the upnp:class tag. By default, this value is "object.container.storageFolder".

The total count represented by this instance (not the count of the subset of items).

When a Payload object is returned for a query, this value represents the total matching items for that given query. If the query specifies a limited subset of items, the total count will still represent the total matching count. The total matching count for this Payload.

Returns true if this is a container, false otherwise.

Returns true if this Payload represents the results of a container search, false otherwise. (A metadata search of a single item will return false for IsContainer, and the first item in the Items array will contain the single AbstractSharedMediaInfo item.)

Contains metadata information suitable for a ContentDirectory service based on a local or online video file.

Contains metadata information suitable for a ContentDirectory service based on a physical media file or online media stream.

Abstract superclass for metadata for ContentDirectory items.

Initializes a new instance from deserialization.

Initializes a new instance.

The unique ID of this instance The unique ID of the owner of this instance The display name A list of optional string-based name/value pairs for arbitrary metadata. Can be null.

Serializes this instance.

Unique ID of this instance.

All ID's must conform to the format name-GUID, where name is the unique named ID for the root-level container that owns this instance, and GUID is a unique GUID. If this instance is a root level container itself, then the ID should just be name. An example ID for a root level container would be "myprovider". An example ID for a sub-container or item would be "myprovider-00000000-0000-0000-0000-000000000000". The unique ID for this instance.

Unique ID of the owner of this instance.

The unique ID for the owner of this instance. AbstractSharedMediaInfo.Id

Display name.

The display name for this instance.

A URL or local path to an image icon or thumbnail for this metadata.

The string-based name/value pairs for arbitrary and optional metadata.

The following keys are optional: Key Name Description ContentRating The MPAA rating. Rating The star or user rating. SortIndex An optional prefix to help with sorting, primarily for Xbox 360 (which always sorts alphabetically). A NameValueCollection of arbitrary and optional metadata.

Initializes a new instance from deserialization.

Initializes a new instance with the given metadata properties.

The sourceId parameter is used to recycle previously utilized ID's for the exact same source media. Typically, this field would be a unique key as defined by the content provider, and which is guaranteed to remain constant over time. Examples include a unique URL for a given piece of media, or a specific media ID assigned by the content provider. The unique ID of this instance. Required. The unique ID of the SharedMediaFolderInfo that contians this instance. Required. The display name. Required. The physical path of the file, or URL to the online stream. Required. An optional textual description of this media. If no description is available, set this to null or an empty string. A URL or local path to an image icon or thumbnail for this media. The date timestamp for this media. If none is available, set to DateTime.MinValue. A unique string that identifies this media as defined by the content provider. Required. A list of optional string-based name/value pairs for arbitrary metadata. Can be null.

Overridden from superclass to serialize this instance.

The physical file path or online media URL.

The physical file path or online media URL for this media.

A textual description of this media.

If no description is available, this property should be set to null or an empty string.

The date timestamp for this media.

A unique string that identifies this media as defined by the content provider.

This property is used to recycle previously utilized ID's for the exact same source media. Typically, this field would be a unique key as defined by the content provider, and which is guaranteed to remain constant over time. Examples include a unique URL for a given piece of media, or a specific media ID assigned by the content provider.

The size of this media, in bytes, or 0 if unknown.

Initializes a new instance from deserialization.

Initializes a new instance with the given metadata properties.

The unique ID of this instance. Required. The unique ID of the SharedMediaFolderInfo that contians this instance. Required. The display name. Required. The physical path of the file, or URL to the online media. Required. An optional textual description of this media. If no description is available, set this to null or an empty string. A URL or local path to an image icon or thumbnail for this media. The date timestamp for this media. If none is available, set to DateTime.MinValue. A unique string that identifies this media as defined by the content provider. Required. A list of optional string-based name/value pairs for arbitrary metadata. Can be null. The length of this media in milliseconds. Set to 0 if unavailable. The bitrate of this media (in bps). Set to 0 if unavailable. The resolution (dimenisions) of this media in pixels, expressed as "widthxheight". Set to null or empty string if unavailable. The genre of this media. Set to null or empty string if unavailable.

Overridden from superclass to serialize this instance.

The length of this media in milliseconds, or 0 if not available.

If this media has no known duration this property should be set to 0.

The bitrate of this media (in bps), or 0 if not available.

The genre of this media, if available.

The resolution (dimensions) of this media in pixels as "widthxheight".

Contains metadata information suitable for a ContentDirectory service based on a local or online audio file.

Initializes a new instance from deserialization.

Initializes a new instance with the given metadata properties.

The unique ID of this instance. Required. The unique ID of the SharedMediaFolderInfo that contians this instance. Required. The display name. Required. The physical path of the file, or URL to the online media. Required. An optional textual description of this media. If no description is available, set this to null or an empty string. A URL or local path to an image icon or thumbnail for this media. The date timestamp for this media. If none is available, set to DateTime.MinValue. A unique string that identifies this media as defined by the content provider. Required. A list of optional string-based name/value pairs for arbitrary metadata. Can be null. The length of this media in milliseconds. Set to 0 if unavailable. The bitrate of this media (in bps). Set to 0 if unavailable. The genre of this media. Set to null or empty string if unavailable. The album of this media. Set to null or empty string if unavailable. The artist of this media. Set to null or empty string if unavailable. The track number of this audio, if relevant. Set to -1 if unavailable.

Overridden from superclass to serialize this instance.

The length of this media in milliseconds.

If this media has no known duration this property should be set to 0.

The bitrate of this media (in bps), or 0 if not available.

The genre of this media, if available.

The album of this media, if available.

The artist of this media, if available.

The track number of this media, if available.

Contains metadata information suitable for a ContentDirectory service based on a local or online image file.

Initializes a new instance from deserialization.

Initializes a new instance with the given metadata properties.

The unique ID of this instance. Required. The unique ID of the SharedMediaFolderInfo that contians this instance. Required. The display name. Required. The physical path of the file, or URL to the online image. Required. An optional textual description of this image. If no description is available, set this to null or an empty string. A URL or local path to an image icon or thumbnail for this image. The date timestamp for this image (eg. "Date Picture Taken"). If none is available, set to DateTime.MinValue. A unique string that identifies this image as defined by the content provider. Required. A list of optional string-based name/value pairs for arbitrary metadata. Can be null. The size of this image in pixels as "widthxheight". Can be null or empty if unknown.

Overridden from superclass to serialize this instance.

The dimensions of this media in pixels as "widthxheight".

Contains metadata information suitable for a ContentDirectory service based on a physical or virtual folder.

Initializes a new instance from deserialization.

Initializes a new instance with the given metadata properties.

The unique ID of this instance. The unique ID of the SharedMediaFolderInfo that contains this instance. The display name. The number of items contained within this folder.

Initializes a new instance with the given metadata properties.

The unique ID of this instance. The unique ID of the SharedMediaFolderInfo that contains this instance. The display name. The number of items contained within this folder. Optional path or URL to an image that represents this folder. Can be null. A list of optional string-based name/value pairs for arbitrary metadata. Can be null.

Overridden from superclass to serialize this instance.

The number of items contained within this folder.

The number of items contained within this folder. Includes both subfolders and items.