Langkau ke kandungan
MS
Dapatkan kunci API
Semak dokumentasi

Panduan

Buat saluran pipa pengiriman media

unduh MP4 ke penyimpanan S3 pribadi, lanjutkan kembali setelah restart dan berikan akses aplikasi anda ke berkas yang telah diverifikasi.

Pada halaman ini

Apa yang akan Anda bangun

Satu item tahan lama bergerak dari video ID ke berkas aplikasi-siap. Keep setiap stage on disk sehingga proses baru dapat dilanjutkan dari hasil terakhir yang dikonfirmasi.

Paipline dan catatan disimpan
item.json
  → → kirim sekali → simpan lari + kerja ID
  → → pulihkan pekerjaan → delivery.json
  → → verifikasi S3 bytes → media.mp4 + ready.json
  → → → otorisasi pengguna aplikasi → unduhan berumur pendek URL

Sebelum kau mulai

Pilih satu jalan untuk semua enam langkah. Keduanya menggunakan sebuah terpasang FlashData CLI Dia dengan profil pemilik tersimpan dan... youtube_download Keizinan, pribadi S3 storage.json upload, dan identitas AWS yang dapat membaca objek yang disampaikan.

Gunakan Python 3.10+ di lingkungan Python Anda. Naskah-naskah tersebut menyebut CLI untuk melestarikan jurnal yang dijalankannya, dan Boto3 untuk membaca S3 dan menandatangani link. Bash, jq, Node.js dan AWS CLI tidak diperlukan. Lakukan perintah di bawah ini dengan python, atau python3 jika itu adalah nama penterjemah Anda.

Pasang dependensi Python
python --version
flashdata --version
python -m pip install boto3

Simpan pengaturan waktu jalan

Buat folder barang pribadi di luar kendali sumber. Simpan pengaturan untuk jalur yang Anda pilih dan sunting jalur mutlak dan nama profil. Setiap proses menggunakan akun yang disimpan dan menjalankan jurnal. Kelayakan penyimpanan berada di storage.json pribadi. Jalankan satu proses per item pada satu waktu.

Simpan pipeline.json. Pada Windows, jalur garis depan-slash seperti C:/private/flashdata-state bekerja di JSON.

pipeline.json
{
  "stateDir": "/absolute/path/to/flashdata-state",
  "storageConfig": "/absolute/path/to/private/storage.json",
  "profile": "default"
}

1. Simpan satu barang tahan lama

Simpan item.json di folder itu. Medisco Gantikan tujuan video dan S3; contoh ini meminta satu MP4 pada hingga 720p. Tetap jaga runId untuk ulangan. output yang direncanakan berbeda membutuhkan runId baru dan awalan objek.

item.json
{
  "runId": "media:clip-001:720p:v1",
  "request": {
    "source": "youtube_download",
    "video_id": "jNQXAC9IVRw",
    "params": {
      "download_type": "audio_video",
      "video_quality": "<=720",
      "output_format": "mp4"
    }
  },
  "destination": {
    "bucket": "your-media-bucket",
    "region": "us-east-1",
    "prefix": "media/clip-001-v1"
  }
}

2. Simpan skrip dan cek akses

Buat berkas di bawah ini sebelum menjalankan pemeriksaan. Haqler Ini memvalidasi tujuan S3 dan menyimpan penerimaan untuk setiap percobaan pengiriman.

Buat skrip pipa

Cipta pipeline.py Di dalam folder yang sama seperti pipeline.json Dan item.json. Salin kode lengkap di bawah ini ke dalam file itu dan menyimpannya. Anda akan menggunakannya kembali untuk pemeriksaan, penyerahan dan pemulihan dalam langkah 2–4.

pipeline.py
# pipeline.py — Python 3.10+ and the FlashData CLI on PATH.
import argparse
import json
import os
import subprocess
import sys
import tempfile
from pathlib import Path

ROOT = Path(__file__).resolve().parent


def read_json(path):
    return json.loads(Path(path).read_text(encoding='utf-8-sig'))


def delivery_directory():
    # Recovery updates this pointer only after the delivery is saved successfully.
    return ROOT / (ROOT / 'delivery-dir.txt').read_text(encoding='utf-8').strip()


def main(action):
    os.umask(0o077)
    settings = read_json(ROOT / 'pipeline.json')
    for name in ['stateDir', 'storageConfig']:
        if not Path(settings[name]).is_absolute():
            raise ValueError('Set an absolute path for ' + name)
    item = read_json(ROOT / 'item.json')
    run_id = item['runId']
    env = dict(os.environ)
    env.pop('FLASHDATA_API_KEY', None)  # Reuse the saved owner profile.
    flags = ['--profile', settings['profile'], '--state-dir', settings['stateDir'],
             '--json', '--non-interactive']

    def cli(*args, payload=None, attempt=None):
        result = subprocess.run(['flashdata', *args, *flags], cwd=ROOT, env=env,
                                input=json.dumps(payload) if payload is not None else None,
                                capture_output=True, text=True, encoding='utf-8')
        if attempt:
            (attempt / 'receipt.json').write_text(result.stdout, encoding='utf-8')
            (attempt / 'error.json').write_text(result.stderr, encoding='utf-8')
        if result.returncode:
            if attempt:
                raise RuntimeError('Keep ' + str(attempt) + '; inspect its error and saved run.')
            raise RuntimeError(result.stderr.strip() or 'FlashData command failed.')
        response = json.loads(result.stdout)
        if not response.get('ok'):
            raise RuntimeError('Inspect the CLI response before continuing.')
        return response

    def new_attempt(stage):
        attempts = ROOT / 'attempts'
        attempts.mkdir(exist_ok=True)
        return Path(tempfile.mkdtemp(prefix=stage + '.', dir=attempts))

    if action == 'check':
        access = cli('auth', 'status')['data']
        identity = access['identity']
        if (not access.get('accessVerified')
                or identity['identity'].get('recurringAllowed') is not True
                or 'youtube_download' not in identity.get('permittedSources', [])):
            raise ValueError('Owner access with youtube_download is required.')
        print(json.dumps({'accountId': identity['identity']['accountId'],
                          'permittedSources': identity['permittedSources']}, indent=2))
        for args in [('account', 'balance'),
                     ('account', 'pricing', '--source', 'youtube_download', '--request-count', '1'),
                     ('account', 'limits')]:
            print(json.dumps(cli(*args)['data'], indent=2))
    elif action in ['dry-run', 'submit']:
        storage = read_json(settings['storageConfig'])
        destination = item['destination']
        if (item['request']['source'] != 'youtube_download'
                or storage.get('storage_type') != 's3'
                or storage.get('storage_url') != destination['bucket']
                or storage.get('region') != destination['region']):
            raise ValueError('Check item.json and the S3 destination in storage.json.')
        request = item['request']
        request['params']['storage'] = {**storage, 'object_prefix': destination['prefix']}
        args = ['query', '--input', '-', '--mode', 'async', '--run-id', run_id]
        if action == 'dry-run':
            response = cli(*args, '--dry-run', payload=request)
            if response['data'].get('dryRun') is not True:
                raise ValueError('Expected a dry-run result.')
            print(json.dumps({'ok': True, 'dryRun': True}))
        else:
            attempt = new_attempt('submit')
            response = cli(*args, '--output', str(attempt / 'submission.json'),
                           payload=request, attempt=attempt)
            print(json.dumps({'runId': run_id, 'cached': response.get('cached'),
                              'receipt': str(attempt / 'submission.json')}, indent=2))
    elif action == 'inspect':
        run = cli('runs', 'show', run_id)['data']
        print(json.dumps({'runId': run_id, 'status': run['status'], 'jobId': run.get('remoteId'),
                          'errorCode': run.get('errorCode'),
                          'candidateJobIds': run.get('candidateRemoteIds')}, indent=2))
    elif action == 'recover':
        attempt = new_attempt('recover')
        cli('runs', 'recover', run_id, '--timeout', '10m',
            '--output', str(attempt / 'delivery.json'), attempt=attempt)
        run = cli('runs', 'show', run_id)
        (attempt / 'run.json').write_text(json.dumps(run, indent=2), encoding='utf-8')
        delivery = read_json(attempt / 'delivery.json')
        if delivery.get('source') != 'youtube_download' or delivery.get('status') != 'done':
            raise ValueError('Inspect the saved delivery before verifying.')
        pointer = ROOT / 'delivery-dir.next'
        pointer.write_text(attempt.relative_to(ROOT).as_posix(), encoding='utf-8')
        pointer.replace(ROOT / 'delivery-dir.txt')
        print('Delivery files:', attempt)
    elif action == 'delivery':
        delivery = read_json(delivery_directory() / 'delivery.json')
        print(json.dumps({'status': delivery['status'], 'file': delivery['results'][0],
                          'usage': delivery.get('usage')}, indent=2))


if __name__ == '__main__':
    sys.stdout.reconfigure(encoding='utf-8')
    sys.stderr.reconfigure(encoding='utf-8')
    parser = argparse.ArgumentParser()
    parser.add_argument('action', choices=['check', 'dry-run', 'submit', 'inspect', 'recover', 'delivery'])
    try:
        main(parser.parse_args().action)
    except (OSError, ValueError, KeyError, RuntimeError) as error:
        print(str(error), file=sys.stderr)
        sys.exit(1)

Periksa rekening tersimpan Anda

Jalankan cek gratis ini dari folder item setelah menyimpan skrip. Akses pemilik yang hilang atau izin youtube_download menghentikan pemeriksaan. Konfirmasi akun ID, saldo, per-TB tingkat dan batas. Cas terakhir tergantung pada byte yang diunggah.

Periksa lingkungan dan akun
python pipeline.py check

Kesahihan disahkan tanpa memuat turun

Setelah menyelamatkan pembantu, jalankan lari kering. Python Sidik jari ok: true Dan dryRun: true; Bash sidik jari true. Ini memvalidasi masukan dan akses tanpa mengirimkan media kerja atau memperoleh kredit.

Kering kering bebas kering
python pipeline.py dry-run

3. Diserahkan dan mempertahankan pekerjaan ID

Ini menyerahkan satu unduhan latar belakang berbayar. Expect status: accepted dan jobId dalam jangka lokal. ¡Keep the profile, state directory dan item.json untuk pemulihan. Media baru siap setelah langkah 5.

Lepaskan aku sekali
python pipeline.py submit
Periksa keadaan setempat · tidak ada pertanyaan baru
python pipeline.py inspect

Jika larian sudah disimpan atau tidak pasti

keadaan CLIAksi
accepted + jobIdPemulihan ini dijalankan dalam langkah 4. Pertahankan pekerjaan ID jika prosesnya berhenti.
succeededRecover/export responnya disimpan, kemudian memverifikasi penyimpanan. Jangan menyerahkan barang baru.
Hasil tidak diketahui / tidak ada pekerjaan dikonfirmasi IDTetap jalankan, penerimaan dan kesalahan. Periksa History atau kandidat IDs sebelum memutuskan penyerahan lain.

4. Kemulihkan kembali catatan pengiriman

Jalankan dari folder item di terminal baru. Recovery menunggu pekerjaan asli dan mencetak direktori yang berisi delivery.json, run.json dan penerimaan. Eksekusi 10-menit berhenti menunggu lokal; pemulihan ulang untuk melanjutkan pekerjaan yang sama.

Kembali melanjutkan pekerjaan yang disimpan

Andai ulang pipeline.py disimpan dalam langkah 2. Tidak ada skrip tambahan yang diperlukan.

Memulihkan pekerjaan yang sudah ada · tidak ada penyerahan baru
python pipeline.py recover

Periksalah objek yang disampaikan

Satu orang yang diharapkan S3 Objek URL, ukuran file positif dan sebuah MD5. Benda pribadimu butuh identitas AWS-mu. Python menyimpan direktori sukses dalam delivery-dir.txt untuk skrip kemudian. Bash menyimpan DELIVERY_DIR; dalam terminal baru, set ke direktori tercetak.

Catatan pengiriman
python pipeline.py delivery

5. Verifikasi bytes sebelum tandaan siap

Pemverifikasi ANEVeris memeriksa input asli, ember dan awalan S3, stream objek pribadi ke disk, dan membandingkan jumlah bytenya dan MD5. Hanya berkas yang cocok dengan plasma yang menghasilkan verified/ready.json. Python dibaca delivery-dir.txt; ¡Node menggunakan DELIVERY_DIR. Tak ada yang mengajukan pertanyaan FlashData.

Simpan skrip verifikasi

Pemverifikasi fahteri ini menangani Amazon S3 standar objek URLs. Untuk titik akhir langganan atau penyedia lain, gunakan objek terotentikasinya yang dibaca dan mempertahankan tujuan yang sama, pemeriksaan byte-count dan checksum.

Buat verify-media.py di samping pipeline.py dan salin kode lengkap di bawah ke dalamnya. Simpan kedua berkas dalam folder item.

verify-media.py
# verify-media.py — uses Boto3's configured AWS read identity.
import hashlib
import json
import os
import re
import sys
from contextlib import closing
from datetime import datetime, timezone
from urllib.parse import unquote, urlsplit

import boto3
from pipeline import ROOT, delivery_directory, read_json


def main():
    os.umask(0o077)
    directory = delivery_directory()
    item = read_json(ROOT / 'item.json')
    saved = read_json(directory / 'run.json')
    raw = (directory / 'delivery.json').read_bytes()
    delivery = json.loads(raw)
    run = saved.get('data', {})
    if (not saved.get('ok') or run.get('id') != item['runId']
            or run.get('status') != 'succeeded' or not run.get('remoteId')
            or delivery.get('source') != 'youtube_download' or delivery.get('status') != 'done'
            or not isinstance(delivery.get('results'), list) or len(delivery['results']) != 1):
        raise ValueError('Inspect the saved run and completed delivery before verifying.')
    file = delivery['results'][0]
    bucket, region, prefix = (item['destination'][key] for key in ['bucket', 'region', 'prefix'])
    original = run.get('input', {})
    storage = original.get('params', {}).get('storage', {})
    if (original.get('source') != 'youtube_download' or original.get('video_id') != item['request']['video_id']
            or any(original.get('params', {}).get(key) != item['request']['params'][key]
                   for key in ['download_type', 'video_quality', 'output_format'])
            or storage.get('storage_url') != bucket or storage.get('region') != region
            or storage.get('object_prefix') != prefix):
        raise ValueError('item.json changed after submission. Inspect the original run.')
    url = urlsplit(file['file_url'])
    hosts = [bucket + '.s3.' + region + '.amazonaws.com', bucket + '.s3.amazonaws.com']
    key = unquote(url.path[1:], errors='strict')
    if (url.scheme != 'https' or url.netloc not in hosts or url.query or url.fragment
            or not prefix or not key.startswith(prefix + '/')):
        raise ValueError('The delivery does not match the planned Amazon S3 destination.')
    if (type(file.get('file_size')) is not int or file['file_size'] <= 0
            or not re.fullmatch(r'[a-fA-F0-9]{32}', file.get('md5', ''))):
        raise ValueError('A positive file_size and MD5 are required. Keep the manifest.')
    verification = directory / 'verified'
    verification.mkdir(mode=0o700)  # Stop if an earlier verification already exists.
    local_file = verification / 'media.mp4'
    s3 = boto3.client('s3', region_name=region)
    response = s3.get_object(Bucket=bucket, Key=key)
    size, digest = 0, hashlib.md5(usedforsecurity=False)
    with closing(response['Body']) as stream, local_file.open('xb') as output:
        while chunk := stream.read(1024 * 1024):
            output.write(chunk)
            size += len(chunk)
            digest.update(chunk)
    md5 = digest.hexdigest()
    if size != file['file_size'] or md5 != file['md5'].lower():
        raise ValueError('Byte count or MD5 mismatch. Keep the file; do not mark it ready.')
    ready = {'runId': item['runId'], 'jobId': run['remoteId'], 'videoId': item['request']['video_id'],
             'bucket': bucket, 'region': region, 'objectKey': key,
             'storageVersionId': response.get('VersionId'), 'bytes': size, 'md5': md5,
             'verifiedAt': datetime.now(timezone.utc).isoformat(), 'localFile': str(local_file.resolve()),
             'deliverySha256': hashlib.sha256(raw).hexdigest(), 'usage': delivery.get('usage')}
    with (verification / 'ready.json').open('x', encoding='utf-8') as output:
        json.dump(ready, output, indent=2)
    print('Delivery verified:', verification / 'ready.json')
    print(json.dumps(ready, indent=2))


if __name__ == '__main__':
    sys.stdout.reconfigure(encoding='utf-8')
    sys.stderr.reconfigure(encoding='utf-8')
    try:
        main()
    except Exception as error:
        print(str(error), file=sys.stderr)
        sys.exit(1)

Jalankan verifikasi

Setelah menyimpan naskah, jalankan dari folder item.

Verifikasi dan baca catatan handoff
python verify-media.py

Berikan ready.json ke aplikasi Anda

Memverifikasi Pengiriman Terjangkapan Kesiapan dan sebuah rekor yang berisi run/job IDs, ember, wilayah, kunci objek, ukuran terverifikasi dan MD5. Ini adalah catatan aplikasi Anda, yang dibuat oleh naskah. Diarsipkan dengan delivery.json dan item asli; ia bertahan dari jendela retensi hasil API.

Untuk transkripsi, pengindeksan atau pengolahan lainnya, lulus localFile yang diverifikasi ke pekerja Anda. Untuk unduhan ke-penggunaan, lanjutkan dengan langkah 6.

6. Berikan akses kontrol aplikasi Anda

Di bagian belakang belakang Anda, otorisasi pengguna dan carilah catatan siap pengguna itu di toko Anda sendiri. Kemudian menciptakan umur pendek S3 download URL. Gunakan destinasi tersimpan; jangan terima ember atau kunci objek yang disuplai oleh peramban.

AWS read identity (identitas baca AWS) milik SDK menggunakan backend. Tak ada pertanyaan FlashData yang dikirim.

URL menamai versi objek terverifikasi ketika versi S3 menyediakan satu. Tanpa versi ID, jaga setiap kunci keluaran tidak dapat dibenamkan setelah verifikasi. Identikasi pencarian identitas membaca versi spesifik membutuhkan s3:GetObjectVersion; bacaan tanpa versi membutuhkan s3:GetObject.

Buat create-download-link.py di samping pipeline.py dan salin kode lengkap di bawah ke dalamnya. Ini menggunakan paket Boto3 yang dipasang pada awal.

create-download-link.py
# create-download-link.py — run in your backend after authorizing the user.
import json
import os
import sys

import boto3
from botocore.config import Config
from pipeline import delivery_directory, read_json


def main():
    os.umask(0o077)
    # In an app, load this user's verified ready record from your own store.
    directory = delivery_directory() / 'verified'
    ready = read_json(directory / 'ready.json')
    if any(not isinstance(ready.get(key), str) or not ready[key]
           for key in ['bucket', 'region', 'objectKey', 'verifiedAt']):
        raise ValueError('Use the ready.json produced by the verification step.')
    destination = directory / 'access.json'
    if destination.exists():
        raise FileExistsError('Keep the existing access.json or choose a new output filename.')
    params = {'Bucket': ready['bucket'], 'Key': ready['objectKey']}
    version = ready.get('storageVersionId')
    if version and version != 'null':
        params['VersionId'] = version
    s3 = boto3.client('s3', region_name=ready['region'], config=Config(signature_version='s3v4'))
    url = s3.generate_presigned_url('get_object', Params=params, ExpiresIn=300, HttpMethod='GET')
    with destination.open('x', encoding='utf-8') as output:
        json.dump({'url': url, 'expiresInSeconds': 300}, output, indent=2)
    # Do not log the signed URL; return it only to the authorized user.
    print('Access record saved:', destination)


if __name__ == '__main__':
    sys.stdout.reconfigure(encoding='utf-8')
    sys.stderr.reconfigure(encoding='utf-8')
    try:
        main()
    except Exception as error:
        print(str(error), file=sys.stderr)
        sys.exit(1)

Keharapan sebuah access.json swasta berisi url dan expiresInSeconds: 300. Rend Anda mengembalikan hanya URL ke pengguna yang berwenang. Siapapun yang memegangnya dapat mengunduh berkasnya hingga lima menit; mungkin akan berakhir lebih awal dengan tanda tangan.

¡Membuat link baru dari rekor siap tersimpan ketika pengguna selanjutnya meminta akses. Keep object kunci dan versi dalam database Anda, daripada menyimpan URL yang luput sebagai alamat aset. Contoh lokal ini berhenti jika access.json sudah ada.

Cipta pautan lima minit
python create-download-link.py

Restart dari tahap terakhir yang dikonfirmasi

Situasi Orang AsingTindakan berikutnya
Menerima pekerjaan / lokal menunggu waktu habisMengulang runs recover dengan runId yang sama ke dalam direktori percobaan baru.
S3 Akses ditolak atau disampukAWS membaca identitas atau koneksi. Kemulih ke direktori segar dan sahkan lagi; simpan berkas parsial sebelumnya.
Jumlah byte / MD5 / tujuan tidak cocokHentikan. Bandingkan manifes, versi objek dan tujuan yang direncanakan sebelum menggunakan media.
Terverifikasi/ sudah adaTesophinea membaca ready.json, atau memeriksa verifikasinya yang tidak lengkap. Naskah tidak akan menimpanya.
Gagal memuat turun aplikasi URLOtorisasi akses lagi dan tanda tangani object/version. yang disimpan Jangan masukkan FlashData lain.
run_id_input_conflictPermintaan itu berubah. Pulihkan larian asli; gunakan runId baru hanya untuk keluaran baru yang disengaja.
401 / 403 / 402 / 429Baiki akses, izin atau keseimbangan; ikuti Retry-After. Periksa karya yang disimpan sebelum mencoba kembali penyerahan.

Terapkan tahap yang sama ke antrian

  1. Mulailah dengan satu barang in-flight. LUDA Baca batasan arus sebelum meningkatkan konkurensi aplikasi.
  2. Simpan satu runId tahan lama untuk setiap versi video/output, dengan awalan tujuan yang berbeda. Simpan rekeningnya, pekerjaan ID dan hasil akhir di database aplikasimu.
  3. Coather Persist direktori keadaan CLI melintasi proses restart. Mesin-mesin yang terpisah-pisah transformer membutuhkan koordinasi aplikasi bersama; sebuah jurnal run lokal tidak menduplikasikan direktori negara bebas.
  4. Use ready.json sebagai handoff untuk hilir pengolahan. Barang-barang yang gagal secara individual sehingga pengiriman sukses digunakan kembali.