BSAPI
Public Member Functions
SWaveformSegmenterI Class Reference

Receives waveform and segmentation and resends waveform by segments. More...

#include <bsapi.h>

Inheritance diagram for SWaveformSegmenterI:
SUnknownI SWaveformSourceCallbackI STransCallbackI

List of all members.

Public Member Functions

virtual void BSAPI_METHOD SetSegmentStartExtensionMs (int segmentStartExtensionMs=0)=0
 Set start segment extension in milliseconds.
virtual void BSAPI_METHOD SetSegmentEndExtensionMs (int segmentEndExtensionMs=0)=0
 Set end segment extension in milliseconds.
virtual void BSAPI_METHOD SetUseNeighbouringWaveform (bool useNeighbouringWaveform=true)=0
 Enable neighbouring waveform to be used by segment extension.
virtual void BSAPI_METHOD SetWaitForWholeSentence (bool waitForWholeSentence=false)=0
 Set whether to wait for all the segments before sending segmented waveform.
virtual void BSAPI_METHOD SetMinimumSegmentLength (int minSegmentLengthMs=0)=0
 Set if produced segments are to small (decoder crashes on 2 frame segments)
virtual void BSAPI_METHOD SetSpeechLabel (const char *pSpeechLabel="voice")=0
 Set speech label to be used with segmentation.
virtual void BSAPI_METHOD SetTarget (SWaveformSourceCallbackI *pTarget)=0
 Set target object.

Detailed Description

Receives waveform and segmentation and resends waveform by segments.


Member Function Documentation

virtual void BSAPI_METHOD SWaveformSegmenterI::SetMinimumSegmentLength ( int  minSegmentLengthMs = 0) [pure virtual]

Set if produced segments are to small (decoder crashes on 2 frame segments)

Parameters:
minSegmentLengthMsset minimal length of wave segment in ms. Smaller segment is then enlarged by SetSegmentStartExtensionMs() SetSegmentEndExtensionMs()
virtual void BSAPI_METHOD SWaveformSegmenterI::SetSegmentEndExtensionMs ( int  segmentEndExtensionMs = 0) [pure virtual]

Set end segment extension in milliseconds.

Sets the portion of waveform in milliseconds each segment will be extended from the end by

Parameters:
segmentEndExtensionMsextension length in milliseconds
virtual void BSAPI_METHOD SWaveformSegmenterI::SetSegmentStartExtensionMs ( int  segmentStartExtensionMs = 0) [pure virtual]

Set start segment extension in milliseconds.

Sets the portion of waveform in milliseconds each segment will be extended from the beginning by

Parameters:
segmentStartExtensionMsextension length in milliseconds
virtual void BSAPI_METHOD SWaveformSegmenterI::SetSpeechLabel ( const char *  pSpeechLabel = "voice") [pure virtual]

Set speech label to be used with segmentation.

Sets the label value so the segments with this label coming to the OnTranscription callback will be considered as speech and will be processed

Parameters:
pSpeechLabellabel of (speech) segments to be processed
virtual void BSAPI_METHOD SWaveformSegmenterI::SetTarget ( SWaveformSourceCallbackI pTarget) [pure virtual]

Set target object.

Target object receives segmented waveform.

Parameters:
pTargetpointer to target object
virtual void BSAPI_METHOD SWaveformSegmenterI::SetUseNeighbouringWaveform ( bool  useNeighbouringWaveform = true) [pure virtual]

Enable neighbouring waveform to be used by segment extension.

Controls the behaviour of segment extension. If the usage of neighbouring waveform is disabled segments are going to be extended from the beginning/end by samples whose value is an average of first/last few samples. If the usage of neighbouring waveform is enabled, segments will be extended using out-of-segment (nonspeech) waveform. If there is not enough samples to do so (at the beginning or end of the sentence) extension by an average sample is used no matter what is set by this function.

Parameters:
useNeighbouringWaveformenable or disable usage of neighbouring waveform
See also:
SetSegmentStartExtensionMs()
SetSegmentEndExtensionMs()
virtual void BSAPI_METHOD SWaveformSegmenterI::SetWaitForWholeSentence ( bool  waitForWholeSentence = false) [pure virtual]

Set whether to wait for all the segments before sending segmented waveform.

Parameters:
waitForWholeSentenceenable or disable waiting for whole sentence

The documentation for this class was generated from the following file: