Interface Options

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

interface Options {
    adTemplateId?: number;
    aiAd?: boolean;
    aspectRatio?: number;
    authToken?: string;
    authTokenVerifyUrl?: string;
    autoPlay?: boolean | AutoPlay;
    clickOnTitle?: boolean;
    debug?: boolean;
    docking?: boolean | Position | MiddlePosition;
    dockingCloseDelay?: number;
    dockingDirection?: VerticalDirection;
    dockingOffset?: number;
    dockingOffsetX?: number;
    dockingOffsetY?: number;
    dockingParentId?: string;
    dockingWidth?: number;
    enforceStartWhenPlayingInParent?: boolean;
    fullscreenVisible?: boolean;
    height?: number;
    id?: string | number;
    lazy?: boolean;
    lazyOffset?: number;
    likes?: boolean;
    live?: boolean;
    mediaControlBackgroundColor?: string;
    mediaControlFontUrl?: string;
    mediaControlForegroundColor?: string;
    mediaControlHoverColor?: string;
    mediaControlSkinName?: MediaControlSkinName;
    mediaControlTextColor?: string;
    mediaControlVisible?: boolean;
    minDurationToShowAd?: number;
    minPlayingVisibleHeight?: number;
    multiplayer?: false;
    multiplayerBackgroundColor?: string;
    multiplayerColor?: string;
    multiplayerFilterId?: number;
    multiplayerFontUrl?: string;
    multiplayerHidden?: boolean;
    multiplayerShuffle?: boolean;
    multiplayerTextColor?: string;
    mute?: boolean;
    parent?: HTMLElement;
    parentId?: string;
    pauseSuggestFilterId?: number;
    pauseSuggestFilterShuffle?: boolean;
    pauseSuggestMobileFilterId?: number;
    playbackRate?: boolean;
    playerTemplateId?: number;
    poster?: string;
    preload?: boolean;
    promoButtonClickUrl?: string;
    promoButtonImage?: string;
    promoButtonPosition?: Position;
    promoButtonSize?: LARGE;
    qualityVisible?: boolean;
    redirectToSuggestOnClick?: boolean;
    referrer?: string;
    replay?: boolean;
    replayTimeout?: number;
    rewind?: boolean;
    saveUserVolume?: boolean;
    seekBarVisible?: boolean;
    shareEmbedCodes?: boolean;
    shareSocialNetworks?: boolean;
    showSuggestNames?: boolean;
    showTitle?: boolean;
    sspJparams?: Record<string, string>;
    sspUserId?: string;
    sspUserIdScope?: string;
    startPosition?: number;
    suggest?: false;
    suggestFilterId?: number;
    suggestFilterShuffle?: boolean;
    suggestMobileFilterId?: number;
    threeSixtyViewer?: boolean;
    unmute?: boolean;
    userId?: string;
    videoBackdropColor?: string;
    volume?: number;
    volumeVisible?: boolean;
    watchNext?: boolean;
    watermark?: string;
    watermarkPosition?: Position;
    yandexMetrikaVideoType?: string;
}

Hierarchy

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

Properties

adTemplateId? aiAd? aspectRatio? authToken? authTokenVerifyUrl? autoPlay? clickOnTitle? debug? docking? dockingCloseDelay? dockingDirection? dockingOffset? dockingOffsetX? dockingOffsetY? dockingParentId? dockingWidth? enforceStartWhenPlayingInParent? fullscreenVisible? height? id? lazy? lazyOffset? likes? live? mediaControlBackgroundColor? mediaControlFontUrl? mediaControlForegroundColor? mediaControlHoverColor? mediaControlSkinName? mediaControlTextColor? mediaControlVisible? minDurationToShowAd? minPlayingVisibleHeight? multiplayer? multiplayerBackgroundColor? multiplayerColor? multiplayerFilterId? multiplayerFontUrl? multiplayerHidden? multiplayerShuffle? multiplayerTextColor? mute? parent? parentId? pauseSuggestFilterId? pauseSuggestFilterShuffle? pauseSuggestMobileFilterId? playbackRate? playerTemplateId? poster? preload? promoButtonClickUrl? promoButtonImage? promoButtonPosition? promoButtonSize? qualityVisible? redirectToSuggestOnClick? referrer? replay? replayTimeout? rewind? saveUserVolume? seekBarVisible? shareEmbedCodes? shareSocialNetworks? showSuggestNames? showTitle? sspJparams? sspUserId? sspUserIdScope? startPosition? suggest? suggestFilterId? suggestFilterShuffle? suggestMobileFilterId? threeSixtyViewer? unmute? userId? videoBackdropColor? volume? volumeVisible? watchNext? watermark? watermarkPosition? yandexMetrikaVideoType?

Properties

Optional adTemplateId

adTemplateId?: number

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

Attribute

data-ad-template-id

Optional aiAd

aiAd?: boolean

AI реклама

Attribute

data-ai-ad

Optional aspectRatio

aspectRatio?: number

Отношение ширины видео к высоте

Attribute

data-aspect-ratio

Например, при соотношении видео 16:9

<div
  data-widget="Player"
  data-id="1"
  data-aspect-ratio="1.77777"
></div>

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

Optional id

id?: string | number

Идентификатор видео (id или uuid)

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 minDurationToShowAd

minDurationToShowAd?: number

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

Attribute

data-min-duration-to-show-ad

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 preload

preload?: boolean

Предзагрузка видео

Attribute

data-preload

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 promoButtonSize

promoButtonSize?: LARGE

Размер промо-кнопки

Attribute

data-promo-button-size

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 rewind

rewind?: boolean

Отключение элементов перемотки

Attribute

data-rewind

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 threeSixtyViewer

threeSixtyViewer?: boolean

Просмотр видео в режиме 360

Attribute

data-three-sixty-viewer

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

Settings

Member Visibility

Theme

On This Page

adTemplateIdaiAdaspectRatioauthTokenauthTokenVerifyUrlautoPlayclickOnTitledebugdockingdockingCloseDelaydockingDirectiondockingOffsetdockingOffsetXdockingOffsetYdockingParentIddockingWidthenforceStartWhenPlayingInParentfullscreenVisibleheightidlazylazyOffsetlikeslivemediaControlBackgroundColormediaControlFontUrlmediaControlForegroundColormediaControlHoverColormediaControlSkinNamemediaControlTextColormediaControlVisibleminDurationToShowAdminPlayingVisibleHeightmultiplayermultiplayerBackgroundColormultiplayerColormultiplayerFilterIdmultiplayerFontUrlmultiplayerHiddenmultiplayerShufflemultiplayerTextColormuteparentparentIdpauseSuggestFilterIdpauseSuggestFilterShufflepauseSuggestMobileFilterIdplaybackRateplayerTemplateIdposterpreloadpromoButtonClickUrlpromoButtonImagepromoButtonPositionpromoButtonSizequalityVisibleredirectToSuggestOnClickreferrerreplayreplayTimeoutrewindsaveUserVolumeseekBarVisibleshareEmbedCodesshareSocialNetworksshowSuggestNamesshowTitlesspJparamssspUserIdsspUserIdScopestartPositionsuggestsuggestFilterIdsuggestFilterShufflesuggestMobileFilterIdthreeSixtyViewerunmuteuserIdvideoBackdropColorvolumevolumeVisiblewatchNextwatermarkwatermarkPositionyandexMetrikaVideoType