Max Recorder Download Archives

The Archive Tool

The Archive Tool allows users to archive call recordings to ISO images before they are automatically deleted. For safe keeping, these image files can be burned to CD/DVD at the convenience of the user.

This article describes how to navigate the tool and use the available features and functions. An example of Archive Tool use is included at the end of the article in the section entitled, Running an archive job.

If you have not yet downloaded and installed the Archive Tool then please refer to knowledge article "Installing the Call Recorder Auto Archive Tool" before proceeding with this article.

Navigating the Archive Tool

With the Archive Tool installed on your desktop/laptop, locate and open the Archive Tool application. The Archive to ISO Image window appears, open at the Parameters tab.

The Archive to ISO Image Window contains four tabs;

• Parameters
• Configuration
• Media Viewer
• Documentation

These tabs are explained in more detail in the following paragraphs.

Parameters

To set up auto-archiving Parameters, complete the following fields as required:

• Time Zone - This is the time zone you wish the search to be based on, for example "search for calls that were made from 08:00 to 17:00, (GMT) Greenwich Mean Time"
• User Name - Authorized user (your Call Recorder portal username)
• Password - User password (your Call Recorder portal password)
• Start Date - Date to begin search, includes start time
• End Date - Date to end search, includes end time

Note:
Date range limited to max 90 days.

• Archive Recycle Bin - When checked, only calls in recycle bin will be archived; the date option is ignored and disabled
• Include Archived Calls - When checked, downloaded records will include calls that have been previously archived
• Output Directory - The directory where the completed ISO file will be stored in. Accept the default location, or use the Browse button to select an alternative location to stiore the completed ISO file.Note that the file name will be created automatically using the following format:
  • username_yyyy_mm_ddThhmmss_[custom name].iso
• Volume Name - The name that will be seen when the image is opened on a CD/DVD drive.
• Media - Output type; choose between CD, DVD and DVD-DL formats

Configuration

The Configuration tab contains the following settings that may be modified as required:

• Call Recording URL - The location of the archive web service; typically the service provider address – the Call Recorder portal URL
• ISO Directory Layout - Describes the directory structure that will be applied to the ISO image - note that this directory description is also be used as the work directory for storing the audio\video files during processing
• Custom File Name - This is an optional value that will be added to the ISO filename created by the application.
• Do not download video files - Select this to ignore downloading video files
• Do not create ISO image file - Select this to ignore creating an ISO image

Note:
When selected, the Do not create ISO image file option will download all calls as individual MP3 files.

• Do not update archive database tables - Select this to ignore updating the service provider system database; always choose this when are testing
• Do not delete downloaded work files - Select this to ignore deleting files downloaded in work directory
• Download this number of files concurrently - The number of files to download concurrently
• Number of CPUs - The number of CPUs on the local computer
• Number of connections - The number of concurrent connections to the web server

Media Viewer

The Media Viewer tab provides options for viewing ISO images. It can also be used to restore previously archived calls

The following options are available:

• Input - This is the location of the ISO file (created by this tool) that you wish to view. Accept the default location, or use the Browse button to select an alternative location for the ISO Image file you wish to view. When you create an ISO, the last one created will be rendered in the Media Viewer.
• Load - Select this to manually load an ISO in the viewer.
• Search – Select, from the drop-down list, the field you wish to search
• For - Enter the data (keyword) you wish to find

Restoring an archived recorded call

To restore an archived call, from the Archive Tool, Media Viewer tab,

1. In the Input field, select the location of the file that you previously archived.
2. Click Load.
3. Select the calls you wish to restore from the archived calls that appear in the lower part of the window.
4. Click Restore.

Documentation

Contains documentation to help setup and use the Archive Tool.

Running an archive job

From your desktop,

1. Open the Archive Tool application.

In the Parameters tab,

1. Set parameters as required. Refer to previous section, Parameters, for further information.
2. Click the Configuration tab to open the Configuration page.

In the Configuration tab,

1. Set   configuration settings as required. Refer to previous section, Configuration, for further information.
2. Return to the Parameters tab.

In the Parameters tab,

1. Click Create to start the archive job.

Once the archive job has been completed, the archived data may be viewed or restored in the Media Viewer tab. Refer to previous section, Media Viewer, for further information.

Eventide's NexLog DX-Series IP-based communications recording solutions are specifically designed for Mission Critical 24/7 operation in dispatch, air traffic management, emergency call-taking and other important communications environments.  With over 6,000 recording systems deployed around the world, Eventide understands that reliability is the NexLog DX-Series recording solution's primary mission.   NexLog DX-Series recording solutions capture and archive media from a wide range of communications systems including E9-1-1 PSAPs, Next-Gen IP-Based 9-1-1 systems, P25 radio, DMR radio, Mototrbo radio, Dimetra IP and other radio systems, Dispatch Consoles, ATC/ATM Systems, Radio over IP (RoIP) networks, VoIP telephones, digital PBX telephones, analog sources, PC Screens and much more. The resulting recordings are available immediately for instant recall, forensic replay, incident reconstruction, burn to CD, and export.

Eventide NexLog DX-Series communications recording solutions offer outstanding flexibility and ease of use, with the choice of a convenient touch-screen front panel and/or secure browser-based remote software accessible from any modern connected device (Windows PC, Windows tablet, Apple MAC, Apple iPad, Apple iPhone, Android tablet, or Android smartphone). Call records are stored in a state-of-the-art SQL relational database, and NexLog DX-Series recording solutions feature an integrated Linux operating system for maximum reliability, security and compatibility with your existing network infrastructure.

NexLog 740 DX-Series Recording Solution:

The NexLog 740 DX-Series recording solution is a 3U rack-mountable system with many options to meet your specific needs:

• Configurable with: 8 to 96 digital PBX telephone channels, 8 to 96 analog channels, 8 to 560 VoIP/SIP/RoIP channels, 8 - 560 NG9-1-1 SIPrec channels, 24 - 192 T1/PRI channels, 30 - 240 E1 channels, 8 - 240 P25 channels, 8-240 Mototrbo channels, 8 - 240 Dimetra TETRA channels, or 8 - 240 DMR channels. A wide range of mixed channel quantities (digital + analog + VoIP/RoIP, etc.) can be accommodated.
• Multiple choices for interal RAID storage (ranging from 1TB to 18TB)
• Multiple NexLog 740 DX-Series recording solutions may be easily combined to provide recording solutions for higher channel counts, multiple sites, and/or redundancy.
• Available with an integrated color multi-touch LCD screen (or with a blank front panel).

NexLog 840 DX-Series Recording Solution:

The NexLog 840 DX-Series recording solution is a 4U rack-mountable system with many configuration options to meet your specific needs:

• Configurable with 8 to 240 digital PBX telephone channels, 8 to 240 analog channels, 8 to 560 VoIP/RoIP channels, 8 - 560 NG9-1-1 SIPrec channels, 24 - 240 T1/PRI channels, 30 - 240 E1 channels, 8 - 240 P25 channels, 8-240 Mototrbo channels, or 8 - 240 DMR channels. A wide range of mixed channel quantities (digital + analog + VoIP/RoIP, etc.) can be accommodated within a single NexLog 840 recorder.
• Multiple choices for interal RAID storage (ranging from 1TB to 18TB)
• Multiple NexLog 840 DX-Series recording solutions may be easily combined to provide recording solutions for higher channel counts, multiple sites, and/or redundancy.
• Available with an integrated color multi-touch screen (or with a blank front panel).

NexLog DX-Series Virtual (VM) Recording Solution:

The NexLog DX-Series Virtual (VM) recording solution is deployable on customer-provided ESXi and computer resources. 

• Licensable with up to 560 VoIP/SIP/RoIP channels, which can be configured to record many types of IP-based sources including Cisco BiB, VoIP SPAN, SIP SPAN, Multicast RoIP, NG9-1-1 SIPrec, P25, Dimetra (TETRA), DMR, Mototrbo and more.
• Add Eventide Smart Edge Capture Devices to record & forward from analog, digital PBX and remote VoIP sources.
• Multiple NexLog DX-Series Virtual (VM) recording solutions may be easily combined to accommodate higher channel counts, multiple sites, and/or redundancy.

Eventide Smart Edge Capture Device:

• The Eventide Smart Edge Capture Devices can record audio and reliably buffer & forward the audio recordings to one or more NexLog DX-Series recording solutions. 
• Smart Edge Capture Devices can be configured to capture audio from Analog lines and sources, Digital PBX Stations, T1/E1 circuits, Cisco BiB or remote VoIP SPAN ports.

NexLog DX-Series Recording  Capabilities

NexLog DX-Series communications recording solutions have been designed to provide full-time recording for compliance needs, as well as distributed recording for agencies and enterprises with multiple sites. NexLog DX-Series recording solutions can record digital PBX telephones, ISDN BRI telephones, VoIP telephones, analog telephones, analog C.O. lines, CAMA trunks, analog radio audio, T1 & E1 trunks, ISDN-PRI trunks, ISDN30 trunks, SIP trunks, IP-dispatch consoles (AVTEC, ZETRON, TELEX, Omnitronics and many others), radio over IP (RoIP), trunked and conventional 2-way radio, Motorola ASTRO 25 with AIS, L3Harris VIDA P25, EFJohnson ATLAS P25, Motorola MOTOTRBO (including Capacity Max), L3Harris/Tait DMR Tier 3, L3Harris/Tait DMR Tier 2, Tait MPT-IP, Sepura/Fylde DMR Tier 3, ICOM iDAS Conventional, Kenwood NexEdge Trunked, ESChat PTT over LTE, PC Screens (Windows and Linux), and much more.

NG9-1-1

NexLog DX-Series recording solutions conform to the NENA i3 standard for recording of NG9-1-1 primary multimedia interactions, via the SIPREC interface method.

Resilience Features

NexLog DX-Series communications recorders offer multiple levels of resilience, including redundant power supplies, redundant hard disk drives (with choices of RAID levels 1, 5, or 10), redundant network capability (via NIC bonding), and multiple choices for local and network-based archive storage. The NexLog 740 DX-Series and NexLog 840 DX-Series recorders are each equipped with dual hot-swap load-sharing 120/240 VAC power supplies.  NexLog 740 DX-Series recorders are available on a special-order basis with dual -48 VDC power supplies.

Advanced Security Features

NexLog DX-Series communications recording solutions include a multi-tier security system that controls each user's access based on role and channel (or talk group) assignments. NexLog DX-Series software has been designed to enhance security by encouraging users to employ strong passwords and to use them properly. Password policy options include complexity enforcement, automatic aging, change reminders, expiration, and lock-out. In addition, each user's access and actions are audited and available for review.  Recordings can optionally be licensed for encryption-at-rest, further protecting recordings that are stored on the NexLog DX-Series recorder's HDD array. 

Metadata Integration Capabilities

In addition to recording audio and PC screens, NexLog DX-Series communications recorders can support integration to a variety of metadata sources that provide call-associated information. Options include 9-1-1 ANI/ALI integration, 9-1-1 SMS integration, SMDR/CDR integration to PBX systems, IP Dispatch console metadata, Radio system metadata, and customized data integrations. In addition, the optional NexLog DX-Series Application Programming Interface (API) licenses allows third party software developers to implement custom/OEM integrations for recording start/stop control, metadata tagging, query, and media retrieval.

Up to 18 TB of Internal Storage

The NexLog 740 DX-Series and NexLog 840 DX-Series recorders include an internal RAID array of hard disk drives for reliability and redundancy. Offerings range from a standard pair of 1 Terabyte hard disk drives with RAID-1 (providing 1 Terabyte of storage for up to 166,000 hours @13kbps compression) all the way up to four hot-swap 6 Terabyte hard disk drives with RAID-5 (providing 18 Terabytes of storage for up to 3 Million hours @13kbps compression).

Flexible Archive Capabilities

NexLog 740 DX-Series and NexLog 840 DX-Series communications recorders include a standard Blu-ray multidrive for Blu-ray or DVD-RAM archiving (4.7GB per single-sided DVD-RAM disk, for 770 hours @13kbps). Upgrade options include a second Blu-ray multidrive for redundant or sequential archiving, and single or dual RDX drives (for use with 1TB or 2TB RDX cartridges). In addition, NexLog DX-Series recorders can archive to as many as six external USB hard disk drives or USB flash devices. For geo-diverse archive redundancy, NexLog DX-Series recorders can optionally archive to as many as six Network Attached Storage (NAS) shares. Multiple NexLog DX-Series recorders can optionally archive to a central NexLog DX-Series unit, which provides a centralized database and storage for calls that have been recorded at multiple sites.

Incident Replay and Management Features

Eventide's MediaWorks DX browser-based software provides secure recording management capabilities including flexible search, multiple-call replay, graphical time-line with pan/zoom, variable-speed replay, incident management tabs, audio redaction, voice annotation, audio waveforms, talking time/date, call protection, burning of calls or incidents to CD/DVD/Blu-Ray, export or email incident, live monitor, instant recall and much more.  

Refer to the MediaWorks DX page for detailed information and documentation.

Geo-Location Display and Search Capabilities

Eventide's MediaWorks DX software can optionally display (with Google Maps on the user's PC/browser) the reported "geo-tagged" location of calls for which both audio and lattitude/longitude data are simultaneously delivered to the recorder.  This NexLog geo-location option is generally available for Wireless 9-1-1 calls, for Harris P25 with GPS subscriber units, and for Harris/Tait DMR Tier 3 with GPS subscriber units.  MediaWorks DX software with this optional geo-location capability also permits convenient map-based searching for "geo-tagged" calls, via a user-definable "geo-fence".

Instant Recall Features

Eventide's MediaWorks DX secure browser-based software provides agents, call takers, and dispatchers with preset-based Instant Recall capabilities including variable-speed replay, record-on demand, text annotation, and export to WAV file.

Color LCD Multi-Touch Screen

The available color multi-touch screen provides convenient control and replay at the recorder's front panel. You can view the current status of each channel and each archive, receive visual and audible alerts, live-monitor multiple channels, and fully administer the system using the NexLog DX-Series Configuration Manager software. Playback functions available at the touch screen include quick replay, advanced search and replay, select calls to be protected, create incidents from groups of calls, add more calls to an existing incident, export an incident to USB, and burn the incident to CD.

Web-based NexLog DX-Series Configuration Manager Software

NexLog DX-Series communications recorders include the NexLog DX-Series Configuration Manager software, which permits secure browser-based access to system configuration parameters. NexLog DX-Series Configuration Manager software also allows the administration of password policies and assignment of each user's access permissions.

Call Evaluation and Reporting

The optional Eventide Quality Factor DX call evaluation software module allows supervisors to efficiently evaluate and score call-handling quality. Evaluation questions, answer banks, and skills can all be quickly entered and maintained, and the call evaluation forms can be created through a simple drag and drop process. The evaluation questions and forms can be quickly adapted for special incidents and changing requirements. Quality Factor DX software's reports are designed to help supervisors measure the quality of call handling and track performance.

Standard Reports

NexLog DX-Series communications recording systems include tabular and graphical reports that can be run at any time. These daily, weekly, and monthly reports provide managers with valuable information about call volumes and channel activity.

Reporting Engine DX Option

The Reporting Engine DX option includes many templates, or you can create your own reports. Please see the Reporting Engine DX product page for more details.

Designed, Assembled, and Supported in the USA

NexLog DX-Series communications recorders and software applications are developed and maintained in the USA by Eventide's highly-talented engineering team - assuring prompt responses to changing market needs and customer requirements. In addition, all NexLog DX-Series recorders are assembled, tested, and supported at our New Jersey USA production and support facility. 

Trusted By Customers - Worldwide

Public safety, utility, government, military, institutional, and industrial customers at thousands of sites worldwide trust Eventide mission-critical recording systems to reliably record and protect their most important interactions and related data. For more information about NexLog DX-Series communications recording solutions, call Eventide at +(201) 641-1200 extension 264, or email loggers@eventide.com

NEXLOG DX-Series Brochure

Request Quote

Vonage Video API archiving lets you record, save and retrieve sessions.

This topic includes the following sections:

Basic workflow

Important: You can only archive sessions that use the OpenTok Media Router (sessions with the media mode set to routed).

You can create an archive for an OpenTok session using the OpenTok REST API or one of the OpenTok Server SDKs. When you create an archive, the recording starts. You can only create an archive for sessions that have at least one client connected. (A client must start publishing a stream within one minute or the archive stops.)

As clients start and stop publishing streams, the streams are recorded.

Important: You can record up to nine streams with composed archiving, or 50 with individual stream archiving. See Individual stream and composed archives. After this limit is reached, if additional streams are published to the session, they are not recorded. Also, archive recordings are limited to 120 minutes in length.

There is no limit to the number of archives you can record. (Note, however, that automatically archived sessions will restart a new recording every 120 minutes until the recording stops.)

The OpenTok REST API and the OpenTok Server SDKs include methods for the following:

• Starting an archive recording
• Stopping an archive recording
• Listing archives
• Retrieving archive information
• Deleting an archive

When you stop recording an archive, the OpenTok server creates an MP4 file or (in the case of individual stream archives) a ZIP file. (See Individual stream and composed archives.)

When an archive recording starts and stops, events are sent in the clients. For example, the OpenTok.js library includes and events dispatched by the Session object.

Archive storage

Use your TokBox Account to specify a target for completed archive files to be uploaded to. This can be your own Amazon S3 bucket, a bucket at an S3-compliant storage provider other than Amazon, or a Windows Azure container. See Using S3 storage with OpenTok archiving and Using an Windows Azure container with OpenTok archiving.

If you do not set an S3 bucket or an Azure container, or if uploading to the specified bucket or container fails, recorded archives are available for retrieval by download from the OpenTok cloud. Archives made available on the OpenTok cloud are available for 72 hours from the time they are created. To prevent this fallback storage, log in to your TokBox Account, select the project, and set the option to disable the archive storage fallback.

Audio-only and video-only archives

When you create an archive using the OpenTok REST API or one of the OpenTok Server SDKs, you can specify whether the archive will record audio, video, or both. (The default is to record both.)

Individual stream and composed archives

Archive output file can be of one of the following formats:

• Composed archives — The archive is a single MP4 file composed of all streams. This is the default setting. It is also used for automatically archived sessions (see Automatically archived sessions). The MP4 file uses H.264 video and AAC audio.

  You can customize the layout of a composed archive, adjusting the visual arrangement of streams and which streams are displayed. See Customizing the video layout for composed archives.

  By default, composed archives have a 640x480-pixel (SD) resolution. To set a composed archive to have a 1280x720 (HD) resolution, set the property to when calling the start archive method of the OpenTok REST API.

• Individual stream archives — The archive is a ZIP container file with multiple individual media files for each stream, and a JSON metadata file for video synchronization. You can specify this format when you use one of the OpenTok server SDKs to start the archive. This format is not available for automatically archived sessions (see Automatically archived sessions).

Working with individual stream archives

Individual stream archive mode is intended for use with a post-processing tool, to produce customized content generated by your application. There are some considerations that developers should evaluate when choosing to use the feature.

Individual stream containers

Individual stream archive media is delivered as a ZIP archive, containing files for each audio-video stream:

• Each stream container in the archive corresponds to a stream published to OpenTok. The publisher's stream ID matches its corresponding file name, and each stream ID is declared in the archive manifest.

• Stream containers are either of type , or , depending on your project's configuration. Archives for projects that have VP8 set as the preferred video codec have containers, and projects that have H.264 set as the preferred video codec use the format.

• Individual stream archive containers are a capture of all the video and audio received by the archive server. This media is not processed, and therefore in most cases the container is not be suitable for direct playback.

The stream container is treated like a transport stream — all media received at the archive server is written directly to file, without inspection or post-processing. This design has implications for downstream consumption of stream containers. In most cases, direct playback of of an individual stream archive container will not be possible, or will have issues because of the contents of the container:

• The declared dimensions for the stream header are seldom correct. Currently, the headers for the container will show a video track with 640x480-pixel dimensions, regardless of the dimensions of encoded video frames.
• Video frames will change in dimensions over time. This can also include aspect ratio changes, particularly with screen-sharing streams.
• Audio and video frames may not arrive with monotonic timestamps; frame rates are not always consistent. This is especially relevant if either the video or audio track is disabled for a time, using one of or publisher properties.

Frame presentation timestamps (PTS) are written based on NTP timestamps taken at the time of capture, offset by the timestamp of the first received frame. Even if a track is muted and later unmuted, the timestamp offset should remain consistent throughout the duration of the entire stream. When decoding in post-processing, a gap in PTS between consecutive frames will exist for the duration of the track mute: there are no "silent" frames in the container.

To produce viewable content from individual stream archiving files, you need to run the media through a post processor to repair individual stream containers or multiplex/composite multiple containers into a final product. Suggestions for getting started with downstream processing are outlined in our archiving-composer GitHub repository: https://github.com/opentok/archiving-composer.

Individual stream archive manifest

Individual stream archives include a JSON metadata file, which provides information on the stream recordings included in the archive. It is of the following format:

This JSON file includes the following properties:

• — The unique identifier of this archive.
• — The partner/project ID of this archive
• — The session ID of this archive
• — The name of this archive. This field is empty if was not specified in the call to start archive.
• — The Unix time in milliseconds for when the archive started.

• — An array of files included in the ZIP container. Each file has the following properties:

  • — The corresponding stream ID for the stream recorded to this file.

  • — The name of the recorded media file. This will be a for an archive of a session in an OpenTok project that uses VP8 as the prefered video codec, and it will be a for an archive of a session in a project that uses H.264 as the prefered video codec.

    If a stream is disrupted or interrupted by a network problem, several files may be present for the same stream (corresponding to each segment), and the filename for each stream segment will be appended with an index number (such as "1" or "2") after the stream ID to identify the order of the segment.

  • — The offset, in milliseconds, for when this file started recording (from the time for the archive)—see the important note below.

  • — The offset, in milliseconds, for when this file stopped recording (from the time for the archive)—see the important note below.
  • — The connection data for the publishing client.
  • — Either or . A video uses screen sharing on the publisher as the video source; for other videos, this property is set to . For a stream published from a mobile device, the screen type can change from a camera to a screen-sharing video type. However, the property in the archive manifest only indicates the initial video type.

Important: In an individual stream archive, if there is a short period where no streams are published during the recording, the and stopTimeOffset values can be off by a bit. This is a known issue.

Post processing individual archives

A sample post processor application is available at https://github.com/opentok/archiving-composer.

Automatically archived sessions

You can also have a session be automatically archived. You can specify this when you create the session, using one of the OpenTok server SDKs. The archive for an automatically archived session starts as soon as a client connects to the session.

If archiving is started and no data is streamed during the duration of the archive (no audio or video is published), the size of archive file will be 0 bytes.

Automatically archived sessions include both audio and video, and they record all streams to the same (composed) MP4 file. However, if the recording lasts longer than 2 hours (120 minutes), the session is recorded to multiple, consecutive MP4 files, of up to 2 hours each in length, until the archive is stopped.

You can call the OpenTok REST method for listing archives and pass in the query parameter to list archives for a specified session ID. You can then determine the sequence of the separate MP4 files, by looking at the property of each archive listed in the JSON data returned by the call the the REST method.

You cannot stop an automatic archive using the OpenTok REST API or server SDKs. Automatic archives stop 60 seconds after the last client disconnects from the session or 60 minutes after the last client stops publishing a stream to the session.

Archive status changes

You can register a callback URL for notification when an archive's status changes. The status of an archive is set to one of the following:

• — The archive started and is in the process of being recorded.
• — When an archive is paused, nothing is recorded. The archive is paused if any of the the following conditions occur:
  • No clients are publishing streams to the session. In this case, there is a timeout of 60 minutes, after which the archive stops and the archive status changes to .
  • All clients disconnect the session. After 60 seconds the archive stops and the archive status changes to .
  If a client resumes publishing while the archive is in the state, the archive recording resumes and the status changes back to .
• — The archive stopped recording.
• — The archive is available for download from the S3 bucket or Azure container you specified at your TokBox Account. Note that for very small archives, the status event may occur before the status event.
• — The archive is available for download from the OpenTok cloud.
• — The archive is no longer available for download from the OpenTok cloud. (Archives on the OpenTok cloud are only available for 72 hours from the time they are created.)
• — The archive recording failed.

Use your TokBox Account to specify a callback URL. When an archive's status changes, the server sends HTTP POST requests to the URL you supply. The Content-Type for the request is application/json. The data of the request is a JSON object of the following form:

The JSON object includes the following properties:

• — The timestamp for when the call to start the archive occurred, expressed in milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC). Note that this value is rounded to the nearest second. Also note that this value differs from the value in the REST method for retrieving archive and the value in the manifest for an individual stream archive In those, the value is set to the time the recording effectively started on the OpenTok servers (not the time when the call to start the recording occurred). Note that even if a call to start an archive is issued, the archive will not start effectively recording on the OpenTok server until at least one client publishes a stream in the session.
• — The duration of the archive in seconds. For archives that are being recorded (with the status property set ), this value is set to 0.
• — The unique archive ID.
• — The name of the archive you supplied (this is optional)
• — Your OpenTok API key.
• — The resolution of the archive (either "640x480" or "1280x720"). This property is only set for composed archives. You can set the resolution of a composed archive when callin the start archive method of the OpenTok REST API.
• — For archives with the status or , this string describes the reason the archive stopped (such as "maximum duration exceeded") or failed.
• — The session ID of the OpenTok session that was archived.
• — The size of the archive file. For archives that have not been generated, this value is set to 0.
• — The status of the archive:
  • — The archive is available for download from OpenTok.
  • — The archive is no longer available for download from the OpenTok cloud. (Archives on the OpenTok cloud are only available for 72 hours from the time they are created.)
  • — The archive recording failed.
  • — When an archive is paused, nothing is recorded. The archive is paused if any of the the following conditions occur:
    • No clients are publishing streams to the session. In this case, there is a timeout of 60 minutes, after which the archive stops and the archive status changes to .
    • All clients disconnect the session. After 60 seconds the archive stops and the archive status changes to .
    If a client resumes publishing while the archive is in the state, the archive recording resumes and the status changes back to .
  • — The archive started and is in the process of being recorded.
  • — The archive stopped recording.
  • — The archive is available for download from the S3 bucket or Azure container you specified in your TokBox Account. Note that for very small archives, the status event may occur before the status event.
• — The download URL of the available archive file. This is only set for an archive with the status set to ; for other archives, (including archives with the status ) 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, use the REST API for retrieving archive information or listing archives.

You can also view the status of archives at the TokBox Account:

1. Navigate to your TokBox Account page.
2. From the list of projects in the left of the page, select the project that will contain sessions that you are archiving.
3. In the Archiving section, click the Archive List tab. Details on archives in the project are listed.

Archive security

You can secure your archives in the following ways:

• Turn off archive storage fallback — By default, TokBox stores an archive file on OpenTok servers if it was unable to upload the file to your specified S3 or Azure server. To prevent this fallback storage, log in to your TokBox Account, select the project, and set the option to disable archive storage fallback.
• Use OpenTok encryption — This lets you to create OpenTok archives where the data is never at rest in an unencrypted state. Of the available methods of securing your OpenTok archives, this provides the highest level of security. This is available as an add-on feature. For more information, see the OpenTok encryption documentation.
• Use Amazon S3 server-side encryption — This uses Amazon S3-managed encryption keys for encryption. Learn about Amazon S3 server-side encryption here.

Sample apps

The following sample apps demonstrate archiving with OpenTok:

More information

See the documentation for the archiving-related methods in the OpenTok REST API and in the API references for the OpenTok server SDKs. Also, each of the server SDKs includes a sample archiving application.

Thank you for your feedback!

We appreciate it.
If you need an answer to a question or help with an issue, contact our support team.