Interface ISGROMicrophone

Interface representing a microphone that extends multiple interfaces.

interface ISGROMicrophone {
    CanRecord(): boolean;
    GetMessagePort(): any;
    RecordToFile(wavFilePath: string): boolean;
    SetMessagePort(port: any): any;
    SetPrompt(prompt: string): any;
    StartRecording(): boolean;
    StopRecording(): boolean;
}

Hierarchy (View Summary)

Index

Methods

CanRecord GetMessagePort RecordToFile SetMessagePort SetPrompt StartRecording StopRecording

Methods

CanRecord

CanRecord(): boolean
Checks if recording is possible

Returns boolean
Inherited from ISGIMicrophone.CanRecord
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:1591

GetMessagePort

GetMessagePort(): any
Gets message port

Returns any
Inherited from ISGIGetMessagePort.GetMessagePort
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:1336

RecordToFile

RecordToFile(wavFilePath: string): boolean
Records audio to file
Parameters
- wavFilePath: string
Returns boolean
Inherited from ISGIMicrophone.RecordToFile
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:1593

SetMessagePort

SetMessagePort(port: any): any
Sets message port
Parameters
- port: any
Returns any
Inherited from ISGISetMessagePort.SetMessagePort
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:1771

SetPrompt

SetPrompt(prompt: string): any
Sets recording prompt
Parameters
- prompt: string
Returns any
Inherited from ISGIMicrophone.SetPrompt
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:1595

StartRecording

StartRecording(): boolean
Starts recording

Returns boolean
Inherited from ISGIMicrophone.StartRecording
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:1597

StopRecording

StopRecording(): boolean
Stops recording

Returns boolean
Inherited from ISGIMicrophone.StopRecording
- Defined in hosanna-ui/src/hosanna-bridge-targets/common/sg-api.ts:1599