Протокол¶
Оглавление¶
Схема классов¶
deviceapis/device/v1/deviceapis_device_safe_osd_v1.proto¶
Спецификация АПИ управления сущностью SafeCityOsd
SafeCityOsdService¶
Сервис управления настройками OSD
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| EditSafeCityOsd | Метод редактирования настроек OSD | deviceapis.device.v1.EditSafeCityOsdRequest | deviceapis.device.v1.EditSafeCityOsdResponse |
| GetSafeCityOsd | Метод получения настроек OSD | deviceapis.device.v1.GetSafeCityOsdRequest | deviceapis.device.v1.GetSafeCityOsdResponse |
EditSafeCityOsdRequest¶
Запрос редактирования настроек OSD
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки OSD | deviceapis.device.v1.SafeCityOsd | REQUIRED |
| update_mask | Маска полей обновления | google.protobuf.FieldMask |
EditSafeCityOsdResponse¶
Ответ на запрос редактирования настроек OSD
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки OSD | optional deviceapis.device.v1.SafeCityOsd | |
| error | Ошибка | optional deviceapis.device.v1.EditSafeCityOsdResponse.Error |
EditSafeCityOsdResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
GetSafeCityOsdRequest¶
Запрос получения настроек OSD
GetSafeCityOsdResponse¶
Ответ на запрос получения настроек OSD
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки OSD | optional deviceapis.device.v1.SafeCityOsd |
SafeCityOsd¶
Настройки OSD
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| is_osd_enabled | Флаг включения OSD | bool | |
| textline | Текст | string | |
| textsize | Размер текста, пикселей | int32 | |
| placement_type | Размещение текста | deviceapis.device.v1.SafeCityOsd.PlacementType | |
| show_datetime_type | Вариант добавления даты | deviceapis.device.v1.SafeCityOsd.ShowDatetimeType | |
| is_show_fps | Флаг отображения количества кадров в секунду | bool | |
| is_show_bitrate | Флаг отображения битрейта | bool | |
| is_show_count_of_streams | Флаг отображения количества потоков | bool | |
| is_show_name_of_device | Флаг отображения имени устройства | bool |
SafeCityOsd.PlacementType¶
Тип размещения текста
| Номер | Тип | Название |
|---|---|---|
| 0 | PLACEMENT_TYPE_UNKNOWN | Значение не указано |
| 1 | TOP_LEFT | Сверху слева |
| 2 | TOP_RIGHT | Сверху справа |
| 3 | BOTTOM_LEFT | Снизу слева |
| 4 | BOTTOM_RIGHT | Снизу справа |
SafeCityOsd.ShowDatetimeType¶
Тип добавления формата даты
| Номер | Тип | Название |
|---|---|---|
| 0 | SHOW_DATETIME_TYPE_UNKNOWN | Значение не указано |
| 1 | ABSENT | Формат отсутствует |
| 2 | DAY_TIME | День и время yyyy-mm-dd HH:MM:SS |
| 3 | TIME | Время HH:MM:SS |
Скалярные типы значений¶
| .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 |