Instrukcja użytkownika Ajax Video SDK

Ajax Video SDK to zestaw narzędzi przeznaczony do integracji monitoringu wideo Ajax z oprogramowaniem innych firm. Umożliwia programistom przesyłanie transmisji wideo na żywo i nagrań wideo z urządzeń wideo Ajax oraz zarządzanie transmisjami wideo w ramach własnych interfejsów.

Ten zestaw narzędzi jest przeznaczony dla programistów oprogramowania, którzy potrzebują zintegrować wideo Ajax w swoich aplikacjach oraz zapewnić stabilną transmisję obrazu.

Przegląd

Ajax Video SDK umożliwia programistom transmisję wideo na żywo i z nagrań z urządzeń wideo Ajax. Wykorzystuje architekturę dwuwarstwową:

• REST API — służy do uwierzytelniania i pobierania zasobów (przestrzeni, urządzeń wideo, kanałów oraz tokenów wideo).

• gRPC SDK — używany do rozpoczynania i kontrolowania transmisji wideo za pomocą tokenów uzyskanych z REST API.

Ajax Video SDK uruchamia lokalną usługę gRPC, która zarządza transmisjami wideo. Aplikacja łączy się z usługą, aby uruchamiać i kontrolować strumienie wideo, a także odbiera adres URL RTSP, który można wykorzystać do odtwarzania wideo w zgodnym odtwarzaczu.

Najważniejsze cechy

Ajax Video SDK zapewnia następujące funkcje:

1. Transmisja na żywo poprzez RTSP.

2. Odtwarzanie archiwum przez RTSP.

3. Kontrola archiwum:

   • wybór zakresu czasu,

   • nawigowanie do określonej daty i godziny,

   • nawigowanie po archiwum za pomocą kalendarza (nawigacja po stronie klienta),

   • pobieranie metadanych dla wybranego zakresu, w tym osi czasu i wykryć.

4. Wybór jakości transmisja (GŁÓWNA/DODATKOWA).

Struktura Ajax Video SDK

Archiwum Ajax Video SDK zawiera bibliotekę SDK, pliki .proto definiujące API gRPC oraz aplikacje demonstracyjne C++ z kodem źródłowym, które mogą być używane do testowania funkcjonalności SDK i służyć jako praktyczny przykład jego zastosowania.

Wymagania systemowe

Ajax Video SDK został napisany w języku C/C++ i można go bezpośrednio zintegrować z aplikacjami w języku C++.

Zestaw narzędzi można również wykorzystać z dowolnym językiem programowania obsługującym gRPC: jest wymagany do uruchomienia SDK jako usługi lokalnej i połączenia z nią przez gRPC.

Przepływ integracji

Aby uzyskać dostęp do Ajax Video SDK, wypełnij formularz zgłoszenia. Zespół Ajax skontaktuje się z Tobą i prześle archiwum zawierające pliki SDK dla Twojego systemu operacyjnego.

Aby rozpocząć korzystanie z Ajax Video SDK:

1. Uwierzytelnianie przy użyciu jednej z obsługiwanych metod.

2. Znajdź wymaganą przestrzeń.

3. Uzyskaj wymagane identyfikatory krawędzi (edge) oraz kanałów poprzez API Ajax. Możesz zażądać listy wszystkich urządzeń w przestrzeni i zidentyfikować kanał po jego nazwie.

4. Upewnij się, że Twoje konto ma wymagane uprawnienia do uzyskania dostępu do wybranego kanału. Transmisje wideo są dostępne tylko dla kanałów, do których użytkownik lub firma ma dostęp.

5. Wygeneruj token dostępu do odtwarzacza wideo używając wymaganych identyfikatorów krawędzie (edge) oraz kanałów.

6. Zainicjuj SDK, aby uruchomić lokalny serwer gRPC.

7. Otwórz transmisję gRPC (LiveStreaming lub ArchiveStreaming) przy użyciu wygenerowanego tokena wideo.

8. Uzyskaj adres URL RTSP z SDK i użyj go do odtwarzania wideo w zgodnym odtwarzaczu.

9. Utrzymuj sesję, odświeżając tokeny sesji i wideo przed ich wygaśnięciem.

Metody uwierzytelniania

Ajax Video SDK obsługuje dwie metody uwierzytelniania:

• Uwierzytelnianie użytkownika — wymaga zalogowania i zapewnia token sesji oraz token odświeżania.

• Token firmy — umożliwia dostęp bez logowania za pomocą wcześniej wydanego tokena.

Dostęp do transmisji wideo zależy od uprawnień przypisanych do uwierzytelnionego użytkownika lub firmy. Uprawnienia są weryfikowane po stronie chmury Ajax Cloud. Jeśli użytkownik lub firma nie ma dostępu do określonego kanału, transmisja nie może zostać pobrana.

Metoda uwierzytelniania definiuje sposób autoryzacji żądań API i to, które punkty końcowe są używane.

Zarządzanie tokenami

Tokeny używane w pakiecie Ajax Video SDK mają ograniczony okres ważności i muszą być odświeżane:

• Token sesji — musi być okresowo odświeżany (około co 30 minut).

• Token wideo — musi zostać odświeżony podczas aktywnej transmisji przez połączenie gRPC.

Brak odświeżenia tokenów może skutkować przerwaniem transmisji wideo.

Przepływ transmisji wideo

Proces transmisji wideo odbywa się w następujący sposób:

App → REST API → SDK (gRPC) → RTSP → Odtwarzacz wideo.

Ajax Video SDK obsługuje komunikację z Usługami Ajax i zapewnia lokalny punkt końcowy transmisji, podczas gdy aplikacja odpowiada za odtwarzanie.

Liczba jednoczesnych transmisji wideo jest ograniczona: do 16 transmisji na użytkownika oraz do 2 transmisji na kamerę.