GetMediaParameter

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Retrieves the value of the specified parameter for an indexed Advanced Stream Redirector (ASX) entry.

Compatibility:Windows Media Player

sRetVal = MediaPlayer.GetMediaParameter(
lEntryNum, sName
)

Parameters

lEntryNum

Long value specifying the index number of an ENTRY element in the ASX file.

sName

BSTR value specifying the NAME attribute of a PARAM element within the specified ENTRY element. This value is not case sensitive.

Return Values

Returns a Stringvalue representing the VALUEattribute of the specified PARAMelement. This method returns a null value if lEntryNumis outside the range of the EntryCountproperty, or if no PARAMelement within the specified ENTRYelement has a NAMEattribute equal to sName.

Remarks

The PARAMelement allows you to place additional information into an ASX file, which the Microsoft Windows Media Player control can then access through scripting. For example, you could insert the names of the producers of each media file inside the ASX file and display them in HTML somewhere near the Windows Media Player window.

Use this method to determine the values of the PARAMelements within an ASX ENTRYelement. Call the GetMediaParameterNamemethod to determine names associated with PARAMelements.

The first ENTRYelement in an ASX file has an lEntryNumindex number of 1. Index number 0is reserved for child elements of the ASX tag, which applies to information valid for the entire show.

An example ASX file might look like the following.

<ASX VERSION="3.0"> <TITLE>The Title
of the Show<TITLE> <ENTRY> <REF
HREF="YourMediaFilename.asf" /> <TITLE>The Title of the
Track</TITLE> <PARAM NAME="Producer" VALUE="Jane Doe">
</ENTRY> </ASX>

To retrieve the producer information for the first entry, call the method as shown below.

MediaPlayer.GetMediaParameter( 1,
"Producer");

This method call would return the string Jane D.

See Also

EntryCount, GetMediaParameterName