Skip to content

Latest commit

 

History

History
164 lines (115 loc) · 4.83 KB

PlaybacksApi.md

File metadata and controls

164 lines (115 loc) · 4.83 KB
Raw

swagger_client.PlaybacksApi

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

Method HTTP request Description
playbacks_playback_id_control_post POST /playbacks/{playbackId}/control Control a playback.
playbacks_playback_id_delete DELETE /playbacks/{playbackId} Stop a playback.
playbacks_playback_id_get GET /playbacks/{playbackId} Get a playback's details.

playbacks_playback_id_control_post

playbacks_playback_id_control_post(playback_id, operation)

Control a playback.

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.PlaybacksApi(swagger_client.ApiClient(configuration))
playback_id = 'playback_id_example' # str | Playback's id
operation = 'operation_example' # str | Operation to perform on the playback.

try:
    # Control a playback.
    api_instance.playbacks_playback_id_control_post(playback_id, operation)
except ApiException as e:
    print("Exception when calling PlaybacksApi->playbacks_playback_id_control_post: %s\n" % e)

Parameters

Name Type Description Notes
playback_id str Playback's id
operation str Operation to perform on the playback.

Return type

void (empty response body)

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]

playbacks_playback_id_delete

playbacks_playback_id_delete(playback_id)

Stop a playback.

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.PlaybacksApi(swagger_client.ApiClient(configuration))
playback_id = 'playback_id_example' # str | Playback's id

try:
    # Stop a playback.
    api_instance.playbacks_playback_id_delete(playback_id)
except ApiException as e:
    print("Exception when calling PlaybacksApi->playbacks_playback_id_delete: %s\n" % e)

Parameters

Name Type Description Notes
playback_id str Playback's id

Return type

void (empty response body)

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]

playbacks_playback_id_get

Playback playbacks_playback_id_get(playback_id)

Get a playback'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.PlaybacksApi(swagger_client.ApiClient(configuration))
playback_id = 'playback_id_example' # str | Playback's id

try:
    # Get a playback's details.
    api_response = api_instance.playbacks_playback_id_get(playback_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PlaybacksApi->playbacks_playback_id_get: %s\n" % e)

Parameters

Name Type Description Notes
playback_id str Playback's id

Return type

Playback

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]