IltmmWMScript::GetHeaderScript

#include "ltmm.h"

C Syntax

HRESULT IltmmWMScript_GetHeaderScript(pWMScript, Index, ScriptType, ScriptCommand, ScriptTime)

C++ Syntax

HRESULT GetHeaderScript(Index, ScriptType, ScriptCommand, ScriptTime)

IltmmWMScript *pWMScript;

pointer to an interface

long Index;

index of desired script command

BSTR *ScriptType;

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

BSTR *ScriptCommand;

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

double *ScriptTime;

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

Gets the header script at the specified index.

Parameter

Description

pWMScript

Pointer to an IltmmWMScript Interface.

Index

The index of the script command to retrieve.

ScriptType

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

ScriptCommand

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.

ScriptTime

Pointer to a varaible that receives 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

See the Microsoft documentation, 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

Example

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

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

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

LEADTOOLS Multimedia C API Help