IltmmWMScript::WriteScriptStream

#include "ltmm.h"

C Syntax	HRESULT IltmmWMScript_WriteScriptStream(pWMScript, ScriptType, ScriptCommand, ScriptTime)
C++ Syntax	HRESULT WriteScriptStream(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 stream-based 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 ScriptName 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

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).

Stream scripts can be processed using the ltmmPlay_Notify_MediaEvent notification for the IltmmPlay object. Stream scripts will generate ltmmEC_OLE_EVENT notifications in which ltmmMediaEvent.lParam1 will be set to ScriptType and ltmmMediaEvent.lParam2 will be set to ScriptCommand.

Although header scripts cannot be processed with ltmmPlay notifications, they can be handled by Media Player.

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::AddHeaderScript, IltmmWMScript::GetHeaderScript, IltmmWMScript::RemoveHeaderScript, IltmmWMScript::RemoveAllHeaderScripts, IltmmWMScript::get_EnableScriptStream, IltmmWMScript::put_EnableScriptStream, IltmmWMScript::CloseScriptStream
Topics:	Multimedia Function Groups
	Processing Script Commands During Windows Media Video Playback
	Adding Script Commands to Windows Media Video

Example

For a C example, refer to IltmmWMScript::CreateScriptStream Example for C.

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