Microsoft DirectX 9.0

IAMTimecodeGenerator::GetTCGMode

The GetTCGMode method retrieves the SMPTE timecode generator properties.

Syntax

HRESULT GetTCGMode(
  long Param,
  long *pValue
);

Parameters

Param

[in] 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

pValue

[out] 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 Values

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.

See Also