BcmBranding

The SDK brading configuration struct (BcmBranding) is an optional interface. The interface is for an object to be assigned to BcmGlobalConfig's branding property. It allows you to configure branding of the SDK.

Please refer to the Branding page for a high-level overview.

Interface

Swift:

public struct BcmBranding {

    /**
     * Tint color for control bars, navigation bars, and buttons.
     */
    let universalPrimary: UIColor

    /**
     * Finger live preview. Initial bounding box color.
     */
    let fingerLiveBoundingBoxInitial: UIColor

    /**
     * Finger live preview. Bounding box color when the configured score threshold is reached.
     */
    let fingerLiveBoundingBoxScoreReached: UIColor

    /**
     * Finger live preview. Bounding box color for fingers which are not selected.
     */
    let fingerLiveUnselected: UIColor

    /**
     * Finger selection view. Start button color.
     */
    let fingerSelectedStartButton: UIColor

    /**
     * Finger selection view. Finger is selected color.
     */
    let fingerSelected: UIColor

    /**
     * Finger selection view. Finger is unselected color.
     */
    let fingerUnselected: UIColor

    public init(
        universalPrimary: UIColor = UIColor(rgb: 0x00a8d0),
        fingerLiveBoundingBoxInitial: UIColor = UIColor.white,
        fingerLiveBoundingBoxScoreReached: UIColor = UIColor.green,
        fingerLiveUnselected: UIColor = UIColor.lightGray,
        fingerSelectedStartButton: UIColor = UIColor(rgb: 0x00a8d0),
        fingerSelected: UIColor = UIColor(rgb: 0x00a8d0),
        fingerUnselected: UIColor = UIColor.red
    ) {
        self.universalPrimary = universalPrimary
        self.fingerLiveBoundingBoxInitial = fingerLiveBoundingBoxInitial
        self.fingerLiveBoundingBoxScoreReached = fingerLiveBoundingBoxScoreReached
        self.fingerLiveUnselected = fingerLiveUnselected
        self.fingerSelectedStartButton = fingerSelectedStartButton
        self.fingerSelected = fingerSelected
        self.fingerUnselected = fingerUnselected
    }

}

Example

Swift:

let bcmBranding = BcmBranding(
            BcmBranding: UIColor(rgb: 0x00a8d0))

Initialize the branding config in the IBcmGlobalConfig class

Swift:

let bcmGlobalConfig = BcmGlobalConfig(
        branding: bcmBranding)

See Also

• BcmGlobalConfig
• Branding