Datastead TVideoGrabber SDK

Sets or retrieves the text string that will be drawn over video frames for the specified text overlay

Declaration
procedure SetTextOverlay_String (Index: LongInt; Value: string);

void __fastcall SetTextOverlay_String(int Index, wchar_t *Value);

Description

Used to set or retrieve the text string that will be drawn over video frames.
The text string can be composed of several lines.
This property can be modified at any time, even if the text is currently drawn over a video frame.

Several TVideoGrabber variables can be used within the text string, delimited by a percent symbol (2).
When TVideoGrabber detects one of these variables the variable label is replaced by its current value:

"%sys_time[dd/mm/yy hh:nn:ss]%" : current system date/time (1)
"%dv_time[dd/mm/yy hh:nn:ss]%" : current date/time stored on the DV VCR tape (1)
"%time_code%" : current DV VCR time code, if available
"%frame_count%" : number of the current frame
"%time_full%" : time of the current frame in hh:mm:ss:cc format
"%time_sec%" : time of the current frame, in seconds with 2 decimals
"%time_100ns%" : time of the current frame, in 100 nano-seconds units
"%custom0% to %custom9%" : up to 10 custom variables that can be set by using SetTextOverlay_CustomVar .

(1) any valid date/time format is accepted between the brackets of sys_time and dv_time.
(2) the percent symbol is a reserved character. If you need to display the percent symbol itself, just duplicate it, e.g. TextOverlay_String = "the percent symbol is %%"

See SetTextOverlay_CustomVar

See Also
TCardinalDirection TOnFrameOverlayUsingDC TOnFrameOverlayUsingDIB TTextOverlayAlign AdjustOverlayAspectRatio DrawBitmapOverFrame GetFrameInfoString GetTextOverlay_AlphaBlend GetTextOverlay_AlphaBlendValue ImageOverlay_StretchToVideoSize MouseWheelEventEnabled OnFrameBitmap OnFrameBitmapEventSynchrone OnFrameOverlayUsingDC OnFrameOverlayUsingDIB OnFrameOverlayUsingVIDEOHDR OnMouseDown OnMouseMove OnMouseUp OnMouseWheel OverlayAfterTransform RefreshPlayerOverlays SetImageOverlay_AlphaBlend SetImageOverlay_AlphaBlendValue SetImageOverlay_ChromaKey SetImageOverlay_ChromaKeyLeewayPercent SetImageOverlay_ChromaKeyRGBColor SetImageOverlay_Enabled SetImageOverlay_Height SetImageOverlay_LeftLocation SetImageOverlay_RotationAngle SetImageOverlay_StretchToVideoSize SetImageOverlay_TargetDisplay SetImageOverlay_TopLocation SetImageOverlay_Transparent SetImageOverlay_TransparentColorValue SetImageOverlay_UseTransparentColor SetImageOverlay_Width SetImageOverlayFromBMPFile SetImageOverlayFromHBitmap SetImageOverlayFromHBitmap2 SetImageOverlayFromImageFile SetImageOverlayFromImageFile2 SetImageOverlayFromJPEGFile SetImageOverlayFromTBitmap SetImageOverlayFromTBitmap2 SetImageOverlayFromTImage SetImageOverlayFromTImage2 SetTextOverlay_Align SetTextOverlay_AlphaBlend SetTextOverlay_AlphaBlendValue SetTextOverlay_BkColor SetTextOverlay_CustomVar SetTextOverlay_Enabled SetTextOverlay_Font SetTextOverlay_FontColor SetTextOverlay_GradientColor SetTextOverlay_GradientMode SetTextOverlay_HighResFont SetTextOverlay_Left SetTextOverlay_Right SetTextOverlay_Scrolling SetTextOverlay_ScrollingSpeed SetTextOverlay_Shadow SetTextOverlay_ShadowColor SetTextOverlay_ShadowDirection SetTextOverlay_TargetDisplay SetTextOverlay_Top SetTextOverlay_Transparent ShapeOverlay ShapeOverlayEnabled ShapeOverlayList TextOverlay_Align TextOverlay_BkColor TextOverlay_CreateCustomFont TextOverlay_CreateCustomFont2 TextOverlay_Enabled TextOverlay_Font TextOverlay_FontColor TextOverlay_Left TextOverlay_Right TextOverlay_Scrolling TextOverlay_ScrollingSpeed TextOverlay_Selector TextOverlay_Shadow TextOverlay_ShadowColor TextOverlay_ShadowDirection TextOverlay_String TextOverlay_Top TextOverlay_Transparent TranslateMouseCoordinates