Skip to content

SetTextOverlay_String

function

Delphi
procedure SetTextOverlay_String (Index: LongInt; const Value: string);
C++Builder
void __fastcall SetTextOverlay_String(System::LongInt Index, const System::UnicodeString Value);
C#
public void SetTextOverlay_String(int Index, string Value);
VB.NET
Public Sub SetTextOverlay_String(Index As Integer, Value As String)
C++/Qt
void SetTextOverlay_String (int Index, wchar_t *Value);
void SetTextOverlay_String (wchar_t *Value);

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

Remarks

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. To display the percent symbol itself, just duplicate it, e.g. TextOverlay_String = "the percent symbol is %%"

See SetTextOverlay_CustomVar