Updated Branches: refs/heads/master bb54c1774 -> 780e0bd6b
[CB-2535] Document media.setVolume - Document media.setVolume in API docs. This is existing functionality. Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/780e0bd6 Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/780e0bd6 Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/780e0bd6 Branch: refs/heads/master Commit: 780e0bd6b75fa5b37e8bed31e5d5dd84ec8b053e Parents: bb54c17 Author: James Jong <[email protected]> Authored: Mon May 20 14:52:02 2013 -0400 Committer: James Jong <[email protected]> Committed: Mon May 20 14:52:02 2013 -0400 ---------------------------------------------------------------------- docs/en/edge/config.json | 1 + docs/en/edge/cordova/media/media.md | 1 + docs/en/edge/cordova/media/media.setVolume.md | 178 ++++++++++++++++++++ 3 files changed, 180 insertions(+), 0 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/780e0bd6/docs/en/edge/config.json ---------------------------------------------------------------------- diff --git a/docs/en/edge/config.json b/docs/en/edge/config.json index 1887fd2..6a62799 100644 --- a/docs/en/edge/config.json +++ b/docs/en/edge/config.json @@ -145,6 +145,7 @@ "cordova/media/media.play.md", "cordova/media/media.release.md", "cordova/media/media.seekTo.md", + "cordova/media/media.setVolume.md", "cordova/media/media.startRecord.md", "cordova/media/media.stop.md", "cordova/media/media.stopRecord.md", http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/780e0bd6/docs/en/edge/cordova/media/media.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/media/media.md b/docs/en/edge/cordova/media/media.md index 2fd0acc..34b8681 100644 --- a/docs/en/edge/cordova/media/media.md +++ b/docs/en/edge/cordova/media/media.md @@ -55,6 +55,7 @@ Methods - media.pause: Pause playing audio file. - media.release: Releases the underlying OS'es audio resources. - media.seekTo: Moves the position within the audio file. +- media.setVolume: Set the volume for audio playback. - media.startRecord: Start recording audio file. - media.stopRecord: Stop recording audio file. - media.stop: Stop playing audio file. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/780e0bd6/docs/en/edge/cordova/media/media.setVolume.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/cordova/media/media.setVolume.md b/docs/en/edge/cordova/media/media.setVolume.md new file mode 100644 index 0000000..48a934a --- /dev/null +++ b/docs/en/edge/cordova/media/media.setVolume.md @@ -0,0 +1,178 @@ +--- +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> \ No newline at end of file
