In This Topic ▼

ILMDVRSource Interface

Data Types

LMDVRSource_APILEVEL

Summary

Lists the valid values for the ApiLevel parameter that can be passed to the ResetToDefaultsEx method.

Syntax

typedef enum 
{ 
   LMDVRSource_APILEVEL_1 = 0, 
} LMDVRSource_APILEVEL; 

Properties

Type Name Description
long FolderCount (Read only) Gets the number of buffer folder locations. Use this to determine the number of DVR buffer folder locations on the system.
BSTR FolderName( long nFolderIndex) (Read only) Gets the name of the fully qualified folder path for the specified buffer location. Use this to determine the full pathname of the specified DVR buffer folder location.
VARIANT_BOOL IsGrowing (Read only) Indicates whether the DVR source is growing. If VARIANT_TRUE, the source is still growing and the final duration is unknown. If VARIANT_FALSE, the file is not growing anymore.

Methods

HRESULT GetAvailabilityInfo(double * pStartOffset, double * pEndOffset, double * pTotalSize)

Description

Gets the availability information for data for the current playback range.

Parameters

pStartOffset

A pointer to a double type that receives the first offset of available video.

pEndOffset

A pointer to a double type that receives the last offset of available video.

pTotalSize

Total size of all video data available.

Returns

Return Description
S_OK Successful.
E_UNEXPECTED Unexpected invalid file handle.
LTMM_E_DVR_NO_RECORDINGS No .LRC recording files exist.
LTMM_E_DVR_CORRUPT_STUB_FILE Corrupted .LBL file.

HRESULT GetBufferTotalSize(long nFolderIndex, long uFlags, long * pnFiles, double * pnTotalFileSize)

Description

Sets the number of buffer (.LRC) files and the allowed size per buffer file for the specified buffer location.

Parameters

nFolderIndex

The index of the desired buffer location.

uFlags

Flag specifying how to calculate the total size. Possible values are:

DVRGetTotalSize_Actual = 0x0000

DVRGetTotalSize_Allowed = 0x0001

pnFiles

Total number of files included in the buffer size calculation.

pnTotalFileSize

The total calculated buffer file size.

Returns

Return Description
S_OK Successful.
E_UNEXPECTED Unexpected invalid file handle.
DISP_E_BADINDEX Index supplied is outside the range of currently valid indexes.

HRESULT CopyBufferToFile(BSTR pszTargetFile, double startOffset, double endOffset)

Description

Copies the buffered recording data to the specified fully qualified file pathname.

Parameters

pszTargetFile

Fully qualified pathname of destination file.

startOffset

Starting offset of data to copy.

endOffset

Ending offset of data to copy.

Returns

Return Description
S_OK Successful.
E_UNEXPECTED Starting offset not found.
DISP_E_BADINDEX Index supplied is outside the range of currently valid indexes.
LTMM_E_DVR_NO_RECORDINGS No .LRC recording files exist.
E_INVALIDARG Either the number of files or file size specified is not valid.

HRESULT ReadData(double startOffset, long minSize, long maxSize, DWORD dwUserData, BYTE * pData, long * pSizeRead)

Description

Reads DVR data from the specified offset.

Parameters

startOffset

A double value indicating the starting offset for the read operation.

minSize

A long value specifying the minimum size to read.

maxSize

A long value specifying the maximum size to read.

dwUserData

Reserved.

pData

A pointer to a block of memory that will receive the read data.

pSizeRead

A pointer to a long type that will receive the size of the read data.

Returns

Return Description
S_OK Successful.
E_UNEXPECTED Unexpected invalid file handle.
LTMM_E_DVR_DISCARDED_DATA Data has been discarded due to a restart.
LTMM_E_DVR_CORRUPT_STUB_FILE Corrupted .LBL file.

HRESULT ResetToDefaultsEx(LMDVRSource_APILEVEL ApiLevel)

Description

Resets the DVRSink interface object to the default settings for the API level specified.

Parameters

ApiLevel

The desired API Level for reset. Possible value is: LMDVRSink_APILEVEL_1.

Returns

Return Description
S_OK Successful.
S_FALSE Otherwise.

HRESULT GetBufferInfo(long nBufferIndex, BSTR * pszFileName, double * pnUsefulSize, double * pnFileSize, long * pnPlayIndex, long * pnFlags, BSTR * pszStubFilePathName)

Description

Gets the buffer information associated with the buffer file index specified.

Parameters

nBufferIndex

The 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 this recording chunk file.

pnFileSize

A pointer to a double type that will receive the physical file size of this recording chunk file.

pnPlayIndex

A pointer to a long type that will receive the index in the play 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. Possible values are:

DVRBuffer_Empty = 0x0001

DVRBuffer_Writing = 0x0002

DVRBuffer_Finished = 0x0004

pszStubFilePathName

A pointer to a string type that will receive the fully qualified path name to the .LBL file.

Returns

Return Description
S_OK Successful.
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. Either the number of files or the file size specified is not valid.

HRESULT GetFragmentAlignment(double startOffset, double endOffset, double *pAlignedStartOffset, double *pAlignedEndOffset)

Description

Takes the user-supplied byte range and scans for transport fragment boundaries.

Parameters

startOffset

Specifies the byte offset at which to begin scanning for transport fragments.

endOffset

Specifies the byte offset at which to stop scanning for transport fragments.

pAlignedStartOffset

A pointer to a double variable, storing the offset of the start of the first transport fragment found.

pAlignedEndOffset

A pointer to a double variable, storing the offset of the end of the last transport fragment.

Comments

Use this method along with CopyBufferToFile to save a completely intact MPEG transport fragment. This is demonstrated in the example.

Set up the MPEG multiplexer used for recording to DVR by calling put_OutputType(Mpg2MxT_OutputType_HLS). Doing so guarantees that fragment boundaries start with synchronization frames. Specify the boundary time interval by calling put_ResyncInterval(intervalTime).

Returns

Return Description
S_OK Successful.
S_FALSE No transport fragment is found: pAlignedStartOffset and pAlignedEndOffset are set equal to startOffset, and indicate an empty search.

HRESULT GetTimedFragmentAlignment(double startOffset, double endOffset, double timeThreshold, double *pAlignedStartOffset, double *pAlignedEndOffset, double *pAlignedDuration)

Description

Takes the user-supplied byte range and scans for transport fragment boundaries. It will only return the minimum number of fragments that meet or exceed the timeThreshold.

Parameters

startOffset

Specifies the byte offset at which to begin scanning for transport fragments.

endOffset

Specifies the byte offset at which to stop scanning for transport fragments.

timeThreshold

Specifies the minimum time (in seconds) of the fragments to find.

pAlignedStartOffset

A pointer to a double variable, storing the offset of the start of the first transport fragment found.

pAlignedEndOffset

A pointer to a double variable, storing the offset of the end of the last transport fragment.

pAlignedDuration

A pointer to a double variable, storing the time (in seconds) of the transport fragments found.

Comments

Use this method along with CopyBufferToFile to save a completely intact MPEG transport fragment.

Set up the MPEG multiplexer used for recording to DVR by calling put_OutputType(Mpg2MxT_OutputType_HLS). Doing so guarantees that fragment boundaries start with synchronization frames. Specify the boundary time interval by calling put_ResyncInterval(intervalTime).

Returns

Return Description
S_OK Successful.
S_FALSE No transport fragment is found: pAlignedStartOffset and pAlignedEndOffset are set equal to startOffset, and indicate an empty search.
Help Version 23.0.2024.9.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

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