BMPStyleConfiguration


@interface BMPStyleConfiguration : BMPConfiguration

Contains configuration values which can be used to alter the visual presentation and behaviour of the player UI.

  • Sets if the the UI should be enabled or not. Default value is YES.

    Declaration

    Objective-C

    @property (getter=isUiEnabled, assign, readwrite, nonatomic) BOOL uiEnabled;

    Swift

    var isUiEnabled: Bool { get set }

  • Set which user interface type should be used. Default value is BMPUserInterfaceTypeBitmovin on iOS and BMPUserInterfaceTypeSystem on tvOS. This setting only applies if BMPStyleConfiguration#uiEnabled is set to YES.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BMPUserInterfaceType userInterfaceType;

    Swift

    var userInterfaceType: BMPUserInterfaceType { get set }

  • Set the CSS file that will be used for the UI. The default CSS file will be completely replaced by the CSS file set with this property.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSURL *_Nonnull playerUiCss;

    Swift

    @NSCopying var playerUiCss: NSURL { get set }

  • Set a CSS file which contains supplemental styles for the player UI. These styles will be added to the default CSS file or the CSS file set with BMPStyleConfiguration#playerUiCss.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSURL *supplementalPlayerUiCss;

    Swift

    @NSCopying var supplementalPlayerUiCss: NSURL? { get set }

  • Sets the JS file that will be used for the UI. The default JS file will be completely replaced by the JS file set with this property.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSURL *_Nonnull playerUiJs;

    Swift

    @NSCopying var playerUiJs: NSURL { get set }

  • Determines how the video content is scaled or stretched within the parent container’s bounds. Possible values are defined in BMPScalingMode. Default value is BMPScalingModeFit.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BMPScalingMode scalingMode;

    Swift

    var scalingMode: BMPScalingMode { get set }

  • An optional configuration object, containing configuration values which apply to the selected user interface type.

    • When BMPUserInterfaceTypeSystem is selected, a BMPSystemUserInterfaceConfiguration can be set.
    • When BMPUserInterfaceTypeSubtitle is selected, a BMPSubtitleUserInterfaceConfiguration can be set.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
    BMPUserInterfaceConfiguration *userInterfaceConfiguration;

    Swift

    var userInterfaceConfiguration: UserInterfaceConfiguration? { get set }