Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TestMicrophoneOption

Interface for test microphone options.

Hierarchy

  • TestMicrophoneOption

Index

Properties

Optional maxRecordDuration

maxRecordDuration: number

The maximum seconds to record, the user needs to record. Default is 10 seconds.

Optional microphoneId

microphoneId: string

The microphone ID. If not specified, the SDK uses the default microphone.

Optional onAnalyseFrequency

onAnalyseFrequency: (averageFrequency: number) => void

The average frequency of the stream, usually used to create audio visualization.

Type declaration

    • (averageFrequency: number): void
    • Parameters

      • averageFrequency: number

      Returns void

Optional onStartPlayRecording

onStartPlayRecording: () => void

When to start playing the recording.

Type declaration

    • (): void
    • Returns void

Optional onStartRecording

onStartRecording: () => void

When to start recording.

Type declaration

    • (): void
    • Returns void

Optional onStopPlayRecording

onStopPlayRecording: () => void

When to stop playing the recording.

Type declaration

    • (): void
    • Returns void

Optional onStopRecording

onStopRecording: () => void

When to stop recording.

Type declaration

    • (): void
    • Returns void

Optional recordAndPlay

recordAndPlay: boolean

Whether the user needs to record and play an audio fragment to test the microphone.

Optional speakerId

speakerId: string

The speaker ID. The Speaker to play the recording.