WMScripter Property

Summary

Provides a way to get the WMScript object.

Syntax
C#
VB
C++
public WMScript WMScripter { get; } 
Public ReadOnly Property WMScripter As WMScript 
public: 
property WMScript^ WMScripter { 
   WMScript^ get(); 
} 

Property Value

A WMScript object, which can be used to manage the Windows Media Script commands.

Remarks

The object is read-only and can be null if the TargetFormat property is not set to TargetFormatType.WMVMux or TargetFormatType.ASFMux. You can keep a copy of the object but only as long as the target format does not change. If the target format changes, get the object again. For more information on Windows Media Script Commands, refer to WMScript object.

Example
C#
VB
using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public ConvertCtrlForm _form = new ConvertCtrlForm(); 
 
public void AddHeaderScriptExample() 
{ 
   ConvertCtrl convertctrl = _form.ConvertCtrl; 
   string inFile = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_Source.avi"); 
   string outFile = Path.Combine(LEAD_VARS.MediaDir, "WMScript_AddHeaderScriptExample.wmv"); 
 
   try 
   { 
      convertctrl.TargetFormat = TargetFormatType.WMVMux; 
      convertctrl.SourceFile = inFile; 
      convertctrl.TargetFile = outFile; 
      WMScript mux = convertctrl.WMScripter; 
      if (mux == null) 
      { 
         _result = false; 
         return; 
      } 
 
      mux.EnableScriptStream = false; 
      mux.RemoveAllHeaderScripts(); 
 
      WriteScript(convertctrl, mux); 
 
      // run the convert 
      convertctrl.StartConvert(); 
   } 
   catch (Exception) 
   { 
      _result = false; 
      return; 
   } 
 
   // we'll loop on the state and pump messages for this example. 
   // but you should not need to if running from a Windows Forms application. 
   while (convertctrl.State == ConvertState.Running) 
      Application.DoEvents(); 
 
   // set the result 
   _result = true; 
} 
 
public void WriteScript(ConvertCtrl convertctrl, WMScript mux) 
{ 
   double duration = convertctrl.Duration; 
 
   for (double t = 0.0; t < duration; t += 1.0) 
   { 
      String sz = String.Format("Sample caption script at {0} seconds", t); 
      mux.AddHeaderScript("caption", sz, t); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media"; 
} 
Imports Leadtools 
Imports Leadtools.Multimedia 
Imports LeadtoolsMultimediaExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As New ConvertCtrlForm() 
 
Public Sub AddHeaderScriptExample() 
   Dim convertctrl As ConvertCtrl = _form.ConvertCtrl 
   Dim inFile As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_Source.avi") 
   Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir, "WMScript_AddHeaderScriptExample.wmv") 
 
   Try 
      convertctrl.TargetFormat = TargetFormatType.WMVMux 
      convertctrl.SourceFile = inFile 
      convertctrl.TargetFile = outFile 
      Dim mux As WMScript = convertctrl.WMScripter 
      If mux Is Nothing Then 
         _result = False 
         Return 
      End If 
 
      mux.EnableScriptStream = False 
      mux.RemoveAllHeaderScripts() 
 
      WriteScript(convertctrl, mux) 
 
      ' run the convert 
      convertctrl.StartConvert() 
   Catch generatedExceptionName As Exception 
      _result = False 
      Return 
   End Try 
 
   ' we'll loop on the state and pump messages for this example. 
   ' but you should not need to if running from a Windows Forms application. 
   While convertctrl.State = ConvertState.Running 
      Application.DoEvents() 
   End While 
 
   ' set the result 
   _result = True 
End Sub 
 
Public Sub WriteScript(ByVal convertctrl As ConvertCtrl, ByVal mux As WMScript) 
   Dim duration As Double = convertctrl.Duration 
 
   Dim t As Double = 0.0 
   While t < duration 
      Dim sz As [String] = [String].Format("Sample caption script at {0} seconds", t) 
      mux.AddHeaderScript("caption", sz, t) 
      t += 1.0 
   End While 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media" 
End Class 

Requirements

Target Platforms

Help Version 20.0.2020.4.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly