类：StreamRequest

ima。StreamRequest

class   static

构造函数

StreamRequest

new StreamRequest()

用于指定视频流请求的属性。

属性

adTagParameters

静态

字符串

可选。您可以在视频流请求中替换一组有限的广告代码参数。 为视频流提供定位参数一文提供了更多信息。您还可以使用 dai-ot 和 dai-ov 参数来设置视频流变体偏好设置。如需了解详情，请参阅替换视频流变体参数。

adUiNode

静态

roSGNode

广告界面显示的场景图节点。在广告播放期间，IMA 会在此元素上放置“为什么显示该广告”和“跳过”按钮等元素。元素必须覆盖整个视频元素。

apiKey

静态

字符串

可选。这些密钥可用于验证流请求。 必须在 DFP UI 中设置 DAI 身份验证密钥。

assetKey

静态

字符串

直播需要用到。这是用来决定应该播放哪个流的。实时流请求 asset key 是一个标识符，可以在 DFP UI 中找到。

authToken

静态

字符串

流请求授权令牌。用于代替 API 密钥，以实现更严格的内容授权。发布者可以根据此令牌控制各个内容流的授权。

contentSourceId

静态

字符串

对于点播视频是必需的。cmsid 来自 DFP 界面中的 DFP 视频内容来源。

customAssetKey

静态

字符串

自定义资源键用于确定应该播放哪个流。 pod 服务流请求需要自定义资产密钥。

格式

静态

ima.StreamFormat

流的格式。默认为 ima.StreamFormat.HLS。

networkCode

静态

字符串

发出流请求的发布商的广告资源网代码。如果使用 createPodLiveStreamRequest 或 createPodVodStreamRequest 发出 Pod 服务视频流请求，则必须提供广告资源网代码。使用 createVideoStitcherLiveStreamRequest、createVideoStitcherVodStreamRequest 或 createVideoStitcherVodStreamRequestWithVodConfig 发出的 Cloud 拼接直播流请求也需要这些代码。这些代码是可选的，建议用于通过 createLiveStreamRequest 或 createVodStreamRequest 发出的完整服务视频流请求。添加广告资源网代码会应用在 Ad Manager 界面中选择的设置，例如启用程序化受限广告。对于 Pod 服务和云拼接，添加网络代码可定位并播放视频流。如需查找广告资源网代码，请参阅这篇文章。

球员

静态

(ima.Player 或无效)

玩家界面的实现。

ppid

静态

字符串

已弃用。使用 adTagParameters。 可选。DFP 受众群体发布商提供的标识符。

streamActivityMonitorId

静态

字符串

用于通过流活动监视器调试流的 ID。 这是为了方便发布者在流媒体活动监控工具中查找流媒体日志而采取的措施。

videoId

静态

字符串

点播流媒体服务需要此功能。 视频内容源标识符。

videoObject

静态

（roVideo 或无效）

负责客户端应用程序视频播放的视频对象（例如 Video roSGNode）。系统会轮询此对象以获取各种数据，用于正确计时 Live HLS ID3 事件。

videoStitcherSessionOptions

静态

V 的数组

会话选项用于为 VideoStitcher 流请求设置视频拼接器特定的参数。

方法

createLiveStreamRequest

静态

createLiveStreamRequest(assetKey, apiKey, networkCode) 返回 ima.StreamRequest

初始化 Live StreamRequest 的必需属性。使用此 API 会导致忽略任何其他 StreamType 特定属性。 如果任何必需参数为空字符串，则会记录错误日志，并且 API 返回通用的 StreamRequest，不忽略任何属性。

参数
assetKey	字符串
apiKey	字符串 分配给返回的 ima.StreamRequest 的 ima.StreamRequest.apiKey 属性的参数。如果 API 密钥不存在，则传递空字符串。
networkCode	字符串 发布者发出流媒体请求的网络代码。网络代码是可选的，但建议包含。

返回

包含必需的 Live 属性的 ima.StreamRequest ima.StreamRequest 对象。

createPodLiveStreamRequest

静态

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) 返回 StreamRequest

初始化 Pod Live ima.StreamRequest 的必需属性。 使用此 API 会导致忽略任何其他 ima.StreamType 特定属性。 如果任何必需参数为空字符串，则会记录错误日志，并且 API 返回通用的 StreamRequest，不忽略任何属性。

参数
customAssetKey	字符串
networkCode	字符串
apiKey	字符串 分配给返回的 ima.StreamRequest 的 ima.StreamRequest.apiKey 属性的可选参数；默认值为空字符串。

返回

StreamRequest ima.StreamRequest 具有必需 PodLive 属性的对象。

createPodVodStreamRequest

静态

createPodVodStreamRequest(networkCode) 返回 StreamRequest

初始化 ima.StreamRequest 的必需属性，以便在使用 DAI Pod 服务和第三方视频拼接器时注册 VOD 流。此函数将请求类型设置为 ima.StreamType.POD_VOD，并验证所有必需的属性是否存在缺失数据。验证失败时，调试控制台中会记录一条错误。

参数
networkCode	字符串 Google Ad Manager 网络代码

返回

StreamRequest 一个 ima.StreamRequest 对象。如果指定了所有必需属性，则请求类型设置为 ima.StreamType.POD_VOD。

createStreamRequest

静态

createStreamRequest() 返回 ima.StreamRequest

返回

ima.StreamRequest 一个空的 ima.StreamRequest 对象。

createVideoStitcherLiveStreamRequest

静态

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) 返回 ima.StreamRequest

初始化视频拼接器直播 StreamRequest 的必需属性。使用此 API 会导致忽略任何其他 StreamType 特有的属性。 如果任何必需参数为空字符串，系统会记录错误，并且 API 会返回一般性 StreamRequest，而不会忽略任何属性。

参数
customAssetKey	字符串
networkCode	字符串
liveConfigId	字符串
区域	字符串
projectNumber	字符串
oAuthToken	字符串

返回

ima.StreamRequest ima.StreamRequest 具有必需 VideoStitcherLive 属性的对象。

createVideoStitcherVodStreamRequest

静态

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) 返回 ima.StreamRequest

初始化 Video Stitcher VOD StreamRequest 的必需属性。使用此 API 会导致忽略任何其他 StreamType 特有的属性。 如果任何必需参数为空字符串，系统会记录错误，并且 API 会返回一般性 StreamRequest，而不会忽略任何属性。

参数
adTagUrl	字符串
networkCode	字符串
contentSourceUrl	字符串
区域	字符串
projectNumber	字符串
oAuthToken	字符串

返回

ima.StreamRequest ima.StreamRequest 具有必需的 VideoStitcherVod 属性的对象。

createVideoStitcherVodStreamRequestWithVodConfig

静态

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) 返回 ima.StreamRequest

使用从云视频拼接器创建的 vodConfigId 初始化视频拼接器 VOD StreamRequest 的必要属性。 使用此 API 会导致忽略任何其他 StreamType 特定属性。 如果任何必需参数为空字符串，则会记录错误日志，并且 API 返回通用的 StreamRequest，不忽略任何属性。

参数
vodConfigId	字符串
networkCode	字符串
区域	字符串
projectNumber	字符串
oAuthToken	字符串

返回

ima.StreamRequest ima.StreamRequest 具有必需的 VideoStitcherVod 属性的对象。

createVodStreamRequest

静态

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) 返回 ima.StreamRequest

初始化 VOD ima.StreamRequest 的必需属性。使用此 API 会导致忽略任何其他 ima.StreamType 特有的属性。 如果任何必需参数为空字符串，系统会记录错误，并且 API 会返回一般性 StreamRequest，且不会忽略任何属性。

参数
contentSourceId	字符串
videoId	字符串
apiKey	字符串 分配给返回的 ima.StreamRequest 的 ima.StreamRequest.apiKey 属性的参数。如果 API 密钥不存在，则传递空字符串。
networkCode	字符串 发布者发出流媒体请求的网络代码。网络代码是可选的，但建议包含。

返回

ima.StreamRequest ima.StreamRequest 具有所需 VOD 属性的对象。