Creates a media object from a media file on the device.

Syntax

voltmx.media.createFromFile(  
    fileobj,psp)

Input Parameters

Example 1

var fileObj = new voltmx.io.File("MyAudioFile.mp3");
var mediaObj = voltmx.media.createFromFile(fileObj);

Example 2

var fileObj = new voltmx.io.File("MyAudioFile.mp3");
var psp = {
"category": voltmx.media.AUDIO_SESSION_CATEGORY_PLAY_AND_RECORD,
"options": [voltmx.media.AUDIO_SESSION_CATEGORY_OPTIONS_DEFAULT_TO_SPEAKER,voltmx.media.AUDIO_SESSION_CATEGORY_OPTIONS_ALLOW_BLUETOOTH_A2DP,voltmx.media.AUDIO_SESSION_CATEGORY_OPTIONS_MIX_WITH_OTHERS]
     }
var mediaObj = voltmx.media.createFromFile(fileObj,psp);

Return Values

Returns a media object that is associated with a specific file on the device, or null if the object was not created.

Remarks

This function has platform-specific behaviors when there are errors. In particular, when the fileObj parameter refers to a file that doesn’t exist on iOS, iOS generates an error with the message string “Unable to play the media file”. However, if this error occurs on Android, no error message is generated. Instead, this function does not create the media object.

Parameter Details

The psp parameter is an object that contains key-value pairs for the AVAudioSession Category and AVAudioSession Category Options parameters.

The structure of the psp parameter is as follows:

psp Structure:{

"category" : <category_name>

"options"  : [categoryOptions]

}

Note: If the value of the options parameter is not an array, the default value
(voltmx.media.AUDIO_SESSION_CATEGORY_OPTIONS_MIX_WITH_OTHERS and voltmx.media.AUDIO_SESSION_CATEGORY_OPTIONS_DEFAULT_TO_SPEAKER) is assigned to the options parameter.

The AVAudioSession Category parameter supports the following values.

The AVAudioSession Category Options parameter supports the following values.

Platform Availability

Windows10, Android, iOS

Creates a media object that plays a remote audio file across the network.

Syntax

voltmx.media.createFromUri(  
    uriString,psp)

Input Parameters

Example 1

var mediaObj = voltmx.media.createFromUri(url);

Example 2

var psp = {
"category": voltmx.media.AUDIO_SESSION_CATEGORY_PLAY_AND_RECORD,
"options": [voltmx.media.AUDIO_SESSION_CATEGORY_OPTIONS_DEFAULT_TO_SPEAKER,voltmx.media.AUDIO_SESSION_CATEGORY_OPTIONS_ALLOW_BLUETOOTH_A2DP,voltmx.media.AUDIO_SESSION_CATEGORY_OPTIONS_MIX_WITH_OTHERS]
}
var mediaObj = voltmx.media.createFromUri(url,psp);

Return Values

Returns a media object that is associated with a remote audio file, or null if the object was not created.

Remarks

Parameter Details

The psp parameter is an object that contains key-value pairs for the AVAudioSessions Category and AVAudioSession Category Option parameters.

The structure of the psp parameter is as follows:

psp Structure:{

"category" : <category_name>

"options"  : [categoryOptions]

}

Note: If the value of the options parameter is not an array, the default value
(voltmx.media.AUDIO_SESSION_CATEGORY_OPTIONS_MIX_WITH_OTHERS and
voltmx.media.AUDIO_SESSION_CATEGORY_OPTIONS_DEFAULT_TO_SPEAKER) is assigned to the options parameter.

The AVAudioSessions Category parameter supports the following values.

The AVAudioSession Category Option parameter supports the following values.

Platform Availability

Windows10, Android, iOS

Creates a record object that your app can use to record audio.

Syntax

The syntax for native platforms is as follows.

voltmx.media.record(fileobj,config)

The syntax for Desktop Web is as follows.

voltmx.media.record(config)

Input Parameters

Example

function errorcallback(errorMessage) {
    var errorMesg = "Reason for failure is : " + errorMessage;
    alert(errorMesg);
}

function successcallback(fileobj) {
    // Your code goes here.
}

var fileObj = new voltmx.io.file("recording");

var config = {
    onSuccess: successCallback,
    onFailure: failureCallback
};

var _recordObj = voltmx.media.record(fileObj, config);

Return Values

Returns an instantiated record object, or null if the object was not created.

Remark

Use the voltmx.media.record function to instantiate a record object that your app can use to record audio on the device.

Parameter Details

The config parameter contains an object with configuration information. Specifically, it contains key-value pairs that set callbacks which are invoked by the voltmx.media.record function. The config parameter supports the following keys.

The callback for the onFailure key must have the following signature.

onFailureCallback(errorMessage);

where the errorMessage parameter is a string containing the reason for the failure.

The callback for the onSuccess key must have the following signature.

onSuccessCallback(fileobj);

where the fileobj parameter is an object of type voltmx.io.file that represents the file the audio is recorded into.

The callback for the onSuccess key must have the following signature in Desktop Web platform.

onSuccessCallback(audiobytes);

here, the audiobytes parameter contains the recorded audio as Blob URL.

Platform-Specific Notes

The following platform-specific features should be considered when using this function.

• iOS: Your app must enable recording before it calls this function. To enable recording, it invokes the voltmx.application.checkPermission(voltmx.os.RESOURCE_AUDIO_RECORD,null) function. In addition, the file extension of the audio file for the recording is set to .aiff, irrespective of the extension specified in the user’s input.
• Android: You must add the RECORD_AUDIO permission into your app’s manifest. On Android 6.0 or later, this will result in the operating system displaying a dialog box asking the user to confirm this permission at runtime. In addition, the file extension of the audio file for the recording is set to .m4a no matter what the user input specifies.
• Windows: To enable your app to record audio, you must add the “Micriphone” capability in the app’s properties.
• Desktop Web: If you are creating more than one record object at the same time, the audiobytes parameter returns only the last recording of all onSuccess callbacks.

Platform Availability

Windows10, Android, iOS, and Desktop Web