HomeAboutCreate a transcode job.

Create a transcode job.

22Aug2011 Posted by admin

Create a transcode job.

Request URL

/mediafile/$mediafile_id/transcode [POST]

Request Authorization

This call needs EGA authentication.

Request Parameters

Parameter (Type)DescriptionRequiredDefault valueMax. length
mediafile_id (ALPHA_NUM)The mediafile ID.Required-
user_id (ALPHA_NUM)The user ID for owner of the mediafile.Required-
command (COMMAND)Command used with transcode, used with transcode job.Optional-
completed_transcoding_url (URL)Triggered when transcoding is completed.Optional-
create_still (BOOL)Create still after job run.OptionalFALSE-
end_frame (INT)Still end frame (in seconds, used when still_type is NORMAL or SECOND). Deprecrated, use end_time instead.Optional-
end_time (INT)Still end time (in seconds, used when still_type is NORMAL or SECOND).Optional-
file_extension (ALPHA_NUM)file extension of the file, used with transcode job.Optional-
file_size (INT)File size.Optional-
frametime (INT)Still frametime (in seconds) for still_type NONE.Optional-
group_id (ALPHA_NUM)The group ID.Optional-
h_padding (INT)Still horizontal padding.Optional-
mediamosa_version (MEDIAMOSA_VERSION)Provide the version to get the REST call returned in the format of the specified MediaMosa version. Keep empty or skip to retrieve in current (latest) version. Provide '2' to retrieve the REST call in 2.x format. Or be more specific by providing up to 3 digits; '2.3.0'. This setting will override any setting used by client application or the default setting in MediaMosa.Optional-
priority (INT)Priority of the job.Optional-
profile_id (INT)Profile ID, used with transcode job.Optional-
retranscode (BOOL)Retranscode after upload, user with upload jobs.OptionalFALSE-
size (STRING)Size of the still.Optional-
start_frame (INT)Still start frame (in seconds, used when still_type is NORMAL or SECOND). Deprecrated, use start_time instead.Optional-
start_time (INT)Still start time (in seconds, used when still_type is NORMAL or SECOND).Optional-
still_every_second (INT)Stills every second. (Used when still_type is SECOND).Optional-
still_per_mediafile (INT)Stills per mediafile. (Used when still_type is NORMAL).Optional-
still_type (STRING)The still type.
Value (when supplied) must be either "NONE" or "SCENE" or "SECOND" or "NORMAL" or "".		OptionalNONE-
tag (STRING)Still tag.Optional-
tool (STRING)Tool used for transcode, used with transcode job.Optional-
v_padding (INT)Still vertical padding.Optional-
watermark_dst_x (INT)X-coordinate of destination point of watermark.Optional0-
watermark_dst_y (INT)Y-coordinate of destination point of watermark.Optional0-
watermark_h_align (STRING)Horizontal align of watermark.
Value (when supplied) must be either "top" or "bottom".		Optionaltop-
watermark_id (ALPHA_NUM)The watermark ID.Optional-
watermark_pct (INT)Alpha transparency of watermark (watermark visibility in percentage [0 - 100%]).Optional75-
watermark_v_align (STRING)Vertical align of watermark.
Value (when supplied) must be either "left" or "right".		Optionalleft-

Example Request

mediafile/OW35AQyoPNUSi4iINunmS2nr/transcode

Example Response

<items>
  <item id="1">
    <job_id>14</job_id>
  </item>
</items>