Class NielsenPlugin.MetadataBuilder

java.lang.Object
com.castlabs.sdk.nielsen.NielsenPlugin.MetadataBuilder
Enclosing class:
NielsenPlugin

public static final class NielsenPlugin.MetadataBuilder extends Object
A helper class to build AnalyticsMetaData objects for the Nielsen plugin.
  • Constructor Details

    • MetadataBuilder

      public MetadataBuilder(boolean live, @NonNull String assetId)
      Creates a new builder.
      Parameters:
      live - true if the current content is a live stream and false otherwise
      assetId - The asset ID uniquely identifies the content
    • MetadataBuilder

      public MetadataBuilder(@NonNull AnalyticsMetaData analyticsMetaData)
      Creates a new builder starting from an existing AnalyticsMetaData object.
      Parameters:
      analyticsMetaData - The base metadata.
  • Method Details

    • channelInfo

      @NonNull public NielsenPlugin.MetadataBuilder channelInfo(@Nullable JSONObject channelInfo)
      Sets the channel information passed to the Nielsen play() call.
      Parameters:
      channelInfo - The channel information, or null to remove it.
      Returns:
      this builder.
    • contentMetadata

      @NonNull public NielsenPlugin.MetadataBuilder contentMetadata(@Nullable JSONObject contentMetadata)
      Sets the content metadata passed to the Nielsen loadMetadata() call.
      Parameters:
      contentMetadata - The content metadata, or null to remove it.
      Returns:
      this builder.
    • adMetadata

      @NonNull public NielsenPlugin.MetadataBuilder adMetadata(@Nullable JSONObject adMetadata)
      Sets the ad metadata passed to the Nielsen loadMetadata() call for each ad.
      Parameters:
      adMetadata - The ad metadata, or null to remove it.
      Returns:
      this builder.
    • get

      @NonNull public AnalyticsMetaData get()
      Returns the final AnalyticsMetaData object.
      Returns:
      The analytics metadata.