@dolbyio/dolbyio-rest-apis-client - v6.0.0
    Preparing search index...

    Interface RegisterMediaAssetRequest

    The information required to register a media asset.

    interface RegisterMediaAssetRequest {
        customPath?: string;
        entrypoint?: string;
        expiration?: string;
        mediaDistributionId?: string;
        name?: string;
        objectPrefix: string;
    }
    Index

    Properties

    customPath? entrypoint? expiration? mediaDistributionId? name? objectPrefix

    Properties

    customPath?: string

    Customise the download url path.

    entrypoint?: string

    Optional. Specify the entry point to the media using its filename relative to the objectPrefix e.g. main.m3u8. This ensures that the discovery url returned by our service links to the file. If an object with key s3://<bucketName>/<objectPrefix>/<entrypoint> is not found, then the registration process will fail.

    expiration?: string

    Optional. If not specified, media asset never expires. ISO 8601 format should be used (eg 2020-01-01T00:00:00Z), all times are expected to be UTC.

    mediaDistributionId?: string

    ID of the media distribution used to authenticate viewing of this media asset.

    name?: string

    Optional. Provide a label for the media asset.

    objectPrefix: string

    Provide the prefix to the location where files have been uploaded. We will inspect our internal storage for this objectPrefix and if we find:

    • An exact match - we will obtain and serve a copy of the single file and ignore any prefix matches
    • A prefix match - we will obtain and serve a copy of all the content under the specified prefix (i.e. files under s3:////)

    Settings

    Member Visibility

    On This Page

    Properties