Aperçu: Kit de développement logiciel natif Brightcove pour Android

Bienvenue dans la documentation développeur du SDK Android. Vous trouverez ici les informations nécessaires pour développer avec le SDK Android.

Structure documentaire

Chez Brightcove, nous nous efforçons de garder la documentation structurée, propre et intuitive. En tant que tel, nous utilisons les README de github pour plus de détails sur tous nos plugins et intégrations. Pour votre commodité, nous avons répertorié et lié ces plugins ci-dessous.

Support Android

Le SDK natif pour Android prend en charge les versions suivantes d'Android :

Soutien actif

Brightcove fournit un support actif pour le dernier SDK Android sur les versions Android suivantes :

  • 12.0
  • 11.0
  • 10,0
  • 9.0
  • 8.0, 8.1
  • 7.0, 7.1
  • 6.0

Assistance passive

Brightcove fournit une prise en charge passive des versions Android suivantes :

  • 5.0, 5.1

Comprendre les niveaux d'assistance

Le soutien est défini en termes de [version majeure].[version mineure] d'un système d'exploitation (par exemple : Android 8.1). Afin de profiter des dernières améliorations technologiques de Google, nous proposons deux niveaux d'assistance :

  • actif: Brightcove testera et corrigera les bogues sur ces versions du système d'exploitation.
  • Passif: Brightcove effectuera des tests sur ces versions du système d'exploitation, mais les corrections de bogues seront traitées au cas par cas.

En règle générale, Brightcove fournit une prise en charge active des versions du système d'exploitation utilisées par 80 % de la base d'utilisateurs et une prise en charge passive des autres versions utilisées par au moins 5 % de la base d'utilisateurs.

Prise en charge des variantes d'Android

Le SDK natif Brightcove pour Android est développé et testé avec les versions principales du système d'exploitation Android. Brightcove ne prend pas officiellement en charge les distributions d'Android après commercialisation, telles que LineageOS.

Les utilisateurs d'appareils fonctionnant avec des versions variantes d'Android peuvent rencontrer des problèmes avec les applications développées à l'aide du SDK natif pour Android.

TV connectée / Décodeurs

Le SDK natif pour Android prend en charge les décodeurs Android suivants :

  • Télévision Android
  • Fire TV (appareils FireOS 5.0+)

Les décodeurs avec lesquels nous avons testé incluent :

  • Lecteur Nexus
  • Bouclier Nvidia

Les Brightcove Native SDK pour les exemples d'applications Android fonctionnera sur Android TV et Fire TV. Cela signifie que vos applications basées sur la télévision peuvent inclure la publicité, la protection du contenu (DRM), la lecture en direct, les commandes d'interface utilisateur personnalisées, Brightcove Analytics et les métriques QoE.

Vérifiez Exemple d'application Contrôles stylisés pour plus de détails sur le style des commandes de l'interface utilisateur dans votre application TV.

Commencer

Avant de commencer le développement avec le SDK Android, vous devez apprendre quelques concepts :

  1. Médias

    La version actuelle du SDK natif prend en charge la lecture de contenu à partir de votre compte Video Cloud via l'API de lecture, ou en tant que ressources distantes avec des URL accessibles sur Internet.

  2. Analytique

    Avec le SDK natif, les clients de Video Cloud obtiennent automatiquement des données analytiques robustes rapportées dans Video Cloud.

  3. Gradle

    Gradle est la base du système de construction Android SDK et est intégré à Android Studio.

  4. Repo Maven

    Les artefacts Brightcove Native Player pour Android Maven (fichiers jar) sont désormais disponibles dans le Brightcove Maven Repo - https://repo.brightcove.com/releases

  5. Présentation du SDK Android

    Pour vous aider à mieux comprendre le SDK, découvrez comment les composants critiques interagissent pour gérer les complexités du contrôle du lecteur vidéo natif.

  6. Créer une application à l'aide du SDK natif pour Android

    Créez votre première application avec le SDK Brightcove Native pour Android, qui lit une vidéo à partir de votre propre système dorsal. Les clients de Video Cloud récupéreront et joueront en outre une vidéo à partir du service de catalogue Brightcove.

  7. Formation vidéo à la demande

    Visionnez une série de vidéos de formation qui vous expliquent les étapes de création d'une application dans Android Studio qui lit une vidéo et une liste de lecture à partir de votre bibliothèque Video Cloud.

  8. Liste de diffusion

    Rejoignez la liste de diffusion des SDK natifs de Brightcove pour rester informé des annonces de publication des SDK natifs.

Télécharger le SDK

Obtenez la dernière version du Brightcove Native SDK pour Android :

  Paquet
(Github Repo)
Documentation de référence Remarques Cadre pris en charge Échantillons
SDK SDK natif pour Android v8.0.0 Référence du SDK Notes de version ExoPlayer 2.17.1 Exemples d'applications

ou sélectionnez ce bouton :

Pour afficher les mises à jour du produit pour tous les SDK natifs et les plug-ins associés, consultez le Notes de version pour les SDK natifs Brightcove document.

Remarques

Les notes suivantes font référence à la dernière version du SDK natif :

  • À partir de la version 6.10.0, le SDK natif de Brightcove pour Android utilise les bibliothèques Jetpack (androidx.*) au lieu des bibliothèques de support d'origine. Cette modification est requise pour Exoplayer version 2.10.0 et supérieure. Pour utiliser Jetpack, vos applications doivent répondre aux exigences suivantes :

    • Migrer vers les dépendances Jetpack (AndroidX)
    • Outils Android Gradle 3.2.0
    • Gradle version 4.6

    Pour plus d'informations sur la migration vers JetPack, reportez-vous au document officiel Guide de migration Android.

  • La version minimale du SDK Android prise en charge par le Brightcove Native SDK pour Android est désormais de 19.
  • Pour ExoPlayer v2.17.1, vous devez activer la prise en charge de Java 11. Pour ce faire, ajoutez ce qui suit à la section android du fichier build.gradle de votre application. Pour plus de détails, voir ExoPlayer d'Android document.
    android {
        compileOptions {
          targetCompatibility JavaVersion.VERSION_11
        }
      }

    Cela remplace la version Java par défaut basée sur le projet compileSdkVersion valeur.

Installation du SDK principal

L'installation du SDK principal de Brightcove est très simple. Il y a deux façons de faire ça:

Utilisation du système de construction gradle

Le moyen le plus simple d'ajouter le Brightcove SDK et ses dépendances est d'utiliser le système de build gradle dans Android Studio.

L'utilisation d'une version de dépendance dynamique avec le caractère '+' est déconseillée dans la communauté Gradle. L'utilisation du contrôle de version dynamique présente un risque important pour votre processus de génération, car les nouvelles API peuvent devenir de manière inattendue incompatibles avec le code source de votre application.

Pour plus d'informations sur l'utilisation de gradle, consultez Android Ajouter des dépendances de build Documentation.

Téléchargement manuel du SDK

Vous pouvez également télécharger manuellement le Brightcove SDK comme suit :

  1. Téléchargez simplement le SDK et décompressez-le. Vous trouverez un certain nombre de dossiers.
  2. À l'intérieur de SDK dossier, vous trouverez le SDK principal avec le nom android-sdk-xxxaar , où xxx est le dernier numéro de version du SDK.
  3. Ajouter le android-sdk-xxxaar dans votre bibliothèque, ainsi que tous les fichiers de plug-in dont vous pourriez avoir besoin.

Intégrations

Le tableau suivant contient des liens pour intégrer des plug-ins à votre implémentation SDK. Les plugins peuvent être téléchargés à partir de leurs dépôts Github respectifs, et chaque dépôt contient un README détaillé avec des instructions sur la façon de configurer le plugin.

Les exemples d'applications illustrent les fonctionnalités de base de chaque plug-in intégré au SDK. Ces exemples d'applications sont un bon moyen d'en savoir plus sur chaque plugin et servent de point de référence lors du débogage.

Versions d'intégration précédentes

Catégorie Plugin Brightcove Documentation de référence Exemples d'applications Plugin partenaire/fournisseur pris en charge
Publicité Plugin FreeWheel 8.0.0 [1] Référence FreeWheel Échantillon FreeWheel de base Bibliothèque FreeWheel AdManager 6.28.0
    FreeWheel avec échantillon modulaire Widevine  
Plugin IMA 8.0.0 [2] Référence IMA Règles publicitaires avec l'exemple IMA Google IMA 3.27.0
    Règles publicitaires avec IMA et Widevine Sample  
    Exemple de base IMA VAST  
Plugin Pulse 8.0.0 Référence d'impulsion Échantillon d'impulsion Pulse SDK 2.5.20.3.0
Plugin SSAI 8.0.0 Référence SSAI Échantillon SSAI de base Aucune
Analytique Plugin Omniture 8.0.0 [3] Référence Omniture AdobeVideoLibrary 4.11.0

VideoHeartBeat 2.0.0
Chromecast Plugin Cast 8.0.0 Référence de distribution Échantillon de récepteur Brightcove
Exemple de récepteur Google
ExoPlayer Cast Extension 2.17.1

Combiner des plugins

Avec le SDK natif pour Android, la plupart des plugins peuvent être combinés. Cette exemple d'application vous montre comment utiliser Brightcove ExoPlayer avec les annonces Google IMA et la protection du contenu avec Widevine Modular.

Échantillons

Brightcove recommande d'utiliser le BrightcoveExoPlayerVideoView mise en œuvre lorsque cela est possible. Pour des exemples et des extraits de code, consultez ce qui suit :

Le tableau suivant contient des liens vers des exemples de code qui s'ajoutent aux exemples associés aux intégrations de la section précédente.

Exemple d'application Description
Échantillon de base Créez une application de base qui lit les vidéos de votre bibliothèque Video Cloud.
Chromecast Diffusez vos vidéos sur un téléviseur connecté à Chromecast. Pour un aperçu, consultez le Le plugin Cast pour le SDK natif pour Android document.
Contrôles personnalisés Personnalisez les commandes du lecteur.
DRM avec Widevine Protégez votre contenu avec Widevine. Le framework Android prend en charge Widevine Modular lors de l'utilisation de la vue vidéo ExoPlayer. Pour plus de détails, consultez le Référence Widevine.
Direct Créez une application qui exécute un flux en direct HLS.
Lecture hors ligne Téléchargez et lisez des vidéos DASH, y compris celles protégées par le cryptage Widevine. Pour un aperçu, consultez le Lecture hors ligne avec les SDK natifs document.
Vidéo à distance Chargez une vidéo à partir d'un serveur distant.
Liste de vidéos Utiliser un RecyclerView pour gérer un ensemble de vidéos.
Vidéo 360° Lit une vidéo à 360°, tant que la propriété de projection est définie. Lorsque vous appuyez sur le bouton Vidéo 360 dans la barre de contrôle, la vidéo s'affiche en mode Lunettes VR avec des images côte à côte. Pour plus de détails, consultez le Utilisation de vidéos à 360° avec les SDK mobiles document.

Guides de solutions

Le tableau suivant contient des liens vers des documents destinés aux développeurs qui vous aideront à créer votre propre application à l'aide du SDK Brightcove Native et vous guideront à travers certaines des caractéristiques et des fonctionnalités disponibles.

Guider Description
Configuration du SDK natif Brightcove pour Android Apprenez les bases du travail avec le SDK natif de Brightcove pour Android en vous guidant dans le développement d'une application de lecture vidéo simple utilisant le contenu de votre propre système dorsal.

Les clients Video Cloud pourront également récupérer et lire une vidéo à partir du service Catalogue Brightcove.
Création de plugins Découvrez comment créer un plugin pour le SDK Brightcove Native pour Android.
Gestion de la disposition des vues Apprenez à gérer la mise en page d'une Vue ajoutée au BrightcoveVideoView .
Gestion des changements d'orientation Apprenez à gérer les comportements par défaut indésirables lorsque l'orientation change.
Mesure ouverte de l'IAB Apprenez à utiliser le SDK Open Measurement avec le plug-in IMA pour la prise en charge d'outils tiers pour la mesure et la vérification des annonces.
Sélection de la source Découvrez le processus de sélection de rendu par défaut lors de la lecture d'une vidéo.
Utilisation de Brightcove Analytics Découvrez comment définir des propriétés dans Brightcove Analytics à partir de votre application mobile à l'aide du SDK Brightcove pour Android.
Utilisation des commandes du lecteur Découvrez comment personnaliser et masquer les commandes du lecteur.

Les meilleures pratiques

Voici des informations supplémentaires qui peuvent vous être utiles lorsque vous travaillez avec le Brightcove Native SDK.

Publicité avec IMA

L'emplacement des annonces VAST est généralement spécifié par un document VMAP. VAST décrit une annonce tandis que VMAP décrit le placement d'annonces dans une vidéo. Pour plus de détails sur le code, consultez les éléments suivants :

 

Lorsque vous travaillez avec des annonces IMA, il est recommandé de vérifier que vos annonces fonctionnent en dehors du SDK avant de les mettre en œuvre. Les liens suivants seront utiles pour cela :

Annonces compagnons

Les annonces associées et les annonces cliquables ne sont pas prises en charge sur Android TV. Comme il n'y a pas de support de navigateur Web sur Android TV, il n'y a pas de destination pour une URL de destination.

Travailler avec ProGuard

À l'aide de ProGuard vous permet de créer des applications plus sécurisées, ce qui les rend plus difficiles à rétroconcevoir. ProGuard est intégré au système de construction Android, vous pouvez donc choisir de l'activer ou de construire sans lui.

Si vous recevez une erreur lorsque ProGuard est activé dans Gradle, essayez d'ajouter les règles d'exclusion suivantes :

  -dontwarn com.google.**
  -dontwarn android.media.**
  -keep class android.media.** { *; }
  -keep class com.google.** { *; }
  -keep interface com.google.** { *; }
  -keep class com.google.ads.interactivemedia.** { *; }
  -keep interface com.google.ads.interactivemedia.** { *; }
  
  

Pour obtenir une liste complète des règles ProGuard utilisées par le Brightcove Native SDK, téléchargez et décompressez le SDK natif actuel pour Android. Ouvrez le SDK dossier et afficher le proguard.txt déposer.

Comportement de lecture

Vous remarquerez peut-être certains des comportements de lecture suivants sur certains appareils Android :

Pause vidéo

Android Pause intelligente La fonction sur les appareils Samsung met en pause une vidéo lorsque l'utilisateur détourne le regard de l'écran de l'appareil. Vous pouvez désactiver cette fonctionnalité si vous ne souhaitez pas que les vidéos soient mises en pause sur les appareils compatibles Smart Pause.