class Asterisk::ARI::Recordings

Defined in:

asterisk/ari/resources/recordings.cr
asterisk/ari/models/recordings_live_recording.cr
asterisk/ari/models/recordings_stored_recording.cr

Instance Method Summary

Instance methods inherited from class Asterisk::ARI::Resources

ari : ARI ari

Constructor methods inherited from class Asterisk::ARI::Resources

new(ari) new

Instance Method Detail

def cancel(recording_name : String) #

Stop a live recording and discard it.

Arguments:

  • recording_name - the name of the recording. (required);

Error responses:

  • 404 - Recording not found

[View source]
def copy_stored(recording_name : String, destination_recording_name : String) : HTTP::Client::Response | Recordings::StoredRecording #

Copy a stored recording.

Arguments:

  • recording_name - the name of the recording to copy. (required);
  • destination_recording_name - the destination name of the recording. (required);

Error responses:

  • 404 - Recording not found
  • 409 - A recording with the same name already exists on the system

[View source]
def delete_stored(recording_name : String) #

Delete a stored recording.

Arguments:

  • recording_name - the name of the recording. (required);

Error responses:

  • 404 - Recording not found

[View source]
def get_live(recording_name : String) : HTTP::Client::Response | Recordings::LiveRecording #

List live recordings.

Arguments:

  • recording_name - the name of the recording. (required);

Error responses:

  • 404 - Recording not found

[View source]
def get_stored(recording_name : String) : HTTP::Client::Response | Recordings::StoredRecording #

Get a stored recording's details.

Arguments:

  • recording_name - the name of the recording. (required);

Error responses:

  • 404 - Recording not found

[View source]
def get_stored_file(recording_name : String) : HTTP::Client::Response | Binary #

Get the file associated with the stored recording.

Arguments:

  • recording_name - the name of the recording. (required);

Error responses:

  • 403 - The recording file could not be opened
  • 404 - Recording not found

[View source]
def list_stored : HTTP::Client::Response | Array(Recordings::StoredRecording) #

List recordings that are complete.


[View source]
def mute(recording_name : String) #

Mute a live recording.

Arguments:

  • recording_name - the name of the recording. (required);

Error responses:

  • 404 - Recording not found
  • 409 - Recording not in session

[View source]
def pause(recording_name : String) #

Pause a live recording.

Arguments:

  • recording_name - the name of the recording. (required);

Error responses:

  • 404 - Recording not found
  • 409 - Recording not in session

[View source]
def stop(recording_name : String) #

Stop a live recording and store it.

Arguments:

  • recording_name - the name of the recording. (required);

Error responses:

  • 404 - Recording not found

[View source]
def unmute(recording_name : String) #

Unmute a live recording.

Arguments:

  • recording_name - the name of the recording. (required);

Error responses:

  • 404 - Recording not found
  • 409 - Recording not in session

[View source]
def unpause(recording_name : String) #

Unpause a live recording.

Arguments:

  • recording_name - the name of the recording. (required);

Error responses:

  • 404 - Recording not found
  • 409 - Recording not in session

[View source]