JavaScript API видеовиджета
События
Обработка события открытия видеовиджета
Событие срабатывает каждый раз, когда пользователь кликает по виджету, т.е. открывает его и переходит в режим просмотра.
Событие срабатывает каждый раз, когда пользователь кликает по виджету, т.е. открывает его и переходит в режим просмотра.
Пример обработки клика по виджету (т.е. когда виджет открывается)
window.GetReviewSettings = {
onEvent: function (event, widget) {
if (event.type === GetReview.Events.WIDGET_OPEN) {
console.log("Виджет был открыт", widget.token) // Ваш код здесь
}
},
};
Обработка события клика по CTA-кнопке
Событие срабатывает каждый раз, когда пользователь кликает по CTA-кнопке в виджете
Событие срабатывает каждый раз, когда пользователь кликает по CTA-кнопке в виджете
Пример обработки клика по CTA-кнопке
window.GetReviewSettings = {
onEvent: function (event, widget) {
if (event.type === GetReview.Events.CALL_TO_ACTION_BUTTON_CLICK) {
console.log("Пользователь кликнул на CTA-кнопку", widget.token) // Ваш код здесь
}
},
};
Основные функции
Принудительная перезагрузка (переотрисовка) видеовиджетов
Для SPA сайтов бывает необходимо принудительно перезагрузить виджеты или заново отрисовать их. Это нужно в случае, если изменение URL не срабатывает, а при этом виджеты нужно отобразить.
Для SPA сайтов бывает необходимо принудительно перезагрузить виджеты или заново отрисовать их. Это нужно в случае, если изменение URL не срабатывает, а при этом виджеты нужно отобразить.
GetReview.API.reset()
Поиск видеовиджета по его уникальному токену в API
Если на странице отображается несколько виджетов, то вы можете найти нужный вам виджет через API метод findWidget и выполнять дальнейшие API вызовы именно у найденного виджета.
Если на странице отображается несколько виджетов, то вы можете найти нужный вам виджет через API метод findWidget и выполнять дальнейшие API вызовы именно у найденного виджета.
var videoWidget = GetReview.API.findWidget("R9CjJREjddUmOeWt")
// R9CjJREjddUmOeWt - уникальный id (токен) виджета
Включение и выключение звука в виджете
Функция позволяет принудительно включить или выключить звук в виджете. Может использоваться, например, для автоматического отключения звука в виджете при его открытии.
Функция позволяет принудительно включить или выключить звук в виджете. Может использоваться, например, для автоматического отключения звука в виджете при его открытии.
// Включить звук
videoWidget.mute();
// Выключить взук
videoWidget.unmute();
// Включить/выключить звук
videoWidget.toggleMuteUnmute();
Открыть видеовиджет
Функция позволяет открыть (кликнуть) видеовиджет.
Функция позволяет открыть (кликнуть) видеовиджет.
videoWidget.openWidget();
Закрыть видеовиджет
Функция позволяет закрыть (свернуть) видеовиджет.
Функция позволяет закрыть (свернуть) видеовиджет.
videoWidget.closeWidget();
Скрыть видеовиджет
Функция позволяет полностью скрыть (убрать) видеовиджет со страницы
Функция позволяет полностью скрыть (убрать) видеовиджет со страницы
videoWidget.destroyWidget();
Начать проигрывание видео
Функция позволяет начать проигрывание видео в видеовиджете. Триггер эмулирует нажатие на кнопку play.
Функция позволяет начать проигрывание видео в видеовиджете. Триггер эмулирует нажатие на кнопку play.
videoWidget.play();
Поставить видео на паузу
Функция позволяет поставить текущее проигрываемое видео в видеовиджете на паузу.
Функция позволяет поставить текущее проигрываемое видео в видеовиджете на паузу.
videoWidget.pause();
Проигрывать видео/ставить на паузу одной функцией
Функция позволяет проигрывать видео или ставить его на паузу в зависимости от текущего состояния видео. Если видео уже проигрывается, то вызов функции поставит его на паузу. Если видео стоит на паузе, то вызов функции начнет его проигрывать.
Функция позволяет проигрывать видео или ставить его на паузу в зависимости от текущего состояния видео. Если видео уже проигрывается, то вызов функции поставит его на паузу. Если видео стоит на паузе, то вызов функции начнет его проигрывать.
videoWidget.togglePlayPause();
Получение текущего проигрываемого кадра в видео в процентах
Функция возвращает процент (от 0 до 100), какая часть видео уже была проиграна. Например, если пользователь посмотрел 30 секунд у 60-секундного видео, то данная функция вернет цифру 50 (т.е. 50%).
Функция возвращает процент (от 0 до 100), какая часть видео уже была проиграна. Например, если пользователь посмотрел 30 секунд у 60-секундного видео, то данная функция вернет цифру 50 (т.е. 50%).
videoWidget.getCurrentVideoProgress();
Получение текущего проигрываемого кадра в видео в секундах
Функция возвращает на какой секунде видео сейчас воспроизводится.
Функция возвращает на какой секунде видео сейчас воспроизводится.
videoWidget.getCurrentVideoTime();
Была ли инструкция полезна?