Manualsbrain.com
  1. Manuals
  2. Brands
  3. Cisco
  4. Headend System Release 2.7

Cisco Headend System Release 2.7

Download
Page of 26
78-4029824-01 Rev B 
 
23 
 
 
Retrieve DVR-Related Data 
 
Retrieve DVR-Related Data 
The following API is used to allow retrieval DVR-related data. 
Note: At present, this API only supports retrieval of HDD usage (in percentage). 
This API is not supported in the DVR 1.5.2 release. 
Syntax 
typedef enum eDvrGetName 
{ 
eDvr_HddUsagePercentage =0,   
// Percentage of HDD  
 
 
 
 
 
// used (0 - 100). 
eDvr_InvalidName   
} eDvrGetName; 
 
extern int saraDvr_Get (  eDvrGetName name, Ptv_Reply *reply);
 
Parameters 
name 
Parameter specifies the type of data requested. 
 
reply 
Pointer to a Ptv_Reply structure. 
Note: The reply->responseQ must be specified and 
reply->timeout must be kPtv_Forever. 
 
Returns 
kSaraDvr_NoErr 
No error.  A kDt_SaraDvr | 
kEt_AsyncResponse event will be sent. 
 
kSaraDvr_InvalidParameterErr 
Unsupported parameter specified by 
caller. 
 
kSaraDvr_InvalidTimeoutErr 
Unsupported timeout value in 
reply
timeout field. 
 
kSaraDvr_InvalidQueueErr 
No response specified in reply structure. 
 
kSaraDvr_UnauthorizedErr 
DVR is not authorized on the STB. 
 
kSaraDvr_NotReadyErr 
DVR is not initialized. 
 
kSaraDvr_NotSupportedErr 
This API is not supported on the platform. 
 
Comments 
The kDt_SaraDvr | kEt_AsyncResponse event sent in response to the 
request has the following information: 
 
x = The response identifier specified in the original Ptv_Reply structure. 
 
y = Generally, a pointer to the requested data.  
In the case of eDvr_HddUsagePercentage, the y field contains the data 
so additional memory does not need to be allocated. 
 
z = Result of request. 
 
kSaraDvr_NoErr 
The requested data has been successfully 
retrieved. 
 
kSaraDvr_InvalidParameterErr  No data or an error in retrieveing the data 
requested. 
 
kSaraDvr_NotReadyErr 
The DVR is not initialized.