Conviva Client Library
Data Fields
ccl_platform_metadata Struct Reference

Encapsulates platform-specific metadata to be reported to Conviva. More...

#include <ccl_platform_if.h>

Data Fields

char device_brand [CCL_MAX_PLATFORM_METADATA_LENGTH]
 Brand of the device. More...
 
char device_manufacturer [CCL_MAX_PLATFORM_METADATA_LENGTH]
 Manufacturer of the device. More...
 
char device_model [CCL_MAX_PLATFORM_METADATA_LENGTH]
 Model of the device. More...
 
ccl_device_type_t device_type
 Type of the device. Case sensitive. More...
 
char device_version [CCL_MAX_PLATFORM_METADATA_LENGTH]
 Version of the device. More...
 
char framework_name [CCL_MAX_PLATFORM_METADATA_LENGTH]
 Name of the main framework used by your application, if applicable. More...
 
char framework_version [CCL_MAX_PLATFORM_METADATA_LENGTH]
 Version of the framework used by your application, if applicable. More...
 
char operating_system_name [CCL_MAX_PLATFORM_METADATA_LENGTH]
 Name of the operating system used by the device, in uppercase. More...
 
char operating_system_version [CCL_MAX_PLATFORM_METADATA_LENGTH]
 Version of the operating system used by the device. More...
 
int screen_height
 Screen Height of the display device. More...
 
int screen_width
 Screen Width of the display device. More...
 
double screen_scale_factor
 Screen Scale Factor of the display device. More...
 

Detailed Description

Encapsulates platform-specific metadata to be reported to Conviva.

Field Documentation

◆ device_brand

char ccl_platform_metadata::device_brand[CCL_MAX_PLATFORM_METADATA_LENGTH]

Brand of the device.

Ex: "iPhone", "Samsung SmartTV"

◆ device_manufacturer

char ccl_platform_metadata::device_manufacturer[CCL_MAX_PLATFORM_METADATA_LENGTH]

Manufacturer of the device.

Ex: "Samsung", "Apple"

◆ device_model

char ccl_platform_metadata::device_model[CCL_MAX_PLATFORM_METADATA_LENGTH]

Model of the device.

Ex: "iPhone 6 Plus", "HTC One", "Roku 3", "Samsung SmartTV 2015"

◆ device_type

ccl_device_type_t ccl_platform_metadata::device_type

Type of the device. Case sensitive.

◆ device_version

char ccl_platform_metadata::device_version[CCL_MAX_PLATFORM_METADATA_LENGTH]

Version of the device.

Usually low-level information pertaining to the hardware.

Ex: "DTP-BP-0869-34"

◆ framework_name

char ccl_platform_metadata::framework_name[CCL_MAX_PLATFORM_METADATA_LENGTH]

Name of the main framework used by your application, if applicable.

It can be the name of application framework itself, or the name of the player framework used for video playback.

Ex: "AVFoundation", "OSMF"

◆ framework_version

char ccl_platform_metadata::framework_version[CCL_MAX_PLATFORM_METADATA_LENGTH]

Version of the framework used by your application, if applicable.

Ex: "alpha12", "4.28.4433"

◆ operating_system_name

char ccl_platform_metadata::operating_system_name[CCL_MAX_PLATFORM_METADATA_LENGTH]

Name of the operating system used by the device, in uppercase.

Ex: "WINDOWS", "LINUX", "IOS", "MAC", ANDROID".

If unknown, an approximation can be used.

Ex: "ROKU", "PLAYSTATION".

◆ operating_system_version

char ccl_platform_metadata::operating_system_version[CCL_MAX_PLATFORM_METADATA_LENGTH]

Version of the operating system used by the device.

Ex: "10.10.1", "8.1", "T-INFOLINK2012-1012"

◆ screen_height

int ccl_platform_metadata::screen_height

Screen Height of the display device.

Ex: 720, 1080

◆ screen_scale_factor

double ccl_platform_metadata::screen_scale_factor

Screen Scale Factor of the display device.

It is the factor by which screen_height and screen_width shall be multiplied to achieve resolution in pixels

Ex: 1.0, 2.0

◆ screen_width

int ccl_platform_metadata::screen_width

Screen Width of the display device.

Ex: 1280, 1920