Skip to content

Latest commit

 

History

History
383 lines (275 loc) · 14.6 KB

README.md

File metadata and controls

383 lines (275 loc) · 14.6 KB

Asset

(asset)

Overview

Operations related to asset/vod api

Available Operations

get_all

Retrieve assets

Example Usage

from livepeer import Livepeer

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

res = s.asset.get_all()

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

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetAssetsResponse

Errors

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

create

To upload an asset, your first need to request for a direct upload URL and only then actually upload the contents of the asset.

Once you created a upload link, you have 2 options, resumable or direct upload. For a more reliable experience, you should use resumable uploads which will work better for users with unreliable or slow network connections. If you want a simpler implementation though, you should just use a direct upload.

Direct Upload

For a direct upload, make a PUT request to the URL received in the url field of the response above, with the raw video file as the request body. response above:

Resumable Upload

Livepeer supports resumable uploads via Tus. This section provides a simple example of how to use tus-js-client to upload a video file.

From the previous section, we generated a URL to upload a video file to Livepeer on POST /api/asset/request-upload. You should use the tusEndpoint field of the response to upload the video file and track the progress:

# This assumes there is an `input` element of `type="file"` with id
`fileInput` in the HTML


const input = document.getElementById('fileInput');

const file = input.files[0];

const upload = new tus.Upload(file, {
  endpoint: tusEndpoint, // URL from `tusEndpoint` field in the
`/request-upload` response
  metadata: {
    filename,
    filetype: 'video/mp4',
  },
  uploadSize: file.size,
  onError(err) {
    console.error('Error uploading file:', err);
  },
  onProgress(bytesUploaded, bytesTotal) {
    const percentage = ((bytesUploaded / bytesTotal) * 100).toFixed(2);
    console.log('Uploaded ' + percentage + '%');
  },
  onSuccess() {
    console.log('Upload finished:', upload.url);
  },
});

const previousUploads = await upload.findPreviousUploads();

if (previousUploads.length > 0) {
  upload.resumeFromPreviousUpload(previousUploads[0]);
}

upload.start();

Note: If you are using tus from node.js, you need to add a custom URL storage to enable resuming from previous uploads. On the browser, this is enabled by default using local storage. In node.js, add urlStorage: new tus.FileUrlStorage("path/to/tmp/file"), to the UploadFile object definition above.

Example Usage

from livepeer import Livepeer
from livepeer.models import components

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

res = s.asset.create(request={
    "name": "filename.mp4",
    "static_mp4": True,
    "playback_policy": {
        "type": components.Type.WEBHOOK,
        "webhook_id": "1bde4o2i6xycudoy",
        "webhook_context": {
            "streamerId": "my-custom-id",
        },
        "refresh_interval": 600,
    },
    "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.data is not None:
    # handle response
    pass

Parameters

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

Response

operations.RequestUploadResponse

Errors

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

create_via_url

Upload asset via URL

Example Usage

from livepeer import Livepeer
from livepeer.models import components

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

res = s.asset.create_via_url(request={
    "name": "filename.mp4",
    "url": "https://s3.amazonaws.com/my-bucket/path/filename.mp4",
    "static_mp4": True,
    "playback_policy": {
        "type": components.Type.WEBHOOK,
        "webhook_id": "1bde4o2i6xycudoy",
        "webhook_context": {
            "streamerId": "my-custom-id",
        },
        "refresh_interval": 600,
    },
    "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.two_hundred_application_json_data is not None:
    # handle response
    pass

Parameters

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

Response

operations.UploadAssetResponse

Errors

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

get

Retrieves an asset

Example Usage

from livepeer import Livepeer

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

res = s.asset.get(asset_id="<value>")

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

Parameters

Parameter Type Required Description
asset_id str ✔️ ID of the asset
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetAssetResponse

Errors

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

update

Patch an asset

Example Usage

from livepeer import Livepeer
from livepeer.models import components

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

res = s.asset.update(asset_id="<value>", asset_patch_payload={
    "name": "filename.mp4",
    "playback_policy": {
        "type": components.Type.WEBHOOK,
        "webhook_id": "1bde4o2i6xycudoy",
        "webhook_context": {
            "streamerId": "my-custom-id",
        },
        "refresh_interval": 600,
    },
})

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

Parameters

Parameter Type Required Description
asset_id str ✔️ ID of the asset
asset_patch_payload components.AssetPatchPayload ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpdateAssetResponse

Errors

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

delete

Delete an asset

Example Usage

from livepeer import Livepeer

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

res = s.asset.delete(asset_id="<value>")

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
asset_id str ✔️ ID of the asset
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.DeleteAssetResponse

Errors

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