LEADTOOLS Multimedia API Help > Add-on Modules > LEADTOOLS MPEG2 Transport Module > LEADTOOLS DVR Components > DVR Component Function References > ILMDVRSink Interface > ILMDVRSink::GetBufferInfo |
#include "ILMDVRSink.h"
C Syntax |
HRESULT ILMDVRSink_GetBufferInfo(pILMDVRSink, nBufferIndex, pszFileName, pnUsefulSize, pnFileSize, pnPlayIndex, pnFlags) |
C++ Syntax |
HRESULT GetBufferInfo(nBufferIndex, pszFileName, pnUsefulSize, pnFileSize, pnPlayIndex, pnFlags) |
I ILMDVRSink *pILMDVRSink ; |
/* pointer to an interface */ |
long nBufferIndex; |
/* (0-based) index to the buffer */ |
BSTR * pszFileName; |
/* pointer to the buffer filename */ |
double * pnUsefulSize; |
/* pointer to useful size */ |
double * pnFileSize; |
/* pointer to file size */ |
long * pnPlayIndex; |
/* pointer to play index */ |
long * pnFlags; |
/* pointer to flags */ |
Gets the DVRSink buffer information associated with the specified buffer file index.
Parameter |
Description |
pILMDVRSink |
Pointer to an ILMDVRSink interface. |
nBufferIndex |
The 0-based index of the buffer file for which to get information. |
pszFileName |
A pointer to a string type that will receive the filename of the related buffer recording file. |
pnUsefulSize |
A pointer to a double type that will receive the used file size of the current recording chunk file. |
pnFileSize |
A pointer to a double type that will receive the physical file size of the current recording chunk file. |
pnPlayIndex |
A pointer to a long type that will receive the index in playing order (the first index might not be 0, but all files should have sequential and incrementing indexes after the first index value). |
pnFlags |
A pointer to a long type that will receive a DVRBufferFlagConstant setting. Value can be: DVRBuffer_Empty = 0x0001, DVRBuffer_Writing = 0x0002, DVRBuffer_Finished = 0x0004
|
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
Returns S_OK if successful, otherwise a return code indicating the reason for failure:
E_INVALIDARG = Buffer index supplied is outside the range of currently valid indexes.
LTMM_E_DVR_NO_RECORDINGS = No .LRC recording files exist.
E_OUTOFMEMORY = A memory allocation error occurred when attempting to allocate storage for the buffer filename string.
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. |
Win32, x64
See Also
Example
For a C example, refer to ILMDVRSink::GetBufferInfo Example for C
For a C++ example, refer to ILMDVRSink::GetBufferInfo Example for C++