telecoms.soundclip.edit function

Home > misc-functions > func.telecoms.soundclip.edit

function telecoms.soundclip.edit

Edit/change an existing soundclip.

See telecoms.soundclip.create for information about automatic conversion of audio formats.

Arguments:

arg	required?	syntax	info
`custID`	N	posint	custID of account that owns the soundclip (default is your own account)
`soundclipID`	Y	posint	identifies the soundclip you wish to edit
`desc`	N	string	new textual description of your sound clip
`roles`	N	list	a replacement list of role names (removes all existing roles and replaces with these)
`roles.add`	N	list	a list of roles to add to this soundclip (in addition to the ones it already has)
`roles.del`	N	list	a list of roles to remove from this soundclip
`b64audiodata`	N	base64 data	new sound file; string containing base64 encoded binary audio data
`audioformat`	(if b64audiodata is supplied)	enum:wav	sound file format of file being uploaded; only wav is supported at this time

Further argument information

roles

A list of roles to which this soundclip can be applied. This can be a comma separated list or an array of values. Use telecoms.soundclip.roletype.list to fetch a list of available role types.

b64audiodata

A base64 encoded string; the result of base64 encoding the sound file to be uploaded. There is no need to introduce line breaks to break up a long line of characters.