Getting Started

Welcome to the StreamLayer iOS SDK documentation hub This guide provides everything you need to seamlessly integrate StreamLayer into your app, enhancing the user experience with interactive features and real-time engagement tools. Our SDK empowers developers with dynamic capabilities designed to drive user interaction and maximize retention.

  1. Understand StreamLayer’s Capabilities
    Start by reading the Introduction and Architecture Overview sections for a high-level overview of the SDK and its key features, and how the SDK integrates with your app.

  2. Review the Integration Guide
    Visit the Integration Guide for a step-by-step walkthrough on installing, configuring, and initializing the SDK. This section covers everything from dependency setup to authentication and feature enablement.

  3. Explore Test Integrations (Quick Setup)
    To quickly validate integration, try one of our Test Integrations, which allow you to implement and test specific SDK features with minimal setup:

    1. Ads Only – Quickly test in-play advertising.
    2. Ads + In-Play Game – Integrate both ads and interactive game elements.
    3. X Only – Focus on integrating our social features.
    4. In-Play Game + X – Test interactive game elements alongside social experiences.
  4. Use Sample Integrations
    Check out our Sample Integrations Sample Integrations for fully functional reference projects that demonstrate common use cases.

  5. Customize Your Experience
    Fine-tune your integration with customization guides:

    1. Overlay Visibility Guide – Manage when overlays appear.
    2. Customizing Themes – Match UI elements to your app’s branding.
    3. Routing and Deep Links Guide – Ensure seamless navigation between app screens.
      Authentication Forwarding – Handle user authentication within StreamLayer features.
    4. Authentication Forwarding – Handle user authentication within StreamLayer features.
  6. Stay Updated:
    Always ensure you’re using the latest version of our SDK by visiting the SDK Release Page.

Support

Need assistance? Use our AI-assisted search in the documentation to quickly find answers to your questions.

For direct support, reach out via:

  • Email: [email protected]
  • Slack: Integration partners can join our real-time support channel for engineering assistance.