Class YospacePlugin.MetadataBuilder

java.lang.Object
com.castlabs.sdk.yospace.YospacePlugin.MetadataBuilder
Enclosing class:
YospacePlugin

public static final class YospacePlugin.MetadataBuilder extends Object
Builder for the Yospace values stored in AnalyticsMetaData.
  • Constructor Details

    • MetadataBuilder

      public MetadataBuilder(boolean live, @NonNull String assetId)
      Creates metadata for a VOD or DVR-live stream.
      Parameters:
      live - true for DVR live, false for VOD
      assetId - the application's asset identifier
    • MetadataBuilder

      public MetadataBuilder(@NonNull AnalyticsMetaData metadata)
      Adds Yospace values to existing analytics metadata.
      Parameters:
      metadata - metadata to update
  • Method Details

    • token

      @NonNull public YospacePlugin.MetadataBuilder token(@NonNull UUID token)
      Sets the optional client-side session identity.
      Parameters:
      token - session identity
      Returns:
      this builder
    • userAgent

      @NonNull public YospacePlugin.MetadataBuilder userAgent(@NonNull String userAgent)
      Sets the user agent used by Yospace requests.
      Parameters:
      userAgent - user agent value
      Returns:
      this builder
    • customHttpHeaders

      @NonNull public YospacePlugin.MetadataBuilder customHttpHeaders(@NonNull Map<String,String> headers)
      Sets headers used by Yospace's manifest and analytics requests.
      Parameters:
      headers - headers to send
      Returns:
      this builder
    • requestTimeoutMs

      @NonNull public YospacePlugin.MetadataBuilder requestTimeoutMs(int timeoutMs)
      Sets the Yospace initialization request timeout in milliseconds.
      Parameters:
      timeoutMs - request timeout in milliseconds
      Returns:
      this builder
    • noAnalyticsBehavior

      @NonNull public YospacePlugin.MetadataBuilder noAnalyticsBehavior(@NonNull YospacePlugin.NoAnalyticsBehavior behavior)
      Overrides the plugin behavior when analytics are unavailable.
      Parameters:
      behavior - desired behavior
      Returns:
      this builder
    • timeoutBehavior

      @NonNull public YospacePlugin.MetadataBuilder timeoutBehavior(@NonNull YospacePlugin.TimeoutBehavior behavior)
      Overrides the plugin behavior when analytics time out.
      Parameters:
      behavior - desired behavior
      Returns:
      this builder
    • get

      @NonNull public AnalyticsMetaData get()
      Returns the configured metadata.
      Returns:
      configured metadata