JWLogoBuilder

@objcMembers
public class JWLogoBuilder : NSObject, JWBuilder

The builder for JWLogo.

  • Declaration

    Swift

    public typealias Output = JWLogo

  • Builds a JWLogo structure for use in ads.

    Throws

    throws An error if the logo is not setup properly.

    Declaration

    Swift

    public func build() throws -> JWLogo

  • Sets the logo’s image using the specified UIImage.

    The dimensions of the logo will match the dimensions of the image provided without resizing. For example, an image of 100x50 pixels will render a logo of 100x50, regardless of the dimensions of the player window.

    Note

    If both a URL and a UIImage are provided, the UIImage takes precedence and the URL is ignored. The SDK supports all formats supported by UIImage.

    Declaration

    Swift

    @discardableResult
public func image(_ image: UIImage) -> JWLogoBuilder

    Parameters

    image

    A UIImage to be displayed.

    Return Value

    The builder, so setters can be chained.

  • Sets the logo’s image by downloading the image at the specified URL.

    The dimensions of the logo will match the dimensions of the image provided without resizing. For example, an image of 100x50 pixels will render a logo of 100x50, regardless of the dimensions of the player window.

    Note

    If both a URL and a UIImage are provided, the UIImage takes precedence and the URL is ignored. The SDK supports all formats supported by UIImage.

    Declaration

    Swift

    @discardableResult
public func imageFile(_ imageFile: URL) -> JWLogoBuilder

    Parameters

    imageFile

    The URL of the image to download and use as a logo.

    Return Value

    The builder, so setters can be chained.

  • Determines if the logo appears and disappears with the controls, but only if the controls are set to fade.

    If the controls are not set to fade, the logo is visible when the controls are visible and not be visible when the controls are turned off. If unspecified, this parameter The default value is false.

    Declaration

    Swift

    @discardableResult
public func fades(_ fades: Bool) -> JWLogoBuilder

    Parameters

    fades

    If true, the logo will fade when the controls fade. If false, the logo will persist.

    Return Value

    The builder, so setters can be chained.

  • URL to which a user is sent when the logo is tapped.

    Declaration

    Swift

    @available(tvOS, unavailable)
@discardableResult
public func weblink(_ weblink: URL) -> JWLogoBuilder

    Parameters

    weblink

    The URL to present to the user when the logo is tapped.

    Return Value

    The builder, so setters can be chained.

  • Distance between the logo and the player’s edge, specified in points. If unspecified, this parameter The default value is 8.

    Declaration

    Swift

    @discardableResult
public func margin(_ margin: Int) -> JWLogoBuilder

    Parameters

    margin

    The desired amount of space between the logo and player’s edge.

    Return Value

    The builder, so setters can be chained.

  • Defines the corner on the player in which the logo displays. If unspecified, this parameter The default value is .topLeft.

    Declaration

    Swift

    @discardableResult
public func position(_ position: JWLogoPosition) -> JWLogoBuilder

    Parameters

    position

    The corner on the player in which the logo displays.

    Return Value

    The builder, so setters can be chained.