Share via

MSVidWebDVD.KaraokeAudioPresentationMode Property

  • Article
 
Microsoft DirectShow 9.0

MSVidWebDVD.KaraokeAudioPresentationMode Property

This topic applies to Windows XP Service Pack 1 or later.

The KaraokeAudioPresentationMode property sets or retrieves the right-left speaker mix for the auxiliary karaoke channels.

Syntax

  VidWebDVD
  .KaraokeAudioPresentationMode As Long

Parameters

This property takes no parameters.

Return Values

Returns a Long value containing a set of bit flags indicating how the auxiliary karaoke channels are mixed to the left and right speakers.

Remarks

This property is read/write with a default value of zero.

Audio channels are zero-based, so channels 0 and 1 generally represent the right and left speaker channels and channels 2 through 4 are the three auxiliary karaoke channels. When the MSVidWebDVD object enters karaoke mode, it automatically mutes channels 2 and higher. Use bitwise OR operations to set the appropriate bit in order to send an auxiliary channel to the left speaker, right speaker, both speakers (both bits on), or to no speakers (both bits off). These bits are all off by default when entering karaoke mode. The value of the bits and their corresponding action is given in the following table.

Hexadecimal Value Description
0x0004 Mix channel 2 to the left speaker.
0x0008 Mix channel 3 to the left speaker.
0x0010 Mix channel 4 to the left speaker.
0x0400 Mix channel 2 to the right speaker.
0x0800 Mix channel 3 to the right speaker.
0x1000 Mix channel 4 to the right speaker.

** Error Codes**

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

Value Description
E_UNEXPECTED Unspecified error.
VFW_E_DVD_INVALIDDOMAIN You attempted to take the value in a domain that does not support this property.
E_NO_DVD_VOLUME No DVD in the machine.
E_REGION_CHANGE_FAIL The DVD has a different region than the player.
VFW_E_DVD_OPERATION_INHIBITED Operation prevented by UOP command.

Example

The following code example shows how to send channel 2 to the left speaker and channels 3 and 4 to the right channel by using a bitwise OR operation:

Dim lMode As Long               ' lMode automatically initialized to 0.
lMode = &H4 Or &H800 Or &H1000  ' VB-style hex values.
VidWebDVD.KaraokeAudioPresentationMode = lMode

To retrieve the value of KaraokeAudioPresentationMode, use a bitwise AND operation against the possible values, as shown in the following code example:

If (VidWebDVD.KaraokeAudioPresentationMode And &H4) Then
  ' Channel 2 is being sent to the left speaker.
End If
If (VidWebDVD.KaraokeAudioPresentationMode And &H8) Then
   ' Channel 3 is being sent to the left speaker.
End If
  ' And so on for all possible values.

Valid Domains

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

Reference: Add a reference to MS Video Control 1.0 Type Library and Microsoft Tuner 1.0 Type Library.

Library: Quartz.dll.

See Also