IltmmDVDControl::put_SubpictureOn

#include "ltmm.h"

C Syntax

HRESULT IltmmDVDControl_put_SubpictureOn(pDVD, newVal)

C++ Syntax

HRESULT put_SubpictureOn(newVal)

IltmmDVDControl *pDVD;

pointer to an interface

VARIANT_BOOL newVal;

state

Sets the subpicture display status.

Parameter Description
pDVD Pointer to an IltmmDVDControl interface.
newVal A Boolean value that specifies whether the subpicture display is enabled. Possible values are:
  Setting Description
  VARIANT_TRUE Enable subpicture display.
  VARIANT_FALSE Disable subpicture display.

Returns

S_OK

The function ran successfully.

<> S_OK

An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

This function does not support command synchronization.

The title currently being played determines which subpicture streams are enabled and disabled. The title must enable a subpicture stream for it to be displayed. The programmer can retrieve the subpicture stream status by calling IltmmDVDControl::IsSubpictureStreamEnabled.

Call IltmmDVDControl::get_SubpictureOn to retrieve the current subpicture display status.

For more detailed information, refer to the Microsoft documentation for IDvdControl2::SetSubpictureState.

Required DLLs and Libraries

LTMM

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64

See Also

Elements:

IltmmDVDControl interface, IltmmDVDControl::get_CurrentSubpictureStream, IltmmDVDControl::put_CurrentSubpictureStream, IltmmDVDControl::get_SubpictureStreamsAvailable, IltmmDVDControl::get_DefaultSubpictureLanguage, IltmmDVDControl::get_DefaultSubpictureLanguageExt, IltmmDVDControl::GetSubpictureLanguage, IltmmDVDControl::IsSubpictureStreamEnabled, IltmmDVDControl::SelectDefaultSubpictureLanguage, IltmmDVDControl::get_SubpictureOn

Topics:

Multimedia Function Group

Example

For a C example, refer to IltmmDVDControl::GetButtonAtPosition Example for C.

For a C++ example, refer to IltmmDVDControl::GetButtonAtPosition Example for C++.

Help Version 20.0.2020.4.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help
Introduction
Version History
Getting Started
Copyright Notice
Directories
Multimedia Files You Must Include With Your Application (Redistributables)
Frequently Asked Questions
LEADTOOLS Multimedia Features
Add-on Modules
Programming with LEADTOOLS Multimedia
Appendix
LEADTOOLS Licensing