FOnline Engine
Current master GitHub
Документация Docs/ru/reference/video/embedded.md

Контракт встроенного видео

Сгенерированный справочник. Не редактируйте его источник напрямую. Обновите BuildTools/VideoInterface.json, затем выполните python BuildTools/docs_video.py --write.

Индекс Форматы Доставка Декодирование Полный экран Встроенное Проверка Канонический JSON Руководство
Стабильный ID Правило Требование Причина Источник
video.embedded.create Создание управляемого скриптом воспроизведения Используйте Game.CreateVideoPlayback(exactPath, looped) для создания независимого воспроизведения с подсчётом ссылок и текстуры. Экспортированный метод PassOwnership загружает ресурс, создаёт VideoClip и текстуру и сохраняет оба в VideoPlayback. Source/Scripting/ClientGlobalScriptMethods.cpp
video.embedded.missing-file Ошибка создания выбрасывает исключение Перехватывайте или предотвращайте отсутствие управляемого скриптом видеоресурса; создание выбрасывает Video file not found. В отличие от полноэкранного PlayVideo, CreateVideoPlayback превращает неудачный ReadFile в ScriptException. Source/Scripting/ClientGlobalScriptMethods.cpp
video.embedded.render-event Рисование только в RenderIface Вызывайте Game.DrawVideoPlayback только при обработке Game.OnRenderIface. Метод выбрасывает исключение вне клиентской script draw scope. Source/Scripting/ClientGlobalScriptMethods.cpp
video.embedded.positive-size Положительный размер цели продвигает воспроизведение Передавайте положительные ширину и высоту в каждом кадре; нулевой или отрицательный размер пропускает декодирование, загрузку текстуры и рисование. RenderFrame вызывается только внутри ветки положительного размера. Source/Scripting/ClientGlobalScriptMethods.cpp
video.embedded.rectangle Прямоугольник и пропорции принадлежат вызывающему коду Выбирайте и поддерживайте целевой прямоугольник и политику пропорций в проектном UI-коде; Engine рисует точно указанную позицию и размер. DrawVideoPlayback создаёт irect32 непосредственно из аргументов скрипта. Source/Scripting/ClientGlobalScriptMethods.cpp
video.embedded.stopped Жизненный цикл поля Stopped Опрашивайте VideoPlayback.Stopped, продолжая рисовать экземпляр; флаг становится true, когда DrawVideoPlayback обнаруживает остановку ролика. Метод рисования очищает ресурсы и устанавливает экспортированное поле после проверки остановки. Source/Scripting/ClientGlobalScriptMethods.cpp, Source/Client/Client.h
video.embedded.null-noop Null и завершённые экземпляры ничего не делают Передача null или экземпляра с очищенными ресурсами воспроизведения ничего не рисует и не выбрасывает исключение. DrawVideoPlayback рано возвращается для обоих состояний после проверки render scope. Source/Scripting/ClientGlobalScriptMethods.cpp
Введите запрос.