IltmmDVDControl::IsSubpictureStreamEnabled

Summary

Determines if the specified subpicture stream is enabled in the current title.

Syntax

#include "ltmm.h"

Language Syntax
C HRESULT IltmmDVDControl_IsSubpictureStreamEnabled(pDVD, stream, pVal)
C++ HRESULT IsSubpictureStreamEnabled(stream, pVal)

Parameters

IltmmDVDControl *pDVD

Pointer to an IltmmDVDControl interface.

long stream

The subpicture stream to check.

VARIANT_BOOL *pVal

Pointer to a variable that receives a value that represents the status of the specified subpicture stream. Possible values are:

Setting Description
VARIANT_TRUE Stream is enabled
VARIANT_FALSE Stream is disabled

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

To determine the number of available subpicture streams, call IltmmDVDControl::get_SubpictureStreamsAvailable.

Call IltmmDVDControl::get_CurrentSubpictureStream to retrieve the current subpicture stream.

To set the current subpicture stream, call IltmmDVDControl::put_CurrentSubpictureStream.

The title currently being played determines which subpicture streams are enabled and disabled.

While setting a disabled subpicture stream as the current subpicture stream will not return an error, the program will not display subpicture data until it plays a title that enables the stream.

For more detailed information, refer to the Microsoft documentation for IDvdInfo2::IsSubpictureStreamEnabled.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

Language Example
C IltmmDVDControl::GetButtonAtPosition
C++ IltmmDVDControl::GetButtonAtPosition
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 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.