Inherits from NSObject
Declared in BZMediaParams.h

Overview

This interface describes the parameters for audio recording .

A BZAudioRecordParams object can be created as follows:

BZAudioRecordParams* bzAudioRecordParams = [[BZAudioRecordParams alloc] init];

Swift
let bzAudioRecordParams = BZAudioRecordParams()

Tasks

  •   m_nNotificationMs

    The bookmark timestamp in milliseconds when client will be notified when audio recording at that timestamp is reached. Default: 0 reflects no bookmark is set.

           property
  •   m_eAudioFormat

    The audio format as defined in BZAudioFormat. Default: BZAudioFormat:AF_PCM_16KHZ.

           property
  •   m_AudioCodec

    The audio codec as defined in BZAudioCodec. Default: nil.

           property
  •   m_bPlayAudioIsActive

    This parameter specifies that audio playback of an audo segment is active during audio recording. Default: FALSE.

           property
  •   m_bStopPlayAudioWhenSpeechDetected

    This parameter instructs audio recording to send a request that stops audio playback when Voice Activity Detection running during audio recording detects speech in recorded audio. Default: FALSE.

           property
  •   m_bStopPlayAudioWhenValidSRHypothesis

    This parameter instructs audio recording to send a request that stops audio playback when speech recognizer executing during audio recording generates a valid hypothesis. Default: FALSE.

           property
  •   m_bEnableStopPlaySRHypothesisPartial

    This parameter instructs audio recording to enable or disable sending a request that stops audio playback when speech recognizer executing during audio recording generates a partial hypothesis. Default: FALSE.

           property
  •   m_StopPlaySRHypothesisList

    This parameter provides audio recording an SR hyppthesis list. When speech recognizer executing during audio recording generates an SR hypothesis that matches one in the SR hypothesis list, audio recording will send a request that stops audio playback. Default: nil.

           property
  •   m_bRecordAudioWithNoSpeechActivity

    This parameter instructs audio recording to enable or disable audio recording for audio that does not contain speech energy. Default: TRUE.

           property
  •   m_strPreVADAudioSegment

    The file path name URL to record audio before Voice Activity Detector processes the audio. This is an optional parameter to record all audio received in a separate file regardless whether the parameter m_bRecordAudioWithNoSpeechActivity is enabled or not. Default: nil

           property
  •   m_AudioRecordControlParams

    The interface containing the parameters which control and stop audio recording as defined in BZAudioRecordControlParams. Default: nil.

           property

Properties

m_AudioCodec

@property BZAudioCodec *m_AudioCodec

Discussion

The audio codec as defined in BZAudioCodec. Default: nil.

Declared In

BZMediaParams.h

m_AudioRecordControlParams

@property BZAudioRecordControlParams *m_AudioRecordControlParams

Discussion

The interface containing the parameters which control and stop audio recording as defined in BZAudioRecordControlParams. Default: nil.

Declared In

BZMediaParams.h

m_StopPlaySRHypothesisList

@property NSArray *m_StopPlaySRHypothesisList

Discussion

This parameter provides audio recording an SR hyppthesis list. When speech recognizer executing during audio recording generates an SR hypothesis that matches one in the SR hypothesis list, audio recording will send a request that stops audio playback. Default: nil.

Declared In

BZMediaParams.h

m_bEnableStopPlaySRHypothesisPartial

@property BOOL m_bEnableStopPlaySRHypothesisPartial

Discussion

This parameter instructs audio recording to enable or disable sending a request that stops audio playback when speech recognizer executing during audio recording generates a partial hypothesis. Default: FALSE.

Declared In

BZMediaParams.h

m_bPlayAudioIsActive

@property BOOL m_bPlayAudioIsActive

Discussion

This parameter specifies that audio playback of an audo segment is active during audio recording. Default: FALSE.

Declared In

BZMediaParams.h

m_bRecordAudioWithNoSpeechActivity

@property BOOL m_bRecordAudioWithNoSpeechActivity

Discussion

This parameter instructs audio recording to enable or disable audio recording for audio that does not contain speech energy. Default: TRUE.

Declared In

BZMediaParams.h

m_bStopPlayAudioWhenSpeechDetected

@property BOOL m_bStopPlayAudioWhenSpeechDetected

Discussion

This parameter instructs audio recording to send a request that stops audio playback when Voice Activity Detection running during audio recording detects speech in recorded audio. Default: FALSE.

Declared In

BZMediaParams.h

m_bStopPlayAudioWhenValidSRHypothesis

@property BOOL m_bStopPlayAudioWhenValidSRHypothesis

Discussion

This parameter instructs audio recording to send a request that stops audio playback when speech recognizer executing during audio recording generates a valid hypothesis. Default: FALSE.

Declared In

BZMediaParams.h

m_eAudioFormat

@property BZAudioFormat m_eAudioFormat

Discussion

The audio format as defined in BZAudioFormat. Default: BZAudioFormat:AF_PCM_16KHZ.

Declared In

BZMediaParams.h

m_nNotificationMs

@property int m_nNotificationMs

Discussion

The bookmark timestamp in milliseconds when client will be notified when audio recording at that timestamp is reached. Default: 0 reflects no bookmark is set.

Declared In

BZMediaParams.h

m_strPreVADAudioSegment

@property NSString *m_strPreVADAudioSegment

Discussion

The file path name URL to record audio before Voice Activity Detector processes the audio. This is an optional parameter to record all audio received in a separate file regardless whether the parameter m_bRecordAudioWithNoSpeechActivity is enabled or not. Default: nil

Declared In

BZMediaParams.h