IWMSPublishingPoint::get_EnableFEC

The get_EnableFEC method retrieves a value that indicates whether Forward Error Correction is enabled.

HRESULT get_EnableFEC(
  VARIANT_BOOL*  pVal
);

Arguments

pVal	[out] Pointer to a VARIANT_BOOL that indicates whether Forward Error Correction is enabled.

Return Value

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

Return code	Number	Description
E_POINTER	0x80004003	Indicates that pVal is a NULL pointer argument.
NS_E_INVALID_OPERATING_SYSTEM_VERSION	0xC00D1459L	Indicates that this feature is not supported on this operating system.
NS_E_PUBLISHING_POINT_REMOVED	0xC00D145AL	Indicates that the publishing point was already removed.

Remarks

The default value is TRUE. When this value is TRUE, a client may request Forward Error Correction at any time that the client is connected. Forward Error Correction is applicable only to RTSP connections and is not supported for outgoing distribution connection clients. Changes to this value apply only to new client connections. The maximum number of data packets that can be buffered before error correction is applied to them can be set by using the IWMSPublishingPointLimits::FECPacketSpan method.

Example

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

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

HRESULT         hr;
VARIANT_BOOL    bVal;
CComVariant     varIndex;
long            lCount;

// 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;

// Retrieve a pointer to the IWMSPublishingPoints interface
// and retrieve the total count of publishing points.
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 Boolean value indicating whether
    // Forward Error Correction is enabled.
    hr = pPubPoint->get_EnableFEC(&bVal);
    if (FAILED(hr)) goto EXIT;

    // Release temporary COM objects.
    pPubPoint->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

Reference

IWMSPublishingPoint Interface

IWMSPublishingPoints Interface