AddHeaderScript Method

Summary
Adds a header script to be executed at a particular time during playback.
Syntax
C#
C++/CLI
public void AddHeaderScript( 
   string ScriptType, 
   string ScriptCommand, 
   double ScriptTime 
) 
public: 
void AddHeaderScript(  
   String^ ScriptType, 
   String^ ScriptCommand, 
   double ScriptTime 
)  

Parameters

ScriptType
The type of script command (for example, "caption", "url", or "filename").

ScriptCommand
The script command text. Syntax depends on the ScriptType value. For example, an "url" script command will expect the ScriptCommand text to be a fully qualified URL string.

ScriptTime
Time (in seconds) when the script command should execute.

Remarks

Header scripts are added when you know how many scripts you have and their location beforehand. Also, since they are stored in the header, they will need to be all downloaded before playback begins. Stream scripts are added when you don't know how many you will have or when there are too many and you don't want to slow down the start of the playback. For example, if you have a live capture and there are certain notifications that you will receive during the capture, you would use stream scripts.

Also, header script commands cannot be processed by players based on Leadtools Multimedia. You should add stream headers if you wish to process these script commands using applications based on PlayCtrl.

See the Microsoft documentation, Using Script Commands Supported by Windows Media Player, for a complete list of script commands supported by Windows Media Player.

Example
C#
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; 
      if (mux.HeaderScriptCount > 0) 
         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:\LEADTOOLS23\Media"; 
} 
Requirements

Target Platforms

See Also

Reference

WMScript Class

WMScript Members

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

Leadtools.Multimedia Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.