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