Skip to content

/AWS1/IF_PLY=>STARTSPEECHSYNTHESISTASK()

About StartSpeechSynthesisTask

Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.

Method Signature

METHODS /AWS1/IF_PLY~STARTSPEECHSYNTHESISTASK
  IMPORTING
    !IV_ENGINE TYPE /AWS1/PLYENGINE OPTIONAL
    !IV_LANGUAGECODE TYPE /AWS1/PLYLANGUAGECODE OPTIONAL
    !IT_LEXICONNAMES TYPE /AWS1/CL_PLYLEXICONNAMELIST_W=>TT_LEXICONNAMELIST OPTIONAL
    !IV_OUTPUTFORMAT TYPE /AWS1/PLYOUTPUTFORMAT OPTIONAL
    !IV_OUTPUTS3BUCKETNAME TYPE /AWS1/PLYOUTPUTS3BUCKETNAME OPTIONAL
    !IV_OUTPUTS3KEYPREFIX TYPE /AWS1/PLYOUTPUTS3KEYPREFIX OPTIONAL
    !IV_SAMPLERATE TYPE /AWS1/PLYSAMPLERATE OPTIONAL
    !IV_SNSTOPICARN TYPE /AWS1/PLYSNSTOPICARN OPTIONAL
    !IT_SPEECHMARKTYPES TYPE /AWS1/CL_PLYSPEECHMARKTYPELS00=>TT_SPEECHMARKTYPELIST OPTIONAL
    !IV_TEXT TYPE /AWS1/PLYTEXT OPTIONAL
    !IV_TEXTTYPE TYPE /AWS1/PLYTEXTTYPE OPTIONAL
    !IV_VOICEID TYPE /AWS1/PLYVOICEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_plystrtspeechsynthe01
  RAISING
    /AWS1/CX_PLYENGINENOTSUPPEDEX
    /AWS1/CX_PLYINVALIDS3BUCKETEX
    /AWS1/CX_PLYINVALIDS3KEYEX
    /AWS1/CX_PLYINVSAMPLERATEEX
    /AWS1/CX_PLYINVSNSTOPICARNEX
    /AWS1/CX_PLYINVALIDSSMLEX
    /AWS1/CX_PLYLANGUAGENOTSUPPE00
    /AWS1/CX_PLYLEXICONNOTFOUNDEX
    /AWS1/CX_PLYMARKSNOTSUPPEDFO00
    /AWS1/CX_PLYSERVICEFAILUREEX
    /AWS1/CX_PLYSSMLMARKSNOTSUPP00
    /AWS1/CX_PLYTEXTLENGTHEXCDEX
    /AWS1/CX_PLYCLIENTEXC
    /AWS1/CX_PLYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_outputformat TYPE /AWS1/PLYOUTPUTFORMAT /AWS1/PLYOUTPUTFORMAT

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

iv_outputs3bucketname TYPE /AWS1/PLYOUTPUTS3BUCKETNAME /AWS1/PLYOUTPUTS3BUCKETNAME

Amazon S3 bucket name to which the output file will be saved.

iv_text TYPE /AWS1/PLYTEXT /AWS1/PLYTEXT

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

iv_voiceid TYPE /AWS1/PLYVOICEID /AWS1/PLYVOICEID

Voice ID to use for the synthesis.

Optional arguments:

iv_engine TYPE /AWS1/PLYENGINE /AWS1/PLYENGINE

Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

iv_languagecode TYPE /AWS1/PLYLANGUAGECODE /AWS1/PLYLANGUAGECODE

Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

it_lexiconnames TYPE /AWS1/CL_PLYLEXICONNAMELIST_W=>TT_LEXICONNAMELIST TT_LEXICONNAMELIST

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

iv_outputs3keyprefix TYPE /AWS1/PLYOUTPUTS3KEYPREFIX /AWS1/PLYOUTPUTS3KEYPREFIX

The Amazon S3 key prefix for the output speech file.

iv_samplerate TYPE /AWS1/PLYSAMPLERATE /AWS1/PLYSAMPLERATE

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

iv_snstopicarn TYPE /AWS1/PLYSNSTOPICARN /AWS1/PLYSNSTOPICARN

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

it_speechmarktypes TYPE /AWS1/CL_PLYSPEECHMARKTYPELS00=>TT_SPEECHMARKTYPELIST TT_SPEECHMARKTYPELIST

The type of speech marks returned for the input text.

iv_texttype TYPE /AWS1/PLYTEXTTYPE /AWS1/PLYTEXTTYPE

Specifies whether the input text is plain text or SSML. The default value is plain text.

RETURNING

oo_output TYPE REF TO /aws1/cl_plystrtspeechsynthe01 /AWS1/CL_PLYSTRTSPEECHSYNTHE01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->startspeechsynthesistask(
  it_lexiconnames = VALUE /aws1/cl_plylexiconnamelist_w=>tt_lexiconnamelist(
    ( new /aws1/cl_plylexiconnamelist_w( |string| ) )
  )
  it_speechmarktypes = VALUE /aws1/cl_plyspeechmarktypels00=>tt_speechmarktypelist(
    ( new /aws1/cl_plyspeechmarktypels00( |string| ) )
  )
  iv_engine = |string|
  iv_languagecode = |string|
  iv_outputformat = |string|
  iv_outputs3bucketname = |string|
  iv_outputs3keyprefix = |string|
  iv_samplerate = |string|
  iv_snstopicarn = |string|
  iv_text = |string|
  iv_texttype = |string|
  iv_voiceid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_synthesistask = lo_result->get_synthesistask( ).
  IF lo_synthesistask IS NOT INITIAL.
    lv_engine = lo_synthesistask->get_engine( ).
    lv_taskid = lo_synthesistask->get_taskid( ).
    lv_taskstatus = lo_synthesistask->get_taskstatus( ).
    lv_taskstatusreason = lo_synthesistask->get_taskstatusreason( ).
    lv_outputuri = lo_synthesistask->get_outputuri( ).
    lv_datetime = lo_synthesistask->get_creationtime( ).
    lv_requestcharacters = lo_synthesistask->get_requestcharacters( ).
    lv_snstopicarn = lo_synthesistask->get_snstopicarn( ).
    LOOP AT lo_synthesistask->get_lexiconnames( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_lexiconname = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_outputformat = lo_synthesistask->get_outputformat( ).
    lv_samplerate = lo_synthesistask->get_samplerate( ).
    LOOP AT lo_synthesistask->get_speechmarktypes( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_speechmarktype = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_texttype = lo_synthesistask->get_texttype( ).
    lv_voiceid = lo_synthesistask->get_voiceid( ).
    lv_languagecode = lo_synthesistask->get_languagecode( ).
  ENDIF.
ENDIF.