Skip to end of metadata
Go to start of metadata

Available since firmware version 7.6

Implemented By

Supported Methods

Description of Methods

CanRecord() as Boolean

Returns true if the platform and paired remote control can be requested to open the microphone.

SetPrompt(prompt as String) as Void

Optionally set a short prompt string to be displayed to the user in the system microphone UI.

RecordToFile(wavFilePath as String) as Boolean

Open the microphone and record to create a WAV file at the specified output file path. Only tmp:/ paths are supported.

Returns true if the recording was performed and saved successfully.

StartRecording() as Boolean

Open the microphone and begin streaming microphone events to the app. The app must have called SetMessagePort previously.

Returns true if the microphone was opened successfully.

While the microphone is open, RecordingInfo events will be sent periodically with audio data. When the microphone is closed, a RecordingDone event will be sent. See roMicrophoneEvent for detailed information.

StopRecording() as Boolean

If the microphone was previously opened via StartRecording() and the application decides to cancel the current recording prematurely, (e.g. due to duration limit reached or an application error), this function can be called to stop recording and close the microphone.

Returns true if the microphone was open and successfully closed by the call.


 

  • No labels