ccl.h

//
// Copyright (c) 2014 Conviva. All rights reserved.
// CCL - Conviva Client Library
//
 
 
 
 
#ifndef CCL_H
#define CCL_H
 
#include "ccl_dictionary.h"
#include "ccl_content_info.h"
#include "ccl_notifier_if.h"
#include "ccl_player_if.h"
#include "ccl_platform_if.h"
#include "app_tracker.h"
 
#define CCL_SUCCESS  0
#define CCL_ERROR   -1
 
typedef enum {
    CCL_LOG_LEVEL_NONE  = 0,
    CCL_LOG_LEVEL_ERROR = 1,
    CCL_LOG_LEVEL_WARN  = 2,
    CCL_LOG_LEVEL_INFO  = 3,
    CCL_LOG_LEVEL_DEBUG = 4
} ccl_log_level_t;
 
#define CCL_MAX_URL_LENGTH 256
#define CCL_MAX_APP_NAME_LENGTH 64
#define CCL_MAX_USER_ID_LENGTH 64
 
#define CCL_APP_MAX_SCREEN_NAME_LEN 1024
#define CCL_APP_MAX_SCREEN_ID_LEN 38
 
#define CCL_MAX_CLIENT_ID_LEN_EXT 49
 
typedef enum {
    // Ads and content are played using the same video player instance.
    CONTENT = 0,
    // Ads and content  are played using separate video player instances.
    SEPARATE = 1,
    // The ad player is unknown.
    Unknown = 2
} ad_player_t;
 
typedef enum {
    // Client Side.
    CLIENT_SIDE,
    // Server Side.
    SERVER_SIDE,
    //Unknown
    AD_TYPE_UNKNOWN
} ad_type_t;
 
typedef enum {
    // The ad is a bumper
    BUMPER = 0,
    // The ad is a preroll, kicking in before content.
    PREROLL,
    // The ad is a midroll, kicking in during content.
    MIDROLL,
    // The ad is a postroll, kicking in after content.
    POSTROLL,
    // The ad player is unknown.
    POD_POSITION_Unknown = 99
}ad_position_t;
 
typedef struct  {
 
    // Pod index
    int pod_index;
    // Pod position
    ad_position_t pod_position;
    // Pod duration
    int pod_duration;
} ad_pod_info_t;
 
typedef struct {
 
    char gateway_url[CCL_MAX_URL_LENGTH];
 
    unsigned int heartbeat_interval;
 
    unsigned int player_poll_interval;
 
    ccl_log_level_t log_level;
 
    int enable_player_state_inference;
 
    char client_id[CCL_MAX_CLIENT_ID_LEN_EXT];
 
} ccl_settings_t;
 
extern void ccl_settings_create (ccl_settings_t *settings);
 
extern void ccl_settings_destroy (ccl_settings_t * settings);
 
 
typedef struct ccl_session ccl_session_t;
 
extern int ccl_init (const char *customer_key, const ccl_platform_t *platform_interface, const ccl_settings_t *settings);
 
extern void ccl_cleanup (void);
 
extern ccl_session_t *ccl_session_create (ccl_content_info_t *content_info);
 
extern ccl_session_t *ccl_ad_session_create(ccl_session_t *content_session, ccl_content_info_t *ad_content_info);
 
extern int ccl_session_destroy (ccl_session_t *session);
 
 
extern int ccl_session_player_attach (ccl_session_t *session, const ccl_player_t *player, void *player_data);
 
extern int ccl_session_player_detach (ccl_session_t *session);
 
extern int ccl_session_ad_start (ccl_session_t *session);
 
extern int ccl_session_ad_end (ccl_session_t *session);
 
extern int ccl_session_report_error (ccl_session_t *session, const char *error_message, int is_fatal);
 
extern int ccl_send_event (const char *name, ccl_dictionary_t *attributes);
 
extern int ccl_session_send_event(ccl_session_t *session, const char *name, ccl_dictionary_t *attributes);
 
extern void ccl_session_update_content_info(ccl_session_t *session, const ccl_content_info_t *content_info);
 
extern void ccl_notify_network_connection_type(const char *type);
 
extern void ccl_notify_network_signal_strength(double value);
 
//extern void ccl_notify_network_wifi_ssid(const char *ssid);
 
extern void ccl_notify_network_wifi_link_encryption(const char *name);
 
extern int ccl_session_set_video_size(ccl_session_t *session, int width, int height);
 
extern unsigned int ccl_session_get_session_id(ccl_session_t *session);
 
extern char* ccl_get_client_id(void);
 
extern int report_ad_break_started(ccl_session_t *session, ad_player_t ad_player, ad_type_t ad_type, ad_pod_info_t *pod_info);
 
extern int report_ad_break_ended(ccl_session_t *session, ad_player_t ad_player, ad_type_t ad_type, ad_pod_info_t *pod_info);
 
extern int cat_start_tracker(char* app_name, char* user_id);
 
extern int cat_stop_tracker(void);
 
#endif /* CCL_H */