Obtenir la position de lecture à partir de l'API XDR

Dans cette rubrique, vous apprendrez à récupérer la position de lecture du spectateur à partir de l'API Cross-Device Resume (XDR).

Aperçu

La reprise multi-appareils permet aux spectateurs de commencer à regarder une vidéo sur un appareil, et plus tard, de continuer à regarder la vidéo là où ils s'étaient arrêtés sur un autre appareil.

Étant donné que l'API Cross-Device Resume (XDR) ne peut pas être appelée à partir de vos applications côté client, vous devrez créer un proxy côté serveur pour effectuer l'appel et renvoyer la valeur de la position de lecture.

Obtenir la position de lecture

Vous pouvez obtenir la position de lecture de la visionneuse avec le API de CV multi-appareils (XDR).

API de CV multi-appareils (XDR)

Avec l'API Cross-Device Resume, vous pouvez obtenir toutes les positions de tête de lecture pour un spectateur spécifique, ou toutes les têtes de lecture pour un spectateur et une vidéo spécifiques.

URL de base

L'URL de base de l'API est :

https://data.brightcove.com/v1/xdr

Chemin du compte

Dans tous les cas, des demandes seront faites pour un Nuage vidéo Compte. Ainsi, vous ajouterez toujours le terme comptes suivi de votre identifiant de compte à l'URL de base :

https://data.brightcove.com/v1/xdr/accounts/{account_id}

Autorisation

Un jeton d'accès pour les demandes est requis et doit être présent dans l'en-tête Authorization :

Authorization: Bearer {access_token}

Le jeton d'accès est un jeton d'accès OAuth2 temporaire qui doit être obtenu auprès du service Brightcove OAuth. Pour plus de détails sur la façon d'obtenir les informations d'identification client et de les utiliser pour récupérer des jetons d'accès, consultez le Présentation de Brightcove OAuth.

Autorisations

Les demandes à l'API de CV multi-appareils doivent être effectuées à partir des informations d'identification du client avec les autorisations suivantes :

  • video-cloud/xdr/read

Notez que ces autorisations ne sont pas encore disponibles dans l'interface utilisateur d'administration de Studio. Jusqu'à ce qu'ils le soient, vous pouvez utiliser ceci Application Brightcove Learning Services pour créer vos identifiants client. Assurez-vous simplement de vérifier le video-cloud/xdr/read lorsque vous créez les informations d'identification (vous pouvez cocher autant d'autres cases que vous le souhaitez).

Méthodes API

L'API Cross-Device Resume prend en charge les requêtes suivantes. Pour plus de détails, consultez le Référence de l'API Cross-Device Resume (XDR).

Obtenir des têtes de lecture de visionneuse

Cette demande obtient toutes les têtes de lecture pour un spectateur.

GET /accounts/{accountID}/playheads/{viewer_id}
Corps de réponse

Le corps de la réponse contient un ensemble de vidéos et de têtes de lecture. Il devrait ressembler à ceci :

{
  "account_id": "1752604059001",
  "viewer_id": "viewer001",
  "items": [
    {
    "timestamp": 1589548991563000,
    "video_id": "6152436480001",
    "playhead_seconds": 17
    },
    {
    "timestamp": 1589548858719000,
    "video_id": "6152440604001",
    "playhead_seconds": 3
    }
  ],
  "size": 2
  }

Obtenir des têtes de lecture vidéo de visionneuse

Cette demande obtient toutes les têtes de lecture pour un spectateur et une vidéo spécifique.

GET /accounts/{account_id}/playheads/{viewer_id}/{video_id}

Corps de réponse

Si vous spécifiez un ID vidéo, le corps de la réponse contiendra un objet élément. Lorsque vous spécifiez plusieurs ID vidéo, le items le tableau contiendra plusieurs objets d'élément. Il devrait ressembler à ceci :

{
  "account_id": "1752604059001",
  "viewer_id": "viewer001",
  "items": [
    {
    "timestamp": 1589896539910000,
    "video_id": "6156696074001",
    "playhead_seconds": 39
    }
  ],
  "size": 1
  }

Utiliser un proxy côté serveur

Un proxy est une application côté serveur qui agit comme intermédiaire entre votre application côté client et l'API REST. Voici quelques liens utiles :