Plyer audio for android with facade and example

README.rst

@@ -34,4 +34,5 @@ Gyroscope                          X             X             X
 Battery                            X             X             X   X       X   X
 Native file chooser                                                X       X   X
 Orientation                        X             X
+Audio recording                    X             X
 ================================== ============= ============= === ======= === =====

examples/audio/buildozer.spec

@@ -0,0 +1,193 @@
+[app]
+
+# (str) Title of your application
+title = Plyer Audio Example
+
+# (str) Package name
+package.name = audioexample
+
+# (str) Package domain (needed for android/ios packaging)
+package.domain = org.test
+
+# (str) Source code where the main.py live
+source.dir = .
+
+# (list) Source files to include (let empty to include all the files)
+source.include_exts = py,png,jpg,kv,atlas
+
+# (list) Source files to exclude (let empty to not exclude anything)
+#source.exclude_exts = spec
+
+# (list) List of directory to exclude (let empty to not exclude anything)
+#source.exclude_dirs = tests, bin
+
+# (list) List of exclusions using pattern matching
+#source.exclude_patterns = license,images/*/*.jpg
+
+# (str) Application versioning (method 1)
+#version.regex = __version__ = ['"](.*)['"]
+#version.filename = %(source.dir)s/main.py
+
+# (str) Application versioning (method 2)
+version = 0.1
+
+# (list) Application requirements
+# comma seperated e.g. requirements = sqlite3,kivy
+requirements = kivy,plyer
+
+# (str) Custom source folders for requirements
+# Sets custom source for any requirements with recipes
+# requirements.source.kivy = ../../kivy
+
+# (list) Garden requirements
+#garden_requirements =
+
+# (str) Presplash of the application
+#presplash.filename = %(source.dir)s/data/presplash.png
+
+# (str) Icon of the application
+#icon.filename = %(source.dir)s/data/icon.png
+
+# (str) Supported orientation (one of landscape, portrait or all)
+orientation = portrait
+
+# (bool) Indicate if the application should be fullscreen or not
+fullscreen = 0
+
+
+#
+# Android specific
+#
+
+# (list) Permissions
+android.permissions = RECORD_AUDIO,WAKE_LOCK
+
+# (int) Android API to use
+#android.api = 14
+
+# (int) Minimum API required (8 = Android 2.2 devices)
+#android.minapi = 8
+
+# (int) Android SDK version to use
+#android.sdk = 21
+
+# (str) Android NDK version to use
+#android.ndk = 9c
+
+# (bool) Use --private data storage (True) or --dir public storage (False)
+#android.private_storage = True
+
+# (str) Android NDK directory (if empty, it will be automatically downloaded.)
+#android.ndk_path =
+
+# (str) Android SDK directory (if empty, it will be automatically downloaded.)
+#android.sdk_path =
+
+# (str) python-for-android git clone directory (if empty, it will be automatically cloned from github)
+#android.p4a_dir =
+
+# (list) python-for-android whitelist
+#android.p4a_whitelist =
+
+# (str) Android entry point, default is ok for Kivy-based app
+#android.entrypoint = org.renpy.android.PythonActivity
+
+# (list) List of Java .jar files to add to the libs so that pyjnius can access
+# their classes. Don't add jars that you do not need, since extra jars can slow
+# down the build process. Allows wildcards matching, for example:
+# OUYA-ODK/libs/*.jar
+#android.add_jars = foo.jar,bar.jar,path/to/more/*.jar
+
+# (list) List of Java files to add to the android project (can be java or a
+# directory containing the files)
+#android.add_src =
+
+# (str) python-for-android branch to use, if not master, useful to try
+# not yet merged features.
+#android.branch = master
+
+# (str) OUYA Console category. Should be one of GAME or APP
+# If you leave this blank, OUYA support will not be enabled
+#android.ouya.category = GAME
+
+# (str) Filename of OUYA Console icon. It must be a 732x412 png image.
+#android.ouya.icon.filename = %(source.dir)s/data/ouya_icon.png
+
+# (str) XML file to include as an intent filters in <activity> tag
+#android.manifest.intent_filters =
+
+# (list) Android additionnal libraries to copy into libs/armeabi
+#android.add_libs_armeabi = libs/android/*.so
+#android.add_libs_armeabi_v7a = libs/android-v7/*.so
+#android.add_libs_x86 = libs/android-x86/*.so
+#android.add_libs_mips = libs/android-mips/*.so
+
+# (bool) Indicate whether the screen should stay on
+# Don't forget to add the WAKE_LOCK permission if you set this to True
+#android.wakelock = False
+
+# (list) Android application meta-data to set (key=value format)
+#android.meta_data =
+
+# (list) Android library project to add (will be added in the
+# project.properties automatically.)
+#android.library_references =
+
+#
+# iOS specific
+#
+
+# (str) Name of the certificate to use for signing the debug version
+# Get a list of available identities: buildozer ios list_identities
+#ios.codesign.debug = "iPhone Developer: <lastname> <firstname> (<hexstring>)"
+
+# (str) Name of the certificate to use for signing the release version
+#ios.codesign.release = %(ios.codesign.debug)s
+
+
+[buildozer]
+
+# (int) Log level (0 = error only, 1 = info, 2 = debug (with command output))
+log_level = 1
+
+# (int) Display warning if buildozer is run as root (0 = False, 1 = True)
+warn_on_root = 1
+
+
+#    -----------------------------------------------------------------------------
+#    List as sections
+#
+#    You can define all the "list" as [section:key].
+#    Each line will be considered as a option to the list.
+#    Let's take [app] / source.exclude_patterns.
+#    Instead of doing:
+#
+#[app]
+#source.exclude_patterns = license,data/audio/*.wav,data/images/original/*
+#
+#    This can be translated into:
+#
+#[app:source.exclude_patterns]
+#license
+#data/audio/*.wav
+#data/images/original/*
+#
+
+
+#    -----------------------------------------------------------------------------
+#    Profiles
+#
+#    You can extend section / key with a profile
+#    For example, you want to deploy a demo version of your application without
+#    HD content. You could first change the title to add "(demo)" in the name
+#    and extend the excluded directories to remove the HD content.
+#
+#[app@demo]
+#title = My Application (demo)
+#
+#[app:source.exclude_patterns@demo]
+#images/hd/*
+#
+#    Then, invoke the command line with the "demo" profile:
+#
+#buildozer --profile demo android debug

examples/audio/main.py

@@ -0,0 +1,101 @@
+from kivy.app import App
+from kivy.lang import Builder
+from kivy.properties import NumericProperty
+from kivy.properties import ObjectProperty
+from kivy.uix.boxlayout import BoxLayout
+
+
+Builder.load_string('''
+#:import audio_player plyer.audio
+<AudioInterface>:
+    audio: audio_player
+    orientation: 'vertical'
+    padding: '50dp'
+    spacing: '20dp'
+    Label:
+        id: state_label
+        size_hint_y: None
+        height: sp(40)
+        text: 'AudioPlayer State: ' + str(root.audio.state)
+    Label:
+        id: location_label
+        size_hint_y: None
+        height: sp(40)
+        text: 'Recording Location: ' + str(root.audio.file_path)
+
+    Button:
+        id: record_button
+        text: 'Start Recording'
+        on_release: root.start_recording()
+
+    Button:
+        id: play_button
+        text: 'Play'
+        on_release: root.play_recording()
+
+''')
+
+
+class AudioInterface(BoxLayout):
+    '''Root Widget.'''
+
+    audio = ObjectProperty()
+    time = NumericProperty(0)
+
+    has_record = False
+
+    def start_recording(self):
+        state = self.audio.state
+        if state == 'ready':
+            self.audio.start()
+
+        if state == 'recording':
+            self.audio.stop()
+            self.has_record = True
+
+        self.update_labels()
+
+    def play_recording(self):
+        state = self.audio.state
+        if state == 'playing':
+            self.audio.stop()
+        else:
+            self.audio.play()
+
+        self.update_labels()
+
+    def update_labels(self):
+        record_button = self.ids['record_button']
+        play_button = self.ids['play_button']
+        state_label = self.ids['state_label']
+
+        state = self.audio.state
+        state_label.text = 'AudioPlayer State: ' + state
+
+        play_button.disabled = not self.has_record
+
+        if state == 'ready':
+            record_button.text = 'Start Recording'
+
+        if state == 'recording':
+            record_button.text = 'Press to Stop Recording'
+            play_button.disabled = True
+
+        if state == 'playing':
+            play_button.text = 'Stop'
+            record_button.disabled = True
+        else:
+            play_button.text = 'Press to play'
+            record_button.disabled = False
+
+
+class AudioApp(App):
+
+    def build(self):
+        return AudioInterface()
+
+    def on_pause(self):
+        return True
+
+if __name__ == "__main__":
+    AudioApp().run()

plyer/__init__.py

@@ -4,7 +4,7 @@
 
 '''
 
-__all__ = ('accelerometer', 'battery', 'camera', 'compass', 'email',
+__all__ = ('accelerometer', 'audio', 'battery', 'camera', 'compass', 'email',
            'filechooser', 'gps', 'gyroscope', 'irblaster', 'orientation',
            'notification', 'sms', 'tts', 'uniqueid', 'vibrator')
 
@@ -17,6 +17,9 @@
 #: Accelerometer proxy to :class:`plyer.facades.Accelerometer`
 accelerometer = Proxy('accelerometer', facades.Accelerometer)
 
+#: Accelerometer proxy to :class:`plyer.facades.Audio`
+audio = Proxy('audio', facades.Audio)
+
 #: Battery proxy to :class:`plyer.facades.Battery`
 battery = Proxy('battery', facades.Battery)
 

plyer/facades/__init__.py

@@ -6,11 +6,12 @@
 
 '''
 
-__all__ = ('Accelerometer', 'Battery', 'Camera', 'Compass', 'Email',
+__all__ = ('Accelerometer', 'Audio', 'Battery', 'Camera', 'Compass', 'Email',
            'FileChooser', 'GPS', 'Gyroscope', 'IrBlaster', 'Orientation',
            'Notification', 'Sms', 'TTS', 'UniqueID', 'Vibrator')
 
 from plyer.facades.accelerometer import Accelerometer
+from plyer.facades.audio import Audio
 from plyer.facades.battery import Battery
 from plyer.facades.camera import Camera
 from plyer.facades.compass import Compass

plyer/facades/audio.py

@@ -0,0 +1,56 @@
+class Audio(object):
+    '''Audio Facade.
+
+    Used for recording audio.
+    Use method `start` to start record and `stop` for stop recording.
+    To hear what you have just recorded, use method `play`.
+
+    `status` will tell you about current job of the Audio.
+
+    Default path for recording is set in platform implementation.
+
+    .. note::
+        On Android the `RECORD_AUDIO` permission is needed.
+    '''
+
+    state = 'ready'
+    _file_path = ''
+
+    def __init__(self, file_path):
+        super(Audio, self).__init__()
+        self._file_path = file_path
+
+    def start(self):
+        '''Start record.'''
+        self._start()
+        self.state = 'recording'
+
+    def _start(self):
+        raise NotImplementedError()
+
+    def stop(self):
+        '''Stop record.'''
+        self._stop()
+        self.state = 'ready'
+
+    def _stop(self):
+        raise NotImplementedError()
+
+    def play(self):
+        '''Play current recording.'''
+        self._play()
+        self.state = 'playing'
+
+    def _play(self):
+        raise NotImplementedError()
+
+    @property
+    def file_path(self):
+        return self._file_path
+
+    @file_path.setter
+    def file_path(self, location):
+        '''Location of the recording.'''
+        assert isinstance(location, (basestring, unicode)), \
+            'Location must be string or unicode'
+        self._file_path = location