StreamRequest

public interface StreamRequest extends BaseRequest


An object containing the data used to request a stream with server-side ad insertion.

Summary

Nested types

Enum of possible stream formats.

Public methods

abstract @Nullable Map<StringString>

Returns any parameters that the SDK will attempt to add to ad tags based on a call to setAdTagParameters().

abstract @Nullable String

Returns the ad tag associated with this stream request.

abstract String

Returns the API key for the ad server.

abstract @Nullable String

Returns the asset key for server-side ad insertion streams.

abstract String

Returns the stream request authorization token.

abstract @Nullable String

Returns the content source ID for video on demand server-side ad insertion streams.

abstract @Nullable String

Returns the source of the content for this stream request.

abstract @Nullable String

Returns the custom asset key for a pod serving request.

abstract StreamRequest.StreamFormat

Returns the format of the stream request.

abstract String

Returns the suffix that the SDK will append to the query of the stream manifest URL.

abstract @Nullable String

Returns the network code of the request.

abstract @Nullable String

Returns the video ID for video on demand server-side ad insertion streams.

abstract @Nullable Map<StringObject>

Returns the associated Video Stitcher-specific session options for a Video Stitcher stream request.

abstract @Nullable String

The vodConfig ID for the VOD stream, as set up on the Video Stitcher.

abstract void
setAdTagParameters(Map<StringString> adTagParameters)

Sets the overridable ad tag parameters on the stream request.

abstract void
setAuthToken(String authToken)

Sets the stream request authorization token.

abstract void

Sets the format of the stream request.

abstract void
setManifestSuffix(String manifestSuffix)

Sets the stream manifest's suffix, which will be appended to the stream manifest's URL.

abstract void
setStreamActivityMonitorId(String streamActivityMonitorId)

Sets the ID to be used to debug the stream with the stream activity monitor.

abstract void
setVideoStitcherSessionOptions(
    Map<StringObject> videoStitcherSessionOptions
)

Sets Video Stitcher-specific session options for a Video Stitcher stream request.

Inherited methods

From com.google.ads.interactivemedia.v3.api.BaseRequest
abstract String

Returns the deep link to the content's screen provided in setContentUrl()

abstract @Nullable SecureSignals

Returns the Secure Signals with custom data

abstract Object

Returns the user-provided object that is associated with the request.

abstract void

Specifies the deep link to the content's screen.

abstract void

Specifies the Secure Signals with custom data for this request.

abstract void
setUserRequestContext(Object userRequestContext)

Sets the user-provided object that is associated with the request.

Public methods

getAdTagParameters

abstract @Nullable Map<StringStringgetAdTagParameters()

Returns any parameters that the SDK will attempt to add to ad tags based on a call to setAdTagParameters(). This method will return null unless setAdTagParameters was called with some value(s).

getAdTagUrl

abstract @Nullable String getAdTagUrl()

Returns the ad tag associated with this stream request. Returns null for all stream requests other than cloud based video on demand request.

getApiKey

abstract String getApiKey()

Returns the API key for the ad server.

getAssetKey

abstract @Nullable String getAssetKey()

Returns the asset key for server-side ad insertion streams. Returns null for video on demand streams and pod streams.

getAuthToken

abstract String getAuthToken()

Returns the stream request authorization token.

getContentSourceId

abstract @Nullable String getContentSourceId()

Returns the content source ID for video on demand server-side ad insertion streams. Returns null for live streams and pod streams.

getContentSourceUrl

abstract @Nullable String getContentSourceUrl()

Returns the source of the content for this stream request. Returns null for all stream requests other than cloud based video on demand request

getCustomAssetKey

abstract @Nullable String getCustomAssetKey()

Returns the custom asset key for a pod serving request. Returns null for live and video on demand streams.

getFormat

abstract StreamRequest.StreamFormat getFormat()

Returns the format of the stream request.

getManifestSuffix

abstract String getManifestSuffix()

Returns the suffix that the SDK will append to the query of the stream manifest URL.

getNetworkCode

abstract @Nullable String getNetworkCode()

Returns the network code of the request.

getVideoId

abstract @Nullable String getVideoId()

Returns the video ID for video on demand server-side ad insertion streams. Returns null for live and pod streams.

getVideoStitcherSessionOptions

abstract @Nullable Map<StringObjectgetVideoStitcherSessionOptions()

Returns the associated Video Stitcher-specific session options for a Video Stitcher stream request. This method will return null unless setVideoStitcherSessionOptions was called with some value(s).

getVodConfigId

abstract @Nullable String getVodConfigId()

The vodConfig ID for the VOD stream, as set up on the Video Stitcher.

setAdTagParameters

abstract void setAdTagParameters(Map<StringString> 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.

setAuthToken

abstract void setAuthToken(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.

setFormat

abstract void setFormat(StreamRequest.StreamFormat format)

Sets the format of the stream request.

setManifestSuffix

abstract void setManifestSuffix(String manifestSuffix)

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

setStreamActivityMonitorId

abstract void setStreamActivityMonitorId(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.

setVideoStitcherSessionOptions

abstract void setVideoStitcherSessionOptions(
    Map<StringObject> videoStitcherSessionOptions
)

Sets Video Stitcher-specific session options for a Video Stitcher stream request.