Field Detail

• DEFAULT_LOAD_VIDEO_TIMEOUT_MS

  public static final int DEFAULT_LOAD_VIDEO_TIMEOUT_MS

  The default timeout for loading the video URI, in milliseconds.

  See Also:

  Constant Field Values

• format

  @ContentType
  public @com.google.android.exoplayer2.C.ContentType int format

Constructor Detail

• ImaServerSideAdInsertionUriBuilder

  public ImaServerSideAdInsertionUriBuilder()

  Creates a new instance.

Method Detail

• setAdsId

  public ImaServerSideAdInsertionUriBuilder setAdsId​(String adsId)

  An opaque identifier for associated ad playback state, or null if the asset key (for live) or video id (for VOD) should be used as the ads identifier.

  Parameters:

  adsId - The ads identifier.

  Returns:

  This instance, for convenience.

• setAssetKey

  public ImaServerSideAdInsertionUriBuilder setAssetKey​(@Nullable
                                                        String assetKey)

  The stream request asset key used for live streams.

  Parameters:

  assetKey - Live stream asset key.

  Returns:

  This instance, for convenience.

• setAuthToken

  public ImaServerSideAdInsertionUriBuilder setAuthToken​(@Nullable
                                                         String authToken)

  Sets the stream request authorization token. Used in place of the API key for stricter content authorization. The publisher can control individual content streams authorizations based on this token.

  Parameters:

  authToken - Live stream authorization token.

  Returns:

  This instance, for convenience.

• setContentSourceId

  public ImaServerSideAdInsertionUriBuilder setContentSourceId​(@Nullable
                                                               String contentSourceId)

  The stream request content source ID used for on-demand streams.

  Parameters:

  contentSourceId - VOD stream content source id.

  Returns:

  This instance, for convenience.

• setVideoId

  public ImaServerSideAdInsertionUriBuilder setVideoId​(@Nullable
                                                       String videoId)

  The stream request video ID used for on-demand streams.

  Parameters:

  videoId - VOD stream video id.

  Returns:

  This instance, for convenience.

• setFormat

  public ImaServerSideAdInsertionUriBuilder setFormat​(@ContentType
                                                      @com.google.android.exoplayer2.C.ContentType int format)

  Sets the format of the stream request.

  Parameters:

  format - VOD or live stream type.

  Returns:

  This instance, for convenience.

• setApiKey

  public ImaServerSideAdInsertionUriBuilder setApiKey​(@Nullable
                                                      String apiKey)

  The stream request API key. This is used for content authentication. The API key is provided to the publisher to unlock their content. It's a security measure used to verify the applications that are attempting to access the content.

  Parameters:

  apiKey - Stream api key.

  Returns:

  This instance, for convenience.

• setStreamActivityMonitorId

  public ImaServerSideAdInsertionUriBuilder setStreamActivityMonitorId​(@Nullable
                                                                       String streamActivityMonitorId)

  Sets the ID to be used to debug the stream with the stream activity monitor. This is used to provide a convenient way to allow publishers to find a stream log in the stream activity monitor tool.

  Parameters:

  streamActivityMonitorId - ID for debugging the stream with the stream activity monitor.

  Returns:

  This instance, for convenience.

• setAdTagParameters

  public ImaServerSideAdInsertionUriBuilder setAdTagParameters​(Map<String,​String> adTagParameters)

  Sets the overridable ad tag parameters on the stream request. Supply targeting parameters to your stream provides more information.

  You can use the dai-ot and dai-ov parameters for stream variant preference. See Override Stream Variant Parameters for more information.

  Parameters:

  adTagParameters - A map of extra parameters to pass to the ad server.

  Returns:

  This instance, for convenience.

• setManifestSuffix

  public ImaServerSideAdInsertionUriBuilder setManifestSuffix​(@Nullable
                                                              String manifestSuffix)

  Sets the optional stream manifest's suffix, which will be appended to the stream manifest's URL. The provided string must be URL-encoded and must not include a leading question mark.

  Parameters:

  manifestSuffix - Stream manifest's suffix.

  Returns:

  This instance, for convenience.

• setContentUrl

  public ImaServerSideAdInsertionUriBuilder setContentUrl​(@Nullable
                                                          String contentUrl)

  Specifies the deep link to the content's screen. If provided, this parameter is passed to the OM SDK. See Android documentation for more information.

  Parameters:

  contentUrl - Deep link to the content's screen.

  Returns:

  This instance, for convenience.

• setLoadVideoTimeoutMs

  public ImaServerSideAdInsertionUriBuilder setLoadVideoTimeoutMs​(int loadVideoTimeoutMs)

  Sets the duration after which resolving the video URI should time out, in milliseconds.

  The default is DEFAULT_LOAD_VIDEO_TIMEOUT_MS milliseconds.

  Parameters:

  loadVideoTimeoutMs - The timeout after which to give up resolving the video URI.

  Returns:

  This instance, for convenience.

• build

  public Uri build()

  Builds a URI with the builder's current values.

  Returns:

  The build Uri.

  Throws:

  IllegalStateException - If the builder has missing or invalid inputs.