ScnLib_SetLogoText()

ScnLib_SetLogoTextA/W()

Std EditionPro EditionMax EditionUltra Edition
C++ __declspec(dllimport) BOOL __stdcall ScnLib_SetLogoTextA(LPCSTR pcszText);
__declspec(dllimport) BOOL __stdcall ScnLib_SetLogoTextW(LPCWSTR pcwszText);
C# [DllImport("ScnLib.dll", CharSet = CharSet.Unicode)] public static extern bool ScnLib_SetLogoTextW(string Text);
Basic Public Declare Unicode Function ScnLib_SetLogoTextW Lib "ScnLib.dll" (ByVal Text As String) As Boolean
Delphi function ScnLib_SetLogoTextA(const Text: PAnsiChar): LongBool; stdcall; external 'ScnLib.dll';
function ScnLib_SetLogoTextW(const Text: PWideChar): LongBool; stdcall; external 'ScnLib.dll';
  • Description
    Set the logo text to be present in the video.

  • Parameters
    • Text [in]
      The logo text to be present in the video, may include any combination of the following predefined variables:
      • <duration> - Incorporate a string that represents the current recording duration, formatted as HH:MM:SS.
      • <duration-ms> - Incorporate a string displaying the current recording duration, precise to milliseconds, formatted as HH:MM:SS.XXX.
      • <date> - Incorporate a string representing the current date in a short format that is suitable for the current locale.
      • <time> - Incorporate a string displaying the current time, formatted as HH:MM:SS.
      • <time-ms> - Incorporate a string displaying the current time, precise to milliseconds, formatted as HH:MM:SS.XXX.
      • <date-time> - Incorporate a string representing the current date and time in a short format that is suitable for the current locale.
      • <long-date> - Incorporate a string representing the current date in a long format that is suitable for the current locale.
      • <long-date-time> - Incorporate a string representing the current date and time in a long format that is suitable for the current locale.
      • <pc-name> - Include a string that displays the current name of the computer.
      • <user-name> - Include a string that represents the current user's name.
      e.g. 'REC <date-time>'
  • Return Value
    If the logo text is set successfully, the return value is TRUE. Otherwise, the return value is FALSE.

  • Remarks
    Use this function to set the logo text to be present in the video. The logo text can include any combination of the predefined variables mentioned above. This function also supports the display of multi-line text, with '\n' used to denote line breaks. To remove or hide the logo text from the video, pass a zero value or an empty string as the Text parameter. You can use this function during the recording process. To retrieve the logo text currently present in the video, call ScnLib_GetLogoTextA/W().

  • See Also
    ScnLib_IsLogoTextPresent()
    ScnLib_IsLogoImagePresent()
    ScnLib_GetLogoTextA/W()
    ScnLib_SetLogoTextStyleA/W()
    ScnLib_SetLogoImageA/W()

Try the SDK for FREE SDK APIs overview