WMS_EVENT_TYPE

  • Article

banner art

Previous Next

WMS_EVENT_TYPE

The WMS_EVENT_TYPE enumeration type identifies the internal event notices that can be sent by the server.

Syntax

  typedef enum WMS_EVENT_TYPE{
  WMS_EVENT_UNKNOWN_EVENT = 0x0000,
  WMS_EVENT_CONNECT = 1,
  WMS_EVENT_DISCONNECT = 2,
  WMS_EVENT_BEGIN_USER_SESSION = 3,
  WMS_EVENT_END_USER_SESSION = 4,
  WMS_EVENT_LOGICAL_URL_TRANSFORM = 5,
  WMS_EVENT_PHYSICAL_URL_TRANSFORM = 6,
  WMS_EVENT_DESCRIBE = 7,
  WMS_EVENT_OPEN = 8,
  WMS_EVENT_SELECT_STREAMS = 9,
  WMS_EVENT_INITIALIZE_PLAYLIST = 10,
  WMS_EVENT_PLAY = 11,
  WMS_EVENT_PAUSE = 12,
  WMS_EVENT_STOP = 13,
  WMS_EVENT_CLOSE = 14,
  WMS_EVENT_SET_PARAMETER = 15,
  WMS_EVENT_GET_PARAMETER = 16,
  WMS_EVENT_VALIDATE_PUSH_DISTRIBUTION = 17,
  WMS_EVENT_CREATE_DISTRIBUTION_DATA_PATH = 18,
  WMS_EVENT_DESTROY_DISTRIBUTION_DATA_PATH = 19,
  WMS_EVENT_LOG = 20,
  WMS_EVENT_SERVER = 21,
  WMS_EVENT_PUBLISHING_POINT = 22,
  WMS_EVENT_LIMIT_CHANGE = 23,
  WMS_EVENT_LIMIT_HIT = 24,
  WMS_EVENT_PLUGIN = 25,
  WMS_EVENT_PLAYLIST = 26,
  WMS_EVENT_CACHE = 27,
  WMS_EVENT_REMOTE_CACHE_OPEN = 28,
  WMS_EVENT_REMOTE_CACHE_CLOSE = 29,
  WMS_EVENT_REMOTE_CACHE_LOG = 30
};

Members

For information about each member of the enumeration type, see Internal Events or click the appropriate link in the following list:

Remarks

You can trap these events in a custom event notification and authorization plug-in after subscribing to them by using the GetAuthorizedEvents method on the IWMSEventAuthorizationPlugin interface or the GetHandledEvents method on the IWMSEventNotificationPlugin interface, depending on the type of plug-in you are creating.

The following table identifies the internal events that can be sent by a Windows Media server. The notification event and authorization event columns indicate whether a notification plug-in or an authorization plug-in can subscribe to the event. Authorization events that are associated with read/write access require that an authentication plug-in be enabled before authorization can occur. This is indicated in the table by the authentication required column.

Event Notification
event		 Authorization
event		 Authentication
required
WMS_EVENT_UNKNOWN_EVENT Yes No n/a
WMS_EVENT_CONNECT Yes Yes No
WMS_EVENT_DISCONNECT Yes No n/a
WMS_EVENT_BEGIN_USER_SESSION Yes Yes No
WMS_EVENT_END_USER_SESSION Yes No n/a
WMS_EVENT_LOGICAL_URL_TRANSFORM No Yes No
WMS_EVENT_PHYSICAL_URL_TRANSFORM No Yes No
WMS_EVENT_DESCRIBE Yes Yes Yes
WMS_EVENT_OPEN Yes Yes Yes
WMS_EVENT_SELECT_STREAMS No Yes Yes
WMS_EVENT_INITIALIZE_PLAYLIST No Yes No
WMS_EVENT_PLAY Yes Yes Yes
WMS_EVENT_PAUSE Yes No n/a
WMS_EVENT_STOP Yes No n/a
WMS_EVENT_CLOSE Yes No n/a
WMS_EVENT_SET_PARAMETER Yes No n/a
WMS_EVENT_GET_PARAMETER Yes Yes Yes
WMS_EVENT_VALIDATE_PUSH_DISTRIBUTION Yes Yes Yes
WMS_EVENT_CREATE_DISTRIBUTION_DATA_PATH Yes No No
WMS_EVENT_DESTROY_DISTRIBUTION_DATA_PATH Yes No n/a
WMS_EVENT_LOG Yes No n/a
WMS_EVENT_SERVER Yes No n/a
WMS_EVENT_PUBLISHING_POINT Yes No n/a
WMS_EVENT_LIMIT_CHANGE Yes No No
WMS_EVENT_LIMIT_HIT Yes No n/a
WMS_EVENT_PLUGIN Yes No n/a
WMS_EVENT_PLAYLIST Yes No n/a
WMS_EVENT_CACHE Yes No n/a
WMS_EVENT_REMOTE_CACHE_OPEN Yes No n/a
WMS_EVENT_REMOTE_CACHE_CLOSE Yes No n/a
WMS_EVENT_REMOTE_CACHE_LOG Yes No n/a

This enumeration completely identifies client events but only indicates the major category for a server event. For example, the server can indicate that a publishing point event occurred by using WMS_EVENT_PUBLISHING_POINT, but to determine the exact nature of the event, you must examine the WMS_COMMAND_CONTEXT_EVENT value in the command context to find the appropriate publishing point subevent from the WMS_PUBLISHING_POINT_EVENT_TYPE enumeration. The following list identifies enumerations that contain subevents.

Requirements

Header: wmsevent.h.

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003 family, Windows Server 2008 family.

See Also (General)

See Also (Visual Basic .NET)

See Also (C#)

See Also (C++)

Previous Next