Suggestions

close search

Class: OpenTok::Archive

Inherits:
Object
Defined in:
lib/opentok/archive.rb

Overview

Represents an archive of an OpenTok session.

Instance Attribute Summary

Instance Method Summary

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

- (Object) method_missing(method, *args, &block)

Instance Attribute Details

- (int) created_at

The time at which the archive was created, in milliseconds since the UNIX epoch.

Returns:

  • (int)

    the current value of created_at

- (string) duration

The duration of the archive, in milliseconds.

Returns:

  • (string)

    the current value of duration

- (true, false) has_audio

Whether the archive has an audio track (true) or not (false).

Returns:

  • (true, false)

    the current value of has_audio

- (true, false) has_video

Whether the archive has a video track (true) or not (false).

Returns:

  • (true, false)

    the current value of has_video

- (string) id

The archive ID.

Returns:

  • (string)

    the current value of id

- (string) name

The name of the archive. If no name was provided when the archive was created, this is set to null.

Returns:

  • (string)

    the current value of name

- (String) output_mode

Whether all streams in the archive are recorded to a single file (:composed) or to individual files (:individual).

Returns:

  • (String)

    the current value of output_mode

- (string) partner_id

The API key associated with the archive.

Returns:

  • (string)

    the current value of partner_id

- (string) reason

For archives with the status "stopped" or "failed", this string describes the reason the archive stopped (such as "maximum duration exceeded") or failed.

Returns:

  • (string)

    the current value of reason

- (string) session_id

The session ID of the OpenTok session associated with this archive.

Returns:

  • (string)

    the current value of session_id

- (float) size

The size of the MP4 file. For archives that have not been generated, this value is set to 0.

Returns:

  • (float)

    the current value of size

- (string) status

The status of the archive, which can be one of the following:

  • "available" -- The archive is available for download from the OpenTok cloud.

  • "expired" -- The archive is no longer available for download from the OpenTok cloud.

  • "failed" -- The archive recording failed.

  • "paused" -- The archive is in progress and no clients are publishing streams to the session. When an archive is in progress and any client publishes a stream, the status is "started". When an archive is paused, nothing is recorded. When a client starts publishing a stream, the recording starts (or resumes). If all clients disconnect from a session that is being archived, the status changes to "paused", and after 60 seconds the archive recording stops (and the status changes to "stopped").

  • "started" -- The archive started and is in the process of being recorded.

  • "stopped" -- The archive stopped recording.

  • "uploaded" -- The archive is available for download from the the upload target Amazon S3 bucket or Windows Azure container you set at for your OpenTok project.

Returns:

  • (string)

    the current value of status

- (string) url

The download URL of the available MP4 file. This is only set for an archive with the status set to "available"; for other archives, (including archives with the status "uploaded") this property is set to null. The download URL is obfuscated, and the file is only available from the URL for 10 minutes. To generate a new URL, call the Archive.listArchives() or OpenTok.getArchive() method.

Returns:

  • (string)

    the current value of url

Instance Method Details

- (Object) delete

Deletes an OpenTok archive.

You can only delete an archive which has a status of "available" or "uploaded". Deleting an archive removes its record from the list of archives. For an "available" archive, it also removes the archive file, making it unavailable for download.

- (Object) stop

Stops an OpenTok archive that is being recorded.

Archives automatically stop recording after 120 minutes or when all clients have disconnected from the session being archived.

- (Object) to_json

A JSON encoded string representation of the archive