S3 Ingest for Viostream makes it possible for you to add media to your Viostream account by uploading it to Amazon Web Services S3 (Simple Storage Service).
This method of ingest is beneficial when you need to upload multiple or very large media files, but also, because developers are able to upload to S3 programmatically, it is a powerful means of integrating Viostream with other platforms.
Requesting access to S3 ingest
In order to put files on S3 your application, or code will require a Bucket name, an Access Key, and a Secret Key. Your Viostream account admin can obtain these through the Viostream Console by navigating to the ACCOUNT MANAGEMENT / DEVELOPER tab and clicking the Request S3 Access button in the S3 Ingest section:
You will be notified when credentials are available:
The S3 Ingest section of the DEVELOPER tab will then be populated with your details:
How you use these credentials will depend on which client or method you choose to use. Your access is limited to your account directory only (i.e. viostream-production-ingest/remote/VC-XXXXXXXXX), so make sure you specify that path when connecting.
Uploading media to S3 for ingest
Once connected to S3, you will see a folder called upload into which you can place your media and associated files. You can simply drop a media file into this folder, and it will be uploaded to your account as if you used the UPLOAD button in the console. That is, the media will be named the same as the file (without extension), and immediately appear in your media list as it starts processing.
For more advanced usage you can create a subfolder under upload with the desired name of the media to be created. In this folder, you can place the following file types.
Video: ".mp4", ".wmv", ".m4v", ".mkv", ".avi", ".flv", ".mov", ".f4v", ".mpg", ".mpeg", ".mxf"
Audio: ".mp3", ".m4a", ".ogg"
Thumbnails: ".jpg", ".jpeg", ".png", ".gif"
Slide Decks: ".ppt", ".pptx"
Captions: ".srt", ".vtt"
Transcripts: ".html", ".htm", ".pdf", ".txt", ".rtf", ".doc", ".docx"
For example, if you create a folder called MyMedia01 and upload video001.mp4, photo_01.jpg, and captions.vtt, into that folder you will get a new media item called MyMedia01, with photo_01.jpg as its thumbnail, and the supplied captions.
For this example files were dragged from Windows Explorer (left), to Cloudberry Explorer for Windows (right).
The processed version of these files can be seen in the media detail.
You can add these files in any order, and can later add new images, captions, and transcripts to be appended to the media. If you add transcript.docx to the above folder the next day, it will become available in the ACCESSIBILITY tab.
Once an ingest has completed successfully, the files will be moved to the completed folder. If you used a subfolder, it will be moved into a folder of the same name, but the original folder in upload will remain for later use.
If an ingest fails, the media will be moved to the failed folder. If it was a subfolder upload you can upload a new media file into that folder to retry the failed ingest.
The name of the folder will become the ReferenceId of the media. A ReferenceId is a user-chosen id, that can be used to query the Viostream Distribution API in place of the MediaId, or PublicKey.