IAMTimecodeGenerator::GetTCGMode method (strmif.h)
[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The GetTCGMode method retrieves the SMPTE timecode generator properties.
Syntax
HRESULT GetTCGMode(
[in] long Param,
[out] long *pValue
);
Parameters
[in] Param
Timecode generator mode. Specify one of the following modes you want to get settings for.
| Value | Description |
|---|---|
| ED_TCG_FRAMERATE | Frame rate |
| ED_TCG_REFERENCE_SOURCE | Source of the count value |
| ED_TCG_SYNC_SOURCE | Source of the hardware clock reference |
| ED_TCG_TIMECODE_TYPE | SMPTE timecode format of the generator |
[out] pValue
Pointer to the current setting of the mode specified in Param.
If you specify ED_TCG_FRAMERATE in Param, this parameter retrieves one of the following.
| Value | Description |
|---|---|
| ED_FORMAT_SMPTE_24 | 24 frames per second. |
| ED_FORMAT_SMPTE_25 | 25 frames per second. |
| ED_FORMAT_SMPTE_30 | 30 frames per second. Nondrop frame. |
| ED_FORMAT_SMPTE_30DROP | 30 frames per second. Drop frame (actually 29.97 fps). |
If you specify ED_TCG_REFERENCE_SOURCE in Param, this parameter retrieves one of the following.
| Value | Description |
|---|---|
| ED_TCG_FREE | No count reference source. |
| ED_TCG_READER | Synchronize to reader value (jamsync). |
If you specify ED_TCG_SYNC_SOURCE in Param, this parameter retrieves one of the following.
| Value | Description |
|---|---|
| ED_TCG_FREE | Lock to nothing (freerun). |
| ED_TCG_READER | Lock to timecode reader. |
| ED_TCG_VIDEO | Lock to incoming video. |
If you specify ED_TCG_TIMECODE_TYPE in Param, this parameter retrieves one of the following.
| Value | Description |
|---|---|
| ED_TCG_MIDI_FULL | MIDI full frame timecode |
| ED_TCG_MIDI_QF | MIDI quarter frame timecode |
| ED_TCG_SMPTE_LTC | Linear timecode |
| ED_TCG_SMPTE_VITC | Vertical interval timecode |
Return value
Returns an HRESULT value that depends on the implementation of the interface.
Remarks
This method returns various settings of the timecode generator. For more information on ED_TCG_TIMECODE_TYPE, see IAMTimecodeReader::SetTCRMode.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | strmif.h (include Dshow.h) |
| Library | Strmiids.lib |