Microsoft DirectX 8.0

IDVBSLocator Interface

This interface is implemented on the DVBSLocator object. It provides information to enable a tuner to acquire a DVBS transport stream.

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.
IDVBSLocator Method NameDescription
get_AzimuthRetrieves the azimuth setting used for positioning the satellite dish.
get_ElevationRetrieves the elevation of the satellite in tenths of a degree.
get_OrbitalPositionRetrieves the setting for the satellite's orbital position.
get_SignalPolarisationRetrieves the signal polarization.
get_WestPositionRetrieves a value indicating whether the orbital position is given in east or west longitude.
put_AzimuthAdjusts the azimuth setting used for positioning the satellite dish.
put_ElevationSets the elevation of the satellite in tenths of a degree.
put_OrbitalPositionSets the setting for the satellite's orbital position.
put_SignalPolarisationSets the signal polarization.
put_WestPositionSets the longitudinal position as west longitude or east longitude.

IDVBSLocator::get_Azimuth

IDVBSLocator Interface

Retrieves the azimuth setting used for positioning the satellite dish.

Syntax

HRESULT get_Azimuth(
    short* Azimuth
    );

Parameters

Azimuth
[out, retval] Pointer to a variable of type short that receives the azimuth in tenths of a degree.

Return Value

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

IDVBSLocator::get_Elevation

IDVBSLocator Interface

Retrieves the elevation of the satellite in tenths of a degree.

Syntax

HRESULT get_Elevation(
    short* Elevation
    );

Parameters

Elevation
[out, retval] Pointer to a variable of type short that receives the elevation setting in tenths of a degree.

Return Value

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

IDVBSLocator::get_OrbitalPosition

IDVBSLocator Interface

Retrieves the setting for the satellite's orbital position.

Syntax

HRESULT get_OrbitalPosition(
    short* longitude
    );

Parameters

longitude
[out, retval] Pointer to a variable of type short that receives the longitude setting in tenths of a degree.

Return Value

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

IDVBSLocator::get_SignalPolarisation

IDVBSLocator Interface

Retrieves the signal polarization.

Syntax

HRESULT get_SignalPolarisation(
    Polarisation* PolarisationVal
    );

Parameters

PolarisationVal
[out, retval] Pointer to a variable of type Polarisation that receives the polarization value.

Return Value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.
The Polarisation enumeration is defined in bdatypes.h as follows:
	typedef enum {
		BDA_POLARISATION_NOT_SET = -1,
		BDA_POLARISATION_NOT_DEFINED = 0,
		BDA_POLARISATION_LINEAR_H = 1,
		BDA_POLARISATION_LINEAR_V = 2,
		BDA_POLARISATION_CIRCULAR_L = 3,
		BDA_POLARISATION_CIRCULAR_R = 4,
		BDA_POLARISATION_MAX = 5
	} Polarisation;
    

IDVBSLocator::get_WestPosition

IDVBSLocator Interface

Retrieves a value indicating whether the orbital position is given in east or west longitude.

Syntax

HRESULT get_WestPosition(
    VARIANT_BOOL* WestLongitude
    );

Parameters

WestLongitude
[out, retval] Pointer to a variable of type VARIANT_BOOL; a value of true means "west longitude."

Return Value

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

IDVBSLocator::put_Azimuth

IDVBSLocator Interface

Adjusts the azimuth setting used for positioning the satellite dish.

Syntax

HRESULT put_Azimuth(
    short Azimuth
    );

Parameters

Azimuth
[in] Variable of type short that specifies the azimuth in tenths of a degree.

Return Value

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

IDVBSLocator::put_Elevation

IDVBSLocator Interface

Sets the elevation of the satellite in tenths of a degree.

Syntax

HRESULT put_Elevation(
    short Elevation
    );

Parameters

longitude
[in] Variable of type short that specifies for the locator the satellite's elevation in tenths of a degree.

Return Value

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

IDVBSLocator::put_OrbitalPosition

IDVBSLocator Interface

Sets the setting for the satellite's orbital position.

Syntax

HRESULT put_OrbitalPosition(
    short longitude
    );

Parameters

longitude
[in] Variable of type short that specifies the satellite's longitude in tenths of a degree.

Return Value

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

IDVBSLocator::put_SignalPolarisation

IDVBSLocator Interface

Sets the signal polarization.

Syntax

HRESULT put_SignalPolarisation(
    Polarisation PolarisationVal
    );

Parameters

PolarisationVal
[in] Variable of type Polarisation that specifies the signal polarization value.

Return Value

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

Remarks

The Polarisation enumeration is defined in bdatypes.h as follows:
	typedef enum {
		BDA_POLARISATION_NOT_SET = -1,
		BDA_POLARISATION_NOT_DEFINED = 0,
		BDA_POLARISATION_LINEAR_H = 1,
		BDA_POLARISATION_LINEAR_V = 2,
		BDA_POLARISATION_CIRCULAR_L = 3,
		BDA_POLARISATION_CIRCULAR_R = 4,
		BDA_POLARISATION_MAX = 5
	} Polarisation;
    

IDVBSLocator::put_WestPosition

IDVBSLocator Interface

Sets the longitudinal position as west longitude or east longitude.

Syntax

HRESULT put_WestPosition(
    VARIANT_BOOL WestLongitude
    );

Parameters

WestLongitude
[in] Variable of type VARIANT_BOOL that specifies whether the following longitude values that follow will be west or east longitude. True means "west longitude."

Return Value

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