Interface VoiceRecorderHandlePlayer

ReadonlyisRecording

onVoiceRecord

• onVoiceRecord(
      callback: (audioRecord: AudioRecord, isPartial: boolean) => void,
  ): void

  Registers a callback that can receive the recorded audio data. If called multiple times, only the last registration is effective.

  Voice input recording starts with start and stops with stop.

  While voice input is being recorded, the recorded data accumulates as long as all of the following conditions are met.

  • The microphone is on and sub-audio is not enabled
  • The volume of the audio input from the microphone is above a certain level

  When the microphone is turned off, when sub-audio is enabled, or when the volume of the audio input from the microphone becomes low, the audio data recorded so far is passed as audioRecord, and false is passed as isPartial.

  Likewise, when voice input recording is stopped with stop, the audio data recorded so far is passed as audioRecord, and false is passed as isPartial.

  In addition, the recorded data passed to the callback is split according to the options specified in start. If the audio data is split by length during recording, the audio data recorded so far is passed as audioRecord, and true is passed as isPartial. When isPartial is true, this audioRecord is continuous with the subsequent audioRecord as an Opus stream, so it must be processed in the correct order.

  When voice input recording stops due to the end of the PlayerScript's lifetime, the callback is not fired, and the audio data being recorded is discarded.

  Parameters

  • callback: (audioRecord: AudioRecord, isPartial: boolean) => void

    audioRecord: the recorded data isPartial: true if the recorded data was split by length, false if it is the end of a continuous piece of audio data

  Returns void

start

• start(option?: VoiceRecorderOption, encoder?: VoiceEncoderOption): void

  Starts recording voice input. Results in an error if recording is already in progress or the option values are invalid.

  Voice input recording stops when the lifetime of the PlayerScript ends.

  Parameters

  • Optionaloption: VoiceRecorderOption

    Option values that specify the behavior of the voice recording.

  • Optionalencoder: VoiceEncoderOption

    Option values that specify the encoder settings. If omitted, settings automatically determined by the system are applied.

  Returns void

stop

• stop(): void

  Stops recording voice input.

  Returns void