Manuel utilisateur Ajax Video SDK

Ajax Video SDK est un kit de développement conçu pour intégrer la vidéosurveillance Ajax dans des logiciels tiers. Cet outil permet aux développeurs d'afficher les images en direct et les vidéos enregistrées par les caméras Ajax directement dans leurs propres applications.

Ce kit est destiné aux développeurs de logiciels qui ont besoin d'intégrer de la vidéo Ajax dans leurs applications et d'assurer une diffusion vidéo stable.

Aperçu

Ajax Video SDK permet aux développeurs de diffuser des vidéos en direct et enregistrées depuis les dispositifs vidéo Ajax. Il utilise une architecture à deux niveaux :

• REST API – utilisé pour s'identifier et accéder aux éléments du système (espaces, caméras, flux et tokens vidéo).

• gRPC SDK – utilisé pour démarrer et contrôler les tokens fournis par l'interface de programmation (REST API).

Ajax Video SDK lance un service gRPC local qui gère le streaming vidéo. L'application se connecte au service pour démarrer et contrôler les flux vidéo et reçoit une URL RTSP qui peut être utilisée pour lire la vidéo dans un lecteur compatible.

Caractéristiques clés

Ajax Video SDK offre les fonctionnalités suivantes :

1. Diffusion en direct via RTSP.

2. Lecture de l'archive via le protocole RTSP.

3. Contrôle de l'archive :

   • sélection d'une plage horaire,

   • navigation vers une date et une heure spécifique,

   • navigation dans une archive à l'aide d'un calendrier (navigation côté client),

   • récupération des métadonnées pour la plage sélectionnée, y compris la chronologie et les détections.

4. Sélection de la qualité du flux (MAIN/SUB).

Structure de l'Ajax Video SDK

L'archive Ajax Video SDK comprend la bibliothèque du SDK, les fichiers .proto définissant l'API gRPC, ainsi que des applications de démonstration en C++ avec leur code source, utilisables pour tester les fonctionnalités du SDK et servant d'exemple pratique d'utilisation.

Configuration système requise

Ajax Video SDK est implémenté en C/C++ et peut être intégré directement dans des applications C++.

Le kit de développement peut également être utilisé avec tout langage de programmation qui prend en charge gRPC : il doit fonctionner comme un programme local sur votre machine, et la connexion se fait par un système de communication appelé gRPC.

Flux d'intégration

Pour accéder à l'Ajax Video SDK, veuillez remplir le formulaire de demande. L'équipe Ajax vous contactera et vous fournira une archive contenant les fichiers SDK pour votre système d'exploitation.

Pour commencer à utiliser Ajax Video SDK :

1. Authentifiez-vous en utilisant l’une des méthodes prises en charge.

2. Trouvez l'espace requis.

3. Récupérez les identifiants nécessaires pour le serveur (edge) et le canal en utilisant l'API Ajax. Vous pouvez demander la liste de tous les dispositifs dans l'espace et identifier le canal par son nom.

4. Assurez-vous que votre compte dispose des autorisations requises pour accéder au canal sélectionné. Le streaming vidéo n'est disponible que pour les canaux auxquels l'utilisateur ou l'entreprise a accès.

5. Créez un token pour le lecteur vidéo en utilisant les identifiants requis (ID du serveur (edge) et ID du canal).

6. Initialisez le SDK pour démarrer un serveur gRPC local.

7. Ouvrez un flux gRPC (LiveStreaming ou ArchiveStreaming) à l'aide du token obtenu.

8. Obtenez une URL RTSP depuis le SDK et utilisez-la pour lire la vidéo dans un lecteur compatible.

9. Évitez les coupures en rafraîchissant vos tokens (session et vidéo) avant qu'ils ne cessent de fonctionner.

Méthodes d'authentification

Ajax Video SDK prend en charge deux méthodes d’authentification :

• Authentification de l'utilisateur – nécessite une connexion et fournit une session token (jeton de session) ainsi qu'un refresh token (jeton de renouvellement).

• Company token – permet l'accès sans authentification préalable via un jeton émis à l'avance.

L'accès aux flux vidéo dépend des autorisations associées à l'utilisateur ou à l'entreprise authentifiés. Chaque accès est validé par le service Ajax Cloud pour garantir l'intégrité des données. Si l'utilisateur ou l'entreprise n'a pas accès à un canal spécifique, le flux ne peut pas être récupéré.

La méthode d'authentification définit le mode d'autorisation des requêtes API et les adresses du serveur utilisées.

Gestion des tokens

Les tokens utilisés dans l'Ajax Video SDK ont une durée de vie limitée et doivent être renouvelés :

• Session token –doit être renouvelé périodiquement (environ toutes les 30 minutes).

• Video token – doit être renouvelé pendant un flux actif via la connexion gRPC.

Le défaut de renouvellement des tokens peut entraîner l'interruption du flux vidéo.

Flux de streaming vidéo

Le processus de streaming vidéo est le suivant :

App → REST API → SDK (gRPC) → RTSP → Lecteur vidéo.

Ajax Video SDK gère la communication avec les Services Ajax et fournit un point de diffusion local, tandis que l'application est responsable de la lecture.

Le nombre de flux vidéo simultanés est limité : jusqu'à 16 flux par utilisateur et jusqu'à 2 flux par caméra.