Show Menu
TOPICS×

MediaOptions

Generates thumbnail image for your video.
Syntax

Parameters

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.

Example

<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

The mediaOptions type is used by: