IDvdInfo2::GetKaraokeAttributes
| Microsoft DirectShow 9.0 |
IDvdInfo2::GetKaraokeAttributes
The GetKaraokeAttributes method retrieves the karaoke attributes of the specified audio stream in the current title or menu.
Syntax
HRESULT GetKaraokeAttributes( ULONG ulStream, DVD_KaraokeAttributes *pATR );
Parameters
ulStream
[in] Variable of type ULONG specifying 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 Values
Returns one of the following HRESULT values.
| Return code | Description |
| S_OK | Success. |
| E_POINTER | Invalid argument. |
| E_UNEXPECTED | The DVD Navigator is not initialized. |
| VFW_E_DVD_NOT_IN_KARAOKE_MODE | The specified stream is not in karaoke format. |
| VFW_E_DVD_INVALIDDOMAIN | The DVD Navigator is not in the title domain. |
| VFW_E_DVD_NO_ATTRIBUTES | 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
Header: Declared in Strmif.h; include Dshow.h.
Library: Use Strmiids.lib.
See Also