added docs + test (db962e6d) · Commits · codevise / cordova-plugin-media

docs/.DS_Store

0 → 100644

+6 KiB

File added.

No diff preview for this file type.

View file

docs/MediaError/mediaError.md

0 → 100644

+45 −0

Changes for docs/MediaError/mediaError.md: 45 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		---
		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.
		---

		MediaError
		==========

		A `MediaError` object is returned to the `mediaError` callback
		function when an error occurs.

		Properties
		----------

		- __code__: One of the predefined error codes listed below.
		- __message__: An error message describing the details of the error.

		Constants
		---------

		- `MediaError.MEDIA_ERR_ABORTED`
		- `MediaError.MEDIA_ERR_NETWORK`
		- `MediaError.MEDIA_ERR_DECODE`
		- `MediaError.MEDIA_ERR_NONE_SUPPORTED`

		Description
		-----------

		The `MediaError` object is passed to a `mediaError` callback function
		when an error occurs.

docs/Parameters/mediaError.md

0 → 100644

+33 −0

Changes for docs/Parameters/mediaError.md: 33 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		---
		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.
		---

		mediaError
		==========

		A user-specified callback function that executes when there is an
		error in media functions.

		function(error) {
		// Handle the error
		}

		Parameters
		----------

		- __error__: The error returned by the device. _(MediaError)_

docs/media.getCurrentPosition.md

0 → 100644

+176 −0

Changes for docs/media.getCurrentPosition.md: 176 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		---
		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.getCurrentPosition
		========================

		Returns the current position within an audio file.

		media.getCurrentPosition(mediaSuccess, [mediaError]);

		Parameters
		----------

		- __mediaSuccess__: The callback that is passed the current position in seconds.
		- __mediaError__: (Optional) The callback to execute if an error occurs.

		Description
		-----------

		An asynchronous function that returns the current position of the
		underlying audio file of a `Media` object. Also updates the `Media`
		object's `position` parameter.

		Supported Platforms
		-------------------

		- Android
		- BlackBerry WebWorks (OS 5.0 and higher)
		- iOS
		- Windows Phone 7 and 8
		- Tizen
		- Windows 8

		Quick Example
		-------------

		// Audio player
		//
		var my_media = new Media(src, onSuccess, onError);

		// Update media position every second
		var mediaTimer = setInterval(function () {
		// get media position
		my_media.getCurrentPosition(
		// success callback
		function (position) {
		if (position > -1) {
		console.log((position) + " sec");
		}
		},
		// error callback
		function (e) {
		console.log("Error getting pos=" + e);
		}
		);
		}, 1000);

		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>

docs/media.getDuration.md

0 → 100644

+167 −0

Changes for docs/media.getDuration.md: 167 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		---
		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.getDuration
		=================

		Returns the duration of an audio file.

		media.getDuration();

		Description
		-----------

		The `media.getDuration` method executes synchronously, returning the
		duration of the audio file in seconds, if known. If the duration is
		unknown, it returns a value of -1.

		Supported Platforms
		-------------------

		- Android
		- BlackBerry WebWorks (OS 5.0 and higher)
		- iOS
		- Windows Phone 7 and 8
		- Tizen
		- Windows 8

		Quick Example
		-------------

		// Audio player
		//
		var my_media = new Media(src, onSuccess, onError);

		// Get duration
		var counter = 0;
		var timerDur = setInterval(function() {
		counter = counter + 100;
		if (counter > 2000) {
		clearInterval(timerDur);
		}
		var dur = my_media.getDuration();
		if (dur > 0) {
		clearInterval(timerDur);
		document.getElementById('audio_duration').innerHTML = (dur) + " sec";
		}
		}, 100);

		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>