1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
{
"_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
"_author": "David M. Lee, II <dlee@digium.com>",
"_svn_revision": "$Revision$",
"apiVersion": "1.7.0",
"swaggerVersion": "1.1",
"basePath": "http://localhost:8088/ari",
"resourcePath": "/api-docs/playbacks.{format}",
"apis": [
{
"path": "/playbacks/{playbackId}",
"description": "Control object for a playback operation.",
"operations": [
{
"httpMethod": "GET",
"summary": "Get a playback's details.",
"nickname": "get",
"responseClass": "Playback",
"parameters": [
{
"name": "playbackId",
"description": "Playback's id",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
}
],
"errorResponses": [
{
"code": 404,
"reason": "The playback cannot be found"
}
]
},
{
"httpMethod": "DELETE",
"summary": "Stop a playback.",
"nickname": "stop",
"responseClass": "void",
"parameters": [
{
"name": "playbackId",
"description": "Playback's id",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
}
],
"errorResponses": [
{
"code": 404,
"reason": "The playback cannot be found"
}
]
}
]
},
{
"path": "/playbacks/{playbackId}/control",
"description": "Control object for a playback operation.",
"operations": [
{
"httpMethod": "POST",
"summary": "Control a playback.",
"nickname": "control",
"responseClass": "void",
"parameters": [
{
"name": "playbackId",
"description": "Playback's id",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
},
{
"name": "operation",
"description": "Operation to perform on the playback.",
"paramType": "query",
"required": true,
"allowMultiple": false,
"dataType": "string",
"allowableValues": {
"valueType": "LIST",
"values": [
"restart",
"pause",
"unpause",
"reverse",
"forward"
]
}
}
],
"errorResponses": [
{
"code": 400,
"reason": "The provided operation parameter was invalid"
},
{
"code": 404,
"reason": "The playback cannot be found"
},
{
"code": 409,
"reason": "The operation cannot be performed in the playback's current state"
}
]
}
]
}
],
"models": {
"Playback": {
"id": "Playback",
"description": "Object representing the playback of media to a channel",
"properties": {
"id": {
"type": "string",
"description": "ID for this playback operation",
"required": true
},
"media_uri": {
"type": "string",
"description": "The URI for the media currently being played back.",
"required": true
},
"next_media_uri": {
"type": "string",
"description": "If a list of URIs is being played, the next media URI to be played back.",
"required": false
},
"target_uri": {
"type": "string",
"description": "URI for the channel or bridge to play the media on",
"required": true
},
"language": {
"type": "string",
"description": "For media types that support multiple languages, the language requested for playback."
},
"state": {
"type": "string",
"description": "Current state of the playback operation.",
"required": true,
"allowableValues": {
"valueType": "LIST",
"values": [
"queued",
"playing",
"continuing",
"done"
]
}
}
}
}
}
}
|
