Funciones varias
takeScreenshot
Captura una pantalla de la vista actual de la cámara. Si se desea, incluye contenido virtual (aumentado).
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
Por defecto
|
|---|---|---|---|---|
|
params
|
Objeto
|
Objeto que contiene la configuración de la pantalla.
|
Obligatorio
|
|
|
params.withAugmentation
|
Boolean
|
Activa o desactiva la inclusión de contenido virtual o aumentado en la captura de pantalla.
|
Obligatorio
|
|
|
params.dataURL
|
Boolean
|
Activa o desactiva la adición de un prefijo de URI de datos (por ejemplo, “data:image/png;base64,”) a la cadena de resultados.
|
Opcional
|
true
|
|
params.imgFormat
|
String
|
Formato de imagen. Se soportan los siguientes tipos de fichero:
• .png
• .jpeg
|
Opcional
|
"PNG"
|
|
params.imgWidth
|
Número
|
Ancho objetivo (en píxeles) de la imagen capturada.
|
Opcional
|
|
|
params.imgHeight
|
Número
|
Altura objetivo (en píxeles) de la imagen capturada.
|
Opcional
|
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
 |
• Si no se facilita imgWidth o imgHeight:
◦ La imagen se captura con la resolución nativa de la cámara.
◦ Si la resolución es inferior a la mitad del ancho y la altura de la pantalla, la escala de la imagen se amplía al menos a la mitad del ancho y la mitad de la altura de la pantalla para evitar bordes grises en la vista previa de la experiencia.
◦ Si la resolución nativa ya alcanza este umbral, la imagen permanece inalterada.
• Si solo se proporciona una cota (imgWidth o imgHeight), la cota que falta se calcula automáticamente para mantener la proporción dimensional original.
• Si se facilitan ambas cotas (imgWidth y imgHeight):
◦ Se vuelve a calcular una cota para conservar la proporción dimensional original.
◦ La imagen final se ajusta a los límites indicados.
• Si dataURL es true, la cadena codificada en Base64 lleva como prefijo un tipo MIME (por ejemplo, "data:image/png;base64," o "data:image/jpeg;base64,").
• La imagen se devuelve a través de successCallback.
|
scanForNextBarCode
Inicia el escáner de códigos de barras y espera el siguiente código de barras legible. Una vez que se detecta un código de barras, el escáner se detiene y devuelve el resultado.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
|---|---|---|---|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
• Una vez que se detecta un código de barras válido, el escaneado se detiene automáticamente.
• El valor devuelto en successCallback es la representación en cadena descodificada del código de barras.
|
scanBarCodeScanning
Detiene el escáner del código de barras en ejecución si está activo y no tiene ningún efecto si el escáner no está en ejecución.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
|---|---|---|---|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
• Esta función permite cancelar manualmente un escaneado de código de barras en curso iniciado a través de scanForNextBarcode.
• Si no hay ningún escaneado activo, la función se devuelve sin efecto.
• El escáner también se detiene automáticamente tras una detección correcta del código de barras; por lo tanto, solo suele ser necesario para la cancelación manual.
|
setupTrackingEventsCommand
Registra una llamada para recibir actualizaciones de eventos de seguimiento, como cambios en la posición u orientación de un objetivo del que se efectúa el seguimiento.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
|---|---|---|---|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
• successCallback se invoca una vez por fotograma mientras el seguimiento está activo.
• Cada llamada recibe una matriz de cadenas con los siguientes valores:
◦ trackerId: ID del rastreador actual (ID del rastreador).
◦ cameraPosition: posición de la cámara en el espacio del rastreador, como una cadena en formato [x,y,z].
◦ cameraForward: vector de dirección hacia delante de la cámara, en el espacio del rastreador.
◦ cameraUp: vector de dirección hacia arriba de la cámara, en el espacio del rastreador.
◦ timestamp: fecha de UNIX (en segundos) en el momento del seguimiento.
• Actualmente, esta función no utiliza errorCallback.
|
setDimensions
Define el ancho y la altura de una imagen 3D.
|
Nombre
|
Tipo
|
Descripción
|
Obligatorio/Opcional
|
|
|---|---|---|---|---|
|
id
|
String
|
ID de Studio de la imagen 3D que se va a actualizar.
|
Obligatorio
|
|
|
params
|
Objeto
|
Objeto que contiene valores de cota.
|
Obligatorio
|
|
|
params.width
|
Número
|
Ancho objetivo de la imagen.
|
Opcional
|
NaN
|
|
params.height
|
Número
|
Altura objetivo de la imagen.
|
Opcional
|
NaN
|
|
successCallback
|
Función
|
Llamada cuando la operación se completa correctamente.
|
Opcional
|
|
|
errorCallback
|
Función
|
Llamada cuando la operación no se puede completar.
|
Opcional
|
|
|
• Esta función solo se soporta con widgets 3D que aceptan imágenes (Imagen 3D, Indicador 3D y Etiqueta 3D).
• Si el ancho o la altura se omiten o se definen como NaN, el valor que falte se calculará según la otra cota proporcionada y se conserva la proporción dimensional original.
• Si el ancho y la altura se omiten o se definen en NaN, las cotas se determinarán automáticamente a partir del tamaño original de la imagen.
|