Share via


WMS_Client_Event Class

The WMS_Client_Event class indicates that the client has connected to or disconnected from the server or changed the state of the presentation. Because this class generates the highest rate of event notices, you should minimize the use of it. The following table identifies the properties of this class.

Display name

Property name

Data type

Value

Description

Sub-event

SubEvent

uint32

Indicates a specific client event.

Connect=0

A client connected to the server.

Disconnect=1

The server has disconnected a client.

Play=2

A client has started to play a specific media file. You can use the Rate property to determine whether the client is fast-forwarding or rewinding.

Stop=3

A client stopped playing a specific media file.

Client ID

ClientID

uint32

Contains the client ID. A unique ID is generated for each client connection.

Client IP

ClientIP

String

Contains the IP address of the client in dotted quad format. This is the IP address returned by the socket used by the server to send data. Therefore, the IP address may not be that of the player, but that of a firewall, NAT (Network Address Translator), or router if any of these are in the network path to the client.

Client Port

ClientPort

String

Contains the port number of the client. This is the port number returned by the socket used by the server to send data. Therefore, the port number may not be that of the outgoing distribution connection client, but rather that of a firewall, NAT (Network Address Translator), or router if any of these are in the network path to the client.

File Name

FileName

String

Contains the physical URL of the presentation being streamed to the client. The physical URL identifies the location of the content on the disk. This value is only set for Play and Stop subevents.

Rate

Rate

real64

Contains the rate at which the client is playing the media content. A negative value indicates that the client is rewinding, and a value greater than one indicates that the client is fast-forwarding.

See Also

Concepts

External Events