MHEG5 1.0
DTVKit MHEG5 1.0 API Documentation
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
mh5filegroup.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright � 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright � 2010 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
25 #ifndef _MH5FILEGROUP_H
26 #define _MH5FILEGROUP_H
27 
28 /*---includes for this file--------------------------------------------------*/
29 #include "fs_types.h"
30 
31 /*---Constant and macro definitions for public use---------------------------*/
32 
33 /*---Enumerations for public use---------------------------------------------*/
34 
35 /*---Global type defs for public use-----------------------------------------*/
36 
37 typedef enum
38 {
42 } E_FG_ORIGIN;
43 
44 /*---Global variable declarations for public use-----------------------------*/
45 
46 /*---Global Function prototypes for public use-------------------------------*/
47 
54 void FG_Initialise( U32BIT nvmSize );
55 
60 void FG_Terminate( void );
61 
69 void FG_FetchManifests( void *hOC, U8BIT cachePriority );
70 
77 void FG_FinishManifests( void *hOC );
78 
84 E_FsStatus FG_LoadRequest( E_FG_ORIGIN origin, char *fname,
85  F_FS_CALLBACK cb_func, S_CONTENT *pContent );
86 
92 E_FsStatus FG_FileExists( E_FG_ORIGIN origin, char *fname );
93 
99 void FG_FactoryReset( void );
100 
106 void* FG_GetCarouselHandle( void *fs_ref );
107 
108 #endif /*_MH5FILEGROUP_H*/
void FG_FactoryReset(void)
In the "factory reset", we clear all file groups from cache store. Then re-aquire file groups for the...
E_FsStatus FG_FileExists(E_FG_ORIGIN origin, char *fname)
Request file from file group stores.
Definition: fs_types.h:52
uint8_t U8BIT
Definition: techtype.h:93
File System types.
Definition: mh5filegroup.h:40
Definition: mh5filegroup.h:41
E_FsStatus FG_LoadRequest(E_FG_ORIGIN origin, char *fname, F_FS_CALLBACK cb_func, S_CONTENT *pContent)
Request file from file group stores.
void(* F_FS_CALLBACK)(E_FsStatus result, S_CONTENT *pContent)
Callback function to notify client of result for a file system load request. This is intented for asy...
Definition: fs_types.h:67
void FG_FinishManifests(void *hOC)
Tell File Group that finished with the Obect Carousel's SRG User Info to reference file groups...
E_FG_ORIGIN
Definition: mh5filegroup.h:37
void * FG_GetCarouselHandle(void *fs_ref)
Get Carousel handle from DSM-CC reference.
void FG_Initialise(U32BIT nvmSize)
Initialise - retrieve data from NVM storage for any file groups and allocate the file group list...
Definition: mh5filegroup.h:39
void FG_Terminate(void)
Terminate - free data associated with all file groups.
void FG_FetchManifests(void *hOC, U8BIT cachePriority)
Examines the Obect Carousel's SRG User Info for references to the file group, and requests the manife...
uint32_t U32BIT
Definition: techtype.h:97
E_FsStatus
Definition: fs_types.h:34