# Протокол

## Оглавление

- [deviceapis/device/v1/deviceapis_device_video_v1.proto](#deviceapis_device_v1_deviceapis_device_video_v1-proto)
    - [VideoChannelService](#deviceapis-device-v1-VideoChannelService)
  
    - [EditVideoChannelRequest](#deviceapis-device-v1-EditVideoChannelRequest)
    - [EditVideoChannelResponse](#deviceapis-device-v1-EditVideoChannelResponse)
    - [EditVideoChannelResponse.Error](#deviceapis-device-v1-EditVideoChannelResponse-Error)
    - [GetVideoChannelListRequest](#deviceapis-device-v1-GetVideoChannelListRequest)
    - [GetVideoChannelListResponse](#deviceapis-device-v1-GetVideoChannelListResponse)
    - [VideoChannel](#deviceapis-device-v1-VideoChannel)
  
    - [VideoChannel.FlowControlModeType](#deviceapis-device-v1-VideoChannel-FlowControlModeType)
    - [VideoChannel.FormatType](#deviceapis-device-v1-VideoChannel-FormatType)
    - [VideoChannel.ProfileType](#deviceapis-device-v1-VideoChannel-ProfileType)
    - [VideoChannel.ResolutionType](#deviceapis-device-v1-VideoChannel-ResolutionType)
  


## [Схема классов](/svg/protos/key/deviceapis/device/v1/deviceapis_device_video_v1.proto.svg)
<a href="/svg/protos/key/deviceapis/device/v1/deviceapis_device_video_v1.proto.svg"><img src="/svg/protos/key/deviceapis/device/v1/deviceapis_device_video_v1.proto.svg" alt="/svg/protos/key/deviceapis/device/v1/deviceapis_device_video_v1.proto.svg" style="height:100%;"></a>




<a name="deviceapis_device_v1_deviceapis_device_video_v1-proto"></a>

## [deviceapis/device/v1/deviceapis_device_video_v1.proto](/protos/key/deviceapis/device/v1/deviceapis_device_video_v1.proto)
Сервис управления настройками видеоконфига


<a name="deviceapis-device-v1-VideoChannelService"></a>

### VideoChannelService
 Сервис управления настройками видеоконфига

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="deviceapis-device-v1-EditVideoChannel"></a> [EditVideoChannel](#deviceapis-device-v1-EditVideoChannel) | Метод редактирования единичной сущности VideoChannel по ключу | [deviceapis.device.v1.EditVideoChannelRequest](#deviceapis-device-v1-EditVideoChannelRequest) | [deviceapis.device.v1.EditVideoChannelResponse](#deviceapis-device-v1-EditVideoChannelResponse) |
| <a id="deviceapis-device-v1-GetVideoChannelList"></a> [GetVideoChannelList](#deviceapis-device-v1-GetVideoChannelList) | Метод получения списка сущностей VideoChannel по фильтру | [deviceapis.device.v1.GetVideoChannelListRequest](#deviceapis-device-v1-GetVideoChannelListRequest) | [deviceapis.device.v1.GetVideoChannelListResponse](#deviceapis-device-v1-GetVideoChannelListResponse) |

 <!-- end services -->


<a name="deviceapis-device-v1-EditVideoChannelRequest"></a>


### [EditVideoChannelRequest](#deviceapis-device-v1-EditVideoChannelRequest)
 Запрос редактирования единичной сущности VideoChannel по ключу


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-EditVideoChannelRequest-data"></a> [data](#deviceapis-device-v1-EditVideoChannelRequest-data) | Настройки видеоконфига |    [deviceapis.device.v1.VideoChannel](#deviceapis-device-v1-VideoChannel) | REQUIRED|
| <a id="deviceapis-device-v1-EditVideoChannelRequest-update_mask"></a> [update_mask](#deviceapis-device-v1-EditVideoChannelRequest-update_mask) | Маска полей обновления |    [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="deviceapis-device-v1-EditVideoChannelResponse"></a>


### [EditVideoChannelResponse](#deviceapis-device-v1-EditVideoChannelResponse)
 Ответ на запрос редактирования единичной сущности VideoChannel по ключу


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-EditVideoChannelResponse-data"></a> [data](#deviceapis-device-v1-EditVideoChannelResponse-data) | Настройки видеоконфига |  optional  [deviceapis.device.v1.VideoChannel](#deviceapis-device-v1-VideoChannel) | <nil>|
| <a id="deviceapis-device-v1-EditVideoChannelResponse-error"></a> [error](#deviceapis-device-v1-EditVideoChannelResponse-error) | Ошибка |  optional  [deviceapis.device.v1.EditVideoChannelResponse.Error](#deviceapis-device-v1-EditVideoChannelResponse-Error) | <nil>|






<a name="deviceapis-device-v1-EditVideoChannelResponse-Error"></a>


### [EditVideoChannelResponse.Error](#deviceapis-device-v1-EditVideoChannelResponse-Error)
 Ошибка запроса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-EditVideoChannelResponse-Error-validation"></a> [validation](#deviceapis-device-v1-EditVideoChannelResponse-Error-validation) | Ошибка валидации |  optional  [deviceapis.device.v1.ValidationError](#deviceapis-device-v1-ValidationError) | <nil>|






<a name="deviceapis-device-v1-GetVideoChannelListRequest"></a>


### [GetVideoChannelListRequest](#deviceapis-device-v1-GetVideoChannelListRequest)
 Запрос получения списка сущностей VideoChannel по фильтру






<a name="deviceapis-device-v1-GetVideoChannelListResponse"></a>


### [GetVideoChannelListResponse](#deviceapis-device-v1-GetVideoChannelListResponse)
 Ответ на запрос получения списка сущностей VideoChannel по фильтру


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-GetVideoChannelListResponse-data"></a> [data](#deviceapis-device-v1-GetVideoChannelListResponse-data) | Список VideoChannel |  repeated  [deviceapis.device.v1.VideoChannel](#deviceapis-device-v1-VideoChannel) | <nil>|






<a name="deviceapis-device-v1-VideoChannel"></a>


### [VideoChannel](#deviceapis-device-v1-VideoChannel)
 Настройки видеоконфига


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-VideoChannel-chanel_number"></a> [chanel_number](#deviceapis-device-v1-VideoChannel-chanel_number) | Порядковый номер видеоконфига |    [int32](#scalar-types) | REQUIRED|
| <a id="deviceapis-device-v1-VideoChannel-is_enabled"></a> [is_enabled](#deviceapis-device-v1-VideoChannel-is_enabled) | Флаг активности |    [bool](#scalar-types) | REQUIRED|
| <a id="deviceapis-device-v1-VideoChannel-resolution_type"></a> [resolution_type](#deviceapis-device-v1-VideoChannel-resolution_type) | Тип разрешения видео |    [deviceapis.device.v1.VideoChannel.ResolutionType](#deviceapis-device-v1-VideoChannel-ResolutionType) | <nil>|
| <a id="deviceapis-device-v1-VideoChannel-format_type"></a> [format_type](#deviceapis-device-v1-VideoChannel-format_type) | Формат видео |    [deviceapis.device.v1.VideoChannel.FormatType](#deviceapis-device-v1-VideoChannel-FormatType) | <nil>|
| <a id="deviceapis-device-v1-VideoChannel-profile_type"></a> [profile_type](#deviceapis-device-v1-VideoChannel-profile_type) | Профиль |    [deviceapis.device.v1.VideoChannel.ProfileType](#deviceapis-device-v1-VideoChannel-ProfileType) | <nil>|
| <a id="deviceapis-device-v1-VideoChannel-fps"></a> [fps](#deviceapis-device-v1-VideoChannel-fps) | Частота кадров |    [int32](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-VideoChannel-gop"></a> [gop](#deviceapis-device-v1-VideoChannel-gop) | Периодичность опорного кадра |    [int32](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-VideoChannel-flow_control_mode_type"></a> [flow_control_mode_type](#deviceapis-device-v1-VideoChannel-flow_control_mode_type) | Режим FlowControlModeType |    [deviceapis.device.v1.VideoChannel.FlowControlModeType](#deviceapis-device-v1-VideoChannel-FlowControlModeType) | <nil>|
| <a id="deviceapis-device-v1-VideoChannel-biterate"></a> [biterate](#deviceapis-device-v1-VideoChannel-biterate) | Целевая скорость потока, килобит |    [int32](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-VideoChannel-is_rtsp_audio"></a> [is_rtsp_audio](#deviceapis-device-v1-VideoChannel-is_rtsp_audio) | Флаг rtsp_audio |    [bool](#scalar-types) | <nil>|
| <a id="deviceapis-device-v1-VideoChannel-is_used_for_sip"></a> [is_used_for_sip](#deviceapis-device-v1-VideoChannel-is_used_for_sip) | Флаг use for sip |    [bool](#scalar-types) | <nil>|





 <!-- end messages -->



<a name="deviceapis-device-v1-VideoChannel-FlowControlModeType"></a>

### [VideoChannel.FlowControlModeType](#deviceapis-device-v1-VideoChannel-FlowControlModeType)
 Режим Flow control mode

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="deviceapis-device-v1-VideoChannel-FlowControlModeType-FLOW_CONTROL_MODE_TYPE_UNKNOWN"></a> [FLOW_CONTROL_MODE_TYPE_UNKNOWN](#deviceapis-device-v1-VideoChannel-FlowControlModeType-FLOW_CONTROL_MODE_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="deviceapis-device-v1-VideoChannel-FlowControlModeType-VBR"></a> [VBR](#deviceapis-device-v1-VideoChannel-FlowControlModeType-VBR) | Режим VBR |
| 2 | <a id="deviceapis-device-v1-VideoChannel-FlowControlModeType-CBR"></a> [CBR](#deviceapis-device-v1-VideoChannel-FlowControlModeType-CBR) | Режим CBR |
| 3 | <a id="deviceapis-device-v1-VideoChannel-FlowControlModeType-CVBR"></a> [CVBR](#deviceapis-device-v1-VideoChannel-FlowControlModeType-CVBR) | Режим CVBR |
| 4 | <a id="deviceapis-device-v1-VideoChannel-FlowControlModeType-AVBR"></a> [AVBR](#deviceapis-device-v1-VideoChannel-FlowControlModeType-AVBR) | Режим AVBR |
| 5 | <a id="deviceapis-device-v1-VideoChannel-FlowControlModeType-FIXP"></a> [FIXP](#deviceapis-device-v1-VideoChannel-FlowControlModeType-FIXP) | Режим FIXP |
| 6 | <a id="deviceapis-device-v1-VideoChannel-FlowControlModeType-QVBR"></a> [QVBR](#deviceapis-device-v1-VideoChannel-FlowControlModeType-QVBR) | Режим QVBR |




<a name="deviceapis-device-v1-VideoChannel-FormatType"></a>

### [VideoChannel.FormatType](#deviceapis-device-v1-VideoChannel-FormatType)
 Формат видео

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="deviceapis-device-v1-VideoChannel-FormatType-FORMAT_TYPE_UNKNOWN"></a> [FORMAT_TYPE_UNKNOWN](#deviceapis-device-v1-VideoChannel-FormatType-FORMAT_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="deviceapis-device-v1-VideoChannel-FormatType-MPEG"></a> [MPEG](#deviceapis-device-v1-VideoChannel-FormatType-MPEG) | Формат mjpeg |
| 2 | <a id="deviceapis-device-v1-VideoChannel-FormatType-H264"></a> [H264](#deviceapis-device-v1-VideoChannel-FormatType-H264) | Формат h.264 |
| 3 | <a id="deviceapis-device-v1-VideoChannel-FormatType-H264_PLUS"></a> [H264_PLUS](#deviceapis-device-v1-VideoChannel-FormatType-H264_PLUS) | Формат h.264+ |
| 4 | <a id="deviceapis-device-v1-VideoChannel-FormatType-H265"></a> [H265](#deviceapis-device-v1-VideoChannel-FormatType-H265) | Формат h.265 |




<a name="deviceapis-device-v1-VideoChannel-ProfileType"></a>

### [VideoChannel.ProfileType](#deviceapis-device-v1-VideoChannel-ProfileType)
 Профиль

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="deviceapis-device-v1-VideoChannel-ProfileType-PROFILE_TYPE_UNKNOWN"></a> [PROFILE_TYPE_UNKNOWN](#deviceapis-device-v1-VideoChannel-ProfileType-PROFILE_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="deviceapis-device-v1-VideoChannel-ProfileType-PROFILE_HIGH"></a> [PROFILE_HIGH](#deviceapis-device-v1-VideoChannel-ProfileType-PROFILE_HIGH) | Высокий |
| 2 | <a id="deviceapis-device-v1-VideoChannel-ProfileType-PROFILE_MAIN"></a> [PROFILE_MAIN](#deviceapis-device-v1-VideoChannel-ProfileType-PROFILE_MAIN) | Основной |
| 3 | <a id="deviceapis-device-v1-VideoChannel-ProfileType-PROFILE_BASE"></a> [PROFILE_BASE](#deviceapis-device-v1-VideoChannel-ProfileType-PROFILE_BASE) | Базовый |




<a name="deviceapis-device-v1-VideoChannel-ResolutionType"></a>

### [VideoChannel.ResolutionType](#deviceapis-device-v1-VideoChannel-ResolutionType)
 Тип разрешения видео

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="deviceapis-device-v1-VideoChannel-ResolutionType-RESOLUTION_TYPE_UNKNOWN"></a> [RESOLUTION_TYPE_UNKNOWN](#deviceapis-device-v1-VideoChannel-ResolutionType-RESOLUTION_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="deviceapis-device-v1-VideoChannel-ResolutionType-R2K"></a> [R2K](#deviceapis-device-v1-VideoChannel-ResolutionType-R2K) | Тип разрешения 2K 2560*1440 |
| 2 | <a id="deviceapis-device-v1-VideoChannel-ResolutionType-FULLHD"></a> [FULLHD](#deviceapis-device-v1-VideoChannel-ResolutionType-FULLHD) | Тип разрешения FULLHD 1920*1080 |
| 3 | <a id="deviceapis-device-v1-VideoChannel-ResolutionType-HD"></a> [HD](#deviceapis-device-v1-VideoChannel-ResolutionType-HD) | Тип разрешения HD 1280*720 |
| 4 | <a id="deviceapis-device-v1-VideoChannel-ResolutionType-SD"></a> [SD](#deviceapis-device-v1-VideoChannel-ResolutionType-SD) | Тип разрешения SD 720*576 |
| 5 | <a id="deviceapis-device-v1-VideoChannel-ResolutionType-R4CIF"></a> [R4CIF](#deviceapis-device-v1-VideoChannel-ResolutionType-R4CIF) | Тип разрешения 4CIF 704*576 |
| 6 | <a id="deviceapis-device-v1-VideoChannel-ResolutionType-VGA"></a> [VGA](#deviceapis-device-v1-VideoChannel-ResolutionType-VGA) | Тип разрешения VGA 640*480 |


 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |