VideoEncoder: метод configure()

Метод configure() интерфейса VideoEncoder изменяет state кодера на "настроенный" и асинхронно подготавливает кодер к приёму VideoEncoder для кодирования с указанными параметрами. Если кодер не поддерживает указанные параметры или не может быть инициализирован по другим причинам, об ошибке будет сообщено через обратный вызов ошибки, предоставленный конструктору VideoEncoder.

Если VideoEncoder уже был настроен, новая настройка не будет применена до тех пор, пока не завершатся все предыдущие задачи.

config

Объект словаря, содержащий следующие члены:

codec

Строка, содержащая допустимую строку кодека. Смотрите "параметр codecs" для получения подробной информации о построении строки кодека.

width Необязательно

Целое число, представляющее ширину каждого выходного EncodedVideoChunk в пикселях до любых корректировок соотношения.

height Необязательно

Целое число, представляющее высоту каждого выходного EncodedVideoChunk в пикселях до любых корректировок соотношения.

displayWidth Необязательно

Целое число, представляющее предполагаемую ширину отображения каждого выходного EncodedVideoChunk в пикселях при отображении.

displayHeight Необязательно

Целое число, представляющее вертикальную размерность каждого выходного EncodedVideoChunk в пикселях при отображении.

hardwareAcceleration

Подсказка, настраивающая метод аппаратного ускорения для этого кодека. Одна из:

• "no-preference"
• "prefer-hardware"
• "prefer-software"

bitrate

Целое число, содержащее среднюю битовую скорость закодированного видео в единицах бит в секунду.

framerate

Целое число, содержащее ожидаемую частоту кадров в кадрах в секунду.

alpha

Строка, указывающая, следует ли сохранить или отбросить альфа-компонент VideoFrame входных данных перед кодированием. Одна из:

• "discard" (по умолчанию)
• "keep"

scalabilityMode

Строка, содержащая идентификатор режима масштабируемости кодирования, как определено в WebRTC.

bitrateMode Необязательно

Строка, содержащая режим битовой скорости. Одна из:

"constant"

Кодер будет нацелен на постоянную битовую скорость.

"variable" (по умолчанию)

Кодер будет нацелен на переменную битовую скорость, позволяя использовать больше места для сложных сигналов и меньше места для менее сложных сигналов.

"quantizer"

Кодер проигнорирует параметр bitrate и вместо этого будет использовать специфичные для кодека значения квантизатора, указанные для каждого кадра в параметре options для VideoEncoder.encode().

latencyMode Необязательно

Строка, содержащая значение, которое настраивает поведение задержки этого кодека. Одна из:

"quality" (по умолчанию)

Кодер должен оптимизировать качество кодирования.

"realtime"

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

Ничего (undefined).

TypeError

Выбрасывается, если предоставленный config недействителен.

InvalidStateError DOMException

Выбрасывается, если state имеет состояние "closed".

NotSupportedError DOMException

Выбрасывается, если предоставленный config действителен, но пользовательский агент не может предоставить кодек, который может декодировать этот профиль.

В следующем примере создаётся новый VideoEncoder и настраивается с некоторыми доступными опциями.

const init = {
  output: handleChunk,
  error: (e) => {
    console.log(e.message);
  },
};

let config = {
  codec: "vp8",
  width: 640,
  height: 480,
  bitrate: 2_000_000, // 2 Mbps
  framerate: 30,
};

let encoder = new VideoEncoder(init);
encoder.configure(config);