Share via

IBDA_Encoder::GetState method (bdaiface.h)

  • Article

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

Queries the current state of the Encoder Service.

Syntax

HRESULT GetState(
  [out] DWORD     *AudioBitrateMax,
  [out] DWORD     *AudioBitrateMin,
  [out] DWORD     *AudioBitrateMode,
  [out] DWORD     *AudioBitrateStepping,
  [out] DWORD     *AudioBitrate,
  [out] DWORD     *AudioMethodID,
  [out] DWORD     *AvailableAudioPrograms,
  [out] DWORD     *AudioProgram,
  [out] DWORD     *VideoBitrateMax,
  [out] DWORD     *VideoBitrateMin,
  [out] DWORD     *VideoBitrateMode,
  [out] DWORD     *VideoBitrate,
  [out] DWORD     *VideoBitrateStepping,
  [out] DWORD     *VideoMethodID,
  [out] DWORD     *SignalSourceID,
  [out] ULONGLONG *SignalFormat,
  [out] BOOL      *SignalLock,
  [out] LONG      *SignalLevel,
  [out] DWORD     *SignalToNoiseRatio
);

Parameters

[out] AudioBitrateMax

Receives the maximum audio bit rate.

[out] AudioBitrateMin

Receives the minimum audio bit rate.

[out] AudioBitrateMode

Receives the audio compression mode. The following values are defined.

Value Meaning
PBDA_Encoder_BitrateMode_Constant
0x00000001
 Constant bit rate (CBR) mode.
PBDA_Encoder_BitrateMode_Variable
0x00000002
 Variable bit rate (VBR) mode.
PBDA_Encoder_BitrateMode_Average
0x00000003
 Average bit rate (ABR) mode.

[out] AudioBitrateStepping

Receives the minimum increment for the audio bit rate.

[out] AudioBitrate

Receives the audio bit rate.

[out] AudioMethodID

Receives the active audio encoder method.

[out] AvailableAudioPrograms

Receives the number of audio programs available to the encoder.

[out] AudioProgram

Receives the program number of the audio program that is currently being encoded.

[out] VideoBitrateMax

Receives the maximum video bit rate.

[out] VideoBitrateMin

Receives the minimum video bit rate.

[out] VideoBitrateMode

Receives the video compression mode. For a list of values, see AudioBitrateMode.

[out] VideoBitrate

Receives the video bit rate.

[out] VideoBitrateStepping

Receives the minimum increment for the video bit rate.

[out] VideoMethodID

Receives the active video encoder method.

[out] SignalSourceID

Receives the identifier of the signal source. The value is an auxiliary connector ID, as returned by the IBDA_AUX::EnumCapability method.

[out] SignalFormat

Receives a value from the AnalogVideoStandard enumeration. This value specifies the analog video standard that is received on the auxiliary input.

[out] SignalLock

Receives the value TRUE if the device has a signal lock, and FALSE otherwise.

[out] SignalLevel

Receives the signal level in decibels.

[out] SignalToNoiseRatio

Receives a value between 0 and 100, indicating the signal-to-noise ratio.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows�7 [desktop apps only]
Minimum supported server Windows Server�2008�R2 [desktop apps only]
Target Platform Windows
Header bdaiface.h

See also

IBDA_Encoder