Benutzerhandbuch für Ajax Video SDK

Ajax Video SDK ist ein Toolkit zur Integration von Ajax Videoüberwachung in Software von Drittanbietern. Es ermöglicht Entwicklern, Live- und aufgezeichnete Videos von Ajax Videogeräten zu streamen und Videostreams innerhalb ihrer eigenen Benutzeroberflächen zu verwalten.

Dieses Toolkit richtet sich an Softwareentwickler, die Ajax Videos in ihre Apps einbetten und ein stabiles Videostreaming gewährleisten müssen.

Übersicht

Das Ajax Video SDK ermöglicht Entwicklern das Streamen von Live- und aufgezeichneten Videos von Ajax Videogeräten. Es verwendet eine zweistufige Architektur:

• REST-API wird zur Authentifizierung und zum Abruf von Ressourcen (Spaces, Videogeräte, Kanäle und Videotoken) verwendet.

• gRPC SDK wird verwendet, um Videostreams mit Tokens zu starten und zu steuern, die über die REST API abgerufen werden.

Das Ajax Video SDK startet einen lokalen gRPC-Service, der das Videostreaming verwaltet. Die App stellt eine Verbindung zum Service her, um Videostreams zu starten und zu steuern, und empfängt eine RTSP URL, die zum Abspielen von Videos in einem kompatiblen Player verwendet werden kann.

Schlüsselfunktionen

Das Ajax Video SDK bietet folgende Funktionen:

1. Live-Streaming über RTSP.

2. Archivwiedergabe über RTSP.

3. Archivsteuerung:

   • Auswahl eines Zeitbereichs,

   • Navigation zu einem bestimmten Datum und einer bestimmten Uhrzeit,

   • Navigation in einem Archiv mithilfe eines Kalenders (clientseitige Navigation),

   • Abruf von Metadaten für den ausgewählten Bereich, einschließlich einer Zeitleiste und Erkennungen.

4. Auswahl der Streamqualität (MAIN/SUB).

Struktur des Ajax Video SDK

Das Ajax Video SDK-Archiv enthält die SDK-Bibliothek, .proto-Dateien, die die gRPC-API definieren, und C++ Demo-Apps mit Quellcode, die zum Testen der SDK-Funktionalität verwendet werden können und als praktisches Beispiel für deren Verwendung dienen.

Systemanforderungen

Ajax Video SDK ist in C/C++ implementiert und kann direkt in C++ Apps integriert werden.

Das Toolkit kann auch mit jeder Programmiersprache verwendet werden, die gRPC unterstützt: Es ist erforderlich, das SDK als lokalen Service auszuführen und sich über gRPC damit zu verbinden.

Integrationsablauf

Um auf das Ajax Video SDK zuzugreifen, füllen Sie das Anfrageformular aus. Das Ajax Team wird sich mit Ihnen in Verbindung setzen und Ihnen ein Archiv mit SDK-Dateien für Ihr Betriebssystem zur Verfügung stellen.

So beginnen Sie mit der Nutzung des Ajax Video SDK:

1. Authentifizieren Sie sich mit einer der unterstützten Methoden.

2. Finden Sie den benötigten Space.

3. Rufen Sie die erforderlichen Edge- und Kanal-IDs über die Ajax API ab. Sie können die Liste aller Geräte im Space anfordern und den Kanal anhand seines Namens identifizieren.

4. Stellen Sie sicher, dass Ihr Konto über die erforderlichen Berechtigungen verfügt, um auf den ausgewählten Kanal zugreifen zu können. Videostreaming ist nur für Kanäle verfügbar, auf die der Nutzer oder das Unternehmen Zugriff hat.

5. Generieren Sie ein Videoplayer-Zugriffstoken unter Verwendung der erforderlichen Edge- und Kanal-IDs.

6. Initialisieren Sie das SDK, um einen lokalen gRPC-Server zu starten.

7. Öffnen Sie einen gRPC-Stream (LiveStreaming oder ArchiveStreaming) mit dem generierten Video-Token.

8. Rufen Sie eine RTSP URL aus dem SDK ab und verwenden Sie diese, um Videos in einem kompatiblen Player abzuspielen.

9. Halten Sie die Sitzung aufrecht, indem Sie die Sitzungs- und Videotoken aktualisieren, bevor diese ablaufen.

Authentifizierungsmethoden

Ajax Video SDK unterstützt zwei Authentifizierungsmethoden:

• Benutzerauthentifizierung, die Anmeldung erfordert und ein Sitzungstoken und ein Aktualisierungstoken bereitstellt.

• Firmentoken, das den Zugriff ohne Anmeldung mithilfe eines zuvor ausgestellten Tokens ermöglicht.

Der Zugriff auf Videostreams hängt von den Berechtigungen ab, die dem authentifizierten Benutzer oder Unternehmen zugeordnet sind. Die Berechtigungen werden auf der Ajax Cloud-Seite validiert. Wenn der Benutzer oder das Unternehmen keinen Zugriff auf einen bestimmten Kanal hat, kann der Stream nicht abgerufen werden.

Die Authentifizierungsmethode definiert, wie API-Anfragen autorisiert werden und welche Endpunkte verwendet werden.

Token-Verwaltung

Die im Ajax Video SDK verwendeten Tokens haben eine begrenzte Lebensdauer und müssen erneuert werden:

• Sitzungstoken muss regelmäßig (etwa alle 30 Minuten) aktualisiert werden.

• Video-Token muss während eines aktiven Streams über die gRPC-Verbindung aktualisiert werden.

Wenn die Tokens nicht aktualisiert werden, kann dies zu Unterbrechungen beim Videostreaming führen.

Videostreaming-Ablauf

Der Videostreaming-Prozess läuft wie folgt ab:

App → REST API → SDK (gRPC) → RTSP → Videoplayer.

Ajax Video SDK übernimmt die Kommunikation mit Ajax Services und stellt einen lokalen Streaming-Endpunkt bereit, während die App für die Wiedergabe zuständig ist.

Die Anzahl der gleichzeitigen Videostreams ist begrenzt: maximal 16 Streams pro Benutzer und maximal 2 Streams pro Kamera.