IAMTVAudio Interface

The IAMTVAudio interface is implemented on filters that provide TV audio capabilities. A TV audio filter is a device used to control settings unique to audio from television sources, including secondary audio program (SAP), and stereo or mono selection. These controls are generally found on devices external to the system audio mixer.

The IAMTVAudio interface enables applications to set audio types through the TVAudioMode enumerated data type.

Methods in Vtable Order

IUnknown methods	Description
QueryInterface	Retrieves pointers to supported interfaces.
AddRef	Increments the reference count.
Release	Decrements the reference count.
IAMTVAudio methods	Description
GetHardwareSupportedTVAudioModes	Retrieves a bitmask of the formats available in the hardware.
GetAvailableTVAudioModes	Retrieves a bitmask of the possible modes.
get_TVAudioMode	Retrieves the current TV audio mode.
put_TVAudioMode	Sets the current TV audio mode.

IAMTVAudio::GetHardwareSupportedTVAudioModes

IAMTVAudio Interface

Retrieves a bitmask of the formats available in the hardware.

Syntax

HRESULT GetHardwareSupportedTVAudioModes(
  long *plModes
  );

Parameters

plModes
[out] Pointer to a TVAudioMode type, identifying the audio mode.

Return Value

Returns an HRESULT value that depends on the implementation. HRESULT can be one of the following standard constants, or other values not listed.

E_FAIL Failure.
E_POINTER Null pointer argument.
E_INVALIDARG Invalid argument.
E_NOTIMPL Method isn't supported.
S_OK or NOERROR Success.

IAMTVAudio::GetAvailableTVAudioModes

IAMTVAudio Interface

Retrieves a bitmask of the possible modes.

Syntax

HRESULT GetAvailableTVAudioModes(
  long *plModes
);

Parameters

plModes
[out] Pointer to a TVAudioMode type, identifying the audio mode.

Return Value

Returns an HRESULT value that depends on the implementation. HRESULT can be one of the following standard constants, or other values not listed.

E_FAIL Failure.
E_POINTER Null pointer argument.
E_INVALIDARG Invalid argument.
E_NOTIMPL Method isn't supported.
S_OK or NOERROR Success.

IAMTVAudio::get_TVAudioMode

IAMTVAudio Interface

Retrieves the current TV audio mode.

Syntax

HRESULT get_TVAudioMode(
  long *plModes
);

Parameters

plModes
[out] Pointer to a TVAudioMode type, identifying the audio mode.

Return Value

Returns an HRESULT value that depends on the implementation. HRESULT can be one of the following standard constants, or other values not listed.

E_FAIL Failure.
E_POINTER Null pointer argument.
E_INVALIDARG Invalid argument.
E_NOTIMPL Method isn't supported.
S_OK or NOERROR Success.

IAMTVAudio::put_TVAudioMode

IAMTVAudio Interface

Sets the current TV audio mode.

Syntax

HRESULT put_TVAudioMode(
  long plModes
);

Parameters

plModes
[in] A TVAudioMode type, identifying the audio mode.

Return Value

Returns an HRESULT value that depends on the implementation. HRESULT can be one of the following standard constants, or other values not listed.

E_FAIL Failure.
E_POINTER Null pointer argument.
E_INVALIDARG Invalid argument.
E_NOTIMPL Method isn't supported.
S_OK or NOERROR Success.

E_FAIL	Failure.
E_POINTER	Null pointer argument.
E_INVALIDARG	Invalid argument.
E_NOTIMPL	Method isn't supported.
S_OK or NOERROR	Success.