Banners
VideoBlockBanner

VideoBlockBanner

Single video block with playback options.

Includes the common banner props.

Props

id
string
required

CMS id.

video
VideoProps
required

Video configuration object.

mutedAutoplay
boolean
required

If true, video starts automatically muted.

hideControls
boolean
required

If true, native controls are hidden.

loop
boolean
required

If true, loops playback.

mobileAspect
'SIXTEEN_TO_NINE' | 'FOUR_TO_THREE' | 'NINE_TO_SIXTEEN'
required

Aspect ratio to use on mobile layouts.

Example

const banner: VideoBlockBanner = {
  typename: BannerTypename.VideoBlock,
  id: 'b_123',
  title: null,
  titleTag: 'h2',
  titleAlign: 'left',
  cssId: null,
  cssClasses: null,
  video: {} as any,
  mutedAutoplay: true,
  hideControls: false,
  loop: true,
  mobileAspect: 'SIXTEEN_TO_NINE'
};