IWMSPublishingPointLimits::put_PlayerBandwidth

  • Article

banner art

Previous Next

IWMSPublishingPointLimits::put_PlayerBandwidth

The put_PlayerBandwidth method specifies the maximum total player bandwidth, in Kbps, permitted for the publishing point.

Syntax

  HRESULT put_PlayerBandwidth(
  long  newVal
);

Parameters

newVal

[in] long containing the maximum permitted bandwidth, in Kbps.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code Number Description
E_INVALIDARG 0x80070057 Indicates that newVal is an invalid argument.

Remarks

By default, the parameter is –1, indicating that there is no limit on the maximum bandwidth permitted.

Example Code

#include <windows.h>
#include <atlbase.h>    // Includes CComVariant.
#include "wmsserver.h"

// Declare variables and interfaces.
IWMSServer                  *pServer;
IWMSPublishingPoints        *pPubPoints;
IWMSPublishingPoint         *pPubPoint;
IWMSPublishingPointLimits   *pLimits;

HRESULT         hr;
CComVariant     varIndex;
long            lCount;
long            lValue;

// Initialize the COM library and retrieve a pointer
// to an IWMSServer interface.
hr = CoInitialize(NULL);
hr = CoCreateInstance(CLSID_WMSServer,
                      NULL,
                      CLSCTX_ALL,
                      IID_IWMSServer,
                      (void **)&pServer);
if (FAILED(hr)) goto EXIT;



hr = pServer->get_PublishingPoints(&pPubPoints);
if (FAILED(hr)) goto EXIT;
hr = pPubPoints->get_Count(&lCount);
if (FAILED(hr)) goto EXIT;

// Retrieve information about each publishing point.
for (long x = 0; x < lCount; x++)
{
    varIndex = x;
    hr = pPubPoints->get_Item(varIndex, &pPubPoint);
    if (FAILED(hr)) goto EXIT;

    // Retrieve a pointer to the IWMSPublishingPointLimits
    // interface for the publishing point.
    hr = pPubPoint->get_Limits(&pLimits);
    if (FAILED(hr)) goto EXIT;

    // Set the total bandwidth limit for client connections.
    hr = pLimits->put_PlayerBandwidth(5068);
    if (FAILED(hr)) goto EXIT;

    // Release temporary COM objects.
    pPubPoint->Release();
    pLimits->Release();
}

EXIT:
    // TODO: Release temporary COM objects and uninitialize COM.

Requirements

Header: wmsserver.h.

Library: WMSServerTypeLib.dll.

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

See Also

Previous Next