xref: /aosp_15_r20/external/oboe/samples/README.md (revision 05767d913155b055644481607e6fa1e35e2fe72c)
1*05767d91SRobert WuOboe Samples
2*05767d91SRobert Wu==============
3*05767d91SRobert WuThese samples demonstrate how to use the Oboe library:
4*05767d91SRobert Wu
5*05767d91SRobert Wu1. [MinimalOboe](minimaloboe): Just create an Oboe stream and play white noise. Restart stream when disconnected. (Kotlin/Compose)
6*05767d91SRobert Wu1. [hello-oboe](hello-oboe): Creates an output (playback) stream and plays a
7*05767d91SRobert Wusine wave when you tap the screen. (Java)
8*05767d91SRobert Wu1. [RhythmGame](RhythmGame): A simple rhythm game where you copy the clap patterns you hear by tapping on the screen.
9*05767d91SRobert WuThere is an associated codelab to follow along with. (Java)
10*05767d91SRobert Wu1. [MegaDrone](MegaDrone): A one hundred oscillator synthesizer, demonstrates low latency and CPU performance. (Java)
11*05767d91SRobert Wu1. [DrumThumper](drumthumper): A drum pad that plays sounds from loaded WAV files. (Kotlin)
12*05767d91SRobert Wu1. [LiveEffect](LiveEffect): Loops audio from input stream to output stream to demonstrate duplex capability. (Java)
13*05767d91SRobert Wu1. [SoundBoard](SoundBoard): A 25 to 40 note dynamic synthesizer, demonstating combining signals. The stream restarts
14*05767d91SRobert Wuwhen the display rotates. (Kotlin)
15*05767d91SRobert Wu
16*05767d91SRobert WuPre-requisites
17*05767d91SRobert Wu-------------
18*05767d91SRobert Wu* Android device or emulator running API 16 (Jelly Bean) or above
19*05767d91SRobert Wu* [Android SDK 26](https://developer.android.com/about/versions/oreo/android-8.0-migration.html#ptb)
20*05767d91SRobert Wu* [NDK r17](https://developer.android.com/ndk/downloads/index.html) or above
21*05767d91SRobert Wu* [Android Studio 2.3.0+](https://developer.android.com/studio/index.html)
22*05767d91SRobert Wu
23*05767d91SRobert WuGetting Started
24*05767d91SRobert Wu---------------
25*05767d91SRobert Wu1. [Install Android Studio](https://developer.android.com/studio/index.html)
26*05767d91SRobert Wu1. Import the sample project into Android Studio
27*05767d91SRobert Wu    - File -> New -> Import Project
28*05767d91SRobert Wu    - Browse to oboe/samples/build.gradle
29*05767d91SRobert Wu    - Click "OK"
30*05767d91SRobert Wu1. Click Run, click on the sample you wish to run
31*05767d91SRobert Wu
32*05767d91SRobert WuSupport
33*05767d91SRobert Wu-------
34*05767d91SRobert WuIf you've found an error in these samples, please [file an issue](https://github.com/google/oboe/issues/new).
35*05767d91SRobert Wu
36*05767d91SRobert WuPatches are encouraged, and may be submitted by [forking this project](https://github.com/google/oboe/fork) and
37*05767d91SRobert Wusubmitting a pull request through GitHub. Please see [CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
38*05767d91SRobert Wu
39*05767d91SRobert Wu- [Stack Overflow](http://stackoverflow.com/questions/tagged/android-ndk)
40*05767d91SRobert Wu- [Google+ Community](https://plus.google.com/communities/105153134372062985968)
41*05767d91SRobert Wu- [Android Tools Feedback](http://tools.android.com/feedback)
42*05767d91SRobert Wu
43*05767d91SRobert Wu
44*05767d91SRobert WuLicense
45*05767d91SRobert Wu-------
46*05767d91SRobert WuCopyright 2017 Google, Inc.
47*05767d91SRobert Wu
48*05767d91SRobert WuLicensed to the Apache Software Foundation (ASF) under one or more contributor
49*05767d91SRobert Wulicense agreements.  See the NOTICE file distributed with this work for
50*05767d91SRobert Wuadditional information regarding copyright ownership.  The ASF licenses this
51*05767d91SRobert Wufile to you under the Apache License, Version 2.0 (the "License"); you may not
52*05767d91SRobert Wuuse this file except in compliance with the License.  You may obtain a copy of
53*05767d91SRobert Wuthe License at
54*05767d91SRobert Wu
55*05767d91SRobert Wuhttp://www.apache.org/licenses/LICENSE-2.0
56*05767d91SRobert Wu
57*05767d91SRobert WuUnless required by applicable law or agreed to in writing, software
58*05767d91SRobert Wudistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
59*05767d91SRobert WuWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
60*05767d91SRobert WuLicense for the specific language governing permissions and limitations under
61*05767d91SRobert Wuthe License.
62