API's for Bid Id feature. More...

Data Structures
struct	ccl_bidid_input_info_t
	Conviva's Bid Id Input Information. More...

struct	ccl_bidid_data_t
	Holds the Bid Id data. More...

Macros
#define	CCL_BIDID_MAX_SIZE 512
	Max size of Bid Id.

Typedefs
typedef struct ccl_session	ccl_session_t
	Conviva monitoring session.

Enumerations
enum	ccl_bidid_stream_type_t { CCL_BIDID_STREAM_TYPE_UNKNOWN , CCL_BIDID_STREAM_TYPE_LIVE , CCL_BIDID_STREAM_TYPE_LIVE_LINEAR , CCL_BIDID_STREAM_TYPE_VOD , CCL_BIDID_STREAM_TYPE_DVR , CCL_BIDID_STREAM_TYPE_CATCHUP }
	Stream type. More...

enum	ccl_bidid_gen_status_t { CCL_BIDID_GEN_SUCCESS = 0 , CCL_BIDID_EMPTY_RESULT = 1 , CCL_BIDID_ID_GEN_DISABLED = 2 , CCL_BIDID_ALL_IDS_DISABLED = 3 , CCL_BIDID_CUSTOMER_KEY_INVALID = 4 }
	Bid Id generation status. More...

enum	ccl_bidid_associate_status_t { CCL_BIDID_ASSOCIATE_SUCCESS = 0 , CCL_BIDID_INVALID_SESSION_ID = 1 , CCL_BIDID_INVALID_BIDID = 2 , CCL_BIDID_SDK_UNINITIALIZED = 3 }
	Bid Id Association status. More...

Functions
ccl_bidid_data_t	ccl_create_bidid (ccl_session_t session, const ccl_bidid_input_info_t input)
	Creates the Bid Id and associates with session if session instance is available.

ccl_bidid_associate_status_t	ccl_session_associate_bidid (ccl_session_t session, const char bidid)
	Associates the Bid Id with Video session.

Detailed Description

API's for Bid Id feature.

These API's allow the application to generate Conviva Bid Id and associate the Bid Id with the video session

Macro Definition Documentation

◆ CCL_BIDID_MAX_SIZE

#define CCL_BIDID_MAX_SIZE 512

Max size of Bid Id.

Typedef Documentation

◆ ccl_session_t

typedef struct ccl_session ccl_session_t

Conviva monitoring session.

Enumeration Type Documentation

◆ ccl_bidid_associate_status_t

enum ccl_bidid_associate_status_t

Bid Id Association status.

Enumerator
CCL_BIDID_ASSOCIATE_SUCCESS	Bid Id association success.
CCL_BIDID_INVALID_SESSION_ID	Invalid session id.
CCL_BIDID_INVALID_BIDID	Invalid Bid Id.
CCL_BIDID_SDK_UNINITIALIZED	Uninitalized SDK.

◆ ccl_bidid_gen_status_t

enum ccl_bidid_gen_status_t

Bid Id generation status.

Enumerator
CCL_BIDID_GEN_SUCCESS	Bid Id generation success.
CCL_BIDID_EMPTY_RESULT	No inputs are availble to genereate Bid Id (ContentId, ChannelId,StreamType,(Internal fields - ClientId and SessionId))
CCL_BIDID_ID_GEN_DISABLED	Bid Id generation is disabled from server.
CCL_BIDID_ALL_IDS_DISABLED	All IDs are disabled from server.
CCL_BIDID_CUSTOMER_KEY_INVALID	Customer key invalid.

◆ ccl_bidid_stream_type_t

enum ccl_bidid_stream_type_t

Stream type.

Enumerator
CCL_BIDID_STREAM_TYPE_UNKNOWN	Unknown stream type.
CCL_BIDID_STREAM_TYPE_LIVE	live stream type
CCL_BIDID_STREAM_TYPE_LIVE_LINEAR	live linear stream type
CCL_BIDID_STREAM_TYPE_VOD	vod stream type
CCL_BIDID_STREAM_TYPE_DVR	dvr stream type
CCL_BIDID_STREAM_TYPE_CATCHUP	catchup stream type

Function Documentation

◆ ccl_create_bidid()

ccl_bidid_data_t ccl_create_bidid	(	ccl_session_t *	session,
		const ccl_bidid_input_info_t *	input
	)

Creates the Bid Id and associates with session if session instance is available.

Parameters

session	Pointer to a ccl_session_t, if not available then pass NULL
input	Input info for Bid Id creation

Returns

Returns Bid Id and its status

◆ ccl_session_associate_bidid()

ccl_bidid_associate_status_t ccl_session_associate_bidid	(	ccl_session_t *	session,
		const char *	bidid
	)

Associates the Bid Id with Video session.