Class: Ari::Recording
- Defined in:
- lib/ari/resources/recording.rb
Class Method Summary collapse
-
.cancel(options = {}) ⇒ Object
DELETE /recordings/live/%recordingName.
-
.copy_stored(options = {}) ⇒ Object
POST /recordings/stored/%recordingName/copy.
-
.copyStored ⇒ Object
POST /recordings/stored/%recordingName/copy.
-
.delete_stored(options = {}) ⇒ Object
DELETE /recordings/stored/%recordingName.
-
.deleteStored ⇒ Object
DELETE /recordings/stored/%recordingName.
-
.get_live(options = {}) ⇒ Object
GET /recordings/live/%recordingName.
-
.get_stored(options = {}) ⇒ Object
GET /recordings/stored/%recordingName.
-
.getLive ⇒ Object
GET /recordings/live/%recordingName.
-
.getStored ⇒ Object
GET /recordings/stored/%recordingName.
-
.list_stored(options = {}) ⇒ Object
(also: listStored)
GET /recordings/stored.
-
.mute(options = {}) ⇒ Object
POST /recordings/live/%recordingName/mute.
-
.pause(options = {}) ⇒ Object
POST /recordings/live/%recordingName/pause.
-
.stop(options = {}) ⇒ Object
POST /recordings/live/%recordingName/stop.
-
.unmute(options = {}) ⇒ Object
DELETE /recordings/live/%recordingName/mute.
-
.unpause(options = {}) ⇒ Object
DELETE /recordings/live/%recordingName/pause.
Instance Method Summary collapse
- #cancel(options = {}) ⇒ Object
- #copy_stored(options = {}) ⇒ Object
- #delete_stored(options = {}) ⇒ Object
- #get_live(options = {}) ⇒ Object
- #get_stored(options = {}) ⇒ Object
- #mute(options = {}) ⇒ Object
- #pause(options = {}) ⇒ Object
- #stop(options = {}) ⇒ Object
- #unmute(options = {}) ⇒ Object
- #unpause(options = {}) ⇒ Object
Methods inherited from Resource
#add_listener, client, #client, #remove_all_listeners!, #remove_listener
Methods inherited from Model
Constructor Details
This class inherits a constructor from Ari::Model
Class Method Details
.cancel(options = {}) ⇒ Object
DELETE /recordings/live/%recordingName
A recording that is in progress
Parameters:
recordingName (required) - The name of the recording
124 125 126 127 128 129 130 |
# File 'lib/ari/resources/recording.rb', line 124 def self.cancel( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/live/%{recordingName}' % response = client().delete(path, ) rescue Ari::RequestError => e raise unless e.code == '404' end |
.copy_stored(options = {}) ⇒ Object
POST /recordings/stored/%recordingName/copy
Copy an individual recording
Parameters:
recordingName (required) - The name of the recording to copy destinationRecordingName (required) - The destination name of the recording
81 82 83 84 85 86 87 |
# File 'lib/ari/resources/recording.rb', line 81 def self.copy_stored( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] raise ArgumentError.new("Parameter destinationRecordingName must be passed in options hash.") unless [:destinationRecordingName] path = '/recordings/stored/%{recordingName}/copy' % response = client().post(path, ) StoredRecording.new(response.merge(client: [:client])) end |
.copyStored ⇒ Object
POST /recordings/stored/%recordingName/copy
Copy an individual recording
Parameters:
recordingName (required) - The name of the recording to copy destinationRecordingName (required) - The destination name of the recording
88 89 90 91 92 93 94 |
# File 'lib/ari/resources/recording.rb', line 88 def self.copy_stored( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] raise ArgumentError.new("Parameter destinationRecordingName must be passed in options hash.") unless [:destinationRecordingName] path = '/recordings/stored/%{recordingName}/copy' % response = client().post(path, ) StoredRecording.new(response.merge(client: [:client])) end |
.delete_stored(options = {}) ⇒ Object
DELETE /recordings/stored/%recordingName
Individual recording
Parameters:
recordingName (required) - The name of the recording
58 59 60 61 62 63 64 |
# File 'lib/ari/resources/recording.rb', line 58 def self.delete_stored( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/stored/%{recordingName}' % response = client().delete(path, ) rescue Ari::RequestError => e raise unless e.code == '404' end |
.deleteStored ⇒ Object
DELETE /recordings/stored/%recordingName
Individual recording
Parameters:
recordingName (required) - The name of the recording
65 66 67 68 69 70 71 |
# File 'lib/ari/resources/recording.rb', line 65 def self.delete_stored( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/stored/%{recordingName}' % response = client().delete(path, ) rescue Ari::RequestError => e raise unless e.code == '404' end |
.get_live(options = {}) ⇒ Object
GET /recordings/live/%recordingName
A recording that is in progress
Parameters:
recordingName (required) - The name of the recording
103 104 105 106 107 108 |
# File 'lib/ari/resources/recording.rb', line 103 def self.get_live( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/live/%{recordingName}' % response = client().get(path, ) LiveRecording.new(response.merge(client: [:client])) end |
.get_stored(options = {}) ⇒ Object
GET /recordings/stored/%recordingName
Individual recording
Parameters:
recordingName (required) - The name of the recording
37 38 39 40 41 42 |
# File 'lib/ari/resources/recording.rb', line 37 def self.get_stored( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/stored/%{recordingName}' % response = client().get(path, ) StoredRecording.new(response.merge(client: [:client])) end |
.getLive ⇒ Object
GET /recordings/live/%recordingName
A recording that is in progress
Parameters:
recordingName (required) - The name of the recording
109 110 111 112 113 114 |
# File 'lib/ari/resources/recording.rb', line 109 def self.get_live( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/live/%{recordingName}' % response = client().get(path, ) LiveRecording.new(response.merge(client: [:client])) end |
.getStored ⇒ Object
GET /recordings/stored/%recordingName
Individual recording
Parameters:
recordingName (required) - The name of the recording
43 44 45 46 47 48 |
# File 'lib/ari/resources/recording.rb', line 43 def self.get_stored( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/stored/%{recordingName}' % response = client().get(path, ) StoredRecording.new(response.merge(client: [:client])) end |
.list_stored(options = {}) ⇒ Object Also known as: listStored
GET /recordings/stored
Recordings
21 22 23 24 25 |
# File 'lib/ari/resources/recording.rb', line 21 def self.list_stored( = {}) path = '/recordings/stored' response = client().get(path, ) response.map { |hash| StoredRecording.new(hash.merge(client: [:client])) } end |
.mute(options = {}) ⇒ Object
POST /recordings/live/%recordingName/mute
Parameters:
recordingName (required) - The name of the recording
204 205 206 207 208 |
# File 'lib/ari/resources/recording.rb', line 204 def self.mute( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/live/%{recordingName}/mute' % response = client().post(path, ) end |
.pause(options = {}) ⇒ Object
POST /recordings/live/%recordingName/pause
Parameters:
recordingName (required) - The name of the recording
164 165 166 167 168 |
# File 'lib/ari/resources/recording.rb', line 164 def self.pause( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/live/%{recordingName}/pause' % response = client().post(path, ) end |
.stop(options = {}) ⇒ Object
POST /recordings/live/%recordingName/stop
Parameters:
recordingName (required) - The name of the recording
145 146 147 148 149 |
# File 'lib/ari/resources/recording.rb', line 145 def self.stop( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/live/%{recordingName}/stop' % response = client().post(path, ) end |
.unmute(options = {}) ⇒ Object
DELETE /recordings/live/%recordingName/mute
Parameters:
recordingName (required) - The name of the recording
223 224 225 226 227 228 229 |
# File 'lib/ari/resources/recording.rb', line 223 def self.unmute( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/live/%{recordingName}/mute' % response = client().delete(path, ) rescue Ari::RequestError => e raise unless e.code == '404' end |
.unpause(options = {}) ⇒ Object
DELETE /recordings/live/%recordingName/pause
Parameters:
recordingName (required) - The name of the recording
183 184 185 186 187 188 189 |
# File 'lib/ari/resources/recording.rb', line 183 def self.unpause( = {}) raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless [:recordingName] path = '/recordings/live/%{recordingName}/pause' % response = client().delete(path, ) rescue Ari::RequestError => e raise unless e.code == '404' end |
Instance Method Details
#cancel(options = {}) ⇒ Object
132 133 134 |
# File 'lib/ari/resources/recording.rb', line 132 def cancel( = {}) self.class.cancel(.merge(recordingId: self.id, client: @client)) end |
#copy_stored(options = {}) ⇒ Object
90 91 92 |
# File 'lib/ari/resources/recording.rb', line 90 def copy_stored( = {}) self.class.copy_stored(.merge(recordingId: self.id, client: @client)) end |
#delete_stored(options = {}) ⇒ Object
67 68 69 |
# File 'lib/ari/resources/recording.rb', line 67 def delete_stored( = {}) self.class.delete_stored(.merge(recordingId: self.id, client: @client)) end |
#get_live(options = {}) ⇒ Object
111 112 113 |
# File 'lib/ari/resources/recording.rb', line 111 def get_live( = {}) self.class.get_live(.merge(recordingId: self.id, client: @client)) end |
#get_stored(options = {}) ⇒ Object
45 46 47 |
# File 'lib/ari/resources/recording.rb', line 45 def get_stored( = {}) self.class.get_stored(.merge(recordingId: self.id, client: @client)) end |
#mute(options = {}) ⇒ Object
210 211 212 |
# File 'lib/ari/resources/recording.rb', line 210 def mute( = {}) self.class.mute(.merge(recordingId: self.id, client: @client)) end |
#pause(options = {}) ⇒ Object
170 171 172 |
# File 'lib/ari/resources/recording.rb', line 170 def pause( = {}) self.class.pause(.merge(recordingId: self.id, client: @client)) end |
#stop(options = {}) ⇒ Object
151 152 153 |
# File 'lib/ari/resources/recording.rb', line 151 def stop( = {}) self.class.stop(.merge(recordingId: self.id, client: @client)) end |
#unmute(options = {}) ⇒ Object
231 232 233 |
# File 'lib/ari/resources/recording.rb', line 231 def unmute( = {}) self.class.unmute(.merge(recordingId: self.id, client: @client)) end |
#unpause(options = {}) ⇒ Object
191 192 193 |
# File 'lib/ari/resources/recording.rb', line 191 def unpause( = {}) self.class.unpause(.merge(recordingId: self.id, client: @client)) end |