audio_streamer 4.1.1 copy "audio_streamer: ^4.1.1" to clipboard
audio_streamer: ^4.1.1 copied to clipboard

Streaming of Pulse-code modulation (PCM) audio from Android and iOS

Audio Streamer #

Streaming of Pulse-code modulation (PCM) audio from Android and iOS with a customizable sampling rate.

Permissions #

Using this plugin needs permission to access the microphone. Requesting this permission is NOT part of the plugin, but should be handled by the app. However, for the app to be able to access the microphone, the app need to have the following permission on Android and iOS.

On Android add the audio recording permission to AndroidManifest.xml.

<uses-permission android:name="android.permission.RECORD_AUDIO" />

On iOS enable the following using XCode:

  • Capabilities > Background Modes > Audio, AirPlay and Picture in Picture
  • In the Runner Xcode project edit the Info.plist file. Add an entry for 'Privacy - Microphone Usage Description'

If editing the Info.plist file manually, the entries needed are:

<key>NSMicrophoneUsageDescription</key>
<string>YOUR DESCRIPTION</string>
<key>UIBackgroundModes</key>
<array>
  <string>audio</string>
</array>

Edit the Podfile to include the permission for the microphone:

post_install do |installer|
  installer.pods_project.targets.each do |target|
    flutter_additional_ios_build_settings(target)

    target.build_configurations.each do |config|
      # for more infomation: https://github.com/BaseflowIT/flutter-permission-handler/blob/master/permission_handler/ios/Classes/PermissionHandlerEnums.h
      config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
        '$(inherited)',
        'PERMISSION_MICROPHONE=1',]
    end
  end
end

Using the plugin #

The plugin works as a singleton and provide a simple audioStream to listen to.

AudioStreamer().audioStream.listen(
  (List<double> buffer) {
    print('Max amp: ${buffer.reduce(max)}');
    print('Min amp: ${buffer.reduce(min)}');
  },
  onError: (Object error) {
    print(error);
  },
  cancelOnError: true,
);

The sampling rate can be set and read using the samplingRate and actualSampleRate properties.

// Set the sampling rate. Must be done BEFORE listening to the audioStream.
AudioStreamer().sampleRate = 22100;

// Get the real sampling rate - may be different from the requested sampling rate.
int sampleRate = await AudioStreamer().actualSampleRate;

Example #

See the file example/lib/main.dart for an example app using the plugin. This app also illustrates how to ask for permission to access the microphone. Note that on iOS the sample rate will not necessarily change, as there is only the option to set a preferred one.

31
likes
140
pub points
85%
popularity

Publisher

verified publishercachet.dk

Streaming of Pulse-code modulation (PCM) audio from Android and iOS

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (LICENSE)

Dependencies

flutter, permission_handler

More

Packages that depend on audio_streamer