←Select platform

SetClosedCaptioningTargetFile Method

Summary

Sets the filename and options to save closed captioning data as SRT or TEXT format files.

Syntax

C#
VB
C++
public virtual void SetClosedCaptioningTargetFile( 
   string FileName, 
   ClosedCaptioningFlags Flags 
) 
Public Overridable Sub SetClosedCaptioningTargetFile( _ 
   ByVal FileName As String, _ 
   ByVal Flags As Leadtools.Multimedia.ClosedCaptioningFlags _ 
)  
public: 
virtual void SetClosedCaptioningTargetFile(  
   String^ FileName, 
   Leadtools.Multimedia.ClosedCaptioningFlags Flags 
)  

Parameters

FileName
A character string that contains the filename to save the closed captioning data.

Flags
Value that represents the desired save options. For a list of possible values, refer to ClosedCaptioningFlags enumeration values.

Remarks

Use this method to save the decoded closed captioning data coming from a LEAD MPEG2 decoder. Closed captioning data can be embedded inside MPEG2 Video Elementary stream. If so, then the convert object can decode this data and write it to SRT format using this method, where the closed captioning text and time are saved. For more information, refer to https://en.wikipedia.org/wiki/SubRip. Also, the convert object can save the closed captioning data as text.

By default this method saves the data as an SRT file; but if ClosedCaptioningFlags.Text is specified, the output will be a pure text file.

Example

C#
VB
using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public ConvertCtrlForm _form = new ConvertCtrlForm(); 
 
public void ClosedCaptioningTargetFile() 
{ 
   // reference the convert control 
   ConvertCtrl convertctrl = _form.ConvertCtrl; 
 
   // target file 
   string targetFileCc = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_ClosedCaptioningTargetFile.srt"); 
   ClosedCaptioningFlags flags = ClosedCaptioningFlags.Default; 
   string testFile; 
   ClosedCaptioningFlags testFlags; 
 
   try 
   { 
      // set target file name and save options 
      convertctrl.SetClosedCaptioningTargetFile(targetFileCc, flags); 
 
      convertctrl.GetClosedCaptioningTargetFile(out testFile, out testFlags); 
 
      if (testFile == targetFileCc && testFlags == flags) 
         _result = true; 
      else 
         _result = false; 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 19\Media"; 
} 
Imports Leadtools 
Imports Leadtools.Multimedia 
Imports LeadtoolsMultimediaExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As ConvertCtrlForm = New ConvertCtrlForm() 
 
Public Sub ClosedCaptioningTargetFile() 
   ' reference the convert control 
   Dim convertctrl As ConvertCtrl = _form.ConvertCtrl 
 
   ' target file 
   Dim targetFileCc As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_ClosedCaptioningTargetFile.srt") 
   Dim flags As ClosedCaptioningFlags = ClosedCaptioningFlags.Default 
   Dim testFile As String = String.Empty 
   Dim testFlags As ClosedCaptioningFlags 
 
   Try 
 
      ' set target file name and save options 
      convertctrl.SetClosedCaptioningTargetFile(targetFileCc, flags) 
 
      convertctrl.GetClosedCaptioningTargetFile(testFile, testFlags) 
 
      If testFile = targetFileCc AndAlso testFlags = flags Then 
         _result = True 
      Else 
         _result = False 
      End If 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 19\Media" 
End Class 

Requirements

Target Platforms

Help Version 19.0.2017.10.19
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly