IDVDRenderer::Highlight (Windows Embedded CE 6.0)
1/6/2010
This method causes the decoder to display a highlight of the specified DVD button.
Syntax
HRESULT Highlight(
BYTE buttonNumber,
EHighlightAction action,
BOOL bRelativeMode
);
Parameters
- buttonNumber
[in] Valid button number in the range 1to 36 if bRelativeMode is FALSE and in the range 1 to 4 if bRelativeMode is TRUE (1=up, 2=down, 3=left, 4=right).
action
[in] Describes the action state of the current highlight.The following table lists the values for the action parameter.
Value Description HIGHLIGHT_SELECT
Selects the specified button. It displays the activation highlight if the button is turned on automatically.
UNHIGHLIGHT
Turns off highlight.
ACTIVATE_BUTTON
Displays the activation highlight.
ACTIVATE_SELECTED
Displays the activation highlight for the currently selected button.
SELECT_AUTO_ACTIVATED
Displays only the selection highlight even if the button is turned on automatically.
- bRelativeMode
[in] Qualifies the range of values that can be passed into buttonNumber. If set to FALSE, the valid button number is in the range of 1 to 36. If set to TRUE, the valid button number is in the range of 1 to 4 (1=up, 2=down, 3=left, 4=right).
Return Value
The following table shows a list of possible return values.
Return value | Description |
---|---|
S_OK |
The request completed successfully. |
E_INVALIDARG |
The button number is invalid. |
E_UNEXPECTED |
The highlight information is invalid. |
Remarks
The decoder executes this command only if there is an active subpicture, complete with active associated highlight information. Only one highlight can be selected.
Requirements
Header | dvddrvr.idl |
Windows Embedded CE | Windows CE .NET 4.0 and later |