StoryBlockConfiguration class

Constructors

StoryBlockConfiguration({VideoPlayerStyle? playerStyle, VideoPlayerScrollDirection? scrollDirection, bool? enableScrollForVertical, VideoPlayerCompleteAction? videoCompleteAction, bool? showShareButton, VideoPlayerCTAStyle? ctaButtonStyle, bool? showPlaybackButton, bool? showMuteButton, bool? showBranding, VideoPlayerCTADelay? ctaDelay, VideoPlayerCTADelay? ctaHighlightDelay, String? shareBaseURL, VideoPlayerCTAWidth? ctaWidth, VideoPlayerButtonConfiguration? buttonConfiguration, VideoPlayerLogoConfiguration? videoPlayerLogoConfiguration, bool? showVideoDetailTitle, ReplayBadgeConfiguration? replayBadgeConfiguration, CountdownTimerConfiguration? countdownTimerConfiguration, VideoPlayerActionButtonStyle? actionButtonStyle, VideoPlayerActionButtonStyle? cancelButtonStyle, ChatStyle? chatStyle, bool? enableAutoplay, bool? enableAutopause, bool? enableFullScreen, bool? enableSmallSizeInCompact, VideoPlayerHorizontalLayoutConfiguration? horizontalLayout, bool? showProductCard, bool? showMoreButton, bool? showCaption, bool? showProductCardInCompact})

Properties

actionButtonStyle ↔ VideoPlayerActionButtonStyle?
The style of Action button style.
getter/setter pair
buttonConfiguration ↔ VideoPlayerButtonConfiguration?
The host app could use this property to customize the button images of the video player.
getter/setter pair
cancelButtonStyle ↔ VideoPlayerActionButtonStyle?
The style of Cancel button style.
getter/setter pair
chatStyle ↔ ChatStyle?
The style configuration for chat.
getter/setter pair
countdownTimerConfiguration ↔ CountdownTimerConfiguration?
Specifies countdown timer configuration.
getter/setter pair
ctaButtonStyle ↔ VideoPlayerCTAStyle?
The style of CTA button style.
getter/setter pair
ctaDelay ↔ VideoPlayerCTADelay?
Specifies the delay before showing the CTA.
getter/setter pair
ctaHighlightDelay ↔ VideoPlayerCTADelay?
Specifies the delay before the highlight animation occurs.
getter/setter pair
ctaWidth ↔ VideoPlayerCTAWidth?
Specifies the desired width for the Video Player CTA button.
getter/setter pair
enableAutopause ↔ bool?
Specifies if autopause is enabled. Only for short videos and embedded mode. Defaults to false.
getter/setter pair
enableAutoplay ↔ bool?
Specifies if autoplay is enabled. Only for embedded mode. Defaults to true.
getter/setter pair
enableFullScreen ↔ bool?
Specifies if full screen is enabled. Only for embedded mode. Defaults to true.
getter/setter pair
enableScrollForVertical ↔ bool?
Indicates if scroll is enabled for vertical direction. Defaults to false.
getter/setter pair
enableSmallSizeInCompact ↔ bool?
Specifies if small size in compact is enabled. Only for embedded mode. Available on Android only. Defaults to false.
getter/setter pair
hashCode → int
The hash code for this object.
no setteroverride
horizontalLayout ↔ VideoPlayerHorizontalLayoutConfiguration?
The configuration for horizontal layout.
getter/setter pair
playerStyle ↔ VideoPlayerStyle?
Sets the proportion of the video player to its container. Default to full.
getter/setter pair
replayBadgeConfiguration ↔ ReplayBadgeConfiguration?
The configuration of replay badge. Only supported on iOS.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollDirection ↔ VideoPlayerScrollDirection?
Specifies the scroll direction of the video player.
getter/setter pair
shareBaseURL ↔ String?
The share base URL of the video.
getter/setter pair
showBranding ↔ bool?
Indicates if Firework branding should be showed or not.
getter/setter pair
showCaption ↔ bool?
Indicates if the video player shows the video caption. Different from showVideoDetailTitle, which controls the title in video details. Defaults to true.
getter/setter pair
showMoreButton ↔ bool?
Indicates if the video player shows the more button. Defaults to true.
getter/setter pair
showMuteButton ↔ bool?
Indicates if the video player shows mute button.
getter/setter pair
showPlaybackButton ↔ bool?
Indicates if the video player shows playback button.
getter/setter pair
showProductCard ↔ bool?
Indicates if the video player shows product cards. Applies to the fullscreen player, and to embedded mode unless showProductCardInCompact is set. Defaults to true.
getter/setter pair
showProductCardInCompact ↔ bool?
Indicates if product cards are shown in embedded (compact) mode. Falls back to showProductCard when null. Does not affect the fullscreen player.
getter/setter pair
showShareButton ↔ bool?
Indicates if the video player shows share button.
getter/setter pair
showVideoDetailTitle ↔ bool?
Specifies if the video detail title should be showed or not.
getter/setter pair
videoCompleteAction ↔ VideoPlayerCompleteAction?
Behavior occurring after video is complete. On iOS, the property only applies to full-screen mode but not to embedded mode. On Android, the property applies to both full-screen and embedded modes.
getter/setter pair
videoPlayerLogoConfiguration ↔ VideoPlayerLogoConfiguration?
Specifies the logo configuration Defaults to { option: 'disabled' }
getter/setter pair

Methods

deepCopy() → StoryBlockConfiguration
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
override