Android SDK

import com.vyslo.opensdk.VysloOpen

// appId comes from POST /open/apps — see the Quickstart.
val vyslo = VysloOpen(context, appId = 42L)

// Optional third argument for a self-hosted or staging instance:
// VysloOpen(context, appId = 42L, baseUrl = "https://your-instance/api/v1/app")

vyslo.isAuthorized     // Boolean — is a token stored?
vyslo.token            // String? — the raw capability token

// 1. Send the user to the VYSLO app's consent screen.
try {
    startActivity(vyslo.authorizeIntent(
        scopes = VysloOpen.SCOPE_RECORDINGS_READ or VysloOpen.SCOPE_RECORDINGS_AUDIO,
        callbackUri = "notesbot://vyslo-auth",
    ))
} catch (e: ActivityNotFoundException) {
    // VYSLO app not installed — send them to install it.
}

// 2. In the activity registered for notesbot://vyslo-auth
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    if (vyslo.handleAuthorizationCallback(intent.data)) {
        // Token stored. Carry on.
    } else {
        // The user denied, or the callback carried no token.
    }
}

vyslo://open/authorize
    ?appId=<your app id>
    &scopes=<scope bitmap>
    &callback=<url-encoded callback uri>

# approved  ->  <callback>?vyslo_token=<capability token>
# denied    ->  <callback>?vyslo_error=denied

val rec: VysloRecording = vyslo.fetchRecording(recordingId)

rec.recordingId
rec.title
rec.segments               // List<VysloRecording.Segment>(speaker, text, timestamp, identity)
rec.summaryLines           // List<String>
rec.identity               // VysloIdentity for the recording as a whole
rec.ownerVerified          // shorthand: identity.verdict == OWNER

// Needs SCOPE_RECORDINGS_AUDIO in the grant.
val bytes: ByteArray = vyslo.fetchRecordingAudio(recordingId)

val id: VysloIdentity = rec.segments.first().identity

id.verdict                 // OWNER, LIKELY_OWNER or OTHER
id.source                  // DEVICE, HOSTED_REVIEW or SELF_HOSTED
id.evidence                // VERIFIED, UNVERIFIED or UNAVAILABLE
id.serverId                // which VYSLO server issued this result

// Needs SCOPE_RECORDINGS_READ. Paged, newest first.
val page = vyslo.listRecordings(from = weekStart, to = now, includesMe = true, cursor = null)
page.items                 // List<VysloRecordingSummary>
page.nextCursor

// Needs SCOPE_RECORDINGS_READ.
val hits = vyslo.searchTranscripts("budget", from = monthStart)

// Needs SCOPE_INSIGHTS_READ.
val week = vyslo.fetchWeeklyInsights()      // talk time, speaking share, topics, to-dos

// Needs SCOPE_DEVICE_STATUS_READ. Cloud snapshot, with observedAt.
val cards = vyslo.listDevices()

// Needs SCOPE_TRANSCRIPTION_CREATE. Any audio file, not only card recordings.
val job = vyslo.transcribe(File(filesDir, "interview.m4a"), summarize = true)

<!-- Android 12 and later -->
<uses-permission android:name="android.permission.BLUETOOTH_SCAN"
                 android:usesPermissionFlags="neverForLocation" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />

<!-- Android 11 and earlier -->
<uses-permission android:name="android.permission.BLUETOOTH" android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" android:maxSdkVersion="30" />

<!-- Fast transfer over the card's Wi-Fi hotspot -->
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />

val scan = vyslo.ble.startScan { card: VysloCard ->
    card.name                 // the name the user gave the card in the VYSLO app
    card.address
    card.rssi
}
// … once the user has picked a card
scan.stop()

// Worker thread. Reuses the system bond if this phone is already paired with the card
// (for example through the VYSLO app); otherwise Android shows its pairing prompt.
val session: VysloCardSession = vyslo.ble.connect(card)

// Needs SCOPE_DEVICE_STATUS_READ.
val s = session.status()
s.batteryPercent
s.charging
s.storageUsedBytes
s.firmwareVersion
s.isRecording
s.isListening               // smart wake is listening, nothing is being stored
s.smartWakeEnabled

session.close()               // disconnects and releases the control lease if you hold it

// Needs SCOPE_CAPTURE_CONTROL.
session.acquireControl()      // exclusive control lease; throws LEASE_HELD if another app has it
session.startRecording()
session.pauseRecording()
session.resumeRecording()
session.stopRecording()
session.releaseControl()

// Needs SCOPE_EVENTS_SUBSCRIBE. Delivered on a background thread.
session.onEvent { e ->
    when (e) {
        is VysloCardEvent.RecordingStarted   -> …
        is VysloCardEvent.RecordingStopped   -> …   // e.recordingId
        is VysloCardEvent.SmartWakeTriggered -> …
        is VysloCardEvent.ListeningChanged   -> …   // e.listening
        is VysloCardEvent.ButtonPressed      -> …
        is VysloCardEvent.ChargingChanged    -> …   // e.charging
    }
}

// Needs SCOPE_RECORDINGS_READ to list, SCOPE_RECORDINGS_AUDIO to export.
val onCard: List<VysloCardRecording> = session.listRecordings()
// id, startedAt, durationMs, sizeBytes

session.exportAudio(
    recordingId = onCard.first().id,
    format = VysloAudioFormat.WAV,          // OPUS, WAV or PCM
    out = File(filesDir, "recording.wav"),
) { progress -> /* 0.0 – 1.0 */ }

// Needs SCOPE_RECORDINGS_AUDIO. For many or long recordings.
session.fastTransfer(
    recordingIds = onCard.map { it.id },
    format = VysloAudioFormat.OPUS,
    outDir = File(filesDir, "vyslo"),
) { done, total -> }

// Needs SCOPE_AUDIO_LIVE. Your app must be in the foreground.
val stream = session.startLiveAudio(format = VysloAudioFormat.PCM) { frame: ByteArray ->
    // 16 kHz mono frames while the user holds the card's button
}
stream.onPushToTalk { pressed -> }   // button down / up
stream.stop()

session.updateSettings(smartWakeEnabled = true)
session.updateSettings(name = "Work card")

val s = session.status()
s.smartWakeEnabled
s.isListening

// About 12 seconds of the user's own voice. Needs network.
session.enrollVoiceprint { step ->
    when (step) {
        is EnrollStep.Recording  -> showLevel(step.level)   // the user speaks now
        is EnrollStep.Processing -> showProgress()
        is EnrollStep.Done       -> showDone()
    }
}

val update = session.checkFirmwareUpdate()     // null when the card is up to date
if (update != null) {
    session.installFirmware(update, overWifi = true) { progress -> }
}

session.deleteRecording(recordingId)

// These wait for a press on the card, then run.
session.deleteAllRecordings()
session.resetVoiceprint()
session.unbind()

val caps = session.feedback.getCapabilities()  // states, events, modes, ranges, effect catalogue
val current = session.feedback.getSettings()   // your overrides, defaults, resolved values, revision

session.feedback.updateSettings(
    patch = FeedbackPatch()
        .setLed("recording.smartWakeOn",
            LedProfile.breathe(colorRgb = Rgb(0, 60, 100), brightnessPercent = 40,
                               periodMs = 2400, minBrightnessPercent = 0))
        .setLed("idle.smartWakeOff", LedProfile.off())
        .setHaptic("recording.started", HapticPattern.effect("START_CONFIRM"))
        .setHaptic("recording.stopped.SILENCE",
            HapticPattern.pulses(levelPercent = 60, onMs = 80, offMs = 120, count = 2)),
    expectedRevision = current.revision,        // rejected if another app saved in between
)

// Try before saving. A preview never saves and never fakes a real event.
val preview = session.feedback.previewLed(profile, durationMs = 3000)
session.feedback.stopPreview(preview.id)
session.feedback.previewHaptic(pattern)

session.feedback.restoreDefaults(listOf("idle.smartWakeOff"))   // or restoreDefaults() for all
session.feedback.onChange { change -> }        // saved elsewhere, defaults restored, state changed
session.feedback.getStatus()                    // the state being shown right now, and why

// Call on foreground start, on a worker thread. Internally rate-limited:
// does nothing if the stored token is younger than minAgeDays.
vyslo.renewIfNeeded()                 // default 7 days
vyslo.renewIfNeeded(minAgeDays = 3)

vyslo.setToken(token)                 // adopt a token you obtained yourself
vyslo.clearToken()                    // forget it (e.g. on your own sign-out)

try {
    val rec = vyslo.fetchRecording(recordingId)
} catch (e: VysloOpenException) {
    when (e.statusCode) {
        401, 403 -> reauthorize()     // token already cleared by the SDK
        404      -> dropLocalCopy()   // hidden, deleted, or not this user's recording
        else     -> retryLater(e.body)
    }
}

// Reference implementation — your server does the same thing in its own language.
val ok = VysloOpen.verifyWebhookSignature(
    webhookSecret = secret,
    rawBody = body,                       // exactly the bytes you received
    signature = header("X-Vyslo-Signature"),
)