MediaPlayer:API:Calls - Revision history

MetrixAdmin: MetrixAdmin moved page Media Player: API Calls to MediaPlayer:API:Calls

2012-07-01T22:01:42Z

MetrixAdmin moved page Media Player: API Calls to MediaPlayer:API:Calls

MetrixAdmin: /* metrix_sendChat */

2011-07-12T00:54:30Z

‎metrix_sendChat

MetrixAdmin at 00:04, 27 March 2011

2011-03-27T00:04:09Z

MetrixAdmin: moved Media Player: API to Media Player: API Calls

2011-03-27T00:02:20Z

moved Media Player: API to Media Player: API Calls

MetrixAdmin at 22:57, 26 March 2011

2011-03-26T22:57:21Z

MetrixAdmin at 22:48, 26 March 2011

2011-03-26T22:48:30Z

MetrixAdmin at 22:44, 26 March 2011

2011-03-26T22:44:57Z

MetrixAdmin at 22:33, 26 March 2011

2011-03-26T22:33:25Z

MetrixAdmin: Created page with "== Getting Started == The media player has several callbacks and functions available to control it as you see fit. This document will go over them all in detail. == Functions =..."

2011-03-26T22:30:45Z

Created page with "== Getting Started == The media player has several callbacks and functions available to control it as you see fit. This document will go over them all in detail. == Functions =..."

New page

== Getting Started ==

The media player has several callbacks and functions available to control it as you see fit. This document will go over them all in detail.

== Functions ==

All functions must be called via JavaScript on the actual DOM element of the media player. This id is exposed in the [[Media_Player:_Macros#getCustomPlayerEmbedCode|getCustomPlayerEmbedCode]] macro.

All examples below will leverage the getDefaultPlayer() JavaScript.

<script type="text/javascript">

function getPlayer(name) {
var isIE = navigator.appName.indexOf("Microsoft") != -1;
var player = (isIE) ? window[name] : document[name];
return player;
}

function getDefaultPlayer() {
return getPlayer("mtxPlayer");
}

</script>

== metrix_playMedia ==

This function allows you to play the existing media at its current position of it was paused or stopped.

=== Parameters ===

This function has no parameters.

=== Example Usage ===

<script type="text/javascript">

getDefaultPlayer().metrix_playMedia();

</script>

== metrix_stopMedia ==

== metrix_seekMedia ==

== metrix_isPlaying ==
== metrix_muteVolume ==
== metrix_unmuteVolume ==
== metrix_setVolume ==
== metrix_getVolume ==
== metrix_isMuted ==
== metrix_playSound ==

<script type="text/javascript"> ==

← Older revision		Revision as of 00:54, 12 July 2011
Line 206:		Line 206:
	getDefaultPlayer().metrix_sendChat("hey there, this is a great show!");		getDefaultPlayer().metrix_sendChat("hey there, this is a great show!");

		+	</script>
		+
		+	== metrix_toggleFullScreenMode ==
		+
		+	This function toggles with media player into and out of fullscreen mode.
		+
		+	=== Parameters ===
		+
		+	This function has no parameters.
		+
		+	=== Example Usage ===
		+
		+	<script type="text/javascript">
		+
		+	getDefaultPlayer().metrix_toggleFullScreenMode();
		+
	</script>		</script>

@@ Line 1: / Line 1: @@
 == Getting Started ==
-The media player has several callbacks and functions available to control it as you see fit. This document will go over them all in detail.
+The media player has functions available to control it as you see fit. This document will go over them all in detail.
 == Functions ==

← Older revision		Revision as of 22:57, 26 March 2011
Line 188:		Line 188:

	getDefaultPlayer().metrix_playSound("/static/sounds/cashregister.mp3");		getDefaultPlayer().metrix_playSound("/static/sounds/cashregister.mp3");
		+
		+	</script>
		+
		+	== metrix_sendChat ==
		+
		+	This function sends a chat message.
		+
		+	=== Parameters ===
		+
		+	;message
		+	:this is the actual message being sent to the other viewers.
		+
		+	=== Example Usage ===
		+
		+	<script type="text/javascript">
		+
		+	getDefaultPlayer().metrix_sendChat("hey there, this is a great show!");
		+
		+	</script>
		+
		+	== metrix_getUserId ==
		+
		+	This function gets the current viewer's user id. This function will return 0 if the viewer is the actual event host and -1 if the viewer is not logged in.
		+
		+	=== Parameters ===
		+
		+	This function has no parameters.
		+
		+	=== Example Usage ===
		+
		+	<script type="text/javascript">
		+
		+	alert("Your user id is: " + getDefaultPlayer().metrix_getUserId());
		+
		+	</script>
		+
		+	== metrix_getUserName ==
		+
		+	This function gets the current viewer's username. This function will return a unique username for anonymous users in the format of "Guest:XXXXXXXXXX", where the X's are digits. This function will do its best to keep the anonymous username persistent from session to session.
		+
		+	=== Parameters ===
		+
		+	This function has no parameters.
		+
		+	=== Example Usage ===
		+
		+	<script type="text/javascript">
		+
		+	alert("Your username is: " + getDefaultPlayer().metrix_getUserName());
		+
		+	</script>
		+
		+	== metrix_isAnonymous ==
		+
		+	This function determines if the viewer is logged in or not.
		+
		+	=== Parameters ===
		+
		+	This function has no parameters.
		+
		+	=== Example Usage ===
		+
		+	<script type="text/javascript">
		+
		+	if (getDefaultPlayer().metrix_isAnonymous()) {
		+	alert("You are anonymous.");
		+	}
		+
		+	</script>
		+
		+	== metrix_isHost ==
		+
		+	This function determines if the viewer is the event host.
		+
		+	=== Parameters ===
		+
		+	This function has no parameters.
		+
		+	=== Example Usage ===
		+
		+	<script type="text/javascript">
		+
		+	if (getDefaultPlayer().metrix_isHost()) {
		+	alert("You are the event host.");
		+	}

	</script>		</script>

@@ Line 157: / Line 157: @@
 == metrix_isMuted ==
 == metrix_playSound ==
-  <script type="text/javascript"> ==
+  <script type="text/javascript">

@@ Line 7: / Line 7: @@
 All functions must be called via JavaScript on the actual DOM element of the media player. This id is exposed in the [[Media_Player:_Macros#getCustomPlayerEmbedCode|getCustomPlayerEmbedCode]] macro.
-All examples below will leverage the getDefaultPlayer() JavaScript.
+The examples below will leverage the getDefaultPlayer() JavaScript shown in following code block.
   <script type="text/javascript">
@@ Line 74: / Line 74: @@
 == metrix_isPlaying ==
 == metrix_muteVolume ==
 == metrix_unmuteVolume ==
 == metrix_setVolume ==
 == metrix_getVolume ==
 == metrix_isMuted ==
 == metrix_playSound ==

@@ Line 42: / Line 42: @@
 == metrix_stopMedia ==
 == metrix_seekMedia ==
 == metrix_isPlaying ==