class Ari::Recording

Public Class Methods

cancel(options = {}) click to toggle source

DELETE /recordings/live/%{recordingName}

A recording that is in progress

Parameters:

recordingName (required) - The name of the recording

# File lib/ari/resources/recording.rb, line 124
def self.cancel(options = {})
  raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
  path = '/recordings/live/%{recordingName}' % options
  response = client(options).delete(path, options)
rescue Ari::RequestError => e
  raise unless e.code == '404'
end
copyStored(options = {})
Alias for: copy_stored
copy_stored(options = {}) click to toggle source

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

# File lib/ari/resources/recording.rb, line 81
def self.copy_stored(options = {})
  raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
  raise ArgumentError.new("Parameter destinationRecordingName must be passed in options hash.") unless options[:destinationRecordingName]
  path = '/recordings/stored/%{recordingName}/copy' % options
  response = client(options).post(path, options)
  StoredRecording.new(response.merge(client: options[:client]))
end
Also aliased as: copyStored
deleteStored(options = {})
Alias for: delete_stored
delete_stored(options = {}) click to toggle source

DELETE /recordings/stored/%{recordingName}

Individual recording

Parameters:

recordingName (required) - The name of the recording

# File lib/ari/resources/recording.rb, line 58
def self.delete_stored(options = {})
  raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
  path = '/recordings/stored/%{recordingName}' % options
  response = client(options).delete(path, options)
rescue Ari::RequestError => e
  raise unless e.code == '404'
end
Also aliased as: deleteStored
getLive(options = {})
Alias for: get_live
getStored(options = {})
Alias for: get_stored
get_live(options = {}) click to toggle source

GET /recordings/live/%{recordingName}

A recording that is in progress

Parameters:

recordingName (required) - The name of the recording

# File lib/ari/resources/recording.rb, line 103
def self.get_live(options = {})
  raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
  path = '/recordings/live/%{recordingName}' % options
  response = client(options).get(path, options)
  LiveRecording.new(response.merge(client: options[:client]))
end
Also aliased as: getLive
get_stored(options = {}) click to toggle source

GET /recordings/stored/%{recordingName}

Individual recording

Parameters:

recordingName (required) - The name of the recording

# File lib/ari/resources/recording.rb, line 37
def self.get_stored(options = {})
  raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
  path = '/recordings/stored/%{recordingName}' % options
  response = client(options).get(path, options)
  StoredRecording.new(response.merge(client: options[:client]))
end
Also aliased as: getStored
listStored(options = {})
Alias for: list_stored
list_stored(options = {}) click to toggle source

GET /recordings/stored

Recordings

# File lib/ari/resources/recording.rb, line 21
def self.list_stored(options = {})
  path = '/recordings/stored'
  response = client(options).get(path, options)
  response.map { |hash| StoredRecording.new(hash.merge(client: options[:client])) }
end
Also aliased as: listStored
mute(options = {}) click to toggle source

POST /recordings/live/%{recordingName}/mute

Parameters:

recordingName (required) - The name of the recording

# File lib/ari/resources/recording.rb, line 204
def self.mute(options = {})
  raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
  path = '/recordings/live/%{recordingName}/mute' % options
  response = client(options).post(path, options)
end
pause(options = {}) click to toggle source

POST /recordings/live/%{recordingName}/pause

Parameters:

recordingName (required) - The name of the recording

# File lib/ari/resources/recording.rb, line 164
def self.pause(options = {})
  raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
  path = '/recordings/live/%{recordingName}/pause' % options
  response = client(options).post(path, options)
end
stop(options = {}) click to toggle source

POST /recordings/live/%{recordingName}/stop

Parameters:

recordingName (required) - The name of the recording

# File lib/ari/resources/recording.rb, line 145
def self.stop(options = {})
  raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
  path = '/recordings/live/%{recordingName}/stop' % options
  response = client(options).post(path, options)
end
unmute(options = {}) click to toggle source

DELETE /recordings/live/%{recordingName}/mute

Parameters:

recordingName (required) - The name of the recording

# File lib/ari/resources/recording.rb, line 223
def self.unmute(options = {})
  raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
  path = '/recordings/live/%{recordingName}/mute' % options
  response = client(options).delete(path, options)
rescue Ari::RequestError => e
  raise unless e.code == '404'
end
unpause(options = {}) click to toggle source

DELETE /recordings/live/%{recordingName}/pause

Parameters:

recordingName (required) - The name of the recording

# File lib/ari/resources/recording.rb, line 183
def self.unpause(options = {})
  raise ArgumentError.new("Parameter recordingName must be passed in options hash.") unless options[:recordingName]
  path = '/recordings/live/%{recordingName}/pause' % options
  response = client(options).delete(path, options)
rescue Ari::RequestError => e
  raise unless e.code == '404'
end

Public Instance Methods

cancel(options = {}) click to toggle source
# File lib/ari/resources/recording.rb, line 132
def cancel(options = {})
  self.class.cancel(options.merge(recordingId: self.id, client: @client))
end
copy_stored(options = {}) click to toggle source
# File lib/ari/resources/recording.rb, line 90
def copy_stored(options = {})
  self.class.copy_stored(options.merge(recordingId: self.id, client: @client))
end
delete_stored(options = {}) click to toggle source
# File lib/ari/resources/recording.rb, line 67
def delete_stored(options = {})
  self.class.delete_stored(options.merge(recordingId: self.id, client: @client))
end
get_live(options = {}) click to toggle source
# File lib/ari/resources/recording.rb, line 111
def get_live(options = {})
  self.class.get_live(options.merge(recordingId: self.id, client: @client))
end
get_stored(options = {}) click to toggle source
# File lib/ari/resources/recording.rb, line 45
def get_stored(options = {})
  self.class.get_stored(options.merge(recordingId: self.id, client: @client))
end
mute(options = {}) click to toggle source
# File lib/ari/resources/recording.rb, line 210
def mute(options = {})
  self.class.mute(options.merge(recordingId: self.id, client: @client))
end
pause(options = {}) click to toggle source
# File lib/ari/resources/recording.rb, line 170
def pause(options = {})
  self.class.pause(options.merge(recordingId: self.id, client: @client))
end
stop(options = {}) click to toggle source
# File lib/ari/resources/recording.rb, line 151
def stop(options = {})
  self.class.stop(options.merge(recordingId: self.id, client: @client))
end
unmute(options = {}) click to toggle source
# File lib/ari/resources/recording.rb, line 231
def unmute(options = {})
  self.class.unmute(options.merge(recordingId: self.id, client: @client))
end
unpause(options = {}) click to toggle source
# File lib/ari/resources/recording.rb, line 191
def unpause(options = {})
  self.class.unpause(options.merge(recordingId: self.id, client: @client))
end