IltmmWMScript::AddHeaderScript

Show in webframe

#include "ltmm.h"

C Syntax	HRESULT IltmmWMScript_AddHeaderScript(pWMScript, ScriptType, ScriptCommand, ScriptTime)
C++ Syntax	HRESULT AddHeaderScript(ScriptType, ScriptCommand, ScriptTime)

IltmmWMScript *pWMScript;	/* pointer to an interface */
BSTR ScriptType;	/* text name of script command */
BSTR ScriptCommand;	/* text containing script command */
double ScriptTime;	/* time (in seconds) when the script command should execute */

Adds a header script to be executed at a particular time during playback.

Parameter	Description
pWMScript	Pointer to an IltmmWMScript Interface.
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	The actual time (in seconds) when the script command should be executed.

Returns

S_OK	The function was successful.
<> S_OK	An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

Header scripts are added when you know how many scripts you have and their location before you start the conversion. 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 save the output of a live capture as WMV and there are certain notifications that you will receive during the capture, you would use stream scripts.To save this data (since you will not know the location before you start capturing.

Although header scripts cannot be processed with IltmmPlay notifications, they can be handled by Media Player. To process the scripts using a player based on IltmmPlay, you should add Stream Scripts using the IltmmWMScript::WriteScriptStream function.

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

Required DLLs and Libraries

LTMM

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64

See Also

Elements:	IltmmWMScript Interface, IltmmWMScript::get_HeaderScriptCount, IltmmWMScript::GetHeaderScript, IltmmWMScript::RemoveHeaderScript, IltmmWMScript::RemoveAllHeaderScripts, IltmmWMScript::get_EnableScriptStream, IltmmWMScript::put_EnableScriptStream, IltmmWMScript::WriteScriptStream, IltmmWMScript::CloseScriptStream
Topics:	Multimedia Function Groups
	Adding Script Commands to Windows Media Video
	Processing Script Commands During Windows Media Video Playback

Example

For a C example, refer to IltmmWMScript HeaderScripts Example for C.

For a C++ example, refer to IltmmWMScript HeaderScripts Example for C++.