Skip to content

Latest commit

 

History

History
114 lines (80 loc) · 3.2 KB

SoundsApi.md

File metadata and controls

114 lines (80 loc) · 3.2 KB
Raw

swagger_client.SoundsApi

All URIs are relative to http://localhost:8088/ari

Method HTTP request Description
sounds_get GET /sounds List all sounds.
sounds_sound_id_get GET /sounds/{soundId} Get a sound's details.

sounds_get

list[Sound] sounds_get(lang=lang, format=format)

List all sounds.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.SoundsApi(swagger_client.ApiClient(configuration))
lang = 'lang_example' # str | Lookup sound for a specific language. (optional)
format = 'format_example' # str | Lookup sound in a specific format. (optional)

try:
    # List all sounds.
    api_response = api_instance.sounds_get(lang=lang, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SoundsApi->sounds_get: %s\n" % e)

Parameters

Name Type Description Notes
lang str Lookup sound for a specific language. [optional]
format str Lookup sound in a specific format. [optional]

Return type

list[Sound]

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sounds_sound_id_get

Sound sounds_sound_id_get(sound_id)

Get a sound's details.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.SoundsApi(swagger_client.ApiClient(configuration))
sound_id = 'sound_id_example' # str | Sound's id

try:
    # Get a sound's details.
    api_response = api_instance.sounds_sound_id_get(sound_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SoundsApi->sounds_sound_id_get: %s\n" % e)

Parameters

Name Type Description Notes
sound_id str Sound's id

Return type

Sound

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]