Skip to main content

CrowdGlow SDK Docs

Current stable SDK docs version: 1.3.0 (Latest): Download CrowdGlow SDK 1.3.0

The CrowdGlow SDK is simple to integrate with any iOS or Android application.

The sample apps are the best reference on how to integrate CrowdGlow into an app.

We provide 1-2-1 developer support for our SDK, if you require any assistance or have any questions at all please contact hello@crowdglow.uk

The SDK is very simple, it only consists of two views:

CrowdGlowView

This is the main view that will display all of the colours & effects on the users phone screen. It is a fullscreen view, that should be placed at the highest Z index of your app. It is fully transparent both visually and to any gestures or taps. It will not affect your underlying app in anyway. This view only becomes visible when the app receives a CrowdNet signal and active colours or effects are being shown.

CrowdGlowStatusView

This is the only visible piece of UI that CrowdGlow requires to be in your app. It initially onboards the user by asking them to accept the required bluetooth permissions to take part in the interactive light show, and if accepted it will let the user know to open the app when they’re at the event. It will change to a “keep the app open” message when it is currently receiving a CrowdNet signal.

The status also handles all error states and guides the user on what they need to do. E.g. bluetooth is turned off or they denied the permission. An open settings button will appear if they have denied the permission and take them to the app settings to enable it manually.

You can pass in the colours of the status label, button background and button text to match your apps design. You can also set the font sizes, font type and the button height. The status view has a transparent background.

We recommend you creating a “Light Show” section or banner in your app that displays this CrowdGlowStatusView. It should be easy to find in your app, as the user needs to enable the light show once to take part. After they have enabled the light show, they can be anywhere in the app and the light show will still work as expected.

Localisation

The CrowdGlow SDK is localised and supports the following languages: English, French, German, French(Canada), Italian, Swedish, Spanish, Turkish, Spanish (Mexico), Dutch, Hungarian

Additional languages can be added at your request.