IC8 Python API:RLPy RAudioRecorder
Contents
- 1 Description
- 2 Constructor & Destructor
- 3 Member Functions
- 4 Properties
Description
This class is used for the recording of audio. In addition, this class provides functionality for selecting the audio input. See Also: RIAudioObject, RAudioRecorderCallback
Constructor & Destructor
__init__ (self)
Initializes a new audio recorder instance.
Member Functions
GetAudio (self)
Get the recorded audio object. If no recording exists then return None.
Sample code
Calls `RLPy.RAudioRecorder.GetAudio` with the inputs shown in the example.
def run_script():
import RLPy
audio_recorder = RLPy.RAudioRecorder()
recorded_audio = audio_recorder.GetAudio() # RIAudioObject
GetAvailableDevices (self)
Get all the available devices on this audio recorder.
Sample code
Calls `RLPy.RAudioRecorder.GetAvailableDevices` with the inputs shown in the example.
def run_script():
import RLPy
audio_recorder = RLPy.RAudioRecorder()
all_device = audio_recorder.GetAvailableDevices()
GetInputDevice (self)
Get the name of the device on this audio recorder.
Sample code
Calls `RLPy.RAudioRecorder.GetInputDevice` with the inputs shown in the example.
def run_script():
import RLPy
audio_recorder = RLPy.RAudioRecorder()
all_device = audio_recorder.GetInputDevice()
GetTimeLimit (self)
Get this audio recorder's time limit.
Sample code
Calls `RLPy.RAudioRecorder.GetTimeLimit` with the inputs shown in the example.
def run_script():
import RLPy
audio_recorder = RLPy.RAudioRecorder()
all_device = audio_recorder.GetTimeLimit()
RegisterCallback (self, pCallback)
Register an audio recorder callback.
Parameters
- pCallback
SetInputDevice (self, strInputAudioDeviceName)
Set the audio recording device name designated for usage.
Parameters
- strInputAudioDeviceName
SetTimeLimit (self, nMillisecond)
Set the audio length limitation. When the recording time exceeds this limitation, then the recording will automatically stop.
Parameters
- nMillisecond
Start (self)
Start recording audio. If the current recording device no longer exists, then return RLPy.RStatus.Failure.
Sample code
Calls `RLPy.RAudioRecorder.Start` with the inputs shown in the example.
def run_script():
import RLPy
audio_recorder = RLPy.RAudioRecorder()
audio_recorder.Start()
Stop (self)
Stop recording audio.
Sample code
Calls `RLPy.RAudioRecorder.Stop` with the inputs shown in the example.
def run_script():
import RLPy
audio_recorder = RLPy.RAudioRecorder()
audio_recorder.Stop()
UnregisterCallback (self)
Unregisters the audio recorder callback.
Properties
thisown
Indicates whether this SWIG proxy owns the underlying C++ object.
