Seguimiento de Roku en SceneGraph

Primeros pasos

Puede utilizar el marco de programación XML de Roku SceneGraph para desarrollar aplicaciones. Este nuevo marco de trabajo incluye dos nuevos conceptos clave:

• Representación SceneGraph en las pantallas de la aplicación
• Configuración de XML en las pantallas de SceneGraph

El SDK de Adobe Mobile para Roku está escrito en BrightScript. El SDK utiliza muchos componentes que no están disponibles para una aplicación que se ejecuta en SceneGraph (por ejemplo, los subprocesos). Por lo tanto, un desarrollador de aplicaciones Roku que pretenda usar el marco de trabajo de SceneGraph no puede llamar las API de SDK de Adobe Mobile (estas últimas son similares a las que están disponibles en aplicaciones heredadas de BrightScript).

Arquitectura

Para que SceneGraph sea compatible con el SDK de AdobeMobile, Adobe ha añadido una nueva API que crea un puente de conector entre el SDK AdobeMobile y adbmobileTask. Este es un nodo SceneGraph utilizado para ejecutar la API del SDK. (El uso de adbmobileTask se explica en detalle en el resto de este documento).

El puente conector está diseñado para funcionar de la siguiente manera:

• El puente devuelve una instancia compatible con SceneGraph del SDK de AdobeMobile. El SDK compatible con SceneGraph tiene todas las API que expone el SDK heredado.
• Las API de SDK de AdobeMobile se usan en SceneGraph de forma muy similar a como se usan las API heredadas.
• El puente también expone un mecanismo para escuchar las llamadas de retorno de las API que arrojan algunos datos.

Componentes

Aplicación SceneGraph:

• Utiliza las API de AdobeMobileLibrary gracias al puente conector con SceneGraph.
• Registra las llamadas de retorno en adbmobileTask para las variables de datos de salida esperadas.

AdobeMobileLibrary:

• Expone un conjunto de API públicas (heredadas), incluida la API de puente conector.
• Arroja una instancia de conector de SceneGraph que envuelve todas las API públicas heredadas.
• Se comunica con un nodo adbmobileTask de SceneGraph para ejecutar las API.

Nodo adbmobileTask:

• Nodo de tareas de SceneGraph que ejecuta la API AdobeMobileLibrary en un subproceso en segundo plano.
• Sirve como delegado para devolver los datos a la aplicación.

API de SceneGraph públicas

ADBMobileConnector

SceneGraphConstants

Nodo 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

Firma de API: ADBMobile().getADBMobileConnectorInstance()
Entrada: adbmobileTask
Tipo de devolución: ADBMobileConnector

sgConstants

Firma de API: ADBMobile().sgConstants()
Entrada: Ninguno
Tipo de devolución: SceneGraphConstants

Constantes ADBMobile

Las API de MediaHeartbeat de utilidades definidas globalmente en el archivo AdobeMobileLibrary heredado son accesibles tal como se encuentran en el entorno de SceneGraph porque no utilizan componentes Brightscript que no estén en los nodos SceneGraph. Para obtener más información sobre estos métodos, consulte la siguiente tabla:

Métodos globales para MediaHeartbeat

Implementación

1. Descargue la biblioteca Roku: Descargue la última biblioteca Roku.

2. Configurar el entorno de desarrollo

   1. Copie adbmobile.brs (AdobeMobileLibrary) en su directorio pkg:/source/.

   2. Para la compatibilidad con SceneGraph, copie adbmobileTask.brs y adbMobileTask.xml en el directorio pkg:/components/.

3. Inicializar

   1. Importe adbmobile.brs en la escena.

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

   2. Cree una instancia del nodo adbmobileTask en la escena.

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

   3. Obtenga una instancia del conector adbmobile para SceneGraph con la instancia de adbmobileTask.

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

   4. Obtenga constantes SG de adbmobile.

      m.adbmobileConstants = m.adbmobile.sceneGraphConstants()
      

   5. Registre una llamada de retorno para recibir un objeto Response para todas las llamadas a la API AdbMobile.

      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
      

Implementación de muestra

Llamadas de API de muestra en el SDK heredado

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

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

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

Ejemplo de llamadas de API en SG SDK

'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