class OpenTok::Archive
Represents an archive of an OpenTok
session.
@attr [int] created_at
The time at which the archive was created, in milliseconds since the UNIX epoch.
@attr [string] duration
The duration of the archive, in seconds.
@attr [string] id
The archive ID.
@attr [string] name
The name of the archive. If no name was provided when the archive was created, this is set to null.
@attr [true, false] has_audio
Whether the archive has an audio track (true) or not (false).
@attr [true, false] has_video
Whether the archive has a video track (true) or not (false).
@attr [String] output_mode
Whether all streams in the archive are recorded to a single file (<code>:composed</code>) or to individual files (<code>:individual</code>).
@attr [string] projectId
The API key associated with the archive.
@attr [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.
@attr [string] resolution
The resolution of the archive, either "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait). You may want to use a portrait aspect ratio for archives that include video streams from mobile devices (which often use the portrait aspect ratio). This property is only set for composed archives.
@attr [string] session_id
The session ID of the OpenTok session associated with this archive.
@attr [float] size
The size of the MP4 file. For archives that have not been generated, this value is set to 0.
@attr [string] streamMode
Whether streams included in the archive are selected automatically ("auto", the default) or manually ("manual").
@attr [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 for your {https://tokbox.com/account OpenTok project}.
@attr [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.
Attributes
Public Class Methods
@private
# File lib/opentok/archive.rb, line 77 def initialize(interface, json) @interface = interface # TODO: validate json fits schema @json = json @multi_archive_tag = @json['multiArchiveTag'] @stream_mode = @json['streamMode'] end
Public Instance Methods
Adds a stream to currently running composed archive that was started with the streamMode set to “manual”. For a description of the feature, see {tokbox.com/developer/rest/#selecting-archive-streams}.
@param [String] stream_id
The ID for the stream to be added to the archive
@option opts [true, false] :has_audio
(Boolean, optional) — Whether the composed archive should include the stream's audio (true, the default) or not (false).
@option opts [true, false] :has_video
(Boolean, optional) — Whether the composed archive should include the stream's video (true, the default) or not (false).
@raise [OpenTokArchiveError]
The streamMode for the archive is not set to "manual".
You can call the method repeatedly with add_stream
set to the same stream ID, to toggle the stream’s audio or video in the archive. If you set both has_audio and has_video to false, you will get error response.
# File lib/opentok/archive.rb, line 171 def add_stream(stream_id, opts = {}) raise OpenTokArchiveError, "stream_mode must be manual in order to add a stream" unless @json['streamMode'] == 'manual' @interface.add_stream(@json['id'], stream_id, opts) end
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.
# File lib/opentok/archive.rb, line 104 def delete # TODO: validate returned json fits schema @json = @interface.delete_by_id @json['id'] end
Sets the layout type for a composed archive. For a description of layout types, see {tokbox.com/developer/guides/archiving/layout-control.html Customizing the video layout for composed archives}.
@option options [String] :type
The layout type. Set this to "bestFit", "pip", "verticalPresentation", "horizontalPresentation", "focus", or "custom".
@option options [String] :stylesheet
The stylesheet for a custom layout. Set this parameter if you set <code>type</code> to <code>"custom"</code>. Otherwise, leave it undefined.
@raise [ArgumentError] The archive_id or options parameter is empty. Or the “custom”
type was specified without a stylesheet option. Or a stylesheet was passed in for a type other than custom. Or an invalid type was passed in.
@raise [OpenTokAuthenticationError]
Authentication failed.
@raise [ArgumentError]
The archive_id or options parameter is empty.
@raise [ArgumentError]
The "custom" type was specified without a stylesheet option.
@raise [ArgumentError]
A stylesheet was passed in for a type other than custom. Or an invalid type was passed in.
@raise [ArgumentError]
An invalid layout type was passed in.
@raise [OpenTokError]
OpenTok server error.
@raise [OpenTokArchiveError]
Setting the layout failed.
# File lib/opentok/archive.rb, line 145 def layout(opts= {}) # TODO: validate returned json fits schema @json = @interface.layout(@json['id'], opts) end
@private ignore
# File lib/opentok/archive.rb, line 191 def method_missing(method, *args, &block) camelized_method = method.to_s.camelize(:lower) if @json.has_key? camelized_method and args.empty? # TODO: convert create_time method call to a Time object if camelized_method == 'outputMode' @json[camelized_method].to_sym else @json[camelized_method] end else super method, *args, &block end end
Removes a stream to currently running composed archive that was started with the streamMode set to “manual”. For a description of the feature, see {tokbox.com/developer/rest/#selecting-archive-streams}.
@param [String] stream_id
The ID for the stream to be removed from the archive
@raise [OpenTokArchiveError]
The streamMode for the archive is not set to "manual".
# File lib/opentok/archive.rb, line 185 def remove_stream(stream_id) raise OpenTokArchiveError, "stream_mode must be manual in order to remove a stream" unless @json['streamMode'] == 'manual' @interface.remove_stream(@json['id'], stream_id) end
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.
# File lib/opentok/archive.rb, line 94 def stop # TODO: validate returned json fits schema @json = @interface.stop_by_id @json['id'] end
A JSON-encoded string representation of the archive.
# File lib/opentok/archive.rb, line 86 def to_json @json.to_json end