Partners Blog Contact Us

Using VidyoReplay Experimental Features

Follow

Auto Export Feature

VidyoReplay Auto Export feature offers a VidyoReplay Administrator the option of exporting the records created on a Replay node or cluster immediately after recording creation.  This feature is available  starting with version 21.1.0 of VidyoReplay.

This export is useful in scenarios such as:

  • Limited disk space on Replay. After a successful export, the recording(s) can be deleted from Replay machines to save space
  • Backup of existing recordings
  • Sharing of recordings
  • Recordings post-processing

Auto Export Settings 

This table includes the descriptions of the settings for VidyoReplay Auto Export: 

Setting  Description 
Export format 

Recordings can be exported in FLV or MP4 format.

Transport method supported 

SCP, FTP, SFTP, HTTP, and HTTPS.

Destination 

Depending on the transport method chosen, this field contains the destination machine (IP or FDQN) and other transport specific details.

Destination folder

The absolute or relative path to destination folder, depending on the transport method chosen.

Authentication type

Password or private key.

Username

Name of the user.

Password or private key

Dynamic field, depending on authentication type chosen.

Metadata format

Recordings contain metadata. This metadata may also be exported in a separate file. This file may be plain text, JSON, or XML. 

NOTE: User must provide a template for the export, and it must conform to the desired format. Templates are not checked for validity.

 

 

 

How it Works

  1. The automatic export of recordings affects only the recordings that were created while this feature is enabled. Therefore, existing recordings will not be exported.
    • Any recording created after an automatic export is disabled in settings will not be exported.
    • There is no mechanism for exporting recording that are created outside the "enable automatic export window". 
  2. After creating a recording on Replay, an auto export process starts.
    • Based on the settings, the recording may be converted to MP4 format. The recording is analyzed, and metadata is extracted if external metadata is required - in this case, the template is used to substitute keys with actual metadata values found in the recording.
    • If the metadata template contains non-existing keys, the resulting file will contain "undefined" as values.
    • If the export fails, retry mechanism is performed.
    • You may download a log of the export. The log contains a full trace of the export with clear indication of whether the action was a success or failure (as it retries).
  3. You can not set/alter the recording file name. An exported recording will have the same name as the one created on the Replay (e.g., 12dd7a9c-32c3-5de6-90ee-4738c019e7e1. [extension]). If metadata is exported in a separate file, it will have the same name as the recording, and an extension according to user settings (e.g., 12dd7a9c-32c3-5de6-90ee-4738c019e7e1.xml).

For Relay Clusters: If you are using a cluster, all RPLY machines should have the same exact settings for Auto-Export. This is required because the auto-export functionality is invoked/performed by the current main controller.

 

Example templates (using a limited number of keys)

  • plain text

Video stream has a frame rate of %videoFramerate% and is %videoHeight% x %videoWidth% pixels.

Audio stream has a data rate of %audioRate%, using %audioCodec% codec

  • XML

<?xml version="1.0"?>

<root>

 <video_keys>

  <frame_rate> %videoFramerate% </frame_rate>

  <height> %videoHeight% </height>

  <width> %videoWidth% </width>

 </video_keys>

 <audio_keys>

  <data_rate> %audioRate% </data_rate>

  <codec> %audioCodec% </codec>

 </audio_keys>

</root>

  • JSON

{

 "video keys": {

   "Frame Rate": %videoFamerate%,

   "Height": %videoHeight%,

   "Width": %videoWidth%

  },

 "audio keys": {

   "Data Rate": %audioRate%,

   "Codec": %audioCodec%

  }

}

FLV and MP4 containers support different metadata keys, and even if they have the same meaning, the key names differ between container types.

The full list of keys supported in export as separate metadata file is as follows:

Key name Description Unit Example
mediaDuration Media duration 

sec

134.89
videoCodec

Video codec name

string

H263|H263Plus|VP8|VP9|H264 |H264Plus|H264Svc
videoFramerate

Video frame rate

frames/sec

30
videoWidth

Video height

pixel

640

videoHeight

Video width

pixel

320

audioCodec

Audio codec name

string

PCMU|PCMA|G722|OPUS|SIL K16|SILK8|SPEEX|AAC|PCM

audioRate

Audio sample rate

samples/sec

48000

roomTenantName

Room tenant name

string

test5

roomName

Room name

string

user1

roomOwnerDisplayName

Room owner display name

string

user1

roomOwnerName

Room owner name

string

user1

userName

User name

string

user1

tenant

Tenant name

string

tenant1

displayName

User display name

string

User-1

participantList

The list of the participants

string

demo,user1,user5

filename

Exporting media file name

string

6a128e59-10e3-59e4-80e9- ac06d72b21b7.flv

guid

Recording created timestamp

YYYY-MM-DDThh:mm: ss.zzz

2020-12-15T13:08:09.782

dateCreated

Recording created timestamp

YYYY-MM-DDThh:mm: ss.zzz

2020-12-15T13:08:09.782

endTime

Recording end timestamp

YYYY-MM-DDThh:mm: ss.zzz

2020-12-15T13:18:09.000

 

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.