Convert url or filelink handle to another audio format. IMPORTANT: To use this function, you must setup webhooks to notify you when the transcoding has completed. See our online documentation for more details: https://www.filestack.com/docs/audio-transformations
Signature
public function convertAudio(string
$resource,
string
$format,
[array
$options = ,
[boolean
$force = false]] )
Parameters
$resource
—
string
url or file handle
$format
—
string
The format to which you would like to convert to. e.g (aac, hls, mp3, m4a, oga)
$options
—
array
Array of options. access: public or private Indicates that the file should be stored in a way that allows public access going directly to the underlying file store. For instance, if the file is stored on S3, this will allow the S3 url to be used directly. This has no impact on the ability of users to read from the Filestack file URL. Defaults to 'private'. audio_bitrate: Sets the audio bitrate for the audio file that is generated by the transcoding process. Must be an integer between 0 and 999. audio_channels: Set the number of audio channels for the audio file that is generated by the transcoding process. Can be an integer between 1 and 12. Default is same as source audio. audio_sample_rate: Set the audio sample rate for the audio file that is generated by the transcoding process. Can be an integer between 0 and 99999. Default is 44100. clip_length: Set the length of the audio file that is generated by the transcoding process. Format is hours:minutes:seconds e.g. (00:00:20) clip_offset: Set the point to begin the audio clip from. For example, clip_offset:00:00:10 will start the audio transcode 10 seconds into the source audio file. Format is hours:minutes:seconds, e.g. (00:00:10) container: The bucket or container in the specified file store where the file should end up. extname: Set the file extension for the audio file that is generated by the transcoding process, e.g. ('.mp4', '.webm') filename: Set the filename of the audio file that is generated by the transcoding process. force: (bool) set to true to restart completed or pending audio encoding if a transcoding fails, and you make the same request again location: The custom storage service to store the converted file to, options incude 'S3', 'azure', 'gcs', 'rackspace', and 'dropbox' path: The path to store the file at within the specified file store. For S3, this is the key where the file will be stored at. By default, Filestack stores the file at the root at a unique id, followed by an underscore, followed by the filename, for example "3AB239102DB_myaudio.mp3" title: Set the title in the file metadata.
$force
—
boolean
set to true to restart completed or pending audio encoding if a transcoding fails, and you make the same request again