IAMTimecodeDisplay Interface
The IAMTimecodeDisplay interface contains properties and methods that define behavior of an external SMPTE/MIDI timecode display device. You should implement this interface in combination with IAMExtDevice, IAMExtTransport, and the other timecode interfaces to control an external device, such as a VCR, which can read, generate and/or display timecode data. This interface controls the physical timecode character generator display that is either built into a VCR or is on some other similar external device.
For more information on SMPTE timecode, see Control an External Device in DirectShow.
Implement this interface on an external device filter that will control the timecode display on an external timecode reader or generator. Timecode readers or generators can be built into a VCR or can be a separate external device. Do not try to implement this interface if your external device can't display timecode or if your timecode is being generated through an internal card with no integral or overlay hardware.
This interface is not intended for rendering in a Microsoft® DirectShow® filter graph; it is purely for use on external device displays.
Use this interface when applications need to control an external device and how its timecode information is displayed.
See the IAMExtTransport interface for hardware requirements.
Methods in Vtable Order
IUnknown methods Description QueryInterface Retrieves pointers to supported interfaces. AddRef Increments the reference count. Release Decrements the reference count. IAMTimecodeDisplay methods Description GetTCDisplayEnable Determines whether an external device's timecode character generator output is enabled or disabled. SetTCDisplayEnable Enables or disables an external device's timecode character output generator. GetTCDisplay Retrieves current settings of the timecode character generator output. SetTCDisplay Sets the timecode character generator output characteristics.
IAMTimecodeDisplay::GetTCDisplay
IAMTimecodeDisplay Interface
Retrieves current settings of the timecode character generator output.
Syntax
HRESULT GetTCDisplay(
long Param,
long *pValue
);
Parameters
- Param
- [in] Timecode display characteristic. Specify one of the following items you want to get settings for.
ED_TCD_BORDER White border for black characters, black border for white characters ED_TCD_INTENSITY Intensity (brightness) of characters ED_TCD_INVERT Black characters on white background or white characters on black background ED_TCD_POSITION Position of characters ED_TCD_SIZE Size of characters ED_TCD_SOURCE Source of display's data ED_TCD_TRANSPARENCY Transparency of characters - pValue
- [out] Pointer to the current setting of the parameter specified in Param. This parameter retrieves one of the following values.
If ED_TCD_SOURCE specified in Param, will return one of the following:
ED_TCG Timecode generator ED_TCR Timecode reader If ED_TCD_SIZE specified in Param, will return one of the following:
ED_LARGE Large ED_MED Medium ED_SMALL Small If ED_TCD_POSITION specified in Param, will return one of the following:
ED_BOTTOM Bottom ED_MIDDLE Middle ED_TOP Top in combination with one of the following:
ED_CENTER Center ED_LEFT Left ED_RIGHT Right If ED_TCD_INTENSITY specified in Param, will return one of the following:
ED_HIGH High ED_LOW Low If ED_TCD_TRANSPARENCY is specified in Param, will return a value from 0 to 4, 0 being completely opaque.
If ED_TCD_INVERT is specified in Param, will return one of the following:
OAFALSE Black characters on white background OATRUE White characters on black background If ED_TCD_BORDER specified in Param, will return one of the following:
OAFALSE Black characters for white border OATRUE White border for black characters
Return Value
Returns an HRESULT value that depends on the implementation of the interface.
See Also
IAMTimecodeDisplay::GetTCDisplayEnable
IAMTimecodeDisplay Interface
Determines whether an external device's timecode character generator output is enabled or disabled.
Syntax
HRESULT GetTCDisplayEnable(
long *pState
);
Parameters
- pState
- [out] Pointer to a value indicating whether timecode character generator output is enabled. OATRUE indicates enabled; OAFALSE indicates disabled.
Return Value
Returns an HRESULT value that depends on the implementation of the interface.
Remarks
This method is not intended for character rendering inside a filter graph, it is purely intended for hardware displays. Ensure that your external timecode reader or generator has display capability before trying to use this method.
See Also
IAMTimecodeDisplay::SetTCDisplay
IAMTimecodeDisplay Interface
Sets the timecode character generator output characteristics.
Syntax
HRESULT SetTCDisplay(
long Param,
long Value
);
Parameters
- Param
- [in] Timecode display characteristic. Specify one of the following properties you want to set properties for.
ED_TCD_BORDER White border for black characters, black border for white characters ED_TCD_INTENSITY Intensity (brightness) of characters ED_TCD_INVERT Black characters on white background or white characters on black background ED_TCD_POSITION Position of characters ED_TCD_SIZE Size of characters ED_TCD_SOURCE Source of the display's data ED_TCD_TRANSPARENCY Transparency of characters - Value
- [in] Setting of the parameter specified in Param. Must be one of the following:
If ED_TCD_SOURCE specified in Param, set one of the following:
ED_TCG Timecode generator ED_TCR Timecode reader If ED_TCD_SIZE is specified in Param, set one of the following:
ED_LARGE Large ED_MED Medium ED_SMALL Small If ED_TCD_POSITION specified in Param, set one of the following:
ED_BOTTOM Bottom ED_MIDDLE Middle ED_TOP Top in combination with one of the following:
ED_CENTER Center ED_LEFT Left ED_RIGHT Right If ED_TCD_INTENSITY is specified in Param, set one of the following:
ED_HIGH High ED_LOW Low If ED_TCD_TRANSPARENCY is specified in Param, set a value from 0 to 4, 0 being completely opaque, 4 being as dark as possible.
If ED_TCD_INVERT is specified in Param, set one of the following:
OAFALSE Black on white OATRUE White on black If ED_TCD_BORDER is specified in Param, set one of the following:
OAFALSE Black characters for white border OATRUE White border for black characters
Return Value
Returns an HRESULT value that depends on the implementation of the interface.
See Also
IAMTimecodeDisplay::SetTCDisplayEnable
IAMTimecodeDisplay Interface
Enables or disables an external device's timecode character output generator.
Syntax
HRESULT SetTCDisplayEnable(
long State
);
Parameters
- State
- [in] Value specifying whether to enable or disable the timecode character output generator. Specify OATRUE to enable or OAFALSE to disable.
Return Value
Returns an HRESULT value that depends on the implementation of the interface.
Remarks
This method is not intended for rendering characters inside a filter graph, it is purely intended for hardware displays. Ensure that your external timecode reader or generator has display capability before trying to use this method.
See Also
Top of Page
© 2000 Microsoft and/or its suppliers. All rights reserved. Terms of Use.