IDvdControl2::SelectKaraokeAudioPresentationMode method (strmif.h)

Article
07/27/2023

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The SelectKaraokeAudioPresentationMode method sends karaoke auxiliary channels to the left or right speakers.

Syntax

HRESULT SelectKaraokeAudioPresentationMode(
  [in] ULONG ulMode
);

Parameters

[in] ulMode

Bitwise OR of DVD_KARAOKE_DOWNMIX enumeration indicating how to downmix the five karaoke channels to channels 0 and 1, which are usually output to the left and right speakers.

Return value

Returns one of the following values.

Return code	Description
S_OK	Success.
E_PROP_SET_UNSUPPORTED	The audio decoder does not support downmixing.
VFW_E_DVD_INVALIDDOMAIN	The DVD Navigator filter is in an invalid domain.
VFW_E_DVD_OPERATION_INHIBITED	UOP control prohibits the current operation.

Remarks

When the DVD Navigator enters karaoke mode, it queries the audio decoder to discover whether it supports karaoke downmixing. If the decoder supports it, then channels 2 through 4 (the karaoke auxiliary channels with the guide vocals, guide melodies, and sound effects) are muted. Use this method to turn individual channels on or off and direct them to channels 0 and 1.

This method is demonstrated in the DVDSample application in CKaraokeDlg::DoModal.

The following table shows the Annex J command name to which this method name corresponds, and the domains in which this method is valid.

Annex J Command Name	Valid Domains
Karaoke_Audio_Presentation_Mode_Change	DVD_DOMAIN_VideoManagerMenu DVD_DOMAIN_VideoTitleSetMenu DVD_DOMAIN_Title DVD_DOMAIN_Stop

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib