Microsoft DirectX 9.0

MSVidWebDVD.SPRM Property

This topic applies to Windows XP Service Pack 1 only.

The SPRM property retrieves the specified system parameter register.

Syntax

VidWebDVD.SPRM(
  lIndex As Long
) As Short

Parameters

lIndex

Specifies the register to retrieve as a Long. The register number ranges from 0 through 23, inclusive.

Return Values

Returns a Short value representing the contents of the specified register. For a listing of possible return values, see the table under the Remarks section.

Error Codes

If the property fails, Err.Number may be set to one of the following values.

Value Description
E_UNEXPECTED Unspecified error; possibly the graph not built.
E_INVALIDARG lIndex less than 0 or greater than 23.

Remarks

This property is read-only. The disc controls system parameter registers (SPRMs). A player application doesn't need to access these registers for any standard navigation functionality. SPRMs represent the status of the player. Each one has a meaning, set by user preferences, disc commands, and other occurrences that an application has no direct control over. An application can read these registers but cannot write to them. To use these registers effectively, you will probably need a more detailed knowledge of the DVD navigation commands than is provided in this documentation. The following table shows the contents of each register. For more detailed information on the register contents, see IDvdInfo2::GetAllSPRMs in the C++ reference section.

Register Contents
0 Language code
1 Audio stream number
2 Subpicture stream number
3 Current angle number
4 Title number
5 Current title number
6 PGC number
7 Current chapter number
8 Highlighted button number
9 Navigation timer
10 PGC jump for navigation timer
11 Karaoke audio presentation mode
12 PML country/region code
13 PML
14 Video setting
15 Audio capability
16 Audio language
17 Audio language extension
18 Subpicture language
19 Subpicture language extension
20 Player region code
21 Reserved
22 Reserved
23 Reserved

Example

' Returning the property.
sSPRM = VidWebDVD.SPRM(lIndex)

See Also