ILMDVRSink::GetStatus

Show in webframe

#include "ILMDVRSink.h"

C Syntax	HRESULT ILMDVRSink_GetStatus(pILMDVRSink, pStatus, pnCurrentFolderIndex, pnCurrentRecordingIndex, pnCurrentRecordingSize)
C++ Syntax	HRESULT GetStatus(pStatus, pnCurrentFolderIndex, pnCurrentRecordingIndex, pnCurrentRecordingSize)

ILMDVRSink *pILMDVRSink ;	/* pointer to an interface */
DVRStatusConstants * pStatus;	/* pointer to status */
long * pnCurrentFolderIndex;	/* pointer to the current buffer folder 0-based index */
long * pnCurrentRecordingIndex;	/* pointer to recording (0-based) index */
double * pnCurrentRecordingSize;	/* pointer to recording size */

Gets the DVRSink status, buffer files folder, buffer file index, and current total recording size.

Parameter	Description
pILMDVRSink	Pointer to an ILMDVRSink interface.
pStatus	Pointer to an enumeration type that will receive the current DVR status. Returned values can be: DVRStatus_Stopped DVRStatus_Paused DVRStatus_Writing
pnCurrentFolderIndex	Pointer to a long type that will receive the current folder (0-based) index.
pnCurrentRecordingIndex	Pointer to a long type that will receive the current recording (0-based) index. This index is the number of the current LRC file.
pnCurrentRecordingSize	Pointer to a double type that will receive the current recording size in bytes.

Returns

S_OK	The function was successful.
<> S_OK	An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

Use this function to determine the current status of the DVR sink (stopped, paused or writing), as well as specific information about where in the buffer folders writing is currently happening. The current folder index indicates which buffer folder the sink is using. The current recording index indicates which buffer .LRC file is currently being written.

The Status parameter can be one of the following values:

DVRStatus_Stopped
DVRStatus_Paused
DVRStatus_Writing

Returns S_OK if successful, S_FALSE otherwise.

Required DLLs and Libraries

LMDVRSink

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:	ILMDVRSink::GetAvailabilityInfo, IILMDVRSink::GetBufferTotalSize, ILMDVRSink::GetBufferInfo,
Topics:	Multimedia Function Group, DVR Function Groups, Introduction to the LEADTOOLS MPEG-2 Transport Module, DVR Component FAQs, LEAD DVR Sink Filter, Accessing the DVR Sink Object,How to Use the DVR Sink Object to Control Capture Buffer Settings (C++), How to Set Capture Buffers on More Than One Physical Disk, How to Copy Buffered DVR Data to a New File

Example

For a C example, refer to ILMDVRSink::GetStatus Example for C

For a C++ example, refer to ILMDVRSink::GetStatus Example for C++