SDK Configuration & API Reference – Orbitly Help Center

Configuration Options

OrbitlyConfig

Customize SDK behavior using OrbitlyConfig.Builder:

OrbitlyConfig config = new OrbitlyConfig.Builder()
    .setWifiOnly(true)              // Only share on Wi-Fi
    .setBandwidthLimit(5)           // Max 5 Mbps
    .setConsentRequired(true)       // Require explicit user consent
    .setNotificationEnabled(true)   // Show foreground service notification
    .build();

Orbitly.init(this, "YOUR_API_KEY", config);

Core methods

Method	Description
`Orbitly.start()`	Start bandwidth sharing
`Orbitly.stop()`	Stop bandwidth sharing
`Orbitly.pause()`	Temporarily pause sharing
`Orbitly.resume()`	Resume after pause
`Orbitly.isRunning()`	Returns `true` if SDK is active
`Orbitly.getEarnings(callback)`	Fetch current earnings asynchronously
`Orbitly.getStatus()`	Returns current SDK status
`Orbitly.setUserId(String)`	Associate a user ID for earnings tracking

Callbacks

Orbitly.setStatusListener(new OrbitlyStatusListener() {
    @Override
    public void onStatusChanged(OrbitlyStatus status) {
        // Handle status changes: RUNNING, PAUSED, STOPPED, ERROR
    }

    @Override
    public void onEarningsUpdated(double amount) {
        // Called when earnings balance updates
    }

    @Override
    public void onError(OrbitlyError error) {
        // Handle errors
    }
});