Wasabi ExpressPlay SDK for Embedded Systems  1.23.0
EmbItem.h
Go to the documentation of this file.
1 /*****************************************************************
2 |
3 | EMBB Item (EPL and GKO)
4 |
5 | A public header file
6 |
7 | $Id: EmbItem.h 2017-12-29
8 | Original author: Kiran Kumar G
9 |
10 | This software is provided to you pursuant to your agreement
11 | with Intertrust Technologies Corporation ("Intertrust").
12 | This software may be used only in accordance with the terms
13 | of the agreement.
14 |
15 | Copyright (c) 2017-2018 by Intertrust. All rights reserved.
16 |
17 ****************************************************************/
23 #ifndef _EMB_ITEM_H_
24 #define _EMB_ITEM_H_
25 
26 /*----------------------------------------------------------------------
27 | includes
28 +---------------------------------------------------------------------*/
29 #include "EmbProcessor.h"
30 
36 /*----------------------------------------------------------------------
37 | constants
38 +---------------------------------------------------------------------*/
43 #define EMB_TYPE_ID_EMBB_OBJ 2000
44 
45 /*----------------------------------------------------------------------
46 | types
47 +---------------------------------------------------------------------*/
53 typedef enum {
54 
57 
60 
63 
66 } EMB_ItemType;
67 
71 typedef enum {
74 
77 
81 
85 typedef struct EMB_Epl EMB_Epl;
86 
90 typedef struct EMB_Gko EMB_Gko;
91 
95 typedef struct EMB_Mbb EMB_Mbb;
96 
100 typedef struct EMB_Item EMB_Item;
101 
102 /*----------------------------------------------------------------------
103 | functions
104 +---------------------------------------------------------------------*/
105 #if defined(__cplusplus)
106 extern "C" {
107 #endif
108 
118 EMB_Item_GetItemId(const EMB_Item* item);
119 
129 EMB_Item_GetId(const EMB_Item* item);
130 
141 EMB_Item_GetType(const EMB_Item* item);
142 
152 EMB_Item_GetData(const EMB_Item* item);
153 
167 EMB_Item_GetFirstUse(const EMB_Item* item);
168 
180 
193 EMB_Item_GetTargetType(const EMB_Item* item);
194 
207 EMB_Item_GetTargetId(const EMB_Item* item);
208 
211 #if defined(__cplusplus)
212 }
213 #endif /* __cplusplus */
214 
215 #endif /* _EMB_ITEM_H_ */
EMB_EXPORT EMB_TargetType EMB_Item_GetTargetType(const EMB_Item *item)
Gets the target type of the retrieved EMBB item.
The item value type is GKO.
Definition: EmbItem.h:62
EMB_EXPORT EMB_UInt32 EMB_Item_GetExpirationDate(const EMB_Item *item)
Gets the expiration date of the retrieved EMBB item.
struct EMB_Mbb EMB_Mbb
Opaque structure for MBB.
Definition: EmbItem.h:95
EMB (Extended Marlin Broadcast) Processor API.
The item value type is EPL.
Definition: EmbItem.h:59
EMB_EXPORT EMB_ByteArray EMB_Item_GetData(const EMB_Item *item)
Gets the data of the retrieved EMBB item.
EMB_EXPORT EMB_UInt32 EMB_Item_GetItemId(const EMB_Item *item)
Gets the item id of the retrieved EMBB item.
EMB_EXPORT EMB_ByteArray EMB_Item_GetId(const EMB_Item *item)
Gets the id of the retrieved EMBB item.
The item value type is MBB.
Definition: EmbItem.h:65
struct EMB_Gko EMB_Gko
Opaque structure for GKO.
Definition: EmbItem.h:90
struct EMB_Item EMB_Item
EMBB item is an object that retrieved from EMBB Storage.
Definition: EmbItem.h:100
EMB_TargetType
EMBB target type.
Definition: EmbItem.h:71
EMB_EXPORT EMB_ByteArray EMB_Item_GetTargetId(const EMB_Item *item)
Gets the target id of the retrieved EMBB item.
EMB_ItemType
EMBB item type.
Definition: EmbItem.h:53
struct EMB_Epl EMB_Epl
Opaque structure for EPL.
Definition: EmbItem.h:85
The item value type is device.
Definition: EmbItem.h:76
The target value type is none.
Definition: EmbItem.h:73
unsigned int EMB_UInt32
An unsigned 32-bit integer.
Definition: EmbTypes.h:53
The item value type is group.
Definition: EmbItem.h:79
EMB_EXPORT EMB_ItemType EMB_Item_GetType(const EMB_Item *item)
Gets the type of the retrieved EMBB item.
An array of bytes.
Definition: EmbProcessor.h:53
EMB_EXPORT EMB_UInt32 EMB_Item_GetFirstUse(const EMB_Item *item)
Gets the "first use" date of the retrieved EMBB item.
The item value type is unknown.
Definition: EmbItem.h:56
#define EMB_EXPORT
Definition: EmbConfig.h:25