Kantar Media Streaming Sensor Apple TV
Kantar Media Streaming Measurement Library for Apple TV
Instance Methods | Class Methods | Properties | List of all members
KMA_SpringStreams Class Reference

The sensor which exists exactly one time in an application and manage all streaming measurement issues. More...

#import <KMA_SpringStreams.h>

Inheritance diagram for KMA_SpringStreams:

Instance Methods

(KMA_Stream *) - track:atts:
 Call this method to start a tracking of a streaming content. More...
 
(void) - unload
 When the method is called all internal tracking processes will be terminated. More...
 
(NSMutableDictionary *) - getEncrypedIdentifiers
 Returns the encrypted (md5) and truncated mobile identifiers. More...
 

Class Methods

(KMA_SpringStreams *) + getInstance:a:
 Returns the instance of the sensor which is initialized with a site name and an application name. More...
 
(KMA_SpringStreams *) + getInstance
 

Properties

BOOL tracking
 Enable or disable usage tracking. More...
 
BOOL debug
 When set to true (default:false) the library logs the internal actions. More...
 
NSTimeInterval timeout
 Internally it sends http requests to the measurement system. More...
 
BOOL offlineMode
 Enable or disable offline mode. More...
 

Detailed Description

The sensor which exists exactly one time in an application and manage all streaming measurement issues.

When the application starts the sensor has to be instantiated one time with the method getInstance:site:app. The next calls must be transmtted by the method getInstance.

See also
+ getInstance (KMA_SpringStreams):a b
+ getInstance (KMA_SpringStreams):a
+ getInstance (KMA_SpringStreams)

Method Documentation

◆ getEncrypedIdentifiers()

- (NSMutableDictionary *) getEncrypedIdentifiers

Returns the encrypted (md5) and truncated mobile identifiers.

The MAC ID is stored with the key 'mid' The Vendor ID is stored with the key 'ifv'

◆ getInstance()

+ (KMA_SpringStreams*) getInstance

◆ getInstance:a:()

+ (KMA_SpringStreams*) getInstance: (NSString *)  site
a: (NSString *)  app 

Returns the instance of the sensor which is initialized with a site name and an application name.

Warning
The site name and the application name will be predefined by the measurement system operator.

This method has to be called the first time when the application is starting.

See also
+ getInstance
Exceptions
Anexception is thrown when this method is called for a second time.

◆ track:atts:()

- (KMA_Stream*) track: (NSObject< KMA_StreamAdapter > *)  stream
atts: (NSDictionary *)  atts 

Call this method to start a tracking of a streaming content.

The sensor gets access to the KMA_Stream through the given adapter. The variable name is mandatory in the attributes object.

See also
KMA_StreamAdapter
KMA_Stream
Parameters
streamThe KMA_StreamAdapter which handles the access to the underlying streaming content
attsA map which contains information about the streaming content.
Exceptions
Anexception if parameter KMA_Stream or atts is null.
Anexception if the mandatory name attributes are not found.
Returns
A instance of KMA_Stream which handles the tracking.

◆ unload()

- (void) unload

When the method is called all internal tracking processes will be terminated.

Call this method when the application is closing.

Property Documentation

◆ debug

- (BOOL) debug
readwritenonatomicassign

When set to true (default:false) the library logs the internal actions.

Each error is logged without checking this property.

◆ offlineMode

- (BOOL) offlineMode
readwriteatomicassign

Enable or disable offline mode.

It will be configured in the release process. Please refer to Main page for more Info

◆ timeout

- (NSTimeInterval) timeout
readwriteatomicassign

Internally it sends http requests to the measurement system.

This property sets a timeout for that purpose.

◆ tracking

- (BOOL) tracking
readwriteatomicassign

Enable or disable usage tracking.

(default: true)


The documentation for this class was generated from the following file: