Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Options

Вы можете использовать следующие параметры для JavaScript интеграции (например, autoPlay) или атрибуты для HTML интеграции (например, data-auto-play)

Hierarchy

  • Omit<PlayerDataRequestInit, "sessionId">
  • PlayerTemplate
    • Options

Index

Properties

Optional adTemplateId

adTemplateId: number

Идентификатор шаблона рекламы

attribute

data-ad-template-id

Optional aiAd

aiAd: boolean

AI реклама

attribute

data-ai-ad

Optional authToken

authToken: string

Токен аутентификации

attribute

data-auth-token

Optional authTokenVerifyUrl

authTokenVerifyUrl: string

URL-адрес для проверки токена аутентификации. Плеер запрашивает этот URL-адрес с идентификатором recordId/token в запросе и ожидает ответа с HTTP-статусом 200

attribute

data-auth-token-verify-url

Optional autoPlay

autoPlay: boolean | AutoPlay

Автоматический запуск проигрывания после загрузки страницы или когда плеер становится видимым

attribute

data-auto-play

Optional clickOnTitle

clickOnTitle: boolean

URL-адрес для перехода после нажатия на заголовок видео

attribute

data-click-on-title

Optional debug

debug: boolean

Режим отладки

attribute

data-debug

Optional docking

docking: boolean | Position | MiddlePosition

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

attribute

data-docking

Optional dockingCloseDelay

dockingCloseDelay: number

Время в секундах, после которого появляется кнопка закрытия мини-плеера

attribute

data-docking-close-delay

Optional dockingDirection

dockingDirection: VerticalDirection

Направление вертикальной прокрутки, по которому происходит переход в режим мини-плеера

attribute

data-docking-direction

Optional dockingOffset

dockingOffset: number

Отступ видео от границ экрана в режиме мини-плеера

attribute

data-docking-offset

Optional dockingOffsetX

dockingOffsetX: number

Горизонтальный отступ видео от границы экрана в режиме мини-плеера

attribute

data-docking-offset-x

Optional dockingOffsetY

dockingOffsetY: number

Вертикальный отступ видео от границы экрана в режиме мини-плеера

attribute

data-docking-offset-y

Optional dockingParentId

dockingParentId: string

Идентификатор контейнера, внутри которого позиционируется плеер в режиме мини-плеера

attribute

data-docking-parent-id

Optional dockingWidth

dockingWidth: number

Ширина видео в режиме мини-плеера

attribute

data-docking-width

Optional enforceStartWhenPlayingInParent

enforceStartWhenPlayingInParent: boolean

Автоматически закрывает активный мини-плеер, если другой плеер с включенным авто-запуском входит в видимую область браузера

attribute

data-enforce-start-when-playing-in-parent

Optional fullscreenVisible

fullscreenVisible: boolean

Отображение кнопки полноэкранного режима

attribute

data-fullscreen-visible

Optional height

height: number

Фиксированная высота видео с адаптивной шириной

attribute

data-height

id

id: number

Идентификатор видео

attribute

data-id

Optional lazy

lazy: boolean

Enable player lazy load, false by default

attribute

data-lazy

Optional lazyOffset

lazyOffset: number

Offset for lazy load, 300 by default

attribute

data-lazy-offset

Optional likes

likes: boolean

Кнопка лайка

attribute

data-likes

Optional live

live: boolean

Прямая трансляция

attribute

data-live

Optional mediaControlBackgroundColor

mediaControlBackgroundColor: string

Пользовательский цвет фона элементов плеера

attribute

data-media-control-background-color

Optional mediaControlFontUrl

mediaControlFontUrl: string

URL пользовательского шрифта

attribute

data-media-control-font-url

Optional mediaControlForegroundColor

mediaControlForegroundColor: string

Пользовательский цвет элементов плеера

attribute

data-media-control-foreground-color

Optional mediaControlHoverColor

mediaControlHoverColor: string

Пользовательский цвет при наведении на элементы плеера

attribute

data-media-control-hover-color

Optional mediaControlSkinName

mediaControlSkinName: MediaControlSkinName

Название скина плеера

attribute

data-media-control-skin-name

Optional mediaControlTextColor

mediaControlTextColor: string

Пользовательский цвет текстовых элементов плеера

attribute

data-media-control-text-color

Optional mediaControlVisible

mediaControlVisible: boolean

Видимость элементов плеера

attribute

data-media-control-visible

Optional minPlayingVisibleHeight

minPlayingVisibleHeight: number

Минимальная видимая высота плеера для его старта

attribute

data-min-playing-visible-height

Optional multiplayer

multiplayer: false

Отображение плейлиста с мультиплеером

attribute

data-multiplayer

Optional multiplayerBackgroundColor

multiplayerBackgroundColor: string

Пользовательский цвет фона плейлиста с мультиплеером

attribute

data-multiplayer-background-color

Optional multiplayerColor

multiplayerColor: string

Пользовательский цвет элементов плейлиста с мультиплеером

attribute

data-multiplayer-color

Optional multiplayerFilterId

multiplayerFilterId: number

Идентификатор фильтра плейлиста с мультиплеером

attribute

data-multiplayer-filter-id

Optional multiplayerFontUrl

multiplayerFontUrl: string

URL-адрес пользовательского шрифта плейлиста с мультиплеером

attribute

data-multiplayer-font-url

Optional multiplayerHidden

multiplayerHidden: boolean

Визуальное скрытие плейлиста с мультиплеером

attribute

data-multiplayer-hidden

Optional multiplayerShuffle

multiplayerShuffle: boolean

Перемешивание порядка видео в плейлисте с мультиплеером

attribute

data-multiplayer-shuffle

Optional multiplayerTextColor

multiplayerTextColor: string

Пользовательский цвет текстовых элементов плейлиста с мультиплеером

attribute

data-multiplayer-text-color

Optional mute

mute: boolean

Старт видео без звука

attribute

data-mute

Optional parent

parent: HTMLElement

Ссылка на DOM элемент, в который должен быть помещен плеер

Optional parentId

parentId: string

Идентификатор элемента на странице, в который должен быть помещен плеер

Optional pauseSuggestFilterId

pauseSuggestFilterId: number

Идентификатор фильтра рекомендованных видео на паузе видео для ПК

attribute

data-pause-suggest-filter-id

Optional pauseSuggestFilterShuffle

pauseSuggestFilterShuffle: boolean

Перемешивание порядка видео рекомендованных видео на паузе видео для ПК

attribute

data-pause-suggest-filter-shuffle

Optional pauseSuggestMobileFilterId

pauseSuggestMobileFilterId: number

Идентификатор фильтра рекомендованных видео на паузе видео для мобильных устройств

attribute

data-pause-suggest-mobile-filter-id

Optional playbackRate

playbackRate: boolean

Отображение кнопки выбора скорости воспроизведения

attribute

data-playback-rate

Optional playerTemplateId

playerTemplateId: number

Идентификатор шаблона плеера

attribute

data-player-template-id

Optional poster

poster: string

URL-адрес изображения, которое будет отображаться до запуска проигрывателя

attribute

data-poster

Optional promoButtonClickUrl

promoButtonClickUrl: string

URL-адрес перехода после клика на промо-кнопку

attribute

data-promo-button-click-url

Optional promoButtonImage

promoButtonImage: string

URL-адрес изображения промо-кнопки

attribute

data-promo-button-image

Optional promoButtonPosition

promoButtonPosition: Position

Позиция промо-кнопки

attribute

data-promo-button-position

Optional qualityVisible

qualityVisible: boolean

Отображение кнопки выбора качества

attribute

data-quality-visible

Optional redirectToSuggestOnClick

redirectToSuggestOnClick: boolean

Открывает новое окно при клике на видео из списка рекомендаций на паузе или в конце видео

attribute

data-redirect-to-suggest-on-click

Optional referrer

referrer: string

URL-адрес страницы, на которой встроен плеер

attribute

data-referrer

Optional replay

replay: boolean

Повтор видео

attribute

data-replay

Optional replayTimeout

replayTimeout: number

Таймаут в секундах перед повтором видео по его окончанию

attribute

data-replay-timeout

Optional saveUserVolume

saveUserVolume: boolean

Сохранение последней выставленной пользователем громкости для конкретного аккаунта

attribute

data-save-user-volume

Optional seekBarVisible

seekBarVisible: boolean

Отображение полоски длительности видео

attribute

data-seek-bar-visibile

Optional shareEmbedCodes

shareEmbedCodes: boolean

Кнопки копирования HTML-кода вставки плеера в меню "Поделиться"

attribute

data-share-embed-codes

Optional shareSocialNetworks

shareSocialNetworks: boolean

Кнопки социальных сетей в меню "Поделиться"

attribute

data-share-social-networks

Optional showSuggestNames

showSuggestNames: boolean

Отображение названия видео для рекомендованных видео на паузе или в конце видео

attribute

data-show-suggest-names

Optional showTitle

showTitle: boolean

Заголовок видео

attribute

data-show-title

Optional sspJparams

sspJparams: Record<string, string>

Дополнительные SSP VAST параметры, для обогащения существующих параметров

attribute

data-ssp-jparams

Optional sspUserId

sspUserId: string

Идентификатор пользователя SSP

attribute

data-ssp-user-id

Optional sspUserIdScope

sspUserIdScope: string

Идентификатор SSP группы пользователей

attribute

data-ssp-user-id-scope

Optional startPosition

startPosition: number

Позиция начала старта проигрывания

attribute

data-start-position

Optional suggest

suggest: false

Отображение списка рекомендованных видео на паузе или в конце видео

attribute

data-suggest

Optional suggestFilterId

suggestFilterId: number

Идентификатор фильтра рекомендованных видео в конце видео для ПК

attribute

data-suggest-filter-id

Optional suggestFilterShuffle

suggestFilterShuffle: boolean

Перемешивание порядка видео рекомендованных видео в конце видео для ПК

attribute

data-suggest-filter-shuffle

Optional suggestMobileFilterId

suggestMobileFilterId: number

Идентификатор фильтра рекомендованных видео в конце видео для мобильных устройств

attribute

data-suggest-mobile-filter-id

Optional unmute

unmute: boolean

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

attribute

data-unmute

Optional userId

userId: string

Пользовательский идентификатор, для пользователей без Rambler/ID session

attribute

data-user-id

Optional videoBackdropColor

videoBackdropColor: string

Цвет фона видео

attribute

data-video-backdrop-color

Optional volume

volume: number

Старт видео с установленной громкостью

attribute

data-volume

Optional volumeVisible

volumeVisible: boolean

Отображение кнопки установки уровня громкости

attribute

data-volume-visible

Optional watchNext

watchNext: boolean

Превью следующего видео из плейлиста мультиплеера

attribute

data-watch-next

Optional watermark

watermark: string

URL-адрес логотипа (водяной знак)

attribute

data-watermark

Optional watermarkPosition

watermarkPosition: Position

Позиция логотипа

attribute

data-watermark-position

Optional yandexMetrikaVideoType

yandexMetrikaVideoType: string

Тип видео для Yandex Metrika, например, video, explainer или live. Если значения явно не передано, будет использоваться тип video для VOD и live для прямых трансляций.

attribute

data-yandex-metrika-video-type

Generated using TypeDoc