cordova-replay v0.0.5
cordova-replay
Install
cordova plugin add cordova-replay
Description
This cordova plugin allows to use the ReplayKit framework in iOS. The ReplayKit is a new feature in iOS 9.0, that performs screen / microphone recording. With iOS 10, ReplayKit introduces live streaming as well.
The plugin is referenced by cordova.plugins.Replay
.
Methods
- startRecording(isMicrophoneEnabled, successCallback, errorCallback)
- isRecording Bool: ~does the microphone is enabled~ Left for legacy. Microphone is always on by default, the user will be prompted to enable microphone or not.
- successCallback Function: callback triggered when succeed
- errorCallback Function: callback triggered when failed
- stopRecording(successCallback, errorCallback)
- successCallback Function: callback triggered when succeed
- errorCallback Function: callback triggered when failed
- isRecording(successCallback, errorCallback)
- successCallback Function: callback triggered when succeed, 1st parameter is true when recording
- errorCallback Function: callback triggered when failed
- isAvailable(successCallback, errorCallback)
- successCallback Function: callback triggered when succeed, 1st parameter is true if recording is available
- errorCallback Function: callback triggered when failed
- startBroadcast(successCallback, errorCallback)
- successCallback Function: callback triggered when succeed
- errorCallback Function: callback triggered when failed
- stopBroadcast(successCallback, errorCallback)
- successCallback Function: callback triggered when succeed
- errorCallback Function: callback triggered when failed
- isBroadcasting(successCallback, errorCallback)
- successCallback Function: callback triggered when succeed, 1st parameter is true when live streaming
- errorCallback Function: callback triggered when failed
- isBroadcastAvailable(successCallback, errorCallback)
- successCallback Function: callback triggered when succeed, 1st parameter is true simply if >iOS 10.0
- errorCallback Function: callback triggered when failed
Usage sample
// start a screen+mic record, and stop it 5sec later
var isRecording = false;
function startRecord(enableMic) {
cordova.plugins.Replay.startRecording(enableMic,
function() {
isRecording = true;
}, function(err) {
console.log(err);
}
);
};
function stopRecording = function() {
cordova.plugins.Replay.stopRecording(
function() {
isRecording = false;
console.log('ok!');
}, function(err) {
console.log(err);
}
);
}
startRecording(true);
setTimeout(function() {
stopRecording();
}, 5000)
Supported Platforms
- iOS
Troubleshouting
- be sure to target iOS 9.0 minimum
- in case of error :
dyld: Library not loaded: @rpath/libswiftCore.dylib
maybe to will need to add @executable_path/Frameworks
in the Build Settings > Runpath Search Paths of your xcode project.