IltmmWMScript::GetHeaderScript

C Syntax

HRESULT IltmmWMScript_GetHeaderScript(pWMScript, Index, pScriptType, pScriptCommand, pScriptTime)

C++ Syntax

HRESULT GetHeaderScript(Index, pScriptType, pScriptCommand, pScriptTime)

IltmmWMScript *pWMScript;

/* pointer to an interface */

long Index;

/* index of desired script command */

BSTR *pScriptType;

/* pointer to a variable to be updated with the type of script command */

BSTR *pScriptCommand;

/* pointer to a variable to be updated with the text containing the script command */

double *pScriptTime;

/* pointer to a variable to be updated with the  time (in seconds) when the script command should execute */

Parameter

Description

pWMScript

Pointer to an IltmmWMScript Interface.

Index

The index of the script command to retrieve.

pScriptType

Pointer to a variable that receives the type of script command (for example, "caption", "url", or  "filename").

pScriptCommand

Pointer to a varaible that receives the type of script command. Syntax depends on the ScriptType value. For example, an "url" script command will expect the ScriptCommand text to be a fully qualified URL string.

pScriptTime

Pointer to a varaible that receives the actual time (in seconds) when the script command should be executed.

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.

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.

Elements:

IltmmWMScript Interface, IltmmWMScript::get_HeaderScriptCount, IltmmWMScript::AddHeaderScript, 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