Skip to content

Latest commit

 

History

History
208 lines (175 loc) · 5.32 KB

README.md

File metadata and controls

208 lines (175 loc) · 5.32 KB
Raw

Transcode

(transcode)

Overview

Operations related to transcode api

Available Operations

create

POST /transcode transcodes a video file and uploads the results to the specified storage service.

Transcoding is asynchronous so you will need to check the status of the task in order to determine when transcoding is complete. The id field in the response is the unique ID for the transcoding Task. The task status can be queried using the GET tasks endpoint:

When status.phase is completed, transcoding will be complete and the results will be stored in the storage service and the specified output location.

The results will be available under params.outputs.hls.path and params.outputs.mp4.path in the specified storage service.

Input


This endpoint currently supports the following inputs:

  • HTTP
  • S3 API Compatible Service

    HTTP
    A public HTTP URL can be used to read a video file.
{
    "url": "https://www.example.com/video.mp4"
}
Name Type Description
url string A public HTTP URL for the video file.

Note: For IPFS HTTP gateway URLs, the API currently only supports “path style” URLs and does not support “subdomain style” URLs. The API will support both styles of URLs in a future update.

S3 API Compatible Service

S3 credentials can be used to authenticate with a S3 API compatible service to read a video file.

{
    "type": "s3",
    "endpoint": "https://gateway.storjshare.io",
    "credentials": {
        "accessKeyId": "$ACCESS_KEY_ID",
        "secretAccessKey": "$SECRET_ACCESS_KEY"
    },
    "bucket": "inbucket",
    "path": "/video/source.mp4"
}

Storage


This endpoint currently supports the following storage services:

  • S3 API Compatible Service
  • Web3 Storage

    S3 API Compatible Service
{
  "type": "s3",
    "endpoint": "https://gateway.storjshare.io",
    "credentials": {
        "accessKeyId": "$ACCESS_KEY_ID",
        "secretAccessKey": "$SECRET_ACCESS_KEY"
    },
    "bucket": "mybucket"
}

Web3 Storage

{
  "type": "web3.storage",
    "credentials": {
        "proof": "$UCAN_DELEGATION_PROOF",
    }
}

Outputs


This endpoint currently supports the following output types:

  • HLS
  • MP4

HLS

{
  "hls": {
        "path": "/samplevideo/hls"
    }
}

MP4

{
  "mp4": {
        "path": "/samplevideo/mp4"
    }
}

Example Usage

from livepeer import Livepeer
from livepeer.models import components

s = Livepeer(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.transcode.create(request={
    "input": {
        "url": "https://s3.amazonaws.com/bucket/file.mp4",
    },
    "storage": {
        "type": components.StorageType.S3,
        "endpoint": "https://gateway.storjshare.io",
        "bucket": "outputbucket",
        "credentials": {
            "access_key_id": "AKIAIOSFODNN7EXAMPLE",
            "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
        },
    },
    "outputs": {
        "hls": {
            "path": "/samplevideo/hls",
        },
        "mp4": {
            "path": "/samplevideo/mp4",
        },
        "fmp4": {
            "path": "/samplevideo/fmp4",
        },
    },
    "profiles": [
        {
            "bitrate": 3000000,
            "width": 1280,
            "name": "720p",
            "height": 720,
            "quality": 23,
            "fps": 30,
            "fps_den": 1,
            "gop": "2",
            "profile": components.TranscodeProfileProfile.H264_BASELINE,
            "encoder": components.TranscodeProfileEncoder.H_264,
        },
    ],
})

if res.task is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request components.TranscodePayload ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.TranscodeVideoResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /