IWMSAdminArchiveSink.Bandwidth (Visual Basic .NET)

The Bandwidth property retrieves the current bandwidth of the content being archived.

Integer = IWMSAdminArchiveSink.Bandwidth

Property Value

Integer containing the bandwidth in bits per second.

If this property fails, it throws an exception.

Number

Description

0x8000FFFF

The WMS Archive Data Writer plug-in cannot be found.

Remarks

This property is read-only.

Example

Imports Microsoft.WindowsMediaServices.Interop
Imports System.Runtime.InteropServices

Private Sub GetBandwidth()

    ' Declare variables.
    Dim Server As WMSServer
    Dim BCPubPoint As IWMSBroadcastPublishingPoint
    Dim Plugin As IWMSPlugin
    Dim AdminArchiveSink As IWMSAdminArchiveSink
    Dim iBandwidth As Integer

Try
    ' Create the WMSServer object.
    Server = New WMSServer()

    ' Add a new broadcast publishing point.
    BCPubPoint = Server.PublishingPoints.Add("NewPubPoint", _
         WMS_PUBLISHING_POINT_CATEGORY.WMS_PUBLISHING_POINT_BROADCAST, _
         "c:\wmpub\wmroot\playlist.wsx")

    ' Retrieve the plug-in to be configured.
    Plugin = BCPubPoint.BroadcastDataSinks.Item( _
         "WMS Archive Data Writer")

    ' Retrieve the custom interface of the plug-in.
    AdminArchiveSink = Plugin.CustomInterface

    ' Retrieve the current bandwidth of
    ' content being archived.
    iBandwidth = AdminArchiveSink.Bandwidth

Catch excCom As COMException
    ' TODO: Handle COM exceptions.
Catch exc As Exception
    ' TODO: Handle errors.
Finally
    ' TODO: Clean-up code goes here.
End Try

End Sub

Requirements

Reference: Add a reference to Microsoft.WindowsMediaServices.

Namespace: Microsoft.WindowsMediaServices.Interop.

Assembly: Microsoft.WindowsMediaServices.dll.

Library: WMSServerTypeLib.dll.

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

See Also

Reference

IWMSAdminArchiveSink Object (Visual Basic .NET)