[This is preliminary documentation and is subject to change.]

Generates support files for the creation of a custom ringtone editor user experience.

Namespace:  PhoneSherpa.Services
Assembly:  App_Code.fxrph_yi (in App_Code.fxrph_yi)
Version: 0.0.0.0

Syntax

C#
public WS..::.GetRingtoneEditorFilesResult GetRingtoneEditorFiles(
	string AccessKey,
	string SourceFile,
	WS..::.WaveFormInformation WaveFormInformation
)
Visual Basic (Declaration)
Public Function GetRingtoneEditorFiles ( _
	AccessKey As String, _
	SourceFile As String, _
	WaveFormInformation As WS..::.WaveFormInformation _
) As WS..::.GetRingtoneEditorFilesResult
JScript
public function GetRingtoneEditorFiles(
	AccessKey : String, 
	SourceFile : String, 
	WaveFormInformation : WS..::.WaveFormInformation
) : WS..::.GetRingtoneEditorFilesResult

Parameters

AccessKey
Type: System..::.String
Security key allocated to a developer enabling access to the web service API.
SourceFile
Type: System..::.String
Internal source file name within Phone Sherpa system. Expressed as a random and unique file name without a path. Typically the output of LoadFileFromURL(...), but can be any internal SourceFile handle to an audio file.

Supported audio formats: mp3, wma, wav, aac, mp4, m4a, aif, snd, and au. Files encoded with DRM are not supported regardless of format.

WaveFormInformation
Type: PhoneSherpa.Services..::.WS..::.WaveFormInformation
Structure that specifies the size and colors used to produce a waveform image of the SourceAudio file.

Return Value

URLs to the audio playback file, waveform image, and the source file's duration in seconds.

Remarks

Phone Sherpa provides a Flash client for editing audio files into ringtones. This is a flexible component that can be used in a large variety of scenarios. That said, a developer may wish to provide thier own editing UI experience. GetRingtoneEditorFiles(...) generates the necessary support files for bulding a custom audio editor UI.

SourceFile audio is converted into a standard mp3 format that is of decent quality yet compact. It is also one of the select mp3 codec types supported by playback within the Flash runtime environment.

A waveform image is also generaged from the SourceFile audio. The rectangular dimensions, background color, and wave color can be specified.

SourceFile audio duration is useful to determine relative position start and stop times from within the custom audio editor UI.

Note that audio clips should be made from the original SourceFile audio to minimize generational loss of audio quality.

See Also