Description

This function converts an image to a new file format.

 The function uses ImageMagick's convert function and is subject to the same file type limitations.

When you call this function, the system creates a new file with the same filename and specified file extension. If the function does not recognize the output format, the function copies and renames the file and does not generate a failure message.

Examples 




$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$image_convert = $cpanel->api1('ImageManager','convert',array('public_html/images','jpg')); // Call the function.



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $image_convert = $cpliveapi->api1('ImageManager','convert',['public_html/images','jpg'] ); # Call the function.

 


<cpanel Module="ImageManager::convert($FORM('target','newtype'))">




cpapi1 --user=username ImageManager convert public_html/images jpg



Converting /home/user/test1.jpg to /home/user/test1. gif...........Done




Parameters

ParameterTypeDescriptionPossible ValuesExample
targetstring

Required

The image or directory with images to convert.

A valid directory or file path, relative to the cPanel account's home directory.public_html/images
newtypestring

Required

The format to which to convert the images.

A valid image format (for example, jpg or gif).jpg

Returns

This function returns a confirmation message.