Class: CloudmersiveVoiceRecognitionApiClient::SpeakApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SpeakApi

Returns a new instance of SpeakApi.



19
20
21
 
# File 'lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#speak_post(format, text, opts = {}) ⇒ Object

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.

Parameters:

  • format —

    File format to generate response in; possible values are "mp3" or "wav"

  • 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."

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


29
30
31
32
 
# File 'lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb', line 29

def speak_post(format, text, opts = {})
  data, _status_code, _headers = speak_post_with_http_info(format, text, opts)
  return data
end

#speak_post_with_http_info(format, text, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

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.

Parameters:

  • format —

    File format to generate response in; possible values are &quot;mp3&quot; or &quot;wav&quot;

  • text —

    The text you would like to conver to speech. Be sure to surround with quotes, e.g. &quot;The quick brown fox jumps over the lazy dog.&quot;

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb', line 40

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 = {}) ⇒ Object

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.

Parameters:

  • req_config —

    String input request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


89
90
91
92
 
# File 'lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb', line 89

def speak_text_to_speech(req_config, opts = {})
  data, _status_code, _headers = speak_text_to_speech_with_http_info(req_config, opts)
  return data
end

#speak_text_to_speech_with_http_info(req_config, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

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.

Parameters:

  • req_config —

    String input request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/cloudmersive-voice-recognition-api-client/api/speak_api.rb', line 99

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