The BlazeStoryPlayerStyle class represents the style configuration for a story.

Properties

title

title?: BlazeStoryPlayerTitleTextStyle

The title style for the story.

lastUpdate

lastUpdate?: BlazeStoryPlayerLastUpdateTextStyle

The last update text style for the story.

buttons

buttons?: BlazeStoryPlayerButtonsStyle

The buttons style for the story.

chips

chips?: BlazeStoryPlayerChipsStyle

The chips style for the story.

backgroundColor

backgroundColor?: string

The background color of the story player's view.

cta

cta?: BlazeStoryPlayerCtaStyle

The CTA (Call to Action) button style for the story.

headerGradient

headerGradient?: BlazeStoryPlayerHeaderGradientStyle

The header gradient style over the story's view.

firstTimeSlide

firstTimeSlide?: BlazeStoryPlayerFirstTimeSlideStyle

The style configuration for the first-time slide screen.

progressBar

progressBar?: BlazeStoryPlayerProgressBarStyle

The progress bar style configuration for the story player.

captions

captions?: BlazeCaptionsStyle

The style of the closed-captions text shown over the player: its font and its position on screen.

To style or hide the CC toggle button instead, use buttons.captions. Read more here.

BlazeCaptionsStyle

Value	Description
font	The `BlazeFont` of the caption text.
textSize	The caption text size, in sp. Android only — on iOS the size is part of `font`, so this field has no effect there.
positioning	The on-screen position of the captions box. See `BlazeCaptionsPositioning` below.

BlazeCaptionsPositioning

Value	Description
xPosition	Horizontal position of the captions box: `Start`, `Center`, or `Custom`. Use `Custom` together with `xOffsetPercent`. The default is `Start`.
xOffsetPercent	Offset from the leading edge, as a percentage of the player width, clamped to 0-100. Used only when `xPosition` is `Custom`.
yPosition	Vertical position of the captions box: `Top`, `Center`, `Bottom`, or `Custom`. Use `Custom` together with `yOffsetPercent`. The default is `Top`.
yOffsetPercent	Offset from the top edge, as a percentage of the player height, clamped to 0-100. Used only when `yPosition` is `Custom`.

Initialization

BlazeStoryPlayerStyle

interface BlazeStoryPlayerStyle {
  title?: BlazeStoryPlayerTitleTextStyle;
  lastUpdate?: BlazeStoryPlayerLastUpdateTextStyle;
  buttons?: BlazeStoryPlayerButtonsStyle;
  backgroundColor?: string;
  cta?: BlazeStoryCtaStyle;
  chips?: BlazeStoryPlayerChipsStyle;
  headerGradient?: BlazeStoryPlayerHeaderGradientStyle;
  firstTimeSlide?: BlazeStoryPlayerFirstTimeSlideStyle;
  progressBar?: BlazeStoryPlayerProgressBarStyle;
  captions?: BlazeCaptionsStyle;
}