IltmmDVDControl::put_SubpictureOn

Summary

Sets the subpicture display status.

Syntax

#include "ltmm.h"

Language Syntax
C HRESULT IltmmDVDControl_put_SubpictureOn(pDVD, newVal)
C++ HRESULT put_SubpictureOn(newVal)

Parameters

IltmmDVDControl *pDVD

Pointer to an IltmmDVDControl interface.

VARIANT_BOOL 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

Value Meaning
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

Platforms

Win32, x64.

See Also

Functions

Topics

Example

Language Example
C IltmmDVDControl::GetButtonAtPosition
C++ IltmmDVDControl::GetButtonAtPosition
Help Version 22.0.2023.1.26
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.