JWPlayerSkinBuilder

@objcMembers
public class JWPlayerSkinBuilder : NSObject, JWPrototypingBuilder

The builder for JWPlayerSkin.

  • Declaration

    Swift

    public typealias Output = JWPlayerSkin

  • Declaration

    Swift

    public internal(set) var outputObject: JWPlayerSkin { get }

  • Declaration

    Swift

    public required init(from prototype: Output? = nil)

  • Undocumented

    Declaration

    Swift

    public override convenience init()

  • Builds a JWPlayerSkin structure for use in interface styling.

    Throws

    throws An error if the style is not setup properly.

    Declaration

    Swift

    public func build() throws -> JWPlayerSkin

  • Sets the style for the slider bar.

    Declaration

    Swift

    @discardableResult
public func timeSliderStyle(_ timeSliderStyle: JWTimeSliderStyle) -> JWPlayerSkinBuilder

    Parameters

    timeSliderStyle

    The style to set on the slider bar.

    Return Value

    The builder, so setters can be chained.

  • Sets the style for the menu.

    Declaration

    Swift

    @discardableResult
public func menuStyle(_ menuStyle: JWMenuStyle) -> JWPlayerSkinBuilder

    Parameters

    menuStyle

    The style for the menu.

    Return Value

    The builder, so setters can be chained.

  • Sets the style for the captions.

    Declaration

    Swift

    @discardableResult
public func captionStyle(_ captionStyle: JWCaptionStyle) -> JWPlayerSkinBuilder

    Parameters

    captionStyle

    The desired style to apply to the captions.

    Return Value

    The builder, so setters can be chained.

  • Sets the default color of the background of the player.

    Declaration

    Swift

    @discardableResult
public func backgroundColor(_ backgroundColor: UIColor) -> JWPlayerSkinBuilder

    Parameters

    backgroundColor

    The color to be set on the background of the player.

    Return Value

    The builder, so setters can be chained.

  • Sets the default font color for the player.

    Note

    It is used if a font color isn’t specified elsewhere.

    Declaration

    Swift

    @discardableResult
public func fontColor(_ fontColor: UIColor) -> JWPlayerSkinBuilder

    Parameters

    fontColor

    The color for the text on the player.

    Return Value

    The builder, so setters can be chained.

  • Sets the default font for the player.

    Note

    It is used if a font isn’t specified elsewhere.

    Declaration

    Swift

    @discardableResult
public func font(_ font: UIFont) -> JWPlayerSkinBuilder

    Parameters

    font

    default font for the player.

    Return Value

    The builder, so setters can be chained.

  • Sets the default color for play, next and previous buttons on the interface.

    Declaration

    Swift

    @discardableResult
public func buttonsColor(_ buttonsColor: UIColor) -> JWPlayerSkinBuilder

    Parameters

    buttonsColor

    The color for the buttons on the interface.

    Return Value

    The builder, so setters can be chained.

  • Sets whether or not the title should be displayed on the interface. The default value is true.

    Declaration

    Swift

    @discardableResult
public func titleIsVisible(_ titleIsVisible: Bool) -> JWPlayerSkinBuilder

    Parameters

    titleIsVisible

    A boolean that indicates whether or not the title should be displayed.

    Return Value

    The builder, so setters can be chained.

  • Sets whether or not the description should be displayed on the interface. The default value is true.

    Declaration

    Swift

    @discardableResult
public func descriptionIsVisible(_ descriptionIsVisible: Bool) -> JWPlayerSkinBuilder

    Parameters

    descriptionIsVisible

    A boolean that indicates whether or not the description should be displayed.

    Return Value

    The builder, so setters can be chained.

  • Sets the default for ad cues in the control bar.

    Declaration

    Swift

    @discardableResult
public func adCueColor(_ color: UIColor) -> JWPlayerSkinBuilder

    Parameters

    color

    The desired color for the cue markers.

    Return Value

    The builder, so setters can be chained.

  • Sets the default for chapter cues in the control bar.

    Declaration

    Swift

    @discardableResult
public func chapterCueColor(_ color: UIColor) -> JWPlayerSkinBuilder

    Parameters

    color

    The desired color for the cue markers.

    Return Value

    The builder, so setters can be chained.