Receiving Data
Receiver
Receiver.destroy()
immediately stop sampling microphone and release all resources
Receiver.getAverageDecodeTime()
returns average time in ms spent decoding data from sound samples over the last 3 runs
Quiet.receiver
Quiet.receiver(opts, opts.profile, opts.onReceive [, opts.onCreate [, opts.onCreateFail [, opts.onReceiveFail [, opts.onReceiverStatsUpdate]]]])
Parameters
opts
- receiver params
opts.profile
- name of profile to use, must be a key in quiet-profiles.json OR an object which contains a complete profile
opts.onReceive
- callback which receiver will call to send user received data
opts.onCreate
- callback to notify user that receiver has been created and is ready to receive. if the user needs to grant permission to use the microphone, this callback fires after that permission is granted.
opts.onCreateFail
- callback to notify user that receiver could not be created
opts.onReceiveFail
- callback to notify user that receiver received corrupted data
opts.onReceiverStatsUpdate
- callback to notify user with new decode stats
Returns
- Receiver object
Receiver.destroy
Receiver.destroy()
immediately stop sampling microphone and release all resources
Receiver.getAverageDecodeTime
Receiver.getAverageDecodeTime()
returns average time in ms spent decoding data from sound samples over the last 3 runs