Solución de problemas con registros para productos SDK .NET¶

Video Capture SDK .Net Video Edit SDK .Net Media Player SDK .Net

Por qué son importantes los registros en la solución de problemas del SDK¶

Al desarrollar aplicaciones que utilizan SDKs multimedia, puede encontrar problemas técnicos que requieren una investigación detallada. Los registros de depuración proporcionan información crítica que ayuda a identificar la causa raíz de los problemas de manera rápida y eficiente. Estos registros capturan todo, desde secuencias de inicialización hasta pasos detallados de operación, condiciones de error e información del sistema.

Los registros recopilados correctamente ofrecen varios beneficios clave:

Resolución de problemas más rápida: El soporte técnico puede identificar rápidamente la fuente de los problemas
Contexto completo: Los registros proporcionan una imagen completa de lo que sucedió antes, durante y después de un problema
Información del sistema: Los detalles sobre su entorno ayudan a reproducir y resolver problemas
Perspectivas de desarrollo: Comprender los registros puede ayudarle a optimizar su implementación

Recopilación de registros en aplicaciones de demostración¶

Nuestras aplicaciones de demostración incluyen capacidades de depuración integradas que facilitan la recopilación de registros para la solución de problemas. Siga estos pasos para habilitar y compartir registros:

Guía paso a paso para el registro en aplicaciones de demostración¶

Iniciar la aplicación de demostración
Abra la aplicación de demostración relevante para su SDK
Localice la interfaz principal donde se pueden configurar los ajustes
Habilitar el modo de depuración
Busque y marque la casilla "Debug" en la interfaz de la aplicación
Esto activa el registro detallado de todas las operaciones del SDK
Reproducir el problema
Configure cualquier otro ajuste requerido para su escenario específico
Presione el botón Iniciar o Reproducir (dependiendo del SDK que esté usando)
Permita que la aplicación se ejecute hasta que ocurra el problema
Después de tiempo suficiente para capturar el problema, presione el botón Detener
Recopilar archivos de registro
Navegue a "Mis Documentos\VisioForge" en su sistema
Esta carpeta contiene todos los archivos de registro generados
Importante: Excluya cualquier grabación de audio/video de su recopilación para reducir el tamaño del archivo
Compartir registros de forma segura
Comprima los archivos de registro en un archivo ZIP
Suba a un servicio seguro de compartición de archivos como Dropbox, Google Drive u OneDrive
Comparta el enlace de acceso con el soporte técnico

Implementación de registros en sus aplicaciones personalizadas¶

Cuando desarrolla sus propias aplicaciones con nuestros SDKs, necesitará habilitar y configurar explícitamente el registro. Esta sección explica cómo implementar el registro con diferentes componentes del SDK.

Habilitación de registros de depuración en su código¶

Independientemente del SDK que esté usando, el enfoque básico para habilitar registros sigue un patrón similar:

// Ejemplo para MediaPlayer SDK
mediaPlayer.Debug_Mode = true;
mediaPlayer.Debug_Dir = "C:\\Logs\\MiAplicacion";

// Ejemplo para Video Capture SDK
videoCapture.Debug_Mode = true;
videoCapture.Debug_Dir = "C:\\Logs\\MiAplicacion";

// Ejemplo para Video Edit SDK
videoEdit.Debug_Mode = true;
videoEdit.Debug_Dir = "C:\\Logs\\MiAplicacion";

Guía de implementación detallada¶

Establecer la propiedad del modo de depuración
Para cualquier componente del SDK que esté usando, establezca la propiedad Debug_Mode en true
Esto debe hacerse antes de llamar a los métodos de inicialización o reproducción
Ejemplo: MediaPlayer1.Debug_Mode = true;
Especificar el directorio de registros
Establezca la propiedad Debug_Dir en una ruta de directorio válida
Asegúrese de que el directorio especificado exista y que su aplicación tenga permisos de escritura
Ejemplo: MediaPlayer1.Debug_Dir = "C:\\ArchivosLog\\MiApp";
Configurar parámetros adicionales
Configure cualquier otro parámetro requerido para su caso de uso específico
Estos podrían incluir fuentes de video, códecs, configuraciones de salida, etc.
Inicializar y ejecutar el componente
Llame al método apropiado para iniciar el componente (p. ej., Start() o Play())
Deje que la aplicación se ejecute hasta que haya reproducido el problema que está solucionando
Recopilar y compartir registros
Localice los archivos de registro tanto en su directorio especificado como en "Mis Documentos\VisioForge"
Comprima todos los archivos de registro en un archivo ZIP
Comparta a través de un servicio seguro de compartición de archivos

Técnicas avanzadas de registro¶

Para aplicaciones más complejas o problemas difíciles de reproducir, considere estos enfoques avanzados de registro:

Activación condicional de depuración¶

Es posible que desee habilitar el registro de depuración solo en ciertos escenarios o basándose en acciones del usuario:

// Habilitar el modo de depuración solo cuando se está solucionando problemas
if (modoSolucionProblemas)
{
    mediaPlayer.Debug_Mode = true;
    mediaPlayer.Debug_Dir = Path.Combine(
        Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments),
        "RegistrosApp"
    );
}

Registro específico del entorno¶

Diferentes entornos de implementación pueden requerir diferentes enfoques de registro:

#if DEBUG
    // Registro del entorno de desarrollo
    videoCapture.Debug_Mode = true;
    videoCapture.Debug_Dir = Path.Combine(
        Environment.GetFolderPath(Environment.SpecialFolder.Desktop),
        "RegistrosDev"
    );
#else
    // Registro del entorno de producción (si lo permite su política de privacidad)
    string rutaAppData = Path.Combine(
        Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData),
        "SuEmpresa",
        "SuApp",
        "Registros"
    );
    Directory.CreateDirectory(rutaAppData);
    videoCapture.Debug_Mode = true;
    videoCapture.Debug_Dir = rutaAppData;
#endif

Mejores prácticas para un registro efectivo¶

Para asegurarse de obtener la información más valiosa de sus registros, siga estas mejores prácticas:

1. Estado inicial limpio¶

Antes de iniciar una sesión de registro, considere restablecer el estado de su aplicación:

Cierre y reinicie la aplicación
Borre cualquier dato en caché si es relevante
Asegúrese de capturar desde un punto de partida conocido

2. Capturar sesiones completas¶

Cuando sea posible, capture toda la sesión de principio a fin:

Habilite el registro antes de inicializar los componentes del SDK
Deje que el registro se ejecute durante toda la operación
Continúe registrando hasta después de que ocurra el problema

3. Documentar los pasos de reproducción¶

Junto con sus registros, proporcione pasos claros para reproducir el problema:

Anote los ajustes específicos utilizados
Documente la secuencia exacta de operaciones
Incluya información de tiempo si es relevante (p. ej., "el fallo ocurre después de 30 segundos de reproducción")

4. Gestionar el tamaño del registro¶

Los registros de depuración pueden crecer mucho, especialmente para sesiones largas:

Para pruebas extendidas, considere dividir el registro en múltiples sesiones
Concéntrese en capturar solo el escenario problemático
Siempre excluya archivos multimedia grandes al compartir registros

5. Asegurar información sensible¶

Antes de compartir registros, tenga en cuenta los datos potencialmente sensibles:

Revise los registros en busca de información personal o sensible
Considere usar contenido de prueba saneado cuando sea posible
Use métodos seguros para transferir archivos de registro

Interpretación de mensajes de registro comunes¶

Aunque el análisis avanzado de registros es mejor dejarlo al soporte técnico, comprender algunos patrones comunes de registro puede ayudarle a identificar problemas:

Errores de inicialización: Busque mensajes que contengan "Init" o "Initialize"
Problemas de formato: Observe mensajes relacionados con "format" o "codec"
Problemas de recursos: Mensajes sobre "memory", "handles" o "resources"
Advertencias de rendimiento: Notas sobre "frame drops", "processing time" o "buffers"

Conclusión¶

El registro adecuado es esencial para la solución eficiente de problemas en aplicaciones basadas en SDK. Al seguir las pautas de este documento, puede proporcionar la información detallada necesaria para resolver rápidamente cualquier problema que encuentre. Recuerde que los registros detallados reducen significativamente el tiempo de resolución y ayudan a mejorar la calidad tanto de su aplicación como de nuestros SDKs.

Para ejemplos de código adicionales y guías de implementación, visite nuestro repositorio de GitHub.