IWMEncPushDistributionStats.Property

Windows Media Encoder SDK banner art

The Property property retrieves statistics from the Windows Media server about push distribution.

Syntax

Variant = IWMEncPushDistributionStats.Property(strProperty)

Parameters

strProperty

[in]  String containing the property. You can use the following property strings.

String Description
PubPointStartTimeForPeak Time at which the publishing point started monitoring the peak counters.
PubPointCurrentConnectedPlayers The number of players currently connected to the publishing point.
PubPointPeakConnectedPlayers The peak number of players connected to the publishing point simultaneously.
PubPointTotalConnectedPlayers The total number of players connected to the publishing point.
PubPointPlayersLimit The maximum number of players that can connect to the publishing point simultaneously.
PubPointCurrentPlayerBandwidth The current total bandwidth being used by players currently connected to the publishing point.
PubPointPeakPlayerBandwidth The peak bandwidth allocated for player connections to the publishing point.
PubPointBandwidthLimit The maximum bandwidth limit for all player connections to the publishing point.
CurrentServerCPU The current CPU usage of the Windows Media server.

Property Value

A Variant that returns the property value.

Remarks

This property is read-only. You must retrieve the IWMEncPushDistributionStats object from the IWMEncStatistics2 object.

Example Code

' Create a WMEncoder Object.
  Dim Encoder As WMEncoder
  Set Encoder = New WMEncoder

' Retrieve an IWMEncStatistics object.
  Dim Stats As IWMEncStatistics2
  Set Stats = Encoder.Statistics

' Configure the encoding session.
' Configure push distribution.

' Retrieve an IWMEncPushDistributionStats object from the
' IWMEncStatistics2 object.
  Dim PushStats As IWMEncPushDistributionStats
  Set PushStats = Stats.PushDistributionStats

' You can create a timer control to retrieve the statistics
' (as follows) after you start the encoding session.
  Dim vStartTime As Variant
  Dim vCurPlayers As Variant
  Dim vPeakPlayers As Variant
  Dim vTTLPlayers As Variant
  Dim vPLimit As Variant
  Dim vCurBWidth As Variant
  Dim vPeakBWidth As Variant
  Dim vBWidthLim As Variant
  Dim vCPU As Variant
  vStartTime = PushStats.Property("PubPointStartTimeForPeak")
  vCurPlayers = PushStats.Property("PubPointCurrentConnectedPlayers")
  vPeakPlayers = PushStats.Property("PubPointPeakConnectedPlayers")
  vTTLPlayers = PushStats.Property("PubPointTotalConnectedPlayers")
  vPLimit = PushStats.Property("PubPointPlayersLimit")
  vCurBWidth = PushStats.Property("PubPointCurrentPlayerBandwidth")
  vPeakBWidth = PushStats.Property("PubPointPeakPlayerBandwidth")
  vBWidthLim = PushStats.Property("PubPointBandwidthLimit")
  vCPU = PushStats.Property("CurrentServerCPU")

Requirements

Reference: Windows Media Encoder

Library: wmenc.exe

See Also