DocumentationDynamic Media Image Production System API

MediaOptions mediaoptions

Last update: Fri Nov 11 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Generates thumbnail image for your video.

Syntax

Parameters section-2fc9bea56b6d4b72b80d4f04c5f9b862

Name
Type
Description
videoEncodingPresetsArray
types:HandleArray
An array of PropertySet handles referencing video encoding presets for transcoding videos.
generateThumbnail
xsd:boolean
When true, the first frame of the video is extracted and used as the thumbnail image.
thumbnailOptions
types:ThumbnailOptions

Optional. Lets you choose a particular video frame to use as the thumbnail image.

To specify a thumbnail image, pass in the time (in milliseconds from video start) for the frame you want to use. Values range from 0 to the end of the video.

Note: If you specify the time incorrectly, generateThumbnail defaults to true.

See ThumbnailOptions.

Example section-a9356de782d74af6933c39fa7ad12212

<complexType name="MediaOptions">
        <sequence>
            <element name="videoEncodingPresetsArray" type="types:HandleArray" minOccurs="0"/>
            <element name="generateThumbnail" type="xsd:boolean" minOccurs="0"/>
            <element name="thumbnailOptions" type="types:ThumbnailOptions" minOccurs="0"/>
        </sequence>
    </complexType>

Used by section-87cb83407198432c95eaa2db9f12f9db

The mediaOptions type is used by:

recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681