MediaPlayer:Macros - Revision history

MetrixAdmin: MetrixAdmin moved page Media Player: Macros to MediaPlayer:Macros

2012-07-01T22:00:39Z

MetrixAdmin moved page Media Player: Macros to MediaPlayer:Macros

MetrixAdmin: moved Media Player Macros to Media Player: Macros

2011-03-26T20:30:49Z

moved Media Player Macros to Media Player: Macros

MetrixAdmin: moved Player:Macros to Media Player Macros

2011-03-26T20:30:37Z

moved Player:Macros to Media Player Macros

MetrixAdmin at 00:52, 22 March 2011

2011-03-22T00:52:22Z

MetrixAdmin at 00:30, 22 March 2011

2011-03-22T00:30:43Z

MetrixAdmin at 14:52, 21 March 2011

2011-03-21T14:52:38Z

MetrixAdmin: Created page with "== Getting Started == There are several macros internally define that let you instantiate a media player. There are several details that you need to pay attention to and we will..."

2011-03-21T14:42:06Z

Created page with "== Getting Started == There are several macros internally define that let you instantiate a media player. There are several details that you need to pay attention to and we will..."

New page

== Getting Started ==

There are several macros internally define that let you instantiate a media player. There are several details that you need to pay attention to and we will go over them below.

== getPlayerUrl ==

This is the most basic player macro and also the most common. It will instantiate a media player in the mp (default) skin and allow playback for both logged in and logged out viewers.

=== Parameters ===
;obj
:this is the content item. Normally this will be MS.activeContent
;index
:this is an offset into the video. This offset is a normalized offset between 0 and 1000. This means that index=500 would be half way through the video.

=== Example Usage ===

<?cs call:getPlayerUrl(MS.activeContent, #0) ?>

← Older revision		Revision as of 00:52, 22 March 2011
Line 164:		Line 164:

	<?cs getSkinUserPlayerEmbedCode(MS.activeContent, #0, #600, #400, "000000", "window", #1, "minimal") ?>		<?cs getSkinUserPlayerEmbedCode(MS.activeContent, #0, #600, #400, "000000", "window", #1, "minimal") ?>
		+
		+	== getCustomPlayerUrl ==
		+
		+	This is the universal macro to generate a URL to the player with any combination of configuration options.
		+
		+	=== Parameters ===
		+	;obj
		+	:this is the content item. Normally this will be MS.activeContent.
		+	;index
		+	:this is an offset into the video. This offset is a normalized offset between 0 and 1000. This means that index=500 would be half way through the video. This is ignored for live events.
		+	;skin
		+	:this is name of the skin you want to use for the player. See SKINS for a list of available skins.
		+	;ppm
		+	:this specififies whether or not to enable the pay-per-minute/pay-per-credit functionality. This is only available to logged in users.
		+	;embed
		+	:this controls whether or not this video can be re-embedded.
		+	;ipod
		+	:this controls whether or not to show an ipod embed link (if available).
		+	;formats
		+	:this is a list of formats concatenated via the \| character.
		+
		+	=== Example Usage ===
		+
		+	<?cs call:getCustomPlayerUrl(MS.activeContent, #0, "minimal", #0, #1, #0, "low\|med\|high\|hd") ?>
		+
		+	== getCustomPlayerEmbedCode ==
		+
		+	This is the universal macro to generate an embed code to the player with any combination of configuration options.
		+
		+	obj, index, width, height, playerId, color, wmode, autoplay, skin, ppm, embed, ipod, formats
		+
		+	=== Parameters ===
		+	;obj
		+	:this is the content item. Normally this will be MS.activeContent.
		+	;index
		+	:this is an offset into the video. This offset is a normalized offset between 0 and 1000. This means that index=500 would be half way through the video. This is ignored for live events.
		+	;width
		+	:this is the width of the embedded player.
		+	;height
		+	:this is the height of the embedded player.
		+	;playerId
		+	:this is HTML element id of the embedded player.
		+	;color
		+	:this is the background color of the embedded player.
		+	;wmode
		+	:this is the window mode of the embedded player. The following values are available: window, opaque, or transparent. Window offers the fastest performance but browser elements can not be placed over the player. Opaque is 2nd fastest and lets browser objects be placed over itself. Transparent is the slowest, but lets you have transparencies within the player.
		+	;autoplay
		+	:whether or not the player should start playing immediately upon loading.
		+	;skin
		+	:this is name of the skin you want to use for the player. See SKINS for a list of available skins.
		+	;ppm
		+	:this specififies whether or not to enable the pay-per-minute/pay-per-credit functionality. This is only available to logged in users.
		+	;embed
		+	:this controls whether or not this video can be re-embedded.
		+	;ipod
		+	:this controls whether or not to show an ipod embed link (if available).
		+	;formats
		+	:this is a list of formats concatenated via the \| character.
		+
		+	=== Example Usage ===
		+
		+	<?cs call:getCustomPlayerEmbedCode(MS.activeContent, #0, #600, #400, "myPlayer", "000000", "transparent", #1, "minimal", #0, #1, #0, "low\|med\|high\|hd") ?>

@@ Line 2: / Line 2: @@
 There are several macros internally define that let you instantiate a media player. There are several details that you need to pay attention to and we will go over them below. There are 2 types of macros. If a macro ends in PlayerUrl, then it means it is intended that the macro returns a link that is used to pop open another browser window. If the macro ends in PlayerEmbed, then it is indented that the video be embedded in the current browser page.
 == getPlayerUrl ==
@@ Line 54: / Line 56: @@
   <?cs getPlayerEmbedCode(MS.activeContent, #0, #600, #400, "000000", "window", #1) ?>

@@ Line 1: / Line 1: @@
 == Getting Started ==
-There are several macros internally define that let you instantiate a media player. There are several details that you need to pay attention to and we will go over them below.
+There are several macros internally define that let you instantiate a media player. There are several details that you need to pay attention to and we will go over them below. There are 2 types of macros. If a macro ends in PlayerUrl, then it means it is intended that the macro returns a link that is used to pop open another browser window. If the macro ends in PlayerEmbed, then it is indented that the video be embedded in the current browser page.
 == getPlayerUrl ==
@@ Line 9: / Line 9: @@
 === Parameters ===
 ;obj
-:this is the content item. Normally this will be MS.activeContent
+:this is the content item. Normally this will be MS.activeContent.
 ;index
-:this is an offset into the video. This offset is a normalized offset between 0 and 1000. This means that index=500 would be half way through the video.
+:this is an offset into the video. This offset is a normalized offset between 0 and 1000. This means that index=500 would be half way through the video. This is ignored for live events.
 === Example Usage ===
   <?cs call:getPlayerUrl(MS.activeContent, #0) ?>