Download media object #296

elv-preethi · 2024-07-25T00:57:19Z

The script OfferingDownloadMedia performs the following:

Retrieves streams metadata from either transcodes or offerings for each provided streamKey.
Then downloads the parts, concatenates them, and trims the media file for each streamKey.

Steps:

export PRIVATE_KEY="xxx"
set demov3 network in TestConfiguration.json or using --config-url
Run the command:

node ./testScripts/OfferingDownloadMedia.js 
--startTime 10 
--endTime 50 
--objectId=iq__bSS84FakdSgxHSiW3kJcA1obH6P 
--out ./out_dir 
--config-url "https://demov3.net955210.contentfabric.io/config"
--streamKey "video,polish_5_1,english_stereo"

For each content with a startTime and endTime, a new folder will be created under the output directory, as shown below:

./out_dir
└── iq__bSS84FakdSgxHSiW3kJcA1obH6P_00-00-40.500_00-01-10.000
    ├── english_stereo
    │   ├── 0001.hqpeBJhFb8U8gedQRc1gPT4uKd6fxawWmQBUjRcQuiRT2TKp1hVZ.mp4
    │   └── 0002.hqpe4oNGvobdiDeX9r9RnTAqtESNjKqtxryUAx51JhMxuhh4fUFq.mp4
    ├── english_stereo.mp4
    ├── parts_english_stereo.txt
    ├── parts_polish_5_1.txt
    ├── parts_video.txt
    ├── polish_5_1
    │   ├── 0001.hqpeNjNmLQvLQxfx3hWvXZzJ4nv2hF41DdrzSefRxxBDVRLyCsZ7.mp4
    │   └── 0002.hqpe6iHZFyZ7qroTSfz6xiVrhtDRyYktLveofuE27NB8EaXGtfCh.mp4
    ├── polish_5_1.mp4
    ├── trimmed
    │   ├── english_stereo_trimmed.mp4
    │   ├── polish_5_1_trimmed.mp4
    │   └── video_trimmed.mp4
    ├── video
    │   ├── 0001.hqpedi3ftDawHChtviNtzCbcVsnVukpjbqm6bmM1TaPJRutgz8x3Q.mp4
    │   └── 0002.hqpe2tXuAapeuTdPFNcwqnJFKyV1RxbVqz4Jc3ejJtn5iYURQDjeWS.mp4
    └── video.mp4

5 directories, 15 files

For instance, for english_stereo streamKey:
english_stereo folder => contains all the parts that fall within the start and end times.
english_stereo.mp4 => the concatenated file
english_stereo_trimeed.mp4 => this file has been both concatenated and trimmed to the specified time range.

Command usage:

 node ./testScripts/OfferingDownloadMedia --help
Options:
  --help                         Show help                                                                                                                                                       [boolean]
  --debug                        Print debug logging for API calls                                                                                                                               [boolean]
  --configUrl, --config-url      URL pointing to the Fabric configuration, enclosed in quotes. e.g. for Eluvio demo network: --configUrl "https://demov3.net955210.contentfabric.io/config"       [string]
  --elvGeo, --elv-geo            Geographic region for the fabric nodes.                       [string] [choices: "as-east", "au-east", "eu-east", "eu-west", "na-east", "na-west-north", "na-west-south"]
  --objectId, --object-id        Object ID (should start with 'iq__')                                                                                                                             [string]
  --versionHash, --version-hash  Object Version Hash (should start with 'hq__')                                                                                                                   [string]
  --offeringKey                  offering key                                                                                                                                [string] [default: "default"]
  --streamKey                    comma separated list of offerings stream key                                                                                                  [string] [default: "video"]
  --startTime                    start time to retrieve parts in seconds                                                                                                               [number] [required]
  --endTime                      end time to retrieve parts in seconds                                                                                                                 [number] [required]
  --out                          output directory

eponymous301 · 2024-07-25T01:11:04Z

For consistency with other scripts I recommend renaming objectHash to versionHash and offeringType to offeringKey

Note also that rather than using TestConfiguration.json to set demov3 network you should be able to use --configUrl https://demov3.net955210.contentfabric.io/config in command line, or alternate option is to set env var FABRIC_CONFIG_URL=https://demov3.net955210.contentfabric.io/config

eponymous301

Looks good overall, I made some suggestions, the only ones that I feel strongly about are:

add a --streamKey argument (optionally defaulting to "video")
change --objectVersion to --versionHash and --offeringType to --offeringKey for consistency with other scripts
use default: ... in option() declarations instead of setting the value via || (this will make the default values show up automatically in help output when user is missing an option or specifies --help)

I also suggest renaming ObjectDownloadMedia.js to OfferingDownloadMedia.js to reflect the fact that it targets a single mez offering.

eponymous301 · 2024-07-25T01:14:33Z