在 SceneGraph (Roku) 中跟踪

简介

Roku 为开发应用程序引入了一个新的编程框架：SceneGraph XML 编程框架。此新框架具有两个新的关键概念：

• 应用程序屏幕的 SceneGraph 渲染
• SceneGraph 屏幕的 XML 配置

Adobe Mobile SDK for Roku 使用 BrightScript 编写。SDK 使用的许多组件不适用于在 SceneGraph 上运行的应用程序（例如线程）。因此，计划使用 SceneGraph 框架的 Roku 应用程序开发人员无法调用 Adobe Mobile SDK API（后者类似于旧版 BrightScript 应用程序中提供的 API）。

架构

为了向 AdobeMobile SDK 添加 SceneGraph 支持，Adobe 已添加了一个新的 API，通过此 API，可在 AdobeMobile SDK 和 adbmobileTask 之间创建一个连接器桥。后者是用于 SDK API 执行的 SceneGraph 节点。（在本文档的其他部分中对 adbmobileTask 的用法进行了详细解释。）

连接器桥旨在执行以下操作：

• 桥会返回 AdobeMobile SDK 的与 SceneGraph 兼容的实例。与 SceneGraph 兼容的 SDK 具有旧版 SDK 公开的所有 API。
• 在 SceneGraph 中使用 Adobe Mobile SDK API 的方式与使用旧版 API 的方式非常相似。
• 桥还公开了一种机制来侦听返回某些数据的 API 的回调。

组件

SceneGraph 应用程序：

• 通过 SceneGraph 连接器桥 API 使用 AdobeMobileLibrary API。
• 在 adbmobileTask 中为预期的输出数据变量注册响应回调。

AdobeMobileLibrary：

• 公开一组公共 API（旧版），包括连接器桥 API。
• 返回包含所有旧版公共 API 的 SceneGraph 连接器实例。
• 与用于执行 API 的 adbmobileTask SceneGraph 节点通信。

adbmobileTask 节点：

• 可在后台线程上执行 AdobeMobileLibrary API 的 SceneGraph 任务节点。
• 用作将数据返回到应用程序场景的委托。

公共 SceneGraph API

ADBMobileConnector

SceneGraphConstants

adbmobileTask 节点

response = {
  "apiName" : <SceneGraphConstants.
               API_NAME>
  "returnValue : <API_RESPONSE>
}

response = {
  "apiName" : m.
              adbmobileConstants.
              VISITOR_MARKETING_CLOUD_ID
  "returnValue : "07050x25671x33760x72644x14"
}

response = {
  "apiName" : m.
              adbmobileConstants.
              VISITOR_MARKETING_CLOUD_ID
  "returnValue : invalid
}

adbmobile.brs

getADBMobileConnectorInstance

API 签名：ADBMobile().getADBMobileConnectorInstance()
输入：adbmobileTask
返回类型：ADBMobileConnector

sgConstants

API 签名：ADBMobile().sgConstants()
输入：无
返回类型：SceneGraphConstants

ADBMobile 常量

旧版 AdobeMobileLibrary 中全局定义的实用程序 MediaHeartbeat API 可在 SceneGraph 环境中“照常”**​进行访问，因为它们未使用任何无法在 SceneGraph 节点中使用的 Brightscript 组件。有关这些方法的更多信息，请参阅下表：

适用于 MediaHeartbeat 的全局方法

实施

1. 下载 Roku 库 - 下载最新版本的 Roku 库。

2. 设置开发环境

   1. 将 adbmobile.brs (AdobeMobileLibrary) 复制到 pkg:/source/ 目录中。

   2. 要支持 Scene Graph，请将 adbmobileTask.brs 和 adbMobileTask.xml 复制到 pkg:/components/ 目录中。

3. 初始化

   1. 将 adbmobile.brs 导入到场景中。

      <script type="text/brightscript" uri="pkg:/source/adbmobile.brs" />
      

   2. 在场景中创建一个 adbmobileTask 节点的实例。

      m.adbmobileTask = createObject("roSGNode", "adbmobileTask")
      

   3. 使用 adbmobile 实例获取 SceneGraph 的 adbmobileTask 连接器实例。

      m.adbmobile = ADBMobile().getADBMobileConnectorInstance(m.adbmobileTask)
      

   4. 获取 adbmobile SG 常量。

      m.adbmobileConstants = m.adbmobile.sceneGraphConstants()
      

   5. 注册一个回调以接收所有 AdbMobile API 调用的响应对象。

      m.adbmobileTask.ObserveField(m.adbmobileConstants.API_RESPONSE,
                                   "onAdbmobileApiResponse")
      
      ' Sample implementation of the callback
      ' Listen for all the constants for which API calls are made on the SDK
      function onAdbmobileApiResponse() as void
          responseObject = m.adbmobileTask[m.adbmobileConstants.API_RESPONSE]
      
          if responseObject <> invalid
              methodName = responseObject.apiName
              retVal = responseObject.returnValue
      
              if methodName = m.adbmobileConstants.DEBUG_LOGGING
                  if retVal
                      print "API Response: DEBUG LOGGING: " + "True"
                  else
                      print "API Response: DEBUG LOGGING: " + "False"
                  endif
              else if methodName = m.adbmobileConstants.PRIVACY_STATUS
                  print "API Response: PRIVACY STATUS: " + retVal
              else if methodName = m.adbmobileConstants.TRACKING_IDENTIFIER
                  if retVal <> invalid
                      print "API Response: TRACKING IDENTIFIER: " + retVal
                  else
                      print "API Response: TRACKING IDENTIFIER: " + "invalid"
                  endif
              else if methodName = m.adbmobileConstants.USER_IDENTIFIER
                  if retVal <> invalid
                      print "API Response: USER IDENTIFIER: " + retVal
                  else
                      print "API Response: USER IDENTIFIER: " + "invalid"
                  endif
              else if methodName = m.adbmobileConstants.VISITOR_MARKETING_CLOUD_ID
                  if retVal <> invalid
                      print "API Response: MCID: " + retVal
                  else
                      print "API Response: MCID: " + "invalid"
                  endif
              else if methodName = m.adbmobileConstants.AUDIENCE_DPID
                  if retVal <> invalid
                      print "API Response: AUDIENCE DPID: " + retVal
                  else
                      print "API Response: AUDIENCE DPID: " + "invalid"
                  endif
              else if methodName = m.adbmobileConstants.AUDIENCE_DPUUID
                  if retVal <> invalid
                      print "API Response: AUDIENCE DPUUID: " + retVal
                  else
                      print "API Response: AUDIENCE DPUUID: " + "invalid"
                  endif
              else if methodName = m.adbmobileConstants.AUDIENCE_VISITOR_PROFILE
                  if retVal <> invalid
                      print "API Response: AUDIENCE VISITOR PROFILE: Valid Object"
                  else
                      print "API Response: AUDIENCE VISITOR PROFILE: " + "invalid"
                  endif
              endif
          endif
      end function
      

实施示例

旧版 SDK 中的 API 调用示例

'get an instance of SDK
m.adbmobile = ADBMobile()

'execute setter APIs
m.adbmobile.setDebugLogging(true)

'execute getter APIs
debugLogging = m.adbmobile.getDebugLogging()

SG SDK 中的 API 调用示例

'create adbmobileTask instance
m.adbmobileTask = createObject("roSGNode", "adbmobileTask")

'get an instance of SDK using task instance
m.adbmobile =
  ADBMobile().getADBMobileConnectorInstace(m.adbmobileTask)
m.adbmobileConstants = m.adbmobile.sceneGraphConstants()
'execute setter APIs
m.adbmobile.setDebugLogging(true)

'execute getter APIs
m.adbmobileTask.ObserverField(m.adbConstants.API_RESPONSE,
                              "onAdbmobileApiResponse")
m.adbmobile.getDebugLogging()

'listen for return data in registered callbacks
function onAdbmobileApiResponse() as void
    responseObject = m.adbmobileTask[m.adbmobileConstants.API_RESPONSE]

        if responseObject <> invalid
            methodName = responseObject.apiName
            retVal = responseObject.returnValue

        if methodName = m.adbmobileConstants.DEBUG_LOGGING
            if retVal
                print "API Response: DEBUG LOGGING: " + "True"
            else
                print "API Response: DEBUG LOGGING: " + "False"
         endif
    endif
end function