Skip to main content

Frequency Documentation

SFTP Ingestion

Frequency can set up a dedicated storage space and transfer protocol via SFTP, which provides hardware-specific credentials for a secure transfer of your content into Frequency's backend storage.

Deliverables

Frequency Studio supports Secure File Transfer Protocol (SFTP) for delivering content, which you can learn more about here. Please deliver the following to your account manager:

Deliverable

Deliverable

Example

SSH

Public Key

SSH public key - we will provide username/host.

P2JV5wbl3xjQ1R0fuVla

Video assets

This is the video asset being ingested.

  • Supported file extensions: mp4, mov, mpg, avi

  • Minimum 1280x720 resolution

  • 16:9 Aspect Ratio

movie.mp4

Image assets

An image to represent your video asset. It is preferable if it is unique.

  • Supported file extensions: jpg, png

  • Minimum 1280x720 resolution

  • 16:9 Aspect Ratio

thumbnail.jpg

Metadata file

A .csv file containing required and optional metadata for ingestion. This is how you assets will be linked into one object.

Required metadata:

  • GUID

  • Title

  • Description

  • Video File Name + Extension (ex: video.mp4)

  • Thumbnail File Name + Extension (ex: thumbnail.jpg)

For optional metadata fields, please see the attached manifest, and refer to Metadata Definitions.

metadata-manifest.csv

Credentials Setup

  1. Generate a SSH Key

    1. WindowsWindows uses a slightly different SSH key-pair format. The public key must be in the PUB format, and the private key must be in the PPK format. On Windows, you can use PuTTYgen to create an SSH key-pair in the appropriate formats. You can also use PuTTYgen to convert a private key generated using ssh-keygen to a .ppk file.

      1. To generate an SSH key on a Windows machine, you can use the PuTTYgen utility. For more information about using the PuTTYgen utility to create a key pair, go to http://www.howtoforge.com/ssh_key_based_logins_putty.

      2. PuTTYgen stores its private keys in a proprietary format that is only used by PuTTY. If you need to use the private key with an SSH client other than PuTTY, you can use PuTTYgen to convert the private key to OpenSSH format by clicking on Conversion in the PuTTYgen menu and selecting Export OpenSSH key.

      3. The public key that is used by the HSM appliance must be in SSH format. In PuTTYgen, copy the contents of the Public key for pasting into OpenSSH authorized keys file field and save this to a file. This is your public key file.

        Here's a video tutorial that would show you how to generate the proper key in Windows:

    2. MacOS / Linux

      1. Open Terminal app and type in the following command:

        ssh-keygen -P "" -f transfer-key
  2. Locate the generated SSH files and retrieve the SSH Public Key (transfer-key.pub). Send this to Frequency to use to administer a new user.

    1. The SSH Public Key looks like this:

      ssh-rsa AAAAB3NzaC................................h2rkp8Uh gotfrank@Franks-MBP-WiFi.local
    2. Frequency will generate and set up a new username.

Uploading Files
  1. Using a SFTP client such as Cyberduck (Windows or MacOS), connect with SFTP to:

    1. Host: sftp.frequency.com

    2. User: <your username as provided by Frequency after you gave us your SSH Public Key)

    3. SSH Private Key: (locate your SSH Private Key file from your computer)

  2. Upload your video, artwork, and/or subtitles files

    1. You can use the root/base folder or put them into separate folders as you wish, as long as they're referenced as relative path in the Metadata Manifest File for the media files.

    2. Asset specifications must meet Frequency's minimum requirements

  3. Upload Metadata Manifest File

    1. You must upload a manifest file in CSV format (e.g.: metadata.csv) that describes your content uploaded. Refer to this template and example for the correct field and field values.

    2. The only required fields are video_file and image_file (both must be of 16:9 aspect ratio and at least 720p resolution). These fields must match the file names in the folder otherwise this may cause issues with ingestion.

    3. You must update this manifest file after you have confirmed that all associated assets have been uploaded successfully, otherwise this may cause issues with ingestion.

    4. In the future, you can overwrite this file with new information when necessary

CSV Example

metadata.csv

Live Google Sheet Example

https://docs.google.com/spreadsheets/d/1e4tZyBEIxnE1236mIT7dPpe7SUQ3gaYnT1YQgmrscUk

Best Practices
  • Upload your metadata.csv after all assets have been fully uploaded

  • Data ending with line breaks will not be valid

  • Ensure file paths on assets are correct

  • File names are case sensitive

Automated Ingestion

Frequency will check the metadata Manifest file periodically and detect new videos to ingest. Videos that are ingested successfully will appear in the MANAGE tool.

File Name Convention

Asset names must adhere to S3's Object key and metadata rules.

The name for a key is a sequence of Unicode characters whose UTF-8 encoding is at most 1,024 bytes long

Safe characters

Please ensure your file names only use the following safe characters:

Alphanumeric characters

  • 0-9

  • a-z

  • A-Z

Special characters

  • Forward slash ( / )

  • Exclamation point ( ! )

  • Hyphen ( - )

  • Underscore ( _ )

  • Period ( . ) Exception: Object name key cannot end with a single period (.), or two periods (..)

  • Asterisk ( * )

  • Single quote ( ' )

  • Open parenthesis ( ( )

  • Close parenthesis ( ) )