IAMAnalogVideoEncoder Interface

The IAMAnalogVideoEncoder interface controls a video encoder filter in video capture operations when an application is streaming data to disk and sending it back out to videotape. It provides methods for setting the video standard and enabling or disabling closed captioning and copy protection.

Methods in Vtable Order

IUnknown methods Description
QueryInterface Retrieves pointers to supported interfaces.
AddRef Increments the reference count.
Release Decrements the reference count.

IAMAnalogVideoEncoder methods Description

get_AvailableTVFormats Retrieves the analog video standards (NTSC/M, PAL/B, SECAM/K1, and so on) supported by the encoder.
put_TVFormat Sets the encoder to a particular analog video standard.
get_TVFormat Retrieves the analog video standard that the encoder is currently set to.
put_CopyProtection Sets the level of copy protection for the encoder.
get_CopyProtection Determines whether copy protection is currently enabled.

put_CCEnable Enables or disables closed captioning.
get_CCEnable Determines whether closed captioning is currently enabled.

IUnknown methods	Description
QueryInterface	Retrieves pointers to supported interfaces.
AddRef	Increments the reference count.
Release	Decrements the reference count.
IAMAnalogVideoEncoder methods	Description
get_AvailableTVFormats	Retrieves the analog video standards (NTSC/M, PAL/B, SECAM/K1, and so on) supported by the encoder.
put_TVFormat	Sets the encoder to a particular analog video standard.
get_TVFormat	Retrieves the analog video standard that the encoder is currently set to.
put_CopyProtection	Sets the level of copy protection for the encoder.
get_CopyProtection	Determines whether copy protection is currently enabled.
put_CCEnable	Enables or disables closed captioning.
get_CCEnable	Determines whether closed captioning is currently enabled.

IAMAnalogVideoEncoder::get_AvailableTVFormats

IAMAnalogVideoEncoder Interface

Retrieves the analog video standards (NTSC/M, PAL/B, SECAM/K1, and so on) supported by the encoder.

Syntax

HRESULT get_AvailableTVFormats(
    long *lAnalogVideoStandard
);

Parameters

lAnalogVideoStandard
[out] Pointer to a variable that receives any combination of the values defined in the AnalogVideoStandard enum.

Return Value

Returns an HRESULT value.

IAMAnalogVideoEncoder::get_CCEnable

IAMAnalogVideoEncoder Interface

Determines whether closed captioning is currently enabled.

Syntax

HRESULT get_CCEnable(
    long *lCCEnable
);

Parameters

lCCEnable
[out] Pointer to a variable that receives the current status of closed captioning on the encoder; 1 means closed captioning is enabled and 0 means it is disabled.

Return Value

Returns an HRESULT value.

IAMAnalogVideoEncoder::get_CopyProtection

IAMAnalogVideoEncoder Interface

Determines whether copy protection is currently enabled on the encoder.

Syntax

HRESULT get_CopyProtection(
    long *lVideoCopyProtection
);

Parameters

lVideoCopyProtection
[out] Pointer to a variable that receives the current copy protection level, as defined in the AM_COPY_MACROVISION_LEVEL enumeration.

Return Value

Returns an HRESULT value.

IAMAnalogVideoEncoder::get_TVFormat

IAMAnalogVideoEncoder Interface

Retrieves the analog video standard that the encoder is currently set to (NTSC/M, PAL/B, SECAM/K1, and so on).

Syntax

HRESULT get_TVFormat(
    long *plAnalogVideoStandard
);

Parameters

plAnalogVideoStandard
[out] Pointer to a variable that receives the encoder's current video standard.

Return Value

Returns an HRESULT value.

Remarks

Possible values and their meaning are defined in the AnalogVideoStandard enumeration.

IAMAnalogVideoEncoder::put_CCEnable

IAMAnalogVideoEncoder Interface

Enables or disables closed captioning.

Syntax

HRESULT put_CCEnable(
    long lCCEnable
);

Parameters

lCCEnable
[in] Value indicating whether to turn closed captioning on or off; 1 means "on" and 0 means "off."

Return Value

Returns an HRESULT value.

IAMAnalogVideoEncoder::put_CopyProtection

IAMAnalogVideoEncoder Interface

Sets the level of copy protection for the encoder.

Syntax

HRESULT put_CopyProtection(
    long lVideoCopyProtection
);

Parameters

lVideoCopyProtection
[in] Value indicating the level of copy protection to set, as defined in the AM_COPY_MACROVISION_LEVEL enumeration.

Return Value

Returns an HRESULT value.

IAMAnalogVideoEncoder::put_TVFormat

IAMAnalogVideoEncoder Interface

Sets the encoder to a particular analog video standard (NTSC/M, PAL/B, SECAM/K1, and so on).

Syntax

HRESULT put_TVFormat(
    long lAnalogVideoStandard
);

Parameters

lAnalogVideoStandard
[in] Video standard that the encoder will be set to. Possible values are defined in the AnalogVideoStandard enumeration.

Return Value

Returns an HRESULT value.