class CloudmersiveVoiceRecognitionApiClient::SpeakApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

speak_post(format, text, opts = {}) click to toggle source

Perform text-to-speech on a string Takes as input a string and a file format (mp3 or wav) and outputs a wave form in the appropriate format. @param format File format to generate response in; possible values are "mp3" or "wav" @param text The text you would like to conver to speech. Be sure to surround with quotes, e.g. "The quick brown fox jumps over the lazy dog." @param [Hash] opts the optional parameters @return [Object]

# File lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb, line 28
def speak_post(format, text, opts = {})
  data, _status_code, _headers = speak_post_with_http_info(format, text, opts)
  data
end
speak_post_with_http_info(format, text, opts = {}) click to toggle source

Perform text-to-speech on a string Takes as input a string and a file format (mp3 or wav) and outputs a wave form in the appropriate format. @param format File format to generate response in; possible values are "mp3&quot; or "wav&quot; @param text The text you would like to conver to speech. Be sure to surround with quotes, e.g. "The quick brown fox jumps over the lazy dog.&quot; @param [Hash] opts the optional parameters @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers

# File lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb, line 39
def speak_post_with_http_info(format, text, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpeakApi.speak_post ...'
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling SpeakApi.speak_post"
  end
  # verify the required parameter 'text' is set
  if @api_client.config.client_side_validation && text.nil?
    fail ArgumentError, "Missing the required parameter 'text' when calling SpeakApi.speak_post"
  end
  # resource path
  local_var_path = '/speech/speak/text/basicVoice/{format}'.sub('{' + 'format' + '}', format.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(text)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpeakApi#speak_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
speak_text_to_speech(req_config, opts = {}) click to toggle source

Perform text-to-speech on a string Takes as input a string and a file format (mp3 or wav) and outputs a wave form in the appropriate format. @param req_config String input request @param [Hash] opts the optional parameters @return [Object]

# File lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb, line 87
def speak_text_to_speech(req_config, opts = {})
  data, _status_code, _headers = speak_text_to_speech_with_http_info(req_config, opts)
  data
end
speak_text_to_speech_with_http_info(req_config, opts = {}) click to toggle source

Perform text-to-speech on a string Takes as input a string and a file format (mp3 or wav) and outputs a wave form in the appropriate format. @param req_config String input request @param [Hash] opts the optional parameters @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers

# File lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb, line 97
def speak_text_to_speech_with_http_info(req_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpeakApi.speak_text_to_speech ...'
  end
  # verify the required parameter 'req_config' is set
  if @api_client.config.client_side_validation && req_config.nil?
    fail ArgumentError, "Missing the required parameter 'req_config' when calling SpeakApi.speak_text_to_speech"
  end
  # resource path
  local_var_path = '/speech/speak/text/voice/basic/audio'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(req_config)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpeakApi#speak_text_to_speech\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end