ByteArkPlayerConfig class
Configuration options for the ByteArk Player.
Constructors
- ByteArkPlayerConfig.new({required ByteArkPlayerLicenseKey licenseKey, bool? autoPlay = true, bool? control = true, bool? seekButtons = true, int? seekTime = 30, required ByteArkPlayerItem? playerItem, bool? fullScreenButton = true, bool? settingButton = true, ByteArkLighthouseSetting? lighthouseSetting, ByteArkAdsSettings? adsSettings, bool? secureSurface = false, ByteArkPlayerSubtitleSize? subtitleSize = ByteArkPlayerSubtitleSize.medium, bool? subtitleBackgroundEnabled = true, int? subtitlePaddingBottomPercentage = 10})
- Constructs a ByteArkPlayerConfig with the specified settings.
Properties
- adsSettings → ByteArkAdsSettings?
-
Ads settings for handling advertisement features in the player.
final
- autoPlay → bool?
-
Determines whether the player should auto-play on load.
final
- control → bool?
-
Indicates if playback controls are shown.
final
- fullScreenButton → bool?
-
Displays a full-screen button in the player UI.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- licenseKey → ByteArkPlayerLicenseKey
-
The license key for the player
final
- lighthouseSetting → ByteArkLighthouseSetting?
-
Lighthouse settings for analytics or additional functionalities.
final
- playerItem → ByteArkPlayerItem?
-
The item to be played by the player.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- secureSurface → bool?
-
Determines whether the player should use a secure surface for rendering protected content.
final
- seekButtons → bool?
-
Determines if seek buttons are available in the player UI.
final
- seekTime → int?
-
The amount of time (in seconds) for seek operations.
final
- settingButton → bool?
-
Displays a settings button in the player UI.
final
- subtitleBackgroundEnabled → bool?
-
Indicates whether the subtitle background should be enabled.
final
- subtitlePaddingBottomPercentage → int?
-
Specifies the bottom padding for subtitles as a percentage.
final
- subtitleSize → ByteArkPlayerSubtitleSize?
-
Specifies the subtitle size for the player.
final
Methods
-
copyWith(
{ByteArkPlayerLicenseKey? licenseKey, bool? autoPlay, bool? control, bool? seekButtons, int? seekTime, ByteArkPlayerItem? playerItem, bool? fullScreenButton, bool? settingButton, ByteArkLighthouseSetting? lighthouseSetting, ByteArkAdsSettings? adsSettings, bool? secureSurface, ByteArkPlayerSubtitleSize? subtitleSize, bool? subtitleBackgroundEnabled, int? subtitlePaddingBottomPercentage}) → ByteArkPlayerConfig - Creates a copy of this ByteArkPlayerConfig with the given fields replaced.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> - Converts the player configuration to a map for easier processing.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited