在 Roku 上使用 IMA DAI SDK

播放使用 Google Cloud Video Stitcher API 注册的直播

本指南演示了如何使用适用于 Roku 的 IMA DAI SDK 请求并播放已通过 Google Cloud Video Stitcher API 注册的活动的直播，以及如何在播放期间插入广告插播时间点。

本指南对 IMA DAI 入门指南中的基本示例进行了扩展。

如需了解如何与其他平台集成或如何使用 IMA 客户端 SDK，请参阅互动式媒体广告 SDK。

如果您想查看或跟随已完成的示例集成，请下载 Cloud 视频拼接器示例。

设置 Google Cloud 项目

输入以下变量以在 IMA SDK 中使用：

位置

您创建实时配置的 Google Cloud 区域：LOCATION

项目编号

使用 Video Stitcher API 的 Google Cloud 项目编号： PROJECT_NUMBER

OAuth 令牌

具有视频拼接工具用户角色的服务账号的短期有效 OAuth 令牌：

OAUTH_TOKEN

详细了解如何为服务账号创建短期有效的凭据。只要 OAuth 令牌未过期，就可以在多个请求中重复使用。

广告资源网代码

用于请求广告的 Ad Manager 广告资源网代码：NETWORK_CODE

直播配置 ID: 您在创建直播活动时指定的实时配置 ID： LIVE_CONFIG_ID
自定义素材资源键: 使用 Video Stitcher API 为直播活动创建配置过程中生成的 Ad Manager 自定义素材资源键：CUSTOM_ASSET_KEY

下载基本示例

下载并运行 IMA Roku DAI 基本示例。点击视频播放器上的播放按钮，即可开始观看短片“钢铁之泪”，该短片每 30 秒就会插播一次广告。

申请直播

如需将选段串流替换为 Cloud Video Stitcher 直播，请使用 sdk.createVideoStitcherLiveStreamRequest() 函数。DAI 会话上线后，您可以使用 Google Ad Manager 界面查找生成的 DAI 会话，以便进行监控和调试。

在现有示例中，有条件语句用于确定是构建 VOD StreamRequest 还是直播 StreamRequest。为了使其与 Google Cloud Video Stitcher API 配合使用，请添加一个新路径，以使用之前生成的值构建 Cloud Video Stitcher 实时 StreamRequest。

示例

basic_example/components/MainScene.xml

<?xml version="1.0" encoding="utf-8" ?>
<component name="MainScene" extends="Scene" initialFocus = "myVideo">
<script type="text/brightscript">
<![CDATA[
  function init()
    m.video = m.top.findNode("myVideo")
    m.video.notificationinterval = 1
    m.testLiveStream = {
      title: "Livestream",
      assetKey: "c-rArva4ShKVIAkNfy6HUQ",
      apiKey: "",
      type: "live"
    }
    m.testVodStream = {
      title: "VOD stream"
      contentSourceId: "2548831",
      videoId: "tears-of-steel",
      apiKey: "",
      type: "vod"
    }
    m.testVideoStitcherLiveStream = {
      title: "Video Stitcher Livestream",
      customAssetKey: "CUSTOM_ASSET_KEY",
      networkCode: "NETWORK_CODE",
      liveConfigId: "LIVE_CONFIG_ID",
      region: "LOCATION",
      projectNumber: "PROJECT_NUMBER",
      oAuthToken: "OAUTH_TOKEN",
      apiKey: "",
      type: "stitcherLive"
    }
    loadImaSdk()
  end function

  function loadImaSdk() as void
    m.sdkTask = createObject("roSGNode", "imasdk")
    m.sdkTask.observeField("sdkLoaded", "onSdkLoaded")
    m.sdkTask.observeField("errors", "onSdkLoadedError")

    ' Set this to the stream data you would like to play.
    selectedStream = m.testVideoStitcherLiveStream
    m.videoTitle = selectedStream.title
    m.sdkTask.streamData = selectedStream

    m.sdkTask.observeField("urlData", "urlLoadRequested")
    m.sdkTask.video = m.video
    ' Setting control to run starts the task thread.
    m.sdkTask.control = "RUN"
  end function

basic_example/components/Sdk.xml

  Sub loadStream()
    sdk = m.sdk
    sdk.initSdk()
    setupVideoPlayer()

    request = {}
    streamData = m.top.streamData
    if streamData.type = "live"
      request = sdk.CreateLiveStreamRequest(streamData.assetKey, streamData.apiKey)
    else if streamData.type = "vod"
      request = sdk.CreateVodStreamRequest(streamData.contentSourceId, streamData.videoId, streamData.apiKey)
    else if streamData.type = "stitcherLive"
      request = sdk.CreateVideoStitcherLiveStreamRequest(
        streamData.customAssetKey,
        streamData.networkCode,
        streamData.liveConfigId,
        streamData.region,
        streamData.projectNumber,
        streamData.oAuthToken
      )
    else
      request = sdk.CreateStreamRequest()
    end if

    request.player = m.player
    request.adUiNode = m.top.video

    requestResult = sdk.requestStream(request)
    If requestResult <> Invalid
      print "Error requesting stream ";requestResult
    Else
      m.streamManager = Invalid
      While m.streamManager = Invalid
        sleep(50)
        m.streamManager = sdk.getStreamManager()
      End While
      If m.streamManager = Invalid or m.streamManager["type"] <> Invalid or m.streamManager["type"] = "error"
        errors = CreateObject("roArray", 1, True)
        print "error ";m.streamManager["info"]
        errors.push(m.streamManager["info"])
        m.top.errors = errors
      Else
        m.top.streamManagerReady = True
        addCallbacks()
        m.streamManager.start()
      End If
    End If
  End Sub

添加这些更改后，请重新加载应用以请求和播放自定义直播。

（可选）添加在线播放会话选项

通过在 StreamRequest 对象中填充 videoStitcherSessionOptions 参数，添加会话选项以替换默认的 Cloud Video Stitcher API 配置，从而自定义数据流请求。

如果您提供的选项无法识别，Cloud Video Stitcher API 将返回 HTTP 400 错误。如需帮助，请参阅问题排查指南。

例如，您可以使用以下代码段替换清单选项，该代码段会请求两个串流清单，其中呈现方式的排序方式为从最低比特率到最高比特率。


request = sdk.createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

request.player = m.player
request.adUiNode = m.top.video

' The following session options are examples. Use session options
' that are compatible with your video stream.
sessionOptions = {
  "manifestOptions": {
    "bitrateOrder": "ascending"
  }
}
request.videoStitcherSessionOptions = sessionOptions

requestResult = sdk.requestStream(request)

插入广告插播时间点

Google Cloud Video Stitcher API 会为每个广告插播时间点插入从广告代码检索到的广告。清单中使用广告标记表示广告插播时间点。广告标记由直播编码器插入。

如果您使用的是自己的直播，则需要插入广告标记。如需详细了解支持的 HLS 和 DASH 广告标记，请参阅广告标记文档。
如果您使用 Google Cloud Livestream API 创建了直播，请插入广告插播频道事件。

广告会在插入广告插播时间点后立即播放。

清理

现在，您已成功使用 Google Cloud Video Stitcher API 托管了直播，并使用适用于 Roku 的 IMA DAI SDK 请求了该直播，因此请务必清理所有广告投放资源。

请按照直播清理指南移除所有不需要的资源和素材资源。

iOS

tvOS