http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/media.seekTo.md ---------------------------------------------------------------------- diff --git a/docs/media.seekTo.md b/docs/media.seekTo.md deleted file mode 100644 index 371705c..0000000 --- a/docs/media.seekTo.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -media.seekTo -======================== - -Sets the current position within an audio file. - - media.seekTo(milliseconds); - -Parameters ----------- - -- __milliseconds__: The position to set the playback position within the audio, in milliseconds. - -Description ------------ - -The `media.seekTo` executes asynchronously, updating the current -playback position within an audio file referenced by a `Media` -object. Also updates the `Media` object's `position` parameter. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 6.0 and higher) -- iOS -- Windows Phone 7 and 8 -- Tizen -- Windows 8 - -Quick Example -------------- - - // Audio player - // - var my_media = new Media(src, onSuccess, onError); - my_media.play(); - // SeekTo to 10 seconds after 5 seconds - setTimeout(function() { - my_media.seekTo(10000); - }, 5000); - -Full Example ------------- - - <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" - "http://www.w3.org/TR/html4/strict.dtd";> - <html> - <head> - <title>Media Example</title> - - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - // Wait for device API libraries to load - // - document.addEventListener("deviceready", onDeviceReady, false); - - // device APIs are available - // - function onDeviceReady() { - playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3";); - } - - // Audio player - // - var my_media = null; - var mediaTimer = null; - - // Play audio - // - function playAudio(src) { - // Create Media object from src - my_media = new Media(src, onSuccess, onError); - - // Play audio - my_media.play(); - - // Update media position every second - mediaTimer = setInterval(function() { - // get media position - my_media.getCurrentPosition( - // success callback - function(position) { - if (position > -1) { - setAudioPosition(position + " sec"); - } - }, - // error callback - function(e) { - console.log("Error getting pos=" + e); - } - ); - }, 1000); - - // SeekTo to 10 seconds after 5 seconds - setTimeout(function() { - my_media.seekTo(10000); - }, 5000); - } - - // Stop audio - // - function stopAudio() { - if (my_media) { - my_media.stop(); - } - clearInterval(mediaTimer); - mediaTimer = null; - } - - // onSuccess Callback - // - function onSuccess() { - console.log("playAudio():Audio Success"); - } - - // onError Callback - // - function onError(error) { - alert('code: ' + error.code + '\n' + - 'message: ' + error.message + '\n'); - } - - // Set audio position - // - function setAudioPosition(position) { - document.getElementById('audio_position').innerHTML = position; - } - - </script> - </head> - <body> - <a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a> - <a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a> - <p id="audio_position"></p> - </body> - </html> - -BlackBerry WebWorks Quirks ----------- - -- Not supported on BlackBerry OS 5 devices.
http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/media.setVolume.md ---------------------------------------------------------------------- diff --git a/docs/media.setVolume.md b/docs/media.setVolume.md deleted file mode 100644 index 6c0c91c..0000000 --- a/docs/media.setVolume.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -media.setVolume -=========== - -Set the volume for an audio file. - - media.setVolume(volume); - -Paramters ---------- - -- __volume__: The volume to set for playback. The value must be within the range of 0.0 to 1.0. - -Description ------------ - -Function `media.setVolume` is an asynchronous function that sets the volume during audio playback. - -Supported Platforms -------------------- - -- Android -- iOS - -Quick Example -------------- - - // Play audio - // - function playAudio(url) { - // Play the audio file at url - var my_media = new Media(url, - // success callback - function() { - console.log("playAudio():Audio Success"); - }, - // error callback - function(err) { - console.log("playAudio():Audio Error: "+err); - }); - - // Play audio - my_media.play(); - - // Mute volume after 2 seconds - setTimeout(function() { - my_media.setVolume('0.0'); - }, 2000); - - // Set volume to 1.0 after 5 seconds - setTimeout(function() { - my_media.setVolume('1.0'); - }, 5000); - } - - -Full Example ------------- - - <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" - "http://www.w3.org/TR/html4/strict.dtd";> - <html> - <head> - <title>Media Example</title> - - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - // Wait for Cordova to load - // - document.addEventListener("deviceready", onDeviceReady, false); - - // Cordova is ready - // - function onDeviceReady() { - playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3";); - } - - // Audio player - // - var my_media = null; - var mediaTimer = null; - - // Play audio - // - function playAudio(src) { - // Create Media object from src - my_media = new Media(src, onSuccess, onError); - - // Play audio - my_media.play(); - - // Update my_media position every second - if (mediaTimer == null) { - mediaTimer = setInterval(function() { - // get my_media position - my_media.getCurrentPosition( - // success callback - function(position) { - if (position > -1) { - setAudioPosition((position) + " sec"); - } - }, - // error callback - function(e) { - console.log("Error getting pos=" + e); - setAudioPosition("Error: " + e); - } - ); - }, 1000); - } - } - - // Set audio volume - // - function setVolume(volume) { - if (my_media) { - my_media.setVolume(volume); - } - } - - // Stop audio - // - function stopAudio() { - if (my_media) { - my_media.stop(); - } - clearInterval(mediaTimer); - mediaTimer = null; - } - - // onSuccess Callback - // - function onSuccess() { - console.log("playAudio():Audio Success"); - } - - // onError Callback - // - function onError(error) { - alert('code: ' + error.code + '\n' + - 'message: ' + error.message + '\n'); - } - - // Set audio position - // - function setAudioPosition(position) { - document.getElementById('audio_position').innerHTML = position; - } - - </script> - </head> - <body> - <a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a> - <a href="#" class="btn large" onclick="setVolume('0.0');">Mute Audio</a> - <a href="#" class="btn large" onclick="setVolume('1.0');">Unmute Audio</a> - <a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a> - <p id="audio_position"></p> - </body> - </html> http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/media.startRecord.md ---------------------------------------------------------------------- diff --git a/docs/media.startRecord.md b/docs/media.startRecord.md deleted file mode 100644 index b94cee9..0000000 --- a/docs/media.startRecord.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -media.startRecord -================= - -Starts recording an audio file. - - media.startRecord(); - -Description ------------ - -The `media.startRecord` method executes synchronously, starts a -recording for an audio file. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 and 8 -- Windows 8 - -Quick Example -------------- - - // Record audio - // - function recordAudio() { - var src = "myrecording.mp3"; - var mediaRec = new Media(src, - // success callback - function() { - console.log("recordAudio():Audio Success"); - }, - - // error callback - function(err) { - console.log("recordAudio():Audio Error: "+ err.code); - }); - - // Record audio - mediaRec.startRecord(); - } - -Full Example ------------- - - <!DOCTYPE html> - <html> - <head> - <title>Device Properties Example</title> - - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - // Wait for device API libraries to load - // - document.addEventListener("deviceready", onDeviceReady, false); - - // Record audio - // - function recordAudio() { - var src = "myrecording.amr"; - var mediaRec = new Media(src, onSuccess, onError); - - // Record audio - mediaRec.startRecord(); - - // Stop recording after 10 sec - var recTime = 0; - var recInterval = setInterval(function() { - recTime = recTime + 1; - setAudioPosition(recTime + " sec"); - if (recTime >= 10) { - clearInterval(recInterval); - mediaRec.stopRecord(); - } - }, 1000); - } - - // device APIs are available - // - function onDeviceReady() { - recordAudio(); - } - - // onSuccess Callback - // - function onSuccess() { - console.log("recordAudio():Audio Success"); - } - - // onError Callback - // - function onError(error) { - alert('code: ' + error.code + '\n' + - 'message: ' + error.message + '\n'); - } - - // Set audio position - // - function setAudioPosition(position) { - document.getElementById('audio_position').innerHTML = position; - } - - </script> - </head> - <body> - <p id="media">Recording audio...</p> - <p id="audio_position"></p> - </body> - </html> - -Android Quirks ----------- - -- Android devices record audio in Adaptive Multi-Rate format. The specified file should end with a _.amr_ extension. - -BlackBerry WebWorks Quirks ----------- - -- BlackBerry devices record audio in Adaptive Multi-Rate format. The specified file must end with a _.amr_ extension. - -iOS Quirks ----------- - -- iOS only records to files of type _.wav_ and returns an error if the file name extension is not correct. -- If a full path is not provided, the recording is placed in the application's _documents/tmp_ directory. This can be accessed via the `File` API using `LocalFileSystem.TEMPORARY`. Any subdirectory specified at record time must already exist. -- Files can be recorded and played back using the documents URI: - - var myMedia = new Media("documents://beer.mp3") - -Tizen Quirks ----------- - -- Not supported on Tizen devices. http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/media.stop.md ---------------------------------------------------------------------- diff --git a/docs/media.stop.md b/docs/media.stop.md deleted file mode 100644 index 77318d6..0000000 --- a/docs/media.stop.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -media.stop -========== - -Stops playing an audio file. - - media.stop(); - -Description ------------ - -The `media.stop` method executes synchronously to stop playing an -audio file. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 and 8 -- Tizen -- Windows 8 - -Quick Example -------------- - - // Play audio - // - function playAudio(url) { - // Play the audio file at url - var my_media = new Media(url, - // success callback - function() { - console.log("playAudio():Audio Success"); - }, - // error callback - function(err) { - console.log("playAudio():Audio Error: "+err); - } - ); - - // Play audio - my_media.play(); - - // Pause after 10 seconds - setTimeout(function() { - my_media.stop(); - }, 10000); - } - -Full Example ------------- - - <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" - "http://www.w3.org/TR/html4/strict.dtd";> - <html> - <head> - <title>Media Example</title> - - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - // Wait for device API libraries to load - // - document.addEventListener("deviceready", onDeviceReady, false); - - // device APIs are available - // - function onDeviceReady() { - playAudio("http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3";); - } - - // Audio player - // - var my_media = null; - var mediaTimer = null; - - // Play audio - // - function playAudio(src) { - // Create Media object from src - my_media = new Media(src, onSuccess, onError); - - // Play audio - my_media.play(); - - // Update my_media position every second - if (mediaTimer == null) { - mediaTimer = setInterval(function() { - // get my_media position - my_media.getCurrentPosition( - // success callback - function(position) { - if (position > -1) { - setAudioPosition((position) + " sec"); - } - }, - // error callback - function(e) { - console.log("Error getting pos=" + e); - setAudioPosition("Error: " + e); - } - ); - }, 1000); - } - } - - // Pause audio - // - function pauseAudio() { - if (my_media) { - my_media.pause(); - } - } - - // Stop audio - // - function stopAudio() { - if (my_media) { - my_media.stop(); - } - clearInterval(mediaTimer); - mediaTimer = null; - } - - // onSuccess Callback - // - function onSuccess() { - console.log("playAudio():Audio Success"); - } - - // onError Callback - // - function onError(error) { - alert('code: ' + error.code + '\n' + - 'message: ' + error.message + '\n'); - } - - // Set audio position - // - function setAudioPosition(position) { - document.getElementById('audio_position').innerHTML = position; - } - - </script> - </head> - <body> - <a href="#" class="btn large" onclick="playAudio('http://audio.ibeat.org/content/p1rj1s/p1rj1s_-_rockGuitar.mp3');">Play Audio</a> - <a href="#" class="btn large" onclick="pauseAudio();">Pause Playing Audio</a> - <a href="#" class="btn large" onclick="stopAudio();">Stop Playing Audio</a> - <p id="audio_position"></p> - </body> - </html> http://git-wip-us.apache.org/repos/asf/cordova-plugin-media-capture/blob/8af169f6/docs/media.stopRecord.md ---------------------------------------------------------------------- diff --git a/docs/media.stopRecord.md b/docs/media.stopRecord.md deleted file mode 100644 index 03fc246..0000000 --- a/docs/media.stopRecord.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -media.stopRecord -================ - -Stops recording an audio file. - - media.stopRecord(); - -Description ------------ - -The `media.stopRecord` method executes synchronously, stopping the -recording of an audio file. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 7 and 8 -- Windows 8 - -Quick Example -------------- - - // Record audio - // - function recordAudio() { - var src = "myrecording.mp3"; - var mediaRec = new Media(src, - // success callback - function() { - console.log("recordAudio():Audio Success"); - }, - - // error callback - function(err) { - console.log("recordAudio():Audio Error: "+ err.code); - } - ); - - // Record audio - mediaRec.startRecord(); - - // Stop recording after 10 seconds - setTimeout(function() { - mediaRec.stopRecord(); - }, 10000); - } - -Full Example ------------- - - <!DOCTYPE html> - <html> - <head> - <title>Device Properties Example</title> - - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - // Wait for device API libraries to load - // - document.addEventListener("deviceready", onDeviceReady, false); - - // Record audio - // - function recordAudio() { - var src = "myrecording.mp3"; - var mediaRec = new Media(src, onSuccess, onError); - - // Record audio - mediaRec.startRecord(); - - // Stop recording after 10 sec - var recTime = 0; - var recInterval = setInterval(function() { - recTime = recTime + 1; - setAudioPosition(recTime + " sec"); - if (recTime >= 10) { - clearInterval(recInterval); - mediaRec.stopRecord(); - } - }, 1000); - } - - // device APIs are available - // - function onDeviceReady() { - recordAudio(); - } - - // onSuccess Callback - // - function onSuccess() { - console.log("recordAudio():Audio Success"); - } - - // onError Callback - // - function onError(error) { - alert('code: ' + error.code + '\n' + - 'message: ' + error.message + '\n'); - } - - // Set audio position - // - function setAudioPosition(position) { - document.getElementById('audio_position').innerHTML = position; - } - - </script> - </head> - <body> - <p id="media">Recording audio...</p> - <p id="audio_position"></p> - </body> - </html> - -Tizen Quirks ----------- - -- Not supported on Tizen devices.
