Page History

message Options
{
    oneof mode
    {
        LiveMode live = 1;
        ArchiveMode archive = 2;
    }
    oneof output_type
    {
        SnapshotType snapshot = 3;
        StreamType stream = 4;
    }
    repeated CommonSetting settings = 5;
    // Maximum size of output file.
    // New file will be created on reaching this value.
    uint64 max_file_size = 6;
    string export_agent_access_point = 100;
}

For each export type, there are timeouts after which the operation is stopped if the GetSessionState method was not executed.

The timeout is counted from the moment the export operation was started and/or from the moment the GetSessionState method was last executed.

The timeout for exporting a video clip from live video is 5 minutes, for all other export types - 30 minutes.

The id of the export operation will be received as the response to this method.

ListSessions method

The SessionInfo message for each export operation will be received as the response to this method. If one response does not fit all the operations, then there will also be the next_page_token for the next page.

The SessionInfo message contains:

Dla każdego typu eksportu istnieje okres oczekiwania, po upłynięciu którego operacja jest zatrzymywana, o ile nie została wykonana metoda GetSessionState.

Okres oczekiwania jest wyliczany począwszy od chwili rozpoczęcia operacji i/lub od chwili, w której ostatnio użyta została metoda GetSessionState.

Okres oczekiwania dla eksportowania klipów wideo to 5 minut; dla wszystkich typów eksportu - 30 minut.

ID operacji eksportu będzie otrzymane jako odpowiedź do tej metody.

Metoda ListSessions

Message SessionInfo dla każdej operacji eksportu będzie otrzymywana jako odpowiedź do tej metody. Jeśli odpowiedź nie zawiera wszystkich operacji, będzie zawarty next_page_token do przejścia do następnej strony.

Message SessionInfo zawiera:

1. ID operacji eksportu oraz jej właściwości.

2. Status eksportu

3. id of the export operation and its properties.

4. export status.

   Code Block
   enum EState { S_NONE = 0; S_RUNNING = 1; S_COMPLETED = 2; S_REMOVED = 3; }

   where the gdzie status S_COMPLETED status does not guarantee that the export was successful.nie oznacza, że eksport zakończył się powodzeniem.

5. Jeśli istnieją wyniki operacji eksportu, zostanie wysłana wiadomość ResultIf there are export operation results, then a Result message will be received.
   

   Code Block
   message Result { message File { string path = 1; uint64 size = 2; string min_timestamp = 3; string max_timestamp = 4; string mime_type = 5; } repeated File files = 1; bool succeeded = 2; }

   where,gdzie:

   1. succeeded - indicates that the export was successfulmówi, że operacja eksportu została zakończona powodzeniem;

   2. message File - describes the list of files ready for download, including the conditional path to be used in the DownloadFile method and size.

After the export operation status changes to S_COMPLETED, you have 1 hour to download the files from the Server. Note that the timeout is reset to zero after the GetSessionState and DownloadFile methods are executed.

If the timeout is exceeded, the files will be deleted from the Server.

GetSessionState method

The id of the export operation is passed in the method.

Its EState status will be received in response to this method.

If there are export operation results, then a Result message will be received.

StopSession method

The id of the export operation is passed in the method.

Its updated EState status will be received in response to this method.

DownloadFile method

The method can be used only after the export operation is completed.

The following data is passed in the method:

1. 1. określa listę plików gotowych do pobrania, wliczając w to warunkową ścieżkę do użytku w metodzie DownloadFile, oraz ich wielkość.

Po zmianie statusu operacji eksportu na S_COMPLETED, limit czasu na pobranie plików z Serwera to 1 godzina. Timeout jest resetowany do zera po wykonaniu jednej z metod: GetSessionState lub DownloadFile.

Jeśli timeout zostanie przekroczony, pliki zostaną usunięte z Serwera.

Metoda GetSessionState

ID operacji eksportu jest przekazywane przy tej metodzie.

Status EState zostanie przekazany w odpowiedzi na tę metodę.

Jeśli istnieją wyniki operacji eksportu, wiadomosć Result zostanie wysłana.

Metoda StopSession

ID operacji eksportu jest przekazywane przy tej metodzie.

Zaktualizowany status EState zostanie przekazany w odpowiedzi na tę metodę.

Metoda DownloadFile

Metoda ta może zostać użyta tylko w sytuacji, gdy operacja eksportu została już wykonana.

Następujące dane są przekazywane w tej metodzie:

1. ID operacji eksportu;
2. ścieżka do pliku
3. export operation id;
4. path to the file;
5. chunk_size_kb - data block sizewielkość bloku danych;
6. start_from_chunk_index - serial number of the data block.

In response to this method, FileChunk messages will be received with file data blocks, which will be coming until the entire file is downloaded.

DestroySession method

1. numer seryjny bloku danych.

W odniesieniu do tej metody wiadomości FileChunk zostaną przesłane wraz z blokami danych plików, które będą przesyłane, aż cały plik zostanie pobrany.

Metoda DestroySession

ID operacji eksportu jest przekazywane w tej metodzieThe id of the export operation is passed in the method.