TextToSpeech screen reader in Java for Android

1
/*
2
 *   Copyright © 2016-2025 PSPDFKit GmbH. All rights reserved.
3
 *
4
 *   The PSPDFKit Sample applications are licensed with a modified BSD license.
5
 *   Please see License for details. This notice may not be removed from this file.
6
 */
7

8
package com.pspdfkit.catalog.examples.java;
9

10
import android.content.Context;
11
import android.content.Intent;
12
import android.speech.tts.TextToSpeech;
13
import androidx.annotation.NonNull;
14
import com.pspdfkit.catalog.R;
15
import com.pspdfkit.catalog.SdkExample;
16
import com.pspdfkit.catalog.examples.java.activities.ScreenReaderExampleActivity;
17
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
18
import com.pspdfkit.document.providers.AssetDataProvider;
19
import com.pspdfkit.ui.PdfActivityIntentBuilder;
20

21
/**
22
 * This example showcases how to build a screen reader. It uses Android's {@link TextToSpeech} class
23
 * for text synthesis while highlighting spoken text using Nutrient's drawable provider API.
24
 */
25
public class ScreenReaderExample extends SdkExample {
26

27
    public ScreenReaderExample(@NonNull Context context) {
28
        super(
29
                context.getString(R.string.screenReaderExampleTitle),
30
                context.getString(R.string.screenReaderExampleDescription));
31
    }
32

33
    @Override
34
    public void launchExample(@NonNull Context context, @NonNull PdfActivityConfiguration.Builder configuration) {
35
        // Simply loads a document from the assets. The actual screen reading is performed by the
36
        // activity.
37
        // Launch the custom example activity using the document and configuration.
38
        final Intent intent = PdfActivityIntentBuilder.fromDataProvider(context, new AssetDataProvider(WELCOME_DOC))
39
                .configuration(configuration.build())
40
                .activityClass(ScreenReaderExampleActivity.class)
41
                .build();
42

43
        // Start the ScreenReaderExampleActivity for the extracted document.
44
        context.startActivity(intent);
45
    }
46
}