Manage Videos

Add output codec to video

Changed on

Encodes and adds an additional output codec to an already-encoded video. Requires Premium Encoding to be enabled for the library and the codec to already be enabled for the library, and fails if the original source file is missing or the codec was already processed.

put/library/{libraryId}/videos/{videoId}/outputs/{outputCodecId}

Request

Path parameters

libraryIdinteger required

The ID of the video library.

videoIdstring guid required

The GUID of the video.

0 required
OR
1 required
OR
2 required
OR
3 required

The output codec to encode and add, must already be enabled for the library.

Response

The details of the requested video

videoLibraryIdinteger required

The ID of the video library that the video belongs to

guidstring required

The unique ID of the video

titlestring required

The title of the video

descriptionstring nullable

The description of the video

dateUploadedstring date-time required

The date when the video was uploaded

viewsinteger required

The number of views the video received

isPublicboolean required

Determines if the video is publically accessible

lengthinteger required

The duration of the video in seconds

frameratenumber double required

The framerate of the video

rotationinteger nullable

Rotation of the source file in degrees as read from container metadata (e.g. 90, -90, 180, 270); null when no rotation metadata is present.

widthinteger required

The width of the original video file

heightinteger required

The height of the original video file

availableResolutionsstring nullable

Comma-separated list of resolution labels (e.g. "360p,720p,1080p") that have finished encoding and are available for playback.

outputCodecsstring required

Comma-separated list of output codecs generated for this video (e.g. "x264,vp9"). See EncoderOutputCodec for possible values.

thumbnailCountinteger required

The number of thumbnails generated for this video

encodeProgressinteger required

Encoding progress as a percentage from 0 to 100; reaches 100 when transcoding finishes.

storageSizeinteger required

Total storage used by this video, in bytes.

hasMP4Fallbackboolean required

Determines if the video has MP4 fallback files generated

collectionIdstring nullable

The ID of the collection where the video belongs

thumbnailFileNamestring nullable

The file name of the thumbnail inside of the storage

thumbnailUrlstring nullable

The CDN URL of the thumbnail

thumbnailBlurhashstring nullable

Thumbnail blurhash to show while the actual thumbnail is being loaded

averageWatchTimeinteger required

The average watch time of the video in seconds

totalWatchTimeinteger required

The total video watch time in seconds

categorystring nullable

Automatically detected content category label; "untagged" when no category has been determined yet.

jitEncodingEnabledboolean nullable

Whether just-in-time encoding is enabled for this specific video, overriding the video library's default JitEncodingEnabled setting when set. Null means the library default applies.

hasOriginalboolean nullable

Determines if video has the original file available in storage

originalHashstring nullable

Original uploaded file SHA256 hash

hasHighQualityPreviewboolean nullable

Whether a high-quality animated preview has been generated for this video.

Changes

    • breaking

      removed the enum value 0.00 from the path request parameter outputCodecId

    • breaking

      removed the enum value 1.00 from the path request parameter outputCodecId

    • breaking

      removed the enum value 2.00 from the path request parameter outputCodecId

    • breaking

      removed the enum value 3.00 from the path request parameter outputCodecId

    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      added subschema #1: Created subschema #2: Uploaded subschema #3: Processing subschema #4: Transcoding subschema #5: Finished subschema #6: Error subschema #7: UploadFailed subschema #8: JitSegmenting subschema #9: JitPlaylistsCreated to the //// response property oneOf list for the response status

    • breaking

      added subschema #1: None subschema #2: Queued subschema #3: InProgress subschema #4: Finished subschema #5: Failed to the //// response property oneOf list for the response status

    • breaking

      the // response's property type changed from integer to no type for status

    • breaking

      the // response's property type changed from integer to no type for status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the 0.00 enum value from the //// response property for the response status

    • info

      removed the 0.00 enum value from the //// response property for the response status

    • info

      removed the 0.00 enum value from the // response property for the response status

    • info

      removed the 0.00 enum value from the // response property for the response status

    • info

      removed the 1.00 enum value from the //// response property for the response status

    • info

      removed the 1.00 enum value from the //// response property for the response status

    • info

      removed the 1.00 enum value from the // response property for the response status

    • info

      removed the 1.00 enum value from the // response property for the response status

    • info

      removed the 10.00 enum value from the // response property for the response status

    • info

      removed the 11.00 enum value from the // response property for the response status

    • info

      removed the 2.00 enum value from the //// response property for the response status

    • info

      removed the 2.00 enum value from the //// response property for the response status

    • info

      removed the 2.00 enum value from the // response property for the response status

    • info

      removed the 2.00 enum value from the // response property for the response status

    • info

      removed the 3.00 enum value from the //// response property for the response status

    • info

      removed the 3.00 enum value from the //// response property for the response status

    • info

      removed the 3.00 enum value from the // response property for the response status

    • info

      removed the 3.00 enum value from the // response property for the response status

    • info

      removed the 4.00 enum value from the //// response property for the response status

    • info

      removed the 4.00 enum value from the //// response property for the response status

    • info

      removed the 4.00 enum value from the // response property for the response status

    • info

      removed the 5.00 enum value from the //// response property for the response status

    • info

      removed the 5.00 enum value from the // response property for the response status

    • info

      removed the 6.00 enum value from the //// response property for the response status

    • info

      removed the 6.00 enum value from the // response property for the response status

    • info

      removed the 7.00 enum value from the //// response property for the response status

    • info

      removed the 7.00 enum value from the // response property for the response status

    • info

      removed the 8.00 enum value from the //// response property for the response status

    • info

      removed the 8.00 enum value from the // response property for the response status

    • info

      removed the 9.00 enum value from the // response property for the response status