Перейти к основному содержимому

Список свойств

Почти все свойства доступны для чтения и записи, для свойств, которые поддерживают только чтение об этом указано отдельно.

Все свойства​

АвтоИмяФайла (AutoFileName)​

Указывает, что формат имен файлов генерируется автоматически. Число. По умолчанию равно 0. Описание значений:

  • 0 – Имя файла на основе порядкового номера c префиксом АвтоПрефиксФайла (AutoFilePrefix), начиная с 000001. Например, если автопрефикс равен «file», то будут создаваться файлы вида: file000001.avi, file000002 и т.д.
  • 1 – Имя файла основано на формате yymmdd_hhmmss_zzz даты и времени с префиксом AutoFilePrefix. Например, если префикс равен «file» file030616_090603_904.jpg и т.д.
  • 2 – Эквивалентно предыдущему значение, но существующие файлы будут перезаписаны.

АвтоПрефиксФайла (AutoFilePrefix)​

Приставка (префикс) имен файлов для генерирования имен файлов автоматически. Строка. По умолчанию равно: file.

АвтоФорматДатаВремяФайла (AutoFileNameDateTimeFormat)​

Указывает формат даты/времени для записи имени файла. Строка. Позволяет настроить формат даты/времени, когда имена файлов записи генерируются автоматически и АвтоИмяФайла (AutoFileName) равно 1.
По умолчанию равно yymmdd_hhmmss, что соответствует: если дата равна 01.04.2016 10:24:53, то файл созданный автоматически будет называется 160401_102453.

АвтоФорматМинимальноеЧислоЦифрФайла (AutoFileNameMinDigits)​

Задает число от 0 до количества цифр в имение файлов автоматически сгенерированных. Число. По умолчанию равно 6. Позволяет настроить формат файла, когда имена файлов записи генерируются автоматически и АвтоИмяФайла (AutoFileName) равно 0. Например, если АвтоПрефиксФайла = file, АвтоИмяФайла = 0, а АвтоФорматМинимальноеЧислоЦифрФайла = 6, то файлы будут создаваться в следующем формате: file000001.avi, file000002.avi, file000003.avi

АдресIPКамеры (IPCameraURL)​

При выборе ТипаУстройства IPCAMERA позволяет задать адрес IP-камеры http/rtsp/rtmp. Строка с полным адресом.
Примеры адресов: http://cam001.ethz.ch/jpg/image.jpg
http://webcam2.schobess.info:8012/mjpg/video.mjpg
http://178.34.230.28/liveimg.cgi
rtsp://admin:123456@192.168.0.24/live/main

АудиоГромкость (AudioVolume)​

Громкость звука, текущего аудио устройства захвата. Число от 1 до 65536.

АудиоИсточник (AudioSource)​

Тип источника аудио. Число. Может принимать значения 0 или 1.

  • 0 – использует аудио выход видео устройства захвата, если таковые имеются, в противном случае используется текущее устройство для записи звука.
  • 1 – использовать внешнее устройство записи звука.

АудиоКомпрессор (AudioCompressor)​

Устанавливает (получает) аудио компрессор (кодек), который будет сжимать аудио при записи видео. Выбирается из списка, полученного методом АудиоКомпрессоры (AudioCompressors) и является порядковым номером компрессора аудио. Число.

АудиоКомпрессорСтрокой (AudioCompressorString)​

Работает аналогично свойству АудиоКомпрессор (AudioCompressor) за тем исключением, что это не порядковый номер, а строка описывающая компрессор для аудио. Строка.

АудиоУстройство (AudioDevice)​

Выбирает текущее устройство для захвата звука. Число. Выбирается из списка, полученного методом АудиоУстройства (AudioDevices) и является порядковым номером видео устройства.

АудиоУстройствоСтрокой (AudioDeviceString)​

Работает аналогично свойству АудиоУстройство (AudioDevice) за тем исключением, что это не порядковый номер, а строка описывающая устройство. Строка.

ВестиЛог (UseLog)​

Указывает вести лог событий компонентой или нет. Может понадобиться если по какой-то причине внешняя компонента не работает. Тип Булево. По умолчанию Ложь.

ВидеоКомпрессор (VideoCompressor)​

Устанавливает (получает) видео компрессор (кодек), который будет сжимать видео. Выбирается из списка, полученного методом ВидеоКомпрессоры (VideoCompressors) и является порядковым номером компрессора видео. Число.

ВидеоКомпрессорСтрокой (VideoCompressorString)​

Работает аналогично свойству ВидеоКомпрессор (VideoCompressor) за тем исключением, что это не порядковый номер, а строка описывающая компрессор для видео. Строка.

ВидеоРазмер (VideoSize)​

Устанавливает (получает) видео размер изображения и видео. Выбирается из списка, полученного методом ВидеоРазмеры (VideoSizes) и является порядковым номером размера изображения и видео. Число.

ВидеоРазмерСтрокой (VideoSizeString)​

Работает аналогично свойству ВидеоРазмер (VideoSize) за тем исключением, что это не порядковый номер, а строка описывающая размер получаемого фото и видео. Строка.

ВидеоУстройство (VideoDevice)​

При выборе ТипаУстройства VIDEODEVICE устанавливает (получает) видео устройство, с которого будут получены фото и видео. Выбирается из списка, полученного методом ВидеоУстройства (VideoDevices) и является порядковым номером видео устройства. Число.

ВидеоУстройствоСтрокой (VideoDeviceString)​

Работает аналогично свойству ВидеоУстройство (VideoDevice) за тем исключением, что это не порядковый номер, а строка описывающая устройство. Строка.

ВизуализироватьЗвуковойПоток (AudioDeviceRendering)​

Если это свойство включено, звуковой поток визуализируется во время предварительного просмотра или записи. Булево. По умолчанию Ложь.

ДетекторДвиженияВключен (MotionDetectorEnabled)​

Включает или отключает детектор движения в текущей камере ВК. Булево. По умолчанию Ложь.

ДетекторДвиженияМакисмумДвиженийОбнаруженныхВСекунду (MotionDetectorMaxDetectionsPerSecond)​

Устанавливает максимально допустимое количество движений, обнаруженных в секунду. Число.

ДетекторДвиженияСетка (MotionDetectorGrid)​

Устанавливает или возвращает структуру сетки детектора движения, выраженное в виде простой строки. Сетка представляет собой матрицу вида:

0 0 0 0 0 4 4 4 4 1
5 5 5 5 5 5 5 5 5 1
4 4 4 4 4 4 4 4 4 1
5 5 5 5 5 5 5 5 5 1
6 6 6 6 6 6 6 6 6 1
6 6 6 6 6 6 6 6 6 1
6 6 6 6 6 6 6 6 6 1
3 3 3 3 3 3 3 3 3 1
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0

Для примера выше строка, которая передается в ВК:

0000044441 5555555551 4444444441 5555555551 6666666661 66666666661 6666666661 3333333331 0000000000 0000000000

Изображение разбивается этой сеткой на равные прямоугольники, а число отвечает за чувствительность прямоугольника, это число должно быть целым и находиться в диапазоне от 0 (без обнаружения движения) до 9 (максимальной чувствительности к движению). Чем число выше, тем выше чувствительность. Например, если размер видеокадра составляет 320х240, и вы указываете размер сетки из 32x24, каждая ячейка будет иметь размер 10x10. Соответственно, каждая из ячеек будет обрабатываться отдельно и проверяться есть ли в ней движение.

Примеры сеток: 2x2
0 6
6 6
Кадры будут разбиваться на 4 равных участка, причем в левом верхнем кадре детектор движения не будет срабатывать. Для примера выше строка, которая передается в ВК:
"06 66"

ЗаписыватьЗвук (AudioRecording)​

Записывать ли при записи видео звук. Булево. По умолчанию Ложь.

ИмяЛогФайла (LogFileName)​

Хранит имя файла, куда делается запись, если ведется логирование (журналирование) всех событий внешней компоненты (ВестиЛог = Истина).

ИмяПользователяIPКамеры (IPCameraUserName)​

Имя пользователя для аутентификации на IP-камере или для доступа к потоковому видео, если доступ к IP-камере защищен логином и паролем. Строка.

ИмяФайла (FileName)​

Свойство, которое, предназначено для хранения того имени файла, куда будет делаться запись изображений и видео, а также, производиться чтение и т.д. Для подробного использования см. Примеры. Строка.
При записи видео используется для установки или извлечения имени файла записи, созданного с помощью НачатьЗапись (StartRecording). Если файл существует, он будет перезаписан при запуске.
Если ИмяФайла (FileName) оставлено пустым, при вызове НачатьЗапись (StartRecording) или выполнена функция RecordToNewFileNow имя файла генерируется автоматически в соответствии с ПутьКХранилищу (StoragePath), АвтоИмяФайла (AutoFileName), АвтоПрефиксФайла (AutoFilePrefix) и свойства РасширениеФайлаЗахвата (CaptureFileExt)

ИнтервалТаймераЗаписи (RecordingTimerInterval)​

Интервал времени для таймера записи. Число. Определяет интервал времени между каждым действием свойства ТаймерЗаписи (RecordingTimer) (генерирует новый файл или останавливает запись).

КачествоJPEG (QualityJPEG)​

Отвечает за качество сохраняемого JPEG при работе с изображениями, если свойство ФорматИзображения указан как JPEG, Число от 1 до 100 (чем больше, тем выше качество). По умолчанию 85.

КлючАктивации (ActivationKey)​

Ключ активации. В паре со свойством ИдентификаторКомпьютера (HardwareID) позволяет активировать внешнюю компоненту. Строка. Подробнее про активацию смотри в соответствующей главе.

НачатьАктивацию (StartActivation)​

Функция выполняет запуск окна активации внешней компоненты. Возвращает КлючАктивации (ActivationKey), который необходимо устанавливать для того, чтобы снять ограничения.

Внимание!

Необходимо выполнять активацию на том компьютере, на котором будет в будущем будет работать ВК. Ключ активации привязываются к компьютеру, на котором запускается ВК.

Обрезка (Cropping)​

Включает/отключает обрезку фото и видео кадров. Булево. По умолчанию Ложь.

ОбрезкаВерх (CroppingTop)​

При включенной обрезке фото и видео кадров отвечает за верхнюю координату точки обрезки. Все что выше не попадает в результат. Число. По умолчанию 0.

ОбрезкаВысота (CroppingHeight)​

При включенной обрезке фото и видео кадров отвечает за высоту обрезки, начиная от точки ОбрезкаВерх (CroppingTop). Все что ниже не попадает в результат. Число.

ОбрезкаЛево (CroppingLeft)​

При включенной обрезке фото и видео кадров отвечает за левую координату точки обрезки. Все что левее не попадает в результат. Число. По умолчанию 0.

ОбрезкаШирина (CroppingWidth)​

При включенной обрезке фото и видео кадров отвечает за ширину обрезки, начиная от точки ОбрезкаЛево (CroppingLeft). Все что левее не попадает в результат. Число.

ОверлейноеИзображениеВерх (OverlayImageTop)​

Верхняя координата вывода оверлейного изображения. Число. По умолчанию 10.

ОверлейноеИзображениеВидимость (OverlayImageVisible)​

Выводить или нет оверлейное изображение (логотип). Булево. По умолчанию Ложь. Оверлейное изображение можно использовать для вывода логотипов или водяных знаков.

ОверлейноеИзображениеВысота (OverlayImageHeight)​

Высота вывода оверлейного изображения от верхней координаты. Число. По умолчанию 100.

ОверлейноеИзображениеЗначениеПрозрачности (OverlayImageAlphaBlendValue)​

Если оверлейное изображения прозрачно, то устанавливает степень прозрачности. Число от 0 до 255. 0 - не прозрачно 255 - максимально прозрачно.

ОверлейноеИзображениеЛево (OverlayImageLeft)​

Левая координата вывода оверлейного изображения. Число. По умолчанию 10.

ОверлейноеИзображениеПрозрачность (OverlayImageAlphaBlend)​

Прозрачно ли оверлейное изображение. Булево. По умолчанию Ложь.

ОверлейноеИзображениеРастягиватьПоВидеоРазмеру (OverlayImageStretchToVideoSize)​

Оверлейное изображение будет растянуто по ширине и высоте всего изображения/видео. Булево. По умолчанию Ложь. Используйте совместно со свойством ОверлейноеИзображениеПрозрачность и ОверлейноеИзображениеЗначениеПрозрачности.

ОверлейноеИзображениеУголПоворота (OverlayImageRotationAngle)​

Угол поворота логотипа. Вещественное число. Указывается в градусах от 0.0 до 360.0.

ОверлейноеИзображениеШирина (OverlayImageWidth)​

Ширина вывода оверлейного изображения от верхней координаты. Число. По умолчанию 100.

ОверлейныйТекст (OverlayText)​

Указывает текст, который будет вставлен в видео. Текст может быть изменен в процессе создания видео. Строка.
Также текст может содержать формулы.

  • %sys_time[dd.mm.yy hh:nn:ss]% : текущая системная дата
  • %frame_count% : количество кадров (фреймов)
  • %time_full% : время в текущем фрейме в формате hh:mm:ss:cc
  • %time_sec% : time of the current frame, in seconds with 2 decimals
  • %time_100ns% : time of the current frame, in 100 nano-seconds units

ОверлейныйТекстВерх (OverlayTextTop)​

Верхнее положение оверлейного текста. Число. По умолчанию 0. Оверлейный текст по умолчанию выводится в левом верхнем углу видео.

ОверлейныйТекстВидимость (OverlayTextVisible)​

Указывает на то, необходимо ли вставлять поверх видео произвольный текст. Булево. По умолчанию Ложь.

ОверлейныйТекстЛево (OverlayTextLeft)​

Левое положение оверлейного текста. Число. По умолчанию 0. Оверлейный текст по умолчанию выводится в левом верхнем углу видео.

ОверлейныйТекстРазмерШрифта (OverlayTextFontSize)​

Размер шрифта оверлейного текста. Число. По умолчанию 14.

ОверлейныйТекстЦветШрифта (OverlayTextFontColor)​

Цвет оверлейного текста. Строка. Формат записи шрифта: #RRGGBB (где RR обозначение красной составляющей цвета в шестнадцатеричном виде, GG – зеленого, BB – синего). Примеры цветов:
#FF0000 – красный;
#00FF00 – зеленый;
#0000FF – синий;
#FFE97F – желтый;
#000000 – черный;
#FFFFFF – белый;
И т.д.

ОверлейныйТекстШрифт (OverlayTextFontName)​

Наименование шрифта для оверлейного текста. Строка. По умолчанию используется шрифт «Verdana».

ПарольIPКамеры (IPCameraPassword)​

Пароль для аутентификации на IP-камере или для доступа к потоковому видео, если доступ к IP-камере защищен логином и паролем. Строка.

ПаузаМс (PauseMs)​

Пауза в миллисекундах используется при создании фото и применяется для создания фото без визуальной формы. Необходима для того, чтобы стабилизировалась картинка на веб-камере. После того, как мы инициализируем web-камеру она может не точно передавать картинку (картинка может быть слишком светлая и т.п.). Задержка и стабилизация позволяет картинке принять нормальный вид. Число. По умолчанию 1500 мс. (1,5 секунды).

ПоверхВсехОкон (StayOnTop)​

Окна с предварительным просмотром фото и видео выводить поверх всех окон. Булево. По умолчанию Ложь.

ПредварительныйПросмотр (Preview)​

Использовать предварительный просмотр для создания фото или записи видео. Булево. По умолчанию Истина. Применяется совместно с методом ПолучитьКадр. Если без пред просмотра, то перед созданием фото делается Пауза между стартом и созданием фото на ПаузаМс миллисекунд для стабилизации картинки.

ПутьКХранилищу (StoragePath)​

Путь к хранилищу файлов для записи фото и видео, когда результат может быть не один. Если результат один, то используется ИмяФайла.

РасширениеФайлаЗахвата (CaptureFileExt)​

Расширение по умолчанию используется для создания видео, когда имя файла генерируется автоматически. Строка. По умолчанию avi. Оставьте это поле пустым, если вы хотите, чтобы сгенерировать идентификатор автоматически.
В этом случае будет присвоено:

  • AVI для стандартных AVI файлов,
  • MPG для MPEG файлов.

СоздаватьНовыйФайлПриПаузеВЗаписи (RecordingPauseCreatesNewFile)​

Создает новый файл каждый раз, когда запись приостановлена. Булево. По умолчанию Ложь. Имя нового файла записи генерируется автоматически. Новый файл будет создан, когда запись приостановлена путем вызова паузы записи. Таким образом, файл уже создан и открыт при вызове ПродолжитьЗапись (ResumeRecording), поэтому никакие кадры не теряются в это время. Если запись останавливается перед вызовом ПродолжитьЗапись (ResumeRecording), новый пустой файл (который только что был создан, когда Пауза записи была вызвана) удаляется.

ТаймерЗаписи (RecordingTimer)​

Используется для включения записи по таймеру. Число. Принимает следующие значения:

  • 0 – отключено;
  • 1 – запись нового файла генерируется каждый ИнтервалТаймераЗаписи (RecordingTimerInterval) секунд;
  • 2 – запись прекращается после ИнтервалТаймераЗаписи (RecordingTimerInterval) секунд;
  • 3 – начать запись в режиме предварительного просмотра после ИнтервалТаймераЗаписи (RecordingTimerInterval) секунд.

ТекущаяКамера (CurrentCamera)​

Номер текущей камеры. Число. По умолчанию 0. После инициализации ВК одна камера создается автоматически и с ней можно сразу работать. Если необходимо работать одновременно с несколькими камерами, то необходимо вызывать функцию ДобавитьКамеру (AddCamera), а далее можно переключаться между камерами и управлять свойствами или вызывать методы.

ТипАутентификацииIPКамеры (IPCameraAuthenticationType)​

Тип аутентификации для доступа к IP-камере или потоковому видео. Число.

  • 0 – Публичная точка Windows media server;
  • 1 – IP-камера;
  • 2 – Потоковое видео.
    По умолчанию равно 1.

ТипУстройства (DeviceType)​

Тип текущего устройства. Внешняя компонента будет пытаться работать с указанным типом устройства. Строка. Принимает и возвращает следующее типы (строкой):

  1. VIDEODEVICE – все устройства, которые обнаружатся в Windows (web-камеры, сканеры и т.д.). Синонимы: VIDEO, WEBCAMERA, WEB.
  2. IPCAMERA – работа с IP-камерами, IP-веб камеры, IP-видео серверы, или RTSP-потоком данных. Синонимы: IP.
  3. SCREEN – видео источником является экран монитора. Можно сделать фото (скриншот) и записать видео того, что происходит на мониторе пользователя. Синонимы: SCREEN, SCREENRECORDING, SCREENREC.
    Одно из основных свойств, которое указывает с каким типом изображений/видео будет работать внешняя компонента. Регистр значения не имеет.

ФорматИзображения (ImageFormat)​

Формат изображения, которое будет возвращено внешней компонентой в файл или через двоичные данные. Строка. Может принимать значения:

  1. BMP
  2. PNG
  3. JPEG
  4. GIF
    По умолчанию «PNG».

ЭкранМонитораЗаписи (ScreenRecordingMonitor)​

Номер экрана монитора для записи при выполнении записи экрана. Число. По умолчанию 0. Указывает монитор для записи при использовании записи экрана и рабочего стола распространяется на несколько мониторов. Просто укажите номер монитора (0 для 1-го монитора, 1 для 2-го монитора, и т.д.) ... Если установить значение в -1, то это будет записывать весь расширенный рабочий стол на всех мониторах.