Getting Started

Horus SDK enables you to collect screen recordings with voice narration from your users. This guide will help you integrate Horus into your application.

Prerequisites

Before you begin, you'll need:

1. A Horus account - Sign up at tryhorus.io
2. A feedback link - Create a feedback link in your Horus dashboard
3. Your feedback link token - Found in the feedback link URL (e.g., tryhorus.io/feedback/{token})

Choose Your Platform

📱

Android

For native Android apps using Kotlin or Java

🍎

iOS

For native iOS apps using Swift

🦋

Flutter

For cross-platform Flutter apps

🌐

Web

For web applications using JavaScript

Integration Overview

All Horus SDKs follow a similar integration pattern:

1. Install the SDK

Add the Horus SDK to your project using your platform's package manager.

2. Initialize with your feedback link

Configure the SDK with your feedback link token:

Android

HorusSDK.initialize(context, "your-feedback-link-token")

iOS

HorusSDK.shared.configure(feedbackLinkToken: "your-feedback-link-token")

Flutter

final horus = HorusSdk();
await horus.initialize(feedbackLinkToken: 'your-feedback-link-token');

Web

const horus = new HorusSupport({
  feedbackLinkToken: 'your-feedback-link-token'
});

3. Start recording

Trigger a recording when the user wants to provide feedback:

Android

HorusSDK.startFeedbackFlow(activity)

iOS

HorusSDK.shared.startRecording()

Flutter

await horus.startRecording();

Web

horus.start();

4. Submit to Horus

The SDK handles uploading the recording to your Horus dashboard automatically.

What Gets Captured

Feature	Android	iOS	Flutter	Web
Screen recording	✅	✅	✅	✅
Microphone audio	✅	✅	✅	✅
System audio	✅	❌	✅ (Android only)	❌
Touch indicators	✅	✅	✅	N/A

Next Steps

• Android SDK - Full Android integration guide
• iOS SDK - Full iOS integration guide
• Flutter SDK - Full Flutter integration guide
• Web SDK - Full Web integration guide