Microsoft DirectX 8.0

IDVBTLocator Interface

This interface is implemented on the DVBTLocator object. It provides information to enable a tuner to acquire a DVBT transport stream. The data types are defined in bdatypes.h. (DVB-T is not supported in the version of Broadcast Architecture that ships with the Microsoft® DirectX® 8 SDK.)

ILocator Method NameDescription
CloneCreates a copy of the Locator.
get_CarrierFrequencyRetrieves the frequency of the RF signal.
get_InnerFECRetrieves the type of inner forward error correction that is used.
get_InnerFECRateRetrieves the inner FEC rate.
get_ModulationRetrieves the modulation type.
get_OuterFECRetrieves the type of outer forward error correction that is used.
get_OuterFECRateSets the outer FEC rate.
get_SymbolRateGets the QPSK symbol rate.
put_CarrierFrequencySets the frequency of the RF signal.
put_InnerFECSets the type of inner forward error correction that is used.
put_InnerFECRateSets the inner FEC rate.
put_ModulationSets the modulation type.
put_OuterFECSets the type of inner forward error correction that is used.
put_OuterFECRateSets the outer FEC rate.
put_SymbolRateSets the QPSK symbol rate.
IDVBTLocator Method NameDescription
get_BandwidthRetrieves the bandwidth of the frequency in megahertz, usually 7 or 8.
get_GuardRetrieves the guard interval.
get_HAlphaRetrieves the hierarchy alpha.
get_LPInnerFECRetrieves the inner FEC type of the low-priority stream.
get_LPInnerFECRateRetrieves the inner FEC rate of the low-priority stream.
get_ModeReceives the transmission mode.
get_OtherFrequencyInUseIndicates whether the frequency is being used by another DVB-T broadcaster.
put_BandwidthSets the bandwidth of the frequency in megahertz, usually 7 or 8.
put_GuardSets the guard interval.
put_HAlphaSets the hierarchy alpha.
put_LPInnerFECSets the inner FEC type of the low-priority stream.
put_LPInnerFECRateSets the inner FEC rate of the low-priority stream.
put_ModeSets the transmission mode.
put_OtherFrequencyInUseSpecifies whether the frequency is being used by another DVB-T broadcaster.

IDVBTLocator::get_Bandwidth

IDVBTLocator Interface

Retrieves the bandwidth of the frequency in megahertz, usually 7 or 8.

Syntax

HRESULT get_Bandwidth(
    long* BandWidthVal
    );

Parameters

BandWidthVal
[out, retval] Pointer to a variable of type long that receives the bandwidth value.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

IDVBTLocator::get_Guard

IDVBTLocator Interface

Retrieves the guard interval.

Syntax

HRESULT get_Guard(
    GuardInterval* GI
    );

Parameters

GI
[out, retval] Pointer that receives a valid GuardInterval value.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

Remarks

typedef enum GuardInterval {
    BDA_GUARD_NOT_SET = -1,
    BDA_GUARD_NOT_DEFINED = 0,
    BDA_GUARD_1_32 = 1, // Guard interval is 1/32
    BDA_GUARD_1_16, // Guard interval is 1/16
    BDA_GUARD_1_8, // Guard interval is 1/8
    BDA_GUARD_1_4, // Guard interval is 1/4
    BDA_GUARD_MAX,
} GuardInterval;

IDVBTLocator::get_HAlpha

IDVBTLocator Interface

Retrieves the hierarchy alpha.

Syntax

HRESULT get_HAlpha(
    HierarchyAlpha* Alpha
    );

Parameters

Alpha
[out, retval] A value from the HierarchyAlpha enum.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

Remarks

typedef enum HierarchyAlpha {
    BDA_HALPHA_NOT_SET = -1,
    BDA_HALPHA_NOT_DEFINED = 0,
    BDA_HALPHA_1 = 1, // Hierarchy alpha is 1.
    BDA_HALPHA_2, // Hierarchy alpha is 2.
    BDA_HALPHA_4, // Hierarchy alpha is 4.
    BDA_HALPHA_MAX,
} HierarchyAlpha;

IDVBTLocator::get_LPInnerFEC

IDVBTLocator Interface

Retrieves the inner FEC type of the low-priority stream.

Syntax

HRESULT get_LPInnerFEC(
    FECMethod* FEC
    );

Parameters

FEC
[out, retval] Pointer to a variable of type FECMethod that receives the FEC type.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

IDVBTLocator::get_LPInnerFECRate

IDVBTLocator Interface

Retrieves the inner FEC rate of the low-priority stream.

Syntax

HRESULT get_LPInnerFECRate(
    BinaryConvolutionCodeRate* FEC
    );

Parameters

FEC
[out, retval] Pointer to a BinaryConvolutionCodeRate value that receives the inner FEC rate.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

Remarks

BinaryConvolutionCodeRate is defined in bdatypes.h as follows:

typedef enum {
    BDA_BCC_RATE_NOT_SET = -1,
    BDA_BCC_RATE_NOT_DEFINED = 0,
    BDA_BCC_RATE_1_2 = 1,
    BDA_BCC_RATE_2_3 = 2,
    BDA_BCC_RATE_3_4 = 3,
    BDA_BCC_RATE_3_5 = 4,
    BDA_BCC_RATE_4_5 = 5,
    BDA_BCC_RATE_5_6 = 6,
    BDA_BCC_RATE_5_11 = 7,
    BDA_BCC_RATE_7_8 = 8,
    BDA_BCC_RATE_MAX = 9
} BinaryConvolutionCodeRate;

IDVBTLocator::get_Mode

IDVBTLocator Interface

Receives the transmission mode.

Syntax

HRESULT get_Mode(
    TransmissionMode* mode
    );

Parameters

mode
[out, retval] A value from the TransmissionMode enum.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

Remarks

typedef enum TransmissionMode {
    BDA_XMIT_MODE_NOT_SET = -1,
    BDA_XMIT_MODE_NOT_DEFINED = 0,
    BDA_XMIT_MODE_2K = 1, // Transmission uses 1705 carriers (use a 2K FFT)
    BDA_XMIT_MODE_8K, // Transmission uses 6817 carriers (use an 8K FFT)
    BDA_XMIT_MODE_MAX,
} TransmissionMode;

IDVBTLocator::get_OtherFrequencyInUse

IDVBTLocator Interface

Indicates whether the frequency is being used by another DVB-T broadcaster.

Syntax

HRESULT get_OtherFrequencyInUse(
    VARIANT_BOOL* OtherFrequencyInUseVal
    );

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

IDVBTLocator::put_Bandwidth

IDVBTLocator Interface

Sets the bandwidth of the frequency in megahertz, usually 7 or 8.

Syntax

HRESULT put_Bandwidth(
    long BandwidthVal
    );

Parameters

BandwidthVal
[in] Variable of type long that specifies the bandwidth.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

IDVBTLocator::put_Guard

IDVBTLocator Interface

Sets the guard interval.

Syntax

HRESULT put_Guard(
    GuardInterval GI
    );

Parameters

GI
[in] Variable of type GuardInterval that specifies the guard interval.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

IDVBTLocator::put_HAlpha

IDVBTLocator Interface

Sets the heirarchy alpha.

Syntax

HRESULT put_HAlpha(
    HierarchyAlpha Alpha
    );

Parameters

Alpha
[in] Variable of type HierarchyAlpha that specifies the hierarchy alpha.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

Remarks

typedef enum HierarchyAlpha {
    BDA_HALPHA_NOT_SET = -1,
    BDA_HALPHA_NOT_DEFINED = 0,
    BDA_HALPHA_1 = 1, // Hierarchy alpha is 1.
    BDA_HALPHA_2, // Hierarchy alpha is 2.
    BDA_HALPHA_4, // Hierarchy alpha is 4.
    BDA_HALPHA_MAX,
} HierarchyAlpha;

IDVBTLocator::put_LPInnerFEC

IDVBTLocator Interface

Sets the inner FEC type of the low-priority stream.

Syntax

HRESULT put_LPInnerFEC(
    FECMethod FEC
    );

Parameters

FEC
[in] Variable of type FECMethod that specifies the FEC type.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

IDVBTLocator::put_LPInnerFECRate

IDVBTLocator Interface

Sets the inner FEC rate of the low-priority stream.

Syntax

HRESULT put_LPInnerFECRate(
    BinaryConvolutionCodeRate FEC
    );

Parameters

FEC
[in] Variable of type BinaryConvolutionCodeRate that specifies the rate.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

IDVBTLocator::put_Mode

IDVBTLocator Interface

Sets the transmission mode.

Syntax

HRESULT put_Mode(
    TransmissionMode mode
    );

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

IDVBTLocator::put_OtherFrequencyInUse

IDVBTLocator Interface

Specifies whether the frequency is being used by another DVB-T broadcaster.

Syntax

HRESULT put_OtherFrequencyInUse(
    VARIANT_BOOL OtherFrequencyInUseVal
    );

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.