Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Contains detailed information about why a result was canceled. Added in version 1.4.0.
Members
Reason
Syntax: public const CancellationReason & Reason;
The reason the result was canceled.
ErrorCode
Syntax: public const CancellationErrorCode & ErrorCode;
The error code in case of an unsuccessful speech synthesis (Reason is set to Error). If Reason is not Error, ErrorCode is set to NoError.
ErrorDetails
Syntax: public const std::string ErrorDetails;
The error message in case of an unsuccessful speech synthesis (Reason is set to Error).
FromResult
Syntax: public inline static std::shared_ptr< SpeechSynthesisCancellationDetails > FromResult ( std::shared_ptr< SpeechSynthesisResult > result );
Creates an instance of SpeechSynthesisCancellationDetails object for the canceled SpeechSynthesisResult.
Parameters
result
The result that was canceled.
Returns
A shared pointer to CancellationDetails.
FromStream
Syntax: public inline static std::shared_ptr< SpeechSynthesisCancellationDetails > FromStream ( std::shared_ptr< AudioDataStream > stream );
Creates an instance of SpeechSynthesisCancellationDetails object for the canceled SpeechSynthesisResult.
Parameters
stream
The audio data stream that was canceled.
Returns
A shared pointer to CancellationDetails.