FWConstants.h
1 
6 #ifndef FW_EXTERN
7 #ifdef __cplusplus
8 #define FW_EXTERN extern "C"
9 #define FW_PRIVATE_EXTERN __attribute__((visibility("hidden")))
10 #else
11 #define FW_EXTERN extern
12 #define FW_PRIVATE_EXTERN __attribute__((visibility("hidden")))
13 #endif
14 
15 #define FW_LINK_RENDERER(r) \
16 @class r; \
17 @interface r : NSObject { \
18 } \
19 @end; \
20 extern void FWAdManager_Force_Link_##r (void) __attribute__ ((constructor)); \
21 void FWAdManager_Force_Link_##r (void) { \
22 @autoreleasepool{ \
23 NSLog(@"AdManager: registering renderer class: %@", [r description]); \
24 } \
25 }
26 
27 #endif
28 
29 typedef enum {
30  FW_LOG_LEVEL_QUIET = 0,
31  FW_LOG_LEVEL_INFO = 3,
32  FW_LOG_LEVEL_VERBOSE = 5
33 } FWLogLevel;
34 
38 typedef enum {
40  FW_SLOT_OPTION_INITIAL_AD_STAND_ALONE = 0,
42  FW_SLOT_OPTION_INITIAL_AD_KEEP_ORIGINAL = 1,
44  FW_SLOT_OPTION_INITIAL_AD_FIRST_COMPANION_ONLY = 2,
46  FW_SLOT_OPTION_INITIAL_AD_FIRST_COMPANION_OR_STAND_ALONE = 3,
48  FW_SLOT_OPTION_INITIAL_AD_FIRST_COMPANION_THEN_STAND_ALONE = 4,
50  FW_SLOT_OPTION_INITIAL_AD_FIRST_COMPANION_OR_NO_STAND_ALONE = 5,
52  FW_SLOT_OPTION_INITIAL_AD_NO_STAND_ALONE = 6,
54  FW_SLOT_OPTION_INITIAL_AD_NO_STAND_ALONE_IF_TEMPORAL = 7,
56  FW_SLOT_OPTION_INITIAL_AD_FIRST_COMPANION_OR_NO_STAND_ALONE_IF_TEMPORAL = 8
57 } FWInitialAdOption;
58 
62 typedef enum {
64  FW_CAPABILITY_STATUS_OFF = 0,
66  FW_CAPABILITY_STATUS_ON = 1,
68  FW_CAPABILITY_STATUS_DEFAULT = -1
69 } FWCapabilityStatus;
70 
74 typedef enum {
76  FW_ID_TYPE_CUSTOM = 0,
78  FW_ID_TYPE_FW = 1,
80  FW_ID_TYPE_FWGROUP = 2
81 } FWIdType;
82 
86 typedef enum {
88  FW_VIDEO_STATE_PLAYING = 1,
90  FW_VIDEO_STATE_PAUSED = 2,
92  FW_VIDEO_STATE_STOPPED = 3,
94  FW_VIDEO_STATE_COMPLETED = 4
95 } FWVideoState;
96 
100 typedef enum {
102  FW_TIME_POSITION_CLASS_PREROLL = 1,
104  FW_TIME_POSITION_CLASS_MIDROLL = 2,
106  FW_TIME_POSITION_CLASS_POSTROLL = 3,
108  FW_TIME_POSITION_CLASS_OVERLAY = 4,
110  FW_TIME_POSITION_CLASS_DISPLAY = 5,
112  FW_TIME_POSITION_CLASS_PAUSE_MIDROLL = 6
113 } FWTimePositionClass;
114 
118 typedef enum {
120  FW_SLOT_TYPE_TEMPORAL = 1,
122  FW_SLOT_TYPE_VIDEOPLAYER_NONTEMPORAL = 2,
124  FW_SLOT_TYPE_SITESECTION_NONTEMPORAL = 3
125 } FWSlotType;
126 
130 typedef enum {
132  FW_PARAMETER_LEVEL_PROFILE = 0,
134  FW_PARAMETER_LEVEL_GLOBAL = 1,
136  FW_PARAMETER_LEVEL_SLOT = 2,
138  FW_PARAMETER_LEVEL_CREATIVE = 3,
140  FW_PARAMETER_LEVEL_RENDITION = 4,
142  FW_PARAMETER_LEVEL_OVERRIDE = 5
143 } FWParameterLevel;
144 
148 typedef enum {
150  FW_RENDERER_STATE_PRELOADED = 2,
152  FW_RENDERER_STATE_STARTED = 3,
154  FW_RENDERER_STATE_COMPLETED = 5,
156  FW_RENDERER_STATE_FAILED = 6
157 } FWRendererStateType;
158 
162 typedef enum {
164  FW_REQUEST_MODE_ON_DEMAND = 1,
166  FW_REQUEST_MODE_LIVE = 2
167 } FWRequestMode;
168 
172 typedef enum {
174  FW_VIDEO_ASSET_DURATION_TYPE_EXACT = 1,
176  FW_VIDEO_ASSET_DURATION_TYPE_VARIABLE = 2
177 } FWVideoAssetDurationType;
178 
182 typedef enum {
184  FW_VIDEO_ASSET_AUTO_PLAY_TYPE_NONE = 0,
186  FW_VIDEO_ASSET_AUTO_PLAY_TYPE_ATTENDED = 1,
188  FW_VIDEO_ASSET_AUTO_PLAY_TYPE_UNATTENDED = 2
189 } FWVideoAssetAutoPlayType;
190 
194 typedef enum {
196  FW_USER_ACTION_PAUSE_BUTTON_CLICKED = 0,
198  FW_USER_ACTION_RESUME_BUTTON_CLICKED = 1
199 } FWUserAction;
200 
206 FW_EXTERN NSString *const FW_NOTIFICATION_REQUEST_COMPLETE;
207 
213 FW_EXTERN NSString *const FW_NOTIFICATION_SLOT_PRELOADED;
214 
220 FW_EXTERN NSString *const FW_NOTIFICATION_SLOT_STARTED;
221 
227 FW_EXTERN NSString *const FW_NOTIFICATION_SLOT_ENDED;
228 
234 FW_EXTERN NSString *const FW_NOTIFICATION_IN_APP_VIEW_OPEN;
235 
241 FW_EXTERN NSString *const FW_NOTIFICATION_IN_APP_VIEW_CLOSE;
242 
248 FW_EXTERN NSString *const FW_NOTIFICATION_IN_APP_VIEW_WILL_OPEN_MEDIA_DOCUMENT;
249 
256 FW_EXTERN NSString *const FW_NOTIFICATION_CONTENT_PAUSE_REQUEST;
257 
264 FW_EXTERN NSString *const FW_NOTIFICATION_CONTENT_RESUME_REQUEST;
265 
269 FW_EXTERN NSString *const FW_NOTIFICATION_AD_IMPRESSION;
270 
274 FW_EXTERN NSString *const FW_NOTIFICATION_AD_IMPRESSION_END;
275 
279 FW_EXTERN NSString *const FW_NOTIFICATION_AD_ERROR;
280 
281 
282 FW_EXTERN NSString *const FW_NOTIFICATION_USER_ACTION_NOTIFIED;
283 
287 FW_EXTERN NSString *const FW_NOTIFICATION_AD_EXPAND_TO_FULLSCREEN;
288 
292 FW_EXTERN NSString *const FW_NOTIFICATION_AD_COLLAPSE_FROM_FULLSCREEN;
293 
297 FW_EXTERN NSString *const FW_NOTIFICATION_SLOT_EXTERNAL_PLAYBACK_STARTED;
298 
302 FW_EXTERN NSString *const FW_NOTIFICATION_SLOT_EXTERNAL_PLAYBACK_STOPPED;
303 
310 FW_EXTERN NSString *const FW_NOTIFICATION_RENDERER_EVENT;
311 
317 FW_EXTERN NSString *const FW_NOTIFICATION_VIDEO_DISPLAY_BASE_CHANGED;
318 
323 FW_EXTERN NSString *const FW_NOTIFICATION_VIDEO_DISPLAY_BASE_FRAME_CHANGED;
324 
329 FW_EXTERN NSString *const FW_NOTIFICATION_EXTENSION_LOADED;
330 
335 FW_EXTERN NSString *const FW_NOTIFICATION_EXTERNALPLAYBACK_INTERRUPTED;
336 
348 FW_EXTERN NSString *const FW_ADUNIT_PREROLL;
349 
361 FW_EXTERN NSString *const FW_ADUNIT_MIDROLL;
362 
374 FW_EXTERN NSString *const FW_ADUNIT_POSTROLL;
375 
387 FW_EXTERN NSString *const FW_ADUNIT_OVERLAY;
388 
389 
401 FW_EXTERN NSString *const FW_ADUNIT_PAUSE_MIDROLL;
402 
414 FW_EXTERN NSString *const FW_ADUNIT_STREAM_PREROLL;
415 
427 FW_EXTERN NSString *const FW_ADUNIT_STREAM_POSTROLL;
428 
435 FW_EXTERN NSString *const FW_CAPABILITY_SLOT_TEMPLATE;
436 
443 FW_EXTERN NSString *const FW_CAPABILITY_ADUNIT_IN_MULTIPLE_SLOTS;
444 
451 FW_EXTERN NSString *const FW_CAPABILITY_BYPASS_COMMERCIAL_RATIO_RESTRICTION;
452 
459 FW_EXTERN NSString *const FW_CAPABILITY_CHECK_COMPANION;
460 
467 FW_EXTERN NSString *const FW_CAPABILITY_CHECK_TARGETING;
468 
472 FW_EXTERN NSString *const FW_CAPABILITY_REQUIRES_VIDEO_CALLBACK_URL;
473 
477 FW_EXTERN NSString *const FW_CAPABILITY_SLOT_CALLBACK;
478 
482 FW_EXTERN NSString *const FW_CAPABILITY_SKIP_AD_SELECTION;
483 
490 FW_EXTERN NSString *const FW_CAPABILITY_RECORD_VIDEO_VIEW;
491 
498 FW_EXTERN NSString *const FW_CAPABILITY_SYNC_MULTI_REQUESTS;
499 
510 FW_EXTERN NSString *const FW_CAPABILITY_RESET_EXCLUSIVITY;
511 
518 FW_EXTERN NSString *const FW_CAPABILITY_FALLBACK_ADS;
519 
526 FW_EXTERN NSString *const FW_CAPABILITY_MULTIPLE_CREATIVE_RENDITIONS;
527 
531 FW_EXTERN NSString *const FW_EVENT_SLOT_IMPRESSION;
532 
536 FW_EXTERN NSString *const FW_EVENT_SLOT_IMPRESSION_END;
537 
541 FW_EXTERN NSString *const FW_EVENT_AD_IMPRESSION;
542 
546 FW_EXTERN NSString *const FW_EVENT_AD_IMPRESSION_END;
547 
551 FW_EXTERN NSString *const FW_EVENT_AD_QUARTILE;
552 
556 FW_EXTERN NSString *const FW_EVENT_AD_FIRST_QUARTILE;
557 
561 FW_EXTERN NSString *const FW_EVENT_AD_MIDPOINT;
562 
566 FW_EXTERN NSString *const FW_EVENT_AD_THIRD_QUARTILE;
567 
571 FW_EXTERN NSString *const FW_EVENT_AD_COMPLETE;
572 
576 FW_EXTERN NSString *const FW_EVENT_AD_CLICK;
577 
581 FW_EXTERN NSString *const FW_EVENT_AD_MUTE;
582 
586 FW_EXTERN NSString *const FW_EVENT_AD_UNMUTE;
587 
591 FW_EXTERN NSString *const FW_EVENT_AD_COLLAPSE;
592 
596 FW_EXTERN NSString *const FW_EVENT_AD_EXPAND;
597 
601 FW_EXTERN NSString *const FW_EVENT_AD_PAUSE;
602 
606 FW_EXTERN NSString *const FW_EVENT_AD_RESUME;
607 
611 FW_EXTERN NSString *const FW_EVENT_AD_REWIND;
612 
616 FW_EXTERN NSString *const FW_EVENT_AD_ACCEPT_INVITATION;
617 
621 FW_EXTERN NSString *const FW_EVENT_AD_CLOSE;
622 
626 FW_EXTERN NSString *const FW_EVENT_AD_MINIMIZE;
627 
631 FW_EXTERN NSString *const FW_EVENT_AD_RESELLER_NO_AD;
632 
636 FW_EXTERN NSString *const FW_EVENT_AD_ERROR;
637 
641 FW_EXTERN NSString *const FW_EVENT_AD_MEASUREMENT;
642 
646 FW_EXTERN NSString *const FW_EVENT_ERROR;
647 
651 FW_EXTERN NSString *const FW_EVENT_RESELLER_NO_AD;
652 
656 FW_EXTERN NSString *const FW_EVENT_TYPE_CLICK_TRACKING;
657 
661 FW_EXTERN NSString *const FW_EVENT_TYPE_IMPRESSION;
662 
666 FW_EXTERN NSString *const FW_EVENT_TYPE_CLICK;
667 
671 FW_EXTERN NSString *const FW_EVENT_TYPE_STANDARD;
672 
676 FW_EXTERN NSString *const FW_EVENT_PAUSE_BUTTON_CLICKED;
677 
681 FW_EXTERN NSString *const FW_EVENT_RESUME_BUTTON_CLCKED;
682 
686 FW_EXTERN NSString *const FW_PARAMETER_OPEN_IN_APP;
687 
694 FW_EXTERN NSString *const FW_PARAMETER_IN_APP_VIEW_LOADING_TIMEOUT;
695 
712 FW_EXTERN NSString *const FW_PARAMETER_IN_APP_VIEW_TOOLBAR_SURFACE_RENDER;
713 
718 FW_EXTERN NSString *const FW_PARAMETER_IN_APP_VIEW_NAVIGATION_BAR_BACKGROUND_COLOR;
719 
725 FW_EXTERN NSString *const FW_PARAMETER_IN_APP_VIEW_NAVIGATION_BAR_ALPHA;
726 
731 FW_EXTERN NSString *const FW_PARAMETER_IN_APP_VIEW_NAVIGATION_BAR_HEIGHT;
732 
738 FW_EXTERN NSString *const FW_PARAMETER_IN_APP_VIEW_WEB_VIEW_BACKGROUND_COLOR;
739 
745 FW_EXTERN NSString *const FW_PARAMETER_IN_APP_VIEW_WEB_VIEW_ALPHA;
746 
747 FW_EXTERN NSString *const FW_PARAMETER_VIDEO_AD_SCALING_MODE DEPRECATED_ATTRIBUTE;
748 FW_EXTERN NSString *const FW_PARAMETER_VIDEO_AD_SCALING_MODE_NONE DEPRECATED_ATTRIBUTE;
749 FW_EXTERN NSString *const FW_PARAMETER_VIDEO_AD_SCALING_MODE_ASPECT_FIT DEPRECATED_ATTRIBUTE;
750 FW_EXTERN NSString *const FW_PARAMETER_VIDEO_AD_SCALING_MODE_ASPECT_FILL DEPRECATED_ATTRIBUTE;
751 FW_EXTERN NSString *const FW_PARAMETER_VIDEO_AD_SCALING_MODE_FILL DEPRECATED_ATTRIBUTE;
752 
758 FW_EXTERN NSString *const FW_PARAMETER_VIDEO_AD_USE_APPLICATION_AUDIO_SESSION;
759 
766 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_DISPLAY;
767 
774 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_REFRESH_INTERVAL;
775 
782 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_UPDATE_CALLBACK;
783 
789 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_POSITION;
790 
797 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_ALPHA;
798 
805 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_HEIGHT;
806 
813 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_WIDTH;
814 
821 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_TEXT_SIZE;
822 
829 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_BG_COLOR;
830 
837 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_FONT_COLOR;
838 
845 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_TEXT_FONT;
846 
853 FW_EXTERN NSString *const FW_PARAMETER_COUNTDOWN_TIMER_HTML;
854 
860 FW_EXTERN NSString *const FW_PARAMETER_NONTEMPORAL_SLOT_VISIBILITY_AUTO_TRACKING;
861 
868 FW_EXTERN NSString *const FW_PARAMETER_PAUSEAD_ENABLE;
869 
875 FW_EXTERN NSString *const FW_INFO_KEY_URL;
876 
877 
883 FW_EXTERN NSString *const FW_INFO_KEY_ERROR;
884 
890 FW_EXTERN NSString *const FW_INFO_KEY_CUSTOM_ID;
891 
897 FW_EXTERN NSString *const FW_INFO_KEY_CONCRETE_EVENT_ID;
898 
904 FW_EXTERN NSString *const FW_INFO_KEY_SLOT;
905 
911 FW_EXTERN NSString *const FW_INFO_KEY_ADINSTANCE;
912 
918 FW_EXTERN NSString *const FW_INFO_KEY_AD_ID;
919 
925 FW_EXTERN NSString *const FW_INFO_KEY_CREATIVE_ID;
926 
927 FW_EXTERN NSString *const FW_INFO_KEY_USER_ACTION;
928 
934 FW_EXTERN NSString *const FW_INFO_KEY_MODULE_NAME;
935 
940 FW_EXTERN NSString *const FW_INFO_KEY_MODULE_TYPE;
941 
947 FW_EXTERN NSString *const FW_INFO_KEY_REQUIRED_API_VERSION;
948 
953 FW_EXTERN NSString *const FW_MODULE_TYPE_RENDERER;
954 
959 FW_EXTERN NSString *const FW_MODULE_TYPE_TRANSLATOR;
960 
965 FW_EXTERN NSString *const FW_INFO_KEY_ERROR_CODE;
966 
971 FW_EXTERN NSString *const FW_INFO_KEY_ERROR_INFO;
972 
977 FW_EXTERN NSString *const FW_INFO_KEY_ERROR_MODULE;
978 
982 FW_EXTERN NSString *const FW_ERROR_IO;
983 
987 FW_EXTERN NSString *const FW_ERROR_TIMEOUT;
988 
992 FW_EXTERN NSString *const FW_ERROR_NULL_ASSET;
993 
997 FW_EXTERN NSString *const FW_ERROR_ADINSTANCE_UNAVAILABLE;
998 
1002 FW_EXTERN NSString *const FW_ERROR_UNKNOWN;
1003 
1007 FW_EXTERN NSString *const FW_ERROR_MISSING_PARAMETER;
1008 
1012 FW_EXTERN NSString *const FW_ERROR_NO_AD_AVAILABLE;
1013 
1017 FW_EXTERN NSString *const FW_ERROR_PARSE;
1018 
1022 FW_EXTERN NSString *const FW_ERROR_INVALID_VALUE;
1023 
1027 FW_EXTERN NSString *const FW_ERROR_INVALID_SLOT;
1028 
1032 FW_EXTERN NSString *const FW_ERROR_NO_RENDERER;
1033 
1037 FW_EXTERN NSString *const FW_ERROR_NO_PRELOAD_IN_TRANSLATOR;
1038 
1042 FW_EXTERN NSString *const FW_ERROR_IN_APP_VIEW;
1043 
1047 FW_EXTERN NSString *const FW_ERROR_3P_COMPONENT;
1048 
1052 FW_EXTERN NSString *const FW_ERROR_UNSUPPORTED_3P_FEATURE;
1053 
1058 FW_EXTERN NSString *const FW_INFO_KEY_SUB_EVENT_NAME;
1059 
1065 FW_EXTERN NSString *const FW_INFO_KEY_CUSTOM_EVENT_NAME;
1066 
1075 FW_EXTERN NSString *const FW_INFO_KEY_SHOW_BROWSER;
1076 
1080 FW_EXTERN NSString *const FW_INFO_KEY_VIDEO_DISPLAY_BASE;
1081 
1085 FW_EXTERN NSString *const FW_PARAMETER_POSTAL_CODE;
1086 
1090 FW_EXTERN NSString *const FW_PARAMETER_AREA_CODE;
1091 
1095 FW_EXTERN NSString *const FW_PARAMETER_DATE_OF_BIRTH;
1096 
1100 FW_EXTERN NSString *const FW_PARAMETER_GENDER;
1101 
1105 FW_EXTERN NSString *const FW_PARAMETER_KEYWORDS;
1106 
1110 FW_EXTERN NSString *const FW_PARAMETER_SEARCH_STRING;
1111 
1115 FW_EXTERN NSString *const FW_PARAMETER_MARITAL;
1116 
1120 FW_EXTERN NSString *const FW_PARAMETER_ETHNICITY;
1121 
1125 FW_EXTERN NSString *const FW_PARAMETER_ORIENTATION;
1126 
1130 FW_EXTERN NSString *const FW_PARAMETER_INCOME;
1131 
1138 FW_EXTERN NSString *const FW_PARAMETER_CLICK_DETECTION;
1139 
1146 FW_EXTERN NSString *const FW_PARAMETER_USE_CONTROL_PANEL;
1147 
1154 FW_EXTERN NSString *const FW_PARAMETER_DESIRED_BITRATE;
1155 
1156 FW_EXTERN NSString *const FW_PARAMETER_DESIRED_ORIENTATION DEPRECATED_ATTRIBUTE;
1157 
1158 FW_EXTERN NSString *const FW_PARAMETER_REQUEST_TEMPLATE_VARIABLES;
1159 
1160 FW_EXTERN NSString *const FW_PARAMETER_REQUEST_ALTERNATIVE_URL;
1161 
1167 FW_EXTERN NSString *const FW_PARAMETER_IDFA;
1168 
1169 FW_EXTERN NSString *const FW_EVENT_AD_BUFFERING_END;
1170 
1171 FW_EXTERN NSString *const FW_EVENT_AD_BUFFERING_START;
1172 
1173 FW_EXTERN NSString *const FW_EVENT_TYPE_CUSTOM;