IDvdInfo2::GetKaraokeAttributes method
The GetKaraokeAttributes method retrieves the karaoke attributes of the specified audio stream in the current title or menu.
Syntax
HRESULT GetKaraokeAttributes(
[in] ULONG ulStream,
[out] DVD_KaraokeAttributes *pATR
);
Parameters
- ulStream [in]
-
Specifies the index of the audio stream whose attributes you want to query. See Remarks.
- pATR [out]
-
Pointer to a DVD_KaraokeAttributes structure that is filled with the karaoke attributes.
Return value
Returns one of the following HRESULT values.
| Return code | Description |
|---|---|
|
Success. |
|
Invalid argument. |
|
The DVD Navigator is not initialized. |
|
The specified stream is not in karaoke format. |
|
The DVD Navigator is not in the title domain. |
|
The karaoke attributes for the specified stream are not available. |
Remarks
This method does not explicitly return the number of channels in the stream. You can obtain that information through a call to IDvdInfo2::GetAudioAttributes. This method is demonstrated in the DVDSample application in CKaraokeDlg::DoModal.
The ulStream parameter may be a value from 0 through 7, or one of the following:
| Value | Description |
|---|---|
| DVD_STREAM_DATA_CURRENT (0x800) | To query the currently selected audio stream. |
| DVD_DEFAULT_AUDIO_STREAM | To query the default audio stream. |
Requirements
|
Minimum supported client |
Windows XP [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2003 [desktop apps only] |
|
Header |
|
|
Library |
|
See also