Sharing to FTP
Yoanna Hristova avatar
Written by Yoanna Hristova
Updated over a week ago

How to add an FTP account

  1. Select your USER icon in the top right-hand corner of the page

  2. Select SOCIAL ACCOUNTS from the drop-down menu

  3. Select ADD ACCOUNT

  4. Select FTP from the menu

  5. Enter a PROTOCOL - either FTP/SFTP/FTPS

  6. Enter a HOST - the URL of your FTP server (it can contain the 'ftp://' or 'sftp://' prefix)

  7. Enter a PORT - the port to connect to (typically FTP:21 SFTP:22 SFTP:990 but can changed)

  8. Enter your USERNAME and PASSWORD

  9. Select SUBMIT to finish

📕 Note: Test connection allows a user to verify their credentials are correct before you create a social credential. We allow users to create an FTP integration with invalid credentials in cases where they know their credentials will be valid at one point in the future.

💡 Tip: Make sure the server is configured to allow traffic from your command channel port (usually port 21) and your data port (this port is random by default so you will have to configure security from your side).

💡 Tip: Mark FTP as insecure - we mark FTP as insecure and recommend using FTPS if available (due to the security benefits of transmitting credentials over TLS).

How to share to an FTP account

1, Select LIVE CLIPPING on the stream that you want to clip from

  1. Select a CAMPAIGN from the drop-down menu on the right-hand side of the page

  2. Set the IN and OUT points of your content

  3. Select a CAMPAIGN and add a SOCIAL MESSAGE

  4. Select your FTP ACCOUNT and select SAVE AND SHARE

  5. A modal will appear where you enter a TITLE and UPLOAD OPTIONAL ASSETS (THUMBNAIL, METADATA JSON, METADATA XML, CLOSED CAPTIONS WEBVTT or CLOSED CAPTIONS SRT)

  6. Select SHARE TO FTP to finish

📕 Note: The main asset (typically a VOD) is always uploaded, but we give the end-user the ability to additionally upload with a thumbnail (turned off by default); upload with closed captions WebVTT (turned off by default, CC streams or assets with CC's attached only); upload with closed captions WebVTT (turned off by default, CC streams or assets with CC's attached only).

💡Tip: A user can dynamically browse the directory structure of their remote FTP server and select the directory to share directly from the share modal

Metadata Export

Metadata export is the exporting of JSON and XML metadata files for media assets when sharing to FTP.

Example data exported for a video:

{"assetId":"someAssetIdGoesHere","aspectRatio":"16:9","fileName":"someFilename.mp4","fileDurationInMilliseconds":139926,"fileSizeInBytes":32112007,"title":"This is the title of my clip","description":"A description","tags":["Tag1", "Tag2"]}
<MetadataOutput><assetId>someAssetIdGoesHere</assetId><aspectRatio>16:9</aspectRatio><fileName>someFilename.mp4</fileName><fileDurationInMilliseconds>139926</fileDurationInMilliseconds><fileSizeInBytes>32112007</fileSizeInBytes><title>This is the title of my clip</title><description>A description</description><tags><tag>Tag1</tag><tag>Tag2</tag></tags></MetadataOutput>

📕 Note: Metadata exports are supported for Videos, GIFs and Images

Did this answer your question?