Inherits from PTTrackingMetadata : PTMetadata : NSObject
Declared in PTVideoAnalyticsTrackingMetadata.h

Overview

PTVideoAnalyticsTrackingMetadata class contains property metadata specific to VideoHeartbeat tracking within the SDK.

Tasks

Properties

  •   trackingServer

    String representing the URL of the tracking endpoint on the backend side.

         property
  •   jobId

    String representing the identifier of the processing path on the backend side.

         property
  •   publisher

    String representing the content publisher unique identifier.

         property
  •   playerName

    String representing the playerName. Default value is “PTMediaPlayer”

         property
  •   channel

    String representing the name of the content distribution channel. Default value is “unknown”.

         property
  •   debugLogging

    Activates the debug tracing.

         property
  •   debugTracking

    Activates the logging of the output network calls.

         property
  •   trackLocal

    Activates the “quiet” mode (suppress the output network calls).

         property
  •   enableHeartbeat

    Activates the real-time video tracking support.

         property

Constructor method

Properties

channel

String representing the name of the content distribution channel. Default value is “unknown”.

@property (nonatomic, retain) NSString *channel

Discussion

String representing the name of the content distribution channel. Default value is “unknown”.

Declared In

PTVideoAnalyticsTrackingMetadata.h

debugLogging

Activates the debug tracing.

@property (nonatomic, assign) BOOL debugLogging

Discussion

Activates the debug tracing.

Declared In

PTVideoAnalyticsTrackingMetadata.h

debugTracking

Activates the logging of the output network calls.

@property (nonatomic, assign) BOOL debugTracking

Discussion

Activates the logging of the output network calls.

Declared In

PTVideoAnalyticsTrackingMetadata.h

enableHeartbeat

Activates the real-time video tracking support.

@property (nonatomic, assign) BOOL enableHeartbeat

Discussion

Activates the real-time video tracking support.

Declared In

PTVideoAnalyticsTrackingMetadata.h

jobId

String representing the identifier of the processing path on the backend side.

@property (nonatomic, readonly) NSString *jobId

Discussion

String representing the identifier of the processing path on the backend side.

Declared In

PTVideoAnalyticsTrackingMetadata.h

playerName

String representing the playerName. Default value is “PTMediaPlayer”

@property (nonatomic, retain) NSString *playerName

Discussion

String representing the playerName. Default value is “PTMediaPlayer”

Declared In

PTVideoAnalyticsTrackingMetadata.h

publisher

String representing the content publisher unique identifier.

@property (nonatomic, readonly) NSString *publisher

Discussion

String representing the content publisher unique identifier.

Declared In

PTVideoAnalyticsTrackingMetadata.h

trackLocal

Activates the “quiet” mode (suppress the output network calls).

@property (nonatomic, assign) BOOL trackLocal

Discussion

Activates the “quiet” mode (suppress the output network calls).

Declared In

PTVideoAnalyticsTrackingMetadata.h

trackingServer

String representing the URL of the tracking endpoint on the backend side.

@property (nonatomic, readonly) NSString *trackingServer

Discussion

String representing the URL of the tracking endpoint on the backend side.

Declared In

PTVideoAnalyticsTrackingMetadata.h

Instance Methods

initWithTrackingServer:jobId:publisher:

The URL of the backend endpoint where the VideoHeartbeat tracking data is being collected.

- (id)initWithTrackingServer:(NSString *)trackingServer jobId:(NSString *)jobId publisher:(NSString *)publisher

Parameters

trackingServer

The URL of the backend endpoint where the VideoHeartbeat tracking data is being collected.

jobId

Identifier of the processing path on the backend side.

publisher

Unique identifier for the content publisher.

NOTE: the constructor method raise an exception if any of the input parameters are either nil or the empty string.

NOTE: calling the init constructor directly is forbidden. Doing so will raise an exception.

Declared In

PTVideoAnalyticsTrackingMetadata.h