IWMSServer Object (C#)

Article
09/04/2009

The IWMSServer object resides at the top of the server hierarchy. You can use it to specify and retrieve server properties and create objects needed to manage a server.

The IWMSServer object exposes the following properties and methods.

Property	Description
AllowClientsToConnect	Specifies and retrieves a Boolean value that indicates whether the server can receive client connections.
Authenticators	Retrieves an IWMSPluginsIWMSPlugins Object (C#) containing a collection of authentication plug-ins. You can use authentication plug-ins to establish the identity of clients that are requesting connections.
AvailableIPAddresses	Retrieves an IWMSAvailableIPAddressesIWMSAvailableIPAddresses Object (C#) containing a collection of IP addresses that can be used by the server to publish content.
CacheProxy	Retrieves an IWMSPlugins object containing a collection of cache plug-ins that can be used to control the caching policy of the server.
ControlProtocols	Retrieves an IWMSPlugins object containing a collection of control protocol plug-ins that can be used to interpret and respond to client requests.
CPUUtilization	Retrieves the CPU utilization of the computer on which the server is running.
CurrentCounters	Retrieves an IWMSServerCurrentCountersIWMSServerCurrentCounters Object (C#) containing information about the server counters.
DataSources	Retrieves an IWMSPlugins object containing a collection of data source plug-ins.
DefaultPath	Specifies and retrieves the default path name of the server.
DefaultPluginLoadType	Specifies and retrieves an enumeration value that indicates whether the server loads authentication, event notification, and authorization plug-ins as in-process or out-of-process objects.
DiagnosticEvents	Retrieves an IWMSDiagnosticEventsIWMSDiagnosticEvents Object (C#) that can be used to retrieve information about critical errors and warnings.
DownloadContent	Downloads audio or video media content locally using the WMS Archive Data Writer plug-in.
EnableReverseProxyMode	Specifies and retrieves a Boolean value indicating whether the server sends all requested content to cache and proxy plug-ins.
EventHandlers	Retrieves an IWMSPlugins object containing a collection of event notification and authorization plug-ins.
get_FileDescriptions	Retrieves an IWMSFileDescriptions collection of IWMSFileDescription objects that describe content files, playlist files, and directories.
get_FileType	Retrieves the type of a content file identified by a specific path.
Limits	Retrieves an IWMSServerLimitsIWMSServerLimits Object (C#) that contains the limits specified for the server.
MediaParsers	Retrieves an IWMSPlugins object containing a collection of media parser plug-ins.
MonikerName	Retrieves the moniker display name that can be used to create and initialize a IWMSServer object.
Name	Retrieves the server name.
OSProductType	Retrieves the operating system product type that Windows Media Services is running on.
OutgoingDistributionConnections	Retrieves an IWMSOutgoingDistributionConnections collection of the streams being distributed to the server.
PeakCounters	Retrieves an IWMSServerPeakCountersIWMSServerPeakCounters Object (C#) that contains methods that can be used to retrieve information collected by a running server.
Players	Retrieves an IWMSPlayers collection of IWMSPlayer objects, each of which contains specific information about a connected client.
PlaylistParsers	Retrieves an IWMSPlugins object containing a collection of playlist parser plug-ins. You can use a playlist parser plug-in to support a playlist format.
Properties	Retrieves an IWMSNamedValues collection of name-value pairs containing descriptive information about the server.
PublishingPoints	Retrieves an IWMSPublishingPoints collection of IWMSPublishingPoint objects.
RootDirectories	Retrieves an IWMSRootDirectories collection of server root directories.
StartTime	Retrieves the date and time at which the Windows Media server started.
Status	Retrieves an enumeration value indicating the current state of the server.
StreamFilters	Reserved for future use.
TotalCounters	Retrieves an IWMSServerTotalCounters object that can be used to obtain information about various totals maintained by the server.
UnicastDataSinks	Retrieves an IWMSPlugins object containing a collection of unicast data sink plug-ins that can be used to send data packets to a client.
Version	Retrieves the version number of the server.

Method	Description
CreatePlaylist	Creates an IXMLDOMDocumentIXMLDOMDocument Object (C#).
ExportXML	Creates an XML document containing the server configuration data.

Example

The following example illustrates how to create an IWMSServer object.

using Microsoft.WindowsMediaServices.Interop;
using System.Runtime.InteropServices;

// Declare variable.
WMSServer   Server;

try {
    // Create a new WMSServer object.
    Server = new WMSServerClass();
}
catch (COMException comExc) {
    // TODO: Handle COM exceptions.
}
catch (Exception e) {
    // TODO: Handle exceptions.
}

Share via

IWMSServer Object (C#)

Example

See Also

Concepts

Additional resources