HomeAboutUpload a mediafile.

Upload a mediafile.

22Aug2011 Posted by admin

Upload a mediafile.

Request URL

/mediafile/upload [PUT]

Request Authorization

This call needs EGA authentication.

Request Parameters

Parameter (Type)DescriptionRequiredDefault valueMax. length
filename (STRING)The filename of the media file (PUT method only, ignored otherwise).Required-
upload_ticket (TICKET_ID)The ID that has been given to enable the upload.Required-
user_id (ALPHA_NUM)User id, determined to check whether the applicant has the rights and quotas to upload the mediafile.Required-
app_id[] (APP_ID)The application ID.Optional0-
completed_transcoding_url (URL)This URL is called after the status of transcoding job changed.Optional-
completed_url (URL)This URL gives opportunity to the APP builder for a status raport; upload_ticket status_code The upload_ticket is used to identify the upload. The status_code is a MediaMosa code. The type is URL and not URI, because this parameter http:// or https://.Optional-
create_still (BOOL)Specify 'true', if you want a still is generated after the upload and analysis See: Still creation parameters (POST) on /mediafile/{mediafile_id}/still/create [POST].OptionalFALSE-
default (BOOL)Is default still? Only used when still_upload = true.OptionalFALSE-
end_frame (INT)Still end frame (in seconds, used when still_type is NORMAL or SECOND).Optional-
frametime (INT)Still frametime (in seconds) for still_type NONE and for still upload.Optional-
h_padding (INT)Still horizontal padding.Optional-
height (INT)Still height.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-
order (INT)Still order number. Only used when still_upload = true.Optional0-
redirect_uri (URL)The URL to redirect when upload has been successful.Optional-
retranscode (BOOL)if 'retranscode' is not put, all existing transcodes of the original media file will be lost. If 'retranscode' is 'true', then new transcode jobs will be created, which replace the existing transcodes..OptionalFALSE-
size (STRING)Size of the still.Optional-
start_frame (INT)Still start frame (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-
still_upload (BOOL)Specify TRUE for adding a still to the mediafile.OptionalFALSE-
tag (STRING)Mediafile tag to set. An empty tag will clear possible set mediafile tag.Optional-
transcode[] (INT)If one (or more) transcode profiles is in this parameter than the media file will be transcoded after the upload.Optional-
transcode_inherits_acl (BOOL)If 'true'; All the acl media rights will be copied to the new transcoded media file.OptionalFALSE-
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-
width (INT)Still width.Optional-

Example Request

[PUT] mediafile/upload

Example Response