Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Record Class Reference

This is the action which customers can specify to indicate that the server call agent should start recording user speech. More...

Inheritance diagram for Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Record:

Public Member Functions

 Record ()
 
override void Validate ()
 

Properties

string Action [get, set]
 The type of action. Various concrete action classes specify their name. This is used to deserialize a list of actions from JSON to their respective concrete classes. More...
 
double InitialSilenceTimeoutInSeconds [get, set]
 Maximum initial silence allowed from the time we start the recording operation before we timeout and fail the operation. More...
 
bool IsStandaloneAction [get]
 Flag to indicate whether this action must not be specified along with any other actions. More...
 
double MaxDurationInSeconds [get, set]
 Maximum duration of recording . Default : 180 secs More...
 
double MaxSilenceTimeoutInSeconds [get, set]
 Maximum allowed silence once the user has started speaking before we conclude the user is done recording. More...
 
string OperationId [get, set]
 An operation Id needs to be specified by customer so that they can correlate outcome to the action. This becomes necessary when multiple actions are specified in one response body More...
 
bool PlayBeep [get, set]
 If specified "true", then we would play a beep before starting recording operation More...
 
PlayPrompt PlayPrompt [get, set]
 Promt to played out (if any) before recording starts. Customers can choose to specify "playPrompt" action separately or specify as part of "record" - mostly all recordings are preceeded by a prompt More...
 
RecordingFormat RecordingFormat [get, set]
 The format is which the recording is expected. More...
 
IEnumerable< char > StopTones [get, set]
 Stop patterns which users can punch to end recording. More...
 

Detailed Description

This is the action which customers can specify to indicate that the server call agent should start recording user speech.

Definition at line 11 of file Record.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Record.Record ( )
inline

Definition at line 79 of file Record.cs.

Member Function Documentation

override void Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Record.Validate ( )
inlinevirtual

Reimplemented from Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ActionBase.

Definition at line 84 of file Record.cs.

Property Documentation

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ActionBase.Action
getsetinherited

The type of action. Various concrete action classes specify their name. This is used to deserialize a list of actions from JSON to their respective concrete classes.

Definition at line 40 of file ActionBase.cs.

double Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Record.InitialSilenceTimeoutInSeconds
getset

Maximum initial silence allowed from the time we start the recording operation before we timeout and fail the operation.

Default : 5

Definition at line 34 of file Record.cs.

bool Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ActionBase.IsStandaloneAction
getinherited

Flag to indicate whether this action must not be specified along with any other actions.

Definition at line 46 of file ActionBase.cs.

double Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Record.MaxDurationInSeconds
getset

Maximum duration of recording . Default : 180 secs

Definition at line 25 of file Record.cs.

double Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Record.MaxSilenceTimeoutInSeconds
getset

Maximum allowed silence once the user has started speaking before we conclude the user is done recording.

Default : 1

Definition at line 43 of file Record.cs.

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ActionBase.OperationId
getsetinherited

An operation Id needs to be specified by customer so that they can correlate outcome to the action. This becomes necessary when multiple actions are specified in one response body

Note: this is the first serialized field since it has the lowest order. By default Json.net starts ordering from -1.

Definition at line 33 of file ActionBase.cs.

bool Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Record.PlayBeep
getset

If specified "true", then we would play a beep before starting recording operation

Default : true

Definition at line 59 of file Record.cs.

PlayPrompt Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Record.PlayPrompt
getset

Promt to played out (if any) before recording starts. Customers can choose to specify "playPrompt" action separately or specify as part of "record" - mostly all recordings are preceeded by a prompt

Definition at line 19 of file Record.cs.

RecordingFormat Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Record.RecordingFormat
getset

The format is which the recording is expected.

Default : wma

Definition at line 51 of file Record.cs.

IEnumerable<char> Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Record.StopTones
getset

Stop patterns which users can punch to end recording.

Ex: " Press pound when done recording" Or "Press 11 when done recording".

Note: each stop tone is a string, since the application might potentially want to stop recording based on when user presses # or 11. Thus multiple digits together might constitute a single stop tone pattern. Hence it is represented as a string and not an int.

Default : none

TODO : change to string from char later when scenario emerges

Definition at line 77 of file Record.cs.


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