Протокол¶
Оглавление¶
Схема классов¶
deviceapis/device/v1/deviceapis_device_video_v1.proto¶
Сервис управления настройками видеоконфига
VideoChannelService¶
Сервис управления настройками видеоконфига
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| EditVideoChannel | Метод редактирования единичной сущности VideoChannel по ключу | deviceapis.device.v1.EditVideoChannelRequest | deviceapis.device.v1.EditVideoChannelResponse |
| GetVideoChannelList | Метод получения списка сущностей VideoChannel по фильтру | deviceapis.device.v1.GetVideoChannelListRequest | deviceapis.device.v1.GetVideoChannelListResponse |
EditVideoChannelRequest¶
Запрос редактирования единичной сущности VideoChannel по ключу
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки видеоконфига | deviceapis.device.v1.VideoChannel | REQUIRED |
| update_mask | Маска полей обновления | google.protobuf.FieldMask |
EditVideoChannelResponse¶
Ответ на запрос редактирования единичной сущности VideoChannel по ключу
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки видеоконфига | optional deviceapis.device.v1.VideoChannel | |
| error | Ошибка | optional deviceapis.device.v1.EditVideoChannelResponse.Error |
EditVideoChannelResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
GetVideoChannelListRequest¶
Запрос получения списка сущностей VideoChannel по фильтру
GetVideoChannelListResponse¶
Ответ на запрос получения списка сущностей VideoChannel по фильтру
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Список VideoChannel | repeated deviceapis.device.v1.VideoChannel |
VideoChannel¶
Настройки видеоконфига
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| chanel_number | Порядковый номер видеоконфига | int32 | REQUIRED |
| is_enabled | Флаг активности | bool | REQUIRED |
| resolution_type | Тип разрешения видео | deviceapis.device.v1.VideoChannel.ResolutionType | |
| format_type | Формат видео | deviceapis.device.v1.VideoChannel.FormatType | |
| profile_type | Профиль | deviceapis.device.v1.VideoChannel.ProfileType | |
| fps | Частота кадров | int32 | |
| gop | Периодичность опорного кадра | int32 | |
| flow_control_mode_type | Режим FlowControlModeType | deviceapis.device.v1.VideoChannel.FlowControlModeType | |
| biterate | Целевая скорость потока, килобит | int32 | |
| is_rtsp_audio | Флаг rtsp_audio | bool | |
| is_used_for_sip | Флаг use for sip | bool |
VideoChannel.FlowControlModeType¶
Режим Flow control mode
| Номер | Тип | Название |
|---|---|---|
| 0 | FLOW_CONTROL_MODE_TYPE_UNKNOWN | Значение не указано |
| 1 | VBR | Режим VBR |
| 2 | CBR | Режим CBR |
| 3 | CVBR | Режим CVBR |
| 4 | AVBR | Режим AVBR |
| 5 | FIXP | Режим FIXP |
| 6 | QVBR | Режим QVBR |
VideoChannel.FormatType¶
Формат видео
| Номер | Тип | Название |
|---|---|---|
| 0 | FORMAT_TYPE_UNKNOWN | Значение не указано |
| 1 | MPEG | Формат mjpeg |
| 2 | H264 | Формат h.264 |
| 3 | H264_PLUS | Формат h.264+ |
| 4 | H265 | Формат h.265 |
VideoChannel.ProfileType¶
Профиль
| Номер | Тип | Название |
|---|---|---|
| 0 | PROFILE_TYPE_UNKNOWN | Значение не указано |
| 1 | PROFILE_HIGH | Высокий |
| 2 | PROFILE_MAIN | Основной |
| 3 | PROFILE_BASE | Базовый |
VideoChannel.ResolutionType¶
Тип разрешения видео
| Номер | Тип | Название |
|---|---|---|
| 0 | RESOLUTION_TYPE_UNKNOWN | Значение не указано |
| 1 | R2K | Тип разрешения 2K 2560*1440 |
| 2 | FULLHD | Тип разрешения FULLHD 1920*1080 |
| 3 | HD | Тип разрешения HD 1280*720 |
| 4 | SD | Тип разрешения SD 720*576 |
| 5 | R4CIF | Тип разрешения 4CIF 704*576 |
| 6 | VGA | Тип разрешения VGA 640*480 |
Скалярные типы значений¶
| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
|---|---|---|---|---|---|---|---|---|
| double | float | float64 | Float | double | double | double | float | |
| float | float | float32 | Float | float | float | float | float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| uint32 | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| uint64 | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| sfixed32 | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sfixed64 | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| bool | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| bytes | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |