playerframework Wiki Rss Feed

New Comment on "Windows 8 Player Documentation"

Sivze — Thu, 16 May 2013 19:56:02 GMT

When I try this url in source, it shows xaml error, how to overcome this? Thats a valid Youtube media url, http://r3---sn-ci5gupcc-h55e.c.youtube.com/videoplayback?mv=m&upn=RaIkzguz7Ao&key=yt1&ip=182.65.172.9&itag=18&ratebypass=yes&fexp=927830%2C906436%2C900817%2C916625%2C924605%2C901208%2C929123%2C929915%2C929906%2C925714%2C929119%2C931202%2C928017%2C912518%2C911416%2C906906%2C904476%2C930807%2C919373%2C906836%2C933701%2C900345%2C912711%2C929606%2C910075&newshard=yes&sparams=cp%2Cid%2Cip%2Cipbits%2Citag%2Cratebypass%2Csource%2Cupn%2Cexpire&source=youtube&mt=1368731727&cp=U0hVTVdQVV9LT0NONV9PSllBOnl4Xzhnbi03MEh0&ipbits=8&sver=3&ms=au&expire=1368757065&id=0b61bacdd18f1992&signature=5CE55BBFF663DCBA779643C7AF341F487302EDA8.B2ED60E3E4242276E12DB84AFA60544839D5D596&title=Grown%20Ups%202%20-%20Official%20Trailer%202%20%5BHD%5D

New Comment on "Getting Started: WP8 Smooth Streaming Player"

Sivze — Thu, 16 May 2013 19:55:35 GMT

Updated Wiki: Documentation

timgreenfield — Fri, 03 May 2013 16:48:42 GMT

Player Framework Documentation

Updated Wiki: Source Code and Build Scripts

timgreenfield — Fri, 03 May 2013 16:47:57 GMT

Getting the source code

1. Install the Visual Studio Tools for Git Extension
2. Find the url for the Git repository via the Source page:

3. In Team Explorer in Visual Studio you can easily clone the Git repository to a local folder:

4. Open the desired solution in Visual Studio 2012:

For Windows 8 Xaml: Microsoft.Win8.PlayerFramework.Xaml.sln
For Windows 8 JS: Microsoft.Win8.PlayerFramework.Js.sln
For Windows Phone 8 Xaml: Microsoft.WP8.PlayerFramework.SL.sln
For HTML5 web browsers: Microsoft.Web.PlayerFramework.Html5.sln

Requirements to run the source code

Windows 8 (Xaml and JS)
Required additional SDKs (these must be installed):

Before building:
Change your build configuration to x64 or x86. AnyCPU (the default in Visual Studio) will not work due to dependencies on native libraries.

Set your startup project to one of the Samples by right clicking on the project and selecting "Set as StartUp Project"

Windows Phone 8 (Xaml and JS)
Required additional SDKs (these must be installed):

Smooth Streaming Client

Set your startup project to Microsoft.WP8.PlayerFramework.SL.Test by right clicking on the project and selecting "Set as StartUp Project"

HTML5 for browsers
There are no special requirements to run this source

Rebuilding the source code

Windows 8 and Windows Phone 8
1. Make sure you have the 64 bit of 7-Zip installed on your machine.
2. In your local reprository folder, there is a subfolder called Build. Simply run the batch file "BuildSDKs.bat". Note, you will have to hit any key to continue a few times before it finishes. When finished, an updated .vsix extension SDK will appear in the Build folder that you can then install to Visual Studio.

HTML5 for web browsers
In your local repository folder, there is a folder called Web.Html5\Build. Simply run the batch file "build.bat" and it will automatically generate an updated files in Web.Html5\js and Web.Html5\css

Updated Wiki: Source Code and Build Scripts

timgreenfield — Fri, 03 May 2013 16:47:04 GMT

Getting the source code

For Windows 8 Xaml: Microsoft.Win8.PlayerFramework.Xaml.sln
For Windows 8 JS: Microsoft.Win8.PlayerFramework.Js.sln
For Windows Phone 8 Xaml: Microsoft.WP8.PlayerFramework.SL.sln
For HTML5 web browsers: Microsoft.Web.PlayerFramework.Html5.sln

Requirements to run the source code

Windows 8 (Xaml and JS)
Required additional SDKs (these must be installed):

Smooth Streaming Client

Rebuilding the source code

Updated Wiki: Source Code and Build Scripts

timgreenfield — Fri, 03 May 2013 16:46:49 GMT

Getting the source code

1. Install the Visual Studio Tools for Git Extension
2. Find the url for the Git repository via the Source page:
imge:git_repo.png
3. In Team Explorer in Visual Studio you can easily clone the Git repository to a local folder:
imge:git_clone.png
4. Open the desired solution in Visual Studio 2012:

For Windows 8 Xaml: Microsoft.Win8.PlayerFramework.Xaml.sln
For Windows 8 JS: Microsoft.Win8.PlayerFramework.Js.sln
For Windows Phone 8 Xaml: Microsoft.WP8.PlayerFramework.SL.sln
For HTML5 web browsers: Microsoft.Web.PlayerFramework.Html5.sln

Requirements to run the source code

Windows 8 (Xaml and JS)
Required additional SDKs (these must be installed):

Smooth Streaming Client

Rebuilding the source code

Updated Wiki: Source Code and Build Scripts

timgreenfield — Fri, 03 May 2013 16:46:08 GMT

Getting the source code

For Windows 8 Xaml: Microsoft.Win8.PlayerFramework.Xaml.sln
For Windows 8 JS: Microsoft.Win8.PlayerFramework.Js.sln
For Windows Phone 8 Xaml: Microsoft.WP8.PlayerFramework.SL.sln
For HTML5 web browsers: Microsoft.Web.PlayerFramework.Html5.sln

Requirements to run the source code

Windows 8 (Xaml and JS)

Required additional SDKs (these must be installed):

Windows Phone 8 (Xaml and JS)

Required additional SDKs (these must be installed):

Smooth Streaming Client

Set your startup project to Microsoft.WP8.PlayerFramework.SL.Test by right clicking on the project and selecting "Set as StartUp Project"

HTML5 for browsers

There are no special requirements to run this source

Rebuilding the source code

Windows 8 and Windows Phone 8

1. Make sure you have the 64 bit of 7-Zip installed on your machine.
2. In your local reprository folder, there is a subfolder called Build. Simply run the batch file "BuildSDKs.bat". Note, you will have to hit any key to continue a few times before it finishes. When finished, an updated .vsix extension SDK will appear in the Build folder that you can then install to Visual Studio.

HTML5 for web browsers

In your local repository folder, there is a folder called Web.Html5\Build. Simply run the batch file "build.bat" and it will automatically generate an updated files in Web.Html5\js and Web.Html5\css

Updated Wiki: Source Code and Build Scripts

timgreenfield — Fri, 03 May 2013 16:45:51 GMT

Getting the source code

For Windows 8 Xaml: Microsoft.Win8.PlayerFramework.Xaml.sln
For Windows 8 JS: Microsoft.Win8.PlayerFramework.Js.sln
For Windows Phone 8 Xaml: Microsoft.WP8.PlayerFramework.SL.sln
For HTML5 web browsers: Microsoft.Web.PlayerFramework.Html5.sln

Requirements to run the source code

Windows 8 (Xaml and JS)

Required additional SDKs (these must be installed):

Windows Phone 8 (Xaml and JS)

Required additional SDKs (these must be installed):

Smooth Streaming Client

Set your startup project to Microsoft.WP8.PlayerFramework.SL.Test by right clicking on the project and selecting "Set as StartUp Project"

HTML5 for browsers

There are no special requirements to run this source

Rebuilding the source code

Windows 8 and Windows Phone 8

HTML5 for web browsers

In your local reprository folder, there is a folder called Web.Html5\Build. Simply run the batch file "build.bat" and it will automatically generate an updated files in Web.Html5\js and Web.Html5\css

Updated Wiki: Source Code and Build Scripts

timgreenfield — Fri, 03 May 2013 16:24:25 GMT

placeholder

Updated Wiki: JavaScript API Reference

timgreenfield — Wed, 24 Apr 2013 20:35:09 GMT

MediaPlayer

Properties

advertisingState (type: PlayerFramework.AdvertisingState, read/write)
Gets or sets the current advertising state of the player.

audioTracks (type: Array, read/write)
Gets the audio tracks for the current media source.

autobuffer (type: Boolean, read/write)
Gets or sets a value that indicates whether to automatically start buffering the current media source.

autohide (type: Boolean, read/write)
Gets or sets a value that specifies whether interactive elements (e.g. the control panel) will be hidden automatically.

autohideBehavior (type: PlayerFramework.AutohideBehavior, read/write)
Gets or sets the behavior of the autohide feature.

autohideTime (type: Number, read/write)
Gets or sets the amount of time (in seconds) before interactive elements (e.g. the control panel) will be hidden automatically.

autoload (type: Boolean, read/write)
Gets or sets a value that specifies whether to start loading the current media source automatically.

autoplay (type: Boolean, read/write)
Gets or sets a value that specifies whether to automatically start playing the current media source.

buffered (type: TimeRanges, read-only)
Gets the buffered time ranges for the current media source.

captionTracks (type: Array, read/write)
Gets the caption and subtitle tracks for the current media source.

controls (type: Boolean, read/write)
Gets or sets a value that specifies whether to display the native controls for the current media source.

currentAudioTrack (type: AudioTrack, read/write)
Gets or sets the current audio track.

currentCaptionTrack (type: TextTrack, read/write)
Gets or sets the current caption/subtitle track.

currentSrc (type: String, read-only)
Gets the URL of the current media source.

currentTime (type: Number, read/write)
Gets or sets the current playback position (in seconds).

defaultInteractiveViewModel (type: PlayerFramework.InteractiveViewModel, read-only)
Gets the view model that will be restored following a temporary change to the current interactive view model (e.g. during an ad).

defaultPlaybackRate (type: Number, read/write)
Gets or sets the playback rate to use when play is resumed.

duration (type: Number, read-only)
Gets the duration (in seconds) of the current media source.

element (type: HTMLElement, read-only)
Gets the host element for the control.

ended (type: Boolean, read-only)
Gets a value that specifies whether playback has ended.

endTime (type: Number, read/write)
Gets or sets the end time (in seconds) of the current media source. This is useful in live streaming scenarios.

error (type: MediaError, read-only)
Gets the current error state of the player.

height (type: String, read/write)
Gets or sets the height of the host element.

initialTime (type: Number, read-only)
Gets the earliest possible position (in seconds) that playback can begin.

interactiveActivationMode (type: PlayerFramework.InteractionType, read/write)
Gets or sets the type of interactions that will cause interactive elements (e.g. the control panel) to be shown.

interactiveDeactivationMode (type: PlayerFramework.InteractionType, read/write)
Gets or sets the type of interactions that will cause interactive elements (e.g. the control panel) to be hidden.

interactiveViewModel (type: PlayerFramework.InteractiveViewModel, read/write)
Gets or sets the view model that interactive elements are bound to (e.g. the control panel).

isAudioAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the audio control is allowed based on the current state of the player.

isAudioEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the audio control is enabled.

isAudioVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the audio control is visible.

isCaptionsAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the captions control is allowed based on the current state of the player.

isCaptionsEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the captions control is enabled.

isCaptionsVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the captions control is visible.

isCurrentTimeLive (type: Boolean, read/write)
Gets a value that specifies whether the current playback position is "live".

isElapsedTimeAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the elapsed time control is allowed based on the current state of the player.

isElapsedTimeEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the elapsed time control is enabled.

isElapsedTimeVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the elapsed time control is visible.

isFastForwardAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the fast forward control is allowed based on the current state of the player.

isFastForwardEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the fast forward control is enabled.

isFastForwardVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the fast forward control is visible.

isFullScreen (type: Boolean, read/write)
Gets or sets a value that specifies whether the player is in full screen mode.

isFullScreenAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the full screen control is allowed based on the current state of the player.

isFullScreenEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the full screen control is enabled.

isFullScreenVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the full screen control is visible.

isGoLiveAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the go live control is allowed based on the current state of the player.

isGoLiveEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the go live control is enabled.

isGoLiveVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the go live control is visible.

isInteractive (type: Boolean, read/write)
Gets or sets a value that specifies whether the player is currently in interactive mode (e.g. showing the control panel).

isLive (type: Boolean, read/write)
Gets a value that specifies whether the current media source is a live stream.

isMediaQualityAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the media quality control is allowed based on the current state of the player.

isMediaQualityEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the media quality control is enabled.

isMediaQualityVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the media quality control is visible.

isMuteAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the mute control is allowed based on the current state of the player.

isMuteEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the mute control is enabled.

isMuteVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the mute control is visible.

isPauseAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the pause control is allowed based on the current state of the player.

isPauseEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the pause control is enabled.

isPauseVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the pause control is visible.

isPlayPauseAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the play/pause control is allowed based on the current state of the player.

isPlayPauseEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the play/pause control is enabled.

isPlayPauseVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the play/pause control is visible.

isPlayResumeAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the play/resume control is allowed based on the current state of the player.

isPlayResumeEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the play/resume control is enabled.

isPlayResumeVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the play/resume control is visible.

isRemainingTimeAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the remaining time control is allowed based on the current state of the player.

isRemainingTimeEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the remaining time control is enabled.

isRemainingTimeVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the remaining time control is visible.

isReplayAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the replay control is allowed based on the current state of the player.

isReplayEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the replay control is enabled.

isReplayVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the replay control is visible.

isRewindAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the rewind control is allowed based on the current state of the player.

isRewindEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the rewind control is enabled.

isRewindVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the rewind control is visible.

isSignalStrengthAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the signal strength control is allowed based on the current state of the player.

isSignalStrengthEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the signal strength control is enabled.

isSignalStrengthVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the signal strength control is visible.

isSkipAheadAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the skip ahead control is allowed based on the current state of the player.

isSkipAheadEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the skip ahead control is enabled.

isSkipAheadVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the skip ahead control is visible.

isSkipBackAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the skip back control is allowed based on the current state of the player.

isSkipBackEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the skip back control is enabled.

isSkipBackVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the skip back control is visible.

isSkipNextAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the skip next control is allowed based on the current state of the player.

isSkipNextEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the skip next control is enabled.

isSkipNextVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the skip next control is visible.

isSkipPreviousAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the skip previous control is allowed based on the current state of the player.

isSkipPreviousEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the skip previous control is enabled.

isSkipPreviousVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the skip previous control is visible.

isSlowMotion (type: Boolean, read/write)
Gets or sets a value that specifies whether the player is playing in slow motion.

isSlowMotionAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the slow motion control is allowed based on the current state of the player.

isSlowMotionEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the slow motion control is enabled.

isSlowMotionVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the slow motion control is visible.

isStartTimeOffset (type: Boolean, read/write)
Gets or sets a value that specifies whether the start time is offset.

isTimelineAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the timeline control is allowed based on the current state of the player.

isTimelineEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the timeline control is enabled.

isTimelineVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the timeline control is visible.

isVolumeAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the volume control is allowed based on the current state of the player.

isVolumeEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the volume control is enabled.

isVolumeMuteAllowed (type: Boolean, read-only)
Gets a value that specifies whether interaction with the volume/mute control is allowed based on the current state of the player.

isVolumeMuteEnabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the volume/mute control is enabled.

isVolumeMuteVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the volume/mute control is visible.

isVolumeVisible (type: Boolean, read/write)
Gets or sets a value that specifies whether the volume control is visible.

liveTime (type: Number, read/write)
Gets or sets the live position (in seconds).

liveTimeBuffer (type: Number, read/write)
Gets or sets the live buffer time (in seconds) for the current playback position to be considered "live".

loop (type: Boolean, read/write)
Gets or sets a value that specifies whether playback should be restarted after it ends.

mediaElement (type: HTMLMediaElement, read-only)
Gets the media element associated with the player.

mediaExtensionManager (type: Windows.Media.MediaExtensionManager, read/write)
Gets or sets the media extension manager to be used by the player and its plugins. A new instance will be created on first use if one is not already set.

mediaQuality (type: PlayerFramework.MediaQuality, read/write)
Gets or sets the quality of the current media source.

msAudioCategory (type: String, read/write)
Gets or sets a value that specifies the purpose of the media, such as background audio or alerts.

msAudioDeviceType (type: String, read/write)
Gets or sets a value that specifies the output device ID that the audio will be sent to.

msHorizontalMirror (type: Boolean, read/write)
Gets or sets a value that specifies whether the media is flipped horizontally.

msIsLayoutOptimalForPlayback (type: Boolean, read-only)
Gets a value that specifies whether the media can be rendered more efficiently.

msIsStereo3D (type: Boolean, read-only)
Gets a value that specifies whether the system considers the media to be stereo 3D.

msPlayToDisabled (type: Boolean, read/write)
Gets or sets a value that specifies whether the DLNA PlayTo device is available.

msPlayToPrimary (type: Boolean, read/write)
Gets or sets the primary DLNA PlayTo device.

msPlayToSource (type: Object, read-only)
Gets the media source for use by the PlayToManager.

msRealTime (type: Boolean, read/write)
Gets or sets a value that specifies whether or not to enable low-latency playback.

msStereo3DPackingMode (type: String, read/write)
Gets or sets the frame-packing mode for stereo 3D video content.

msStereo3DRenderMode (type: String, read/write)
Gets or sets a value that specifies whether the system display is set to stereo display.

msZoom (type: Boolean, read/write)
Gets or sets a value that specifies whether the video frame is trimmed to fit the display.

muted (type: Boolean, read/write)
Gets or sets a value that indicates whether the audio is muted.

networkState (type: PlayerFramework.NetworkState, read-only)
Gets the current network state for the player.

paused (type: Boolean, read-only)
Gets a value that specifies whether playback is paused.

playbackRate (type: Number, read/write)
Gets or sets the playback rate for the current media source.

played (type: TimeRanges, read-only)
Gets the played time ranges for the current media source.

playerState (type: PlayerFramework.PlayerState, read/write)
Gets or sets the current state of the player.

plugins (type: Array, read-only)
Gets the plugins associated with the player.

poster (type: String, read/write)
Gets or sets the URL of an image to display while the current media source is loading.

preload (type: String, read/write)
Gets or sets a hint to how much buffering is advisable for the current media source.

readyState (type: PlayerFramework.ReadyState, read-only)
Gets the current readiness state of the player.

replayOffset (type: Number, read/write)
Gets or sets the amount of time (in seconds) to offset the current playback position during replay.

scrubbing (type: Boolean, read-only)
Gets a value that specifies whether the player is currently moving to a new playback position due to a scrub operation.

seekable (type: TimeRanges, read-only)
Gets the seekable time ranges of the current media source.

seeking (type: Boolean, read-only)
Gets a value that specifies whether the player is currently moving to a new playback position due to a seek operation.

seekWhileScrubbing (type: Boolean, read/write)
Gets or sets a value that specifies whether the current video frame should be updated during a scrub operation.

signalStrength (type: Number, read/write)
Gets or sets the signal strength of the current media source. This is useful in adaptive streaming scenarios.

skipAheadInterval (type: Number, read/write)
Gets or sets the amount of time (in seconds) that the skip ahead control will seek forward.

skipBackInterval (type: Number, read/write)
Gets or sets the amount of time (in seconds) that the skip back control will seek backward.

slowMotionPlaybackRate (type: Number, read/write)
Gets or sets the playback rate to use when in slow motion.

sources (type: Array, read/write)
Gets or sets the media sources to be considered.

src (type: String, read/write)
Gets or sets the URL of the current media source to be considered.

startTime (type: Number, read/write)
Gets or sets the start time (in seconds) of the current media source. This is useful in live streaming scenarios.

startupTime (type: Number, read/write)
Gets or sets the position (in seconds) where playback should start. This is useful for resuming a video where the user left off in a previous session.

testForMediaPack (type: Boolean, read/write)
Gets or sets whether a test for the media feature pack should be performed prior to allowing content to be laoded. This is useful to enable if Windows 8 N/KN users will be using this app.

textTracks (type: TextTrackList, read-only)
Gets the text tracks for the current media source.

tracks (type: Array, read/write)
Gets or sets the tracks for the player.

videoHeight (type: Number, read-only)
Gets the intrinsic height of the current video (in pixels).

videoWidth (type: Number, read-only)
Gets the intrinsic width of the current video (in pixels).

volume (type: Number, read/write)
Gets or sets the volume level (from 0 to 1) for the audio portions of media playback.

width (type: String, read/write)
Gets or sets the width of the host element.

Methods

addClass(name)
Adds the specified CSS class to the host element.

name: (type: String) The name of the class to add. Multiple classes can be added using space-delimited names.

canPlayType(type)
Returns a value that specifies whether the player can play a given media type.

type: (type: String) The type of media to be played.
Returns: (type: String) One of the following values: "probably", "maybe", or an empty string if the media cannot be rendered.

decreasePlaybackRate()
Decreases the current playback rate by a factor of two. After the rate reaches 1 (normal speed), it will flip to -1, and then begins to rewind.

dispose()
Shuts down and releases all resources.

focus()
Gives focus to the host element.

increasePlaybackRate()
Increases the current playback rate by a factor of two. After the rate reaches -1, it flips to 1 (normal speed), and then begins to fast forward.

load()
Reloads the current media source.

msClearEffects()
Clears all effects from the media pipeline.

msFrameStep(forward)
Steps the video forward or backward by one frame.

forward: (type: Boolean) If true, the video is stepped forward, otherwise the video is stepped backward.

msInsertAudioEffect(activatableClassId,effectRequired,config)
Inserts the specified audio effect into the media pipeline.

activatableClassId: (type: String) The audio effects class.
effectRequired: (type: Boolean)
config: (type: Object)

msInsertVideoEffect(activatableClassId,effectRequired,config)
Inserts the specified video effect into the media pipeline.

activatableClassId: (type: String) The video effects class.
effectRequired: (type: Boolean)
config: (type: Object)

msSetMediaProtectionManager(mediaProtectionManager)
Sets the media protection manager for a given media pipeline.

mediaProtectionManager: (type: Windows.Media.Protection.MediaProtectionManager)

msSetVideoRectangle(left,top,right,bottom)
Sets the dimensions of a sub-rectangle within a video.

left: (type: Number) The left position of the rectangle.
top: (type: Number) The top position of the rectangle.
right: (type: Number) The right position of the rectangle.
bottom: (type: Number) The bottom position of the rectangle.

pause()
Pauses playback of the current media source.

play()
Loads and starts playback of the current media source.

playResume()
Resets the playback rate and resumes playing the current media source.

removeClass(name)
Removes the specified CSS class from the host element.

name: (type: String) The name of the class to remove. Multiple classes can be removed using space-delimited names.

replay()
Supports instant replay by applying an offset to the current playback position.

retry()
Reloads the current media source and resumes where playback was left off.

update(mediaSource)
Updates the player and its plugins with the specified media source (e.g. the current playlist item).

mediaSource: (type: Object) A JSON object containing the set of options that represent a media source.

Events

advertisingstatechange
Occurs when the advertising state of the player is changed.

canplay
Occurs when playback is possible, but would require further buffering.

canplaythrough
Occurs when playback to the end is possible without requiring further buffering.

currentaudiotrackchange
Occurs when the current audio track has changed.

currentaudiotrackchanging
Occurs when the current audio track is changing and presents an opportunity for custom behavior. Used by the adaptive plugin.

currentcaptiontrackchange
Occurs when the current caption track has changed.

currentcaptiontrackchanging
Occurs when the current caption track is changing and presents an opportunity for custom behavior. Used by the captions plugin.

durationchange
Occurs when the media duration is updated.

emptied
Occurs when the media element is reset to its initial state.

ended
Occurs when the end of playback is reached.

ending
Occurs before the ended event and presents an opportunity for deferral. Useful for postroll ads.

error
Occurs when the media element encounters an error.

fullscreenchange
Occurs when the full screen state of the player is changed.

initialized
Occurs when the player has finished initializing itself and its plugins.

interactivestatechange
Occurs when the interactive state of the player is changed.

interactiveviewmodelchange
Occurs when the view model used to drive interactive components such as the control panel is changed (e.g. when an ad start or ends).

islivechange
Occurs when the live state of the media source changes.

loadeddata
Occurs when media data is loaded at the current playback position.

loadedmetadata
Occurs when the duration and dimensions of the media have been determined.

loading
Occurs before the media source is set and offers the ability to perform blocking operations.

loadstart
Occurs after the media source is set and the player begins looking for media data.

msvideoformatchanged
Occurs when the video format changes.

msvideoframestepcompleted
Occurs when the video frame has been stepped forward or backward one frame.

msvideooptimallayoutchanged
Occurs when the msIsLayoutOptimalForPlayback state changes.

mutedchange
Occurs when the muted state of the player changes.

pause
Occurs when playback is paused.

play
Occurs when the play method is requested.

playerstatechange
Occurs when the state of the player has changed.

playing
Occurs when the media has started playing.

progress
Occurs when progress is made while downloading media data.

ratechange
Occurs when the playback rate is increased or decreased.

readystatechange
Occurs when the ready state has changed.

scrub
Occurs when a scrub operation is requested.

scrubbed
Occurs when a scrub operation ends.

scrubbing
Occurs when the current playback position is moved due to a scrub operation.

seek
Occurs when a seek operation is requested.

seeked
Occurs when a seek operation ends.

seeking
Occurs when the current playback position is moved due to a seek operation.

stalled
Occurs when the media download has stopped.

started
Occurs after playback has started.

starting
Occurs before playback has started and presents an opportunity for deferral or cancellation. Useful for preroll ads.

suspend
Occurs when the load operation has been intentionally halted.

timeupdate
Occurs when the current playback position is updated.

updated
Occurs when the player is updated with a new media source (e.g. when the current playlist item is changed).

volumechange
Occurs when the volume is changed.

waiting
Occurs when playback stops because the next video frame is unavailable.

Updated Wiki: Home

mdowney — Mon, 22 Apr 2013 23:10:35 GMT

Player Framework: an open source component of the Microsoft Media Platform

Player Framework for Windows 8 and Windows Phone 8 - v1.2 now available (4/22/13)

Project Description
An open source, robust video player framework for Windows 8, HTML5, Silverlight, Windows Phone and other application platforms.

Video players can be incredibly difficult to build. When developers require support for adaptive streaming, closed captioning, advertising standards integration, DVR-style playback control, and other advanced features, the complexity of their video player grows exponentially. Over the last few years at Microsoft we have helped build some of the most advanced video applications on the Web including the browser-based experience for the Beijing and Vancouver Olympics with NBC Sports, the last three seasons of NBC's Sunday Night Football (including the 2012 Super Bowl), the CBS March Madness college basketball tournament, Wimbledon, and a number of other major, live events with millions of simultaneous users. As a part of those projects we have developed one of the most powerful video players on the planet. And we've decided to share it with everyone, for free.

The Microsoft Media Platform's Player Framework is an open source video player that we continue to develop and evolve. It is available for Silverlight, HTML5, Windows Phone, Xbox, and now, in our latest release, Windows 8 applications. And it's fully open source!

The Player Framework supports a long list of advanced features including:

Adaptive streaming and advanced playback heuristics via the IIS Smooth Streaming Client SDK for Windows 8
Closed captioning support via SMPTE-TT and TTML
Advertising standards support including VAST, MAST, and VPAID
Advanced DVR-style playback
Robust skinning and styling
A number of other powerful features

Follow the links below to start building for each of these platforms:

In the future we plan to expand our platform support to include other popular mobile platforms, even the ones that aren't a part of the Microsoft family. ;)

Additional information

Learn about the Microsoft Media Platform
Check out Microsoft's Nigel Parker's post on navigating the HTML5 video maze

Updated Wiki: Analytics

mdowney — Mon, 22 Apr 2013 23:08:48 GMT

The player framework now offers a number of ways to support video analytics and telemetry in your app. There are two overall approaches you can take depending on your needs.

DIY: The player framework includes numerous events and properties that you can easily wire up to in order to track and collect information about how your user is behaving when watching and interacting with the media. Please review the API documentation for details on all the possible APIs available to you.
Tracking plugin: The player framework includes a simple yet valuable plugin to track playback positions and playtime milestones. This can be used, for example, to easily gather information about when the user has spent more than 30 minutes watching your video or when they reached the 75% point. Used in combination with #1 above, it can usually provide access to most of the analytic data you may wish to track. Click here to learn more about this plugin, tracking and markers.
Analytics plugin: For more advanced scenarios, the player framework now includes a new analytics plugin to help collect and send quality and user behavior data to the web for analysis to help you troubleshoot your streams, understand the quality your users perceive and learn about usage patterns. This plugin builds on top of #1 and #2 above and offers an extensible architecture that 3rd party analytics services can easily expand on.

The rest of this document will focus on #3: The Analytics plugin

This analytics plugin is an optional plugin that can be hooked up to any backend such as Microsoft Audience Insight, Adobe SiteCatalyst (part of the Adobe Omniture suite), or any other service designed to help analyze your app's video usage.

Architecture

Before we get started and take a look at how to add this to your project, it is important to understand the general architecture of the analytics plugin in the player framework so you understand the basics of how it works. The analytics engine of the player framework uses simple log objects to pass around information about what is occurring during playback. Here are some of the primary pieces of the analytics engine:

AnalyticsCollector

This is the primary class (built as a WinRT component) responsible for glueing together the data clients (the objects responsible for providing the information) and the logging service (the object responsible for broadcasting logs).

DataClients

The analytics plugin collects data from four different types of data clients (each implementing a unique interface).

IEdgeServerMonitor: This dataclient is responsible for retrieving extra information about the server streaming your video such as the IP or domain name for your CDN. This will help you identify if a certain CDN is having problems.
IEnvironmentMonitor: This dataclient is responsible for providing system & environment information such as frames per second and CPU load. Note: this information is only available for Windows Phone.
IPlayerMonitor: This dataclient is responsible for relaying information about the state of the player. The Xaml and JS versions of the player framework each provide their own implementation.
IAdaptiveMonitor: This optional dataclient provides information specific to adaptive streaming and is not relevant when serving progressive download content. The player framework ships with an implementation specifically for smooth streaming but you could build your own if you are using a custom media foundation extension (or MediaStreamSource in WP8) such as HLS.

LoggingService

The logging service is a central (static) object responsible for broadcasting data to ILoggingTarget objects. These logging targets then consume the logs and process them.

Microsoft Audience Insight

The Audience Insight logging target is included out of the box with the player framework analytics plugin and is responsible for filtering, serializing, batching and uploading logs to an Audience Insight server. Find out more info about adding Audience Insight to your application.

Adobe SiteCatalyst

We have created a proof of concept logging target capable of logging to Adobe SiteCatalyst using the Site Catalyst SDK. We do not ship this with the player framework because it has a dependency on the Adobe SiteCatalyst SDK (which you need to download separately from Adobe). Find out more info about adding Site Catalyst to your application.

Custom logging target

Using the same technique as the Audience Insight and SiteCatalyst components, you can easily create one of your own to log data to a web service or monitor activity from within your app for diagnostic purposes. This could be a different analytics collection service in the cloud or it could be a part of your app used to diagnose problems. Find out more info about building and adding a custom logging target to your application.

Updated Wiki: Analytics

mdowney — Mon, 22 Apr 2013 23:06:46 GMT

The player framework now offers a number of ways to support video analytics and telemetry in your app. There are two overall approaches you can take depending on your needs.

DIY: The player framework includes numerous events and properties that you can easily wire up to in order to track and collect information about how your user is behaving when watching and interacting with the media. Please review the API documentation for details on all the possible APIs available to you.
Tracking plugin: The player framework includes a simple yet valuable plugin to optional track playback positions and playtime milestones. This can be used for example to easily gather information about when the user has spent more than 30 minutes watching your video or when they reached the 75% point. Used in combination with #1 above, it can usually provide access to most of the analytic data you may wish to track. Click here to learn more about this plugin, tracking and markers.
Analytics plugin: For more advanced scenarios, the player framework now includes a new analytics plugin to help collect and send quality and user behavior data to the web for analysis to help you troubleshoot your streams, understand the quality your users perceive and learn about usage patterns. This plugin builds on top of #1 and #2 above and offers an extensible architecture that 3rd party analytics services can easily expand on.

Architecture

AnalyticsCollector

DataClients

The analytics plugin collects data from four different types of data clients (each implementing a unique interface).

IEdgeServerMonitor: This dataclient is responsible for retrieving extra information about the server streaming your video such as the IP or domain name for your CDN. This will help you identify if a certain CDN is having problems.
IEnvironmentMonitor: This dataclient is responsible for providing system & environment information such as frames per second and CPU load. Note: this information is only available for Windows Phone.
IPlayerMonitor: This dataclient is responsible for relaying information about the state of the player. The Xaml and JS versions of the player framework each provide their own implementation.
IAdaptiveMonitor: This optional dataclient provides information specific to adaptive streaming and is not relevant when serving progressive download content. The player framework ships with an implementation specifically for smooth streaming but you could build your own if you are using a custom media foundation extension (or MediaStreamSource in WP8) such as HLS.

LoggingService

The logging service is a central (static) object responsible for broadcasting data to ILoggingTarget objects. These logging targets then consume the logs and process them.

Microsoft Audience Insight

Adobe SiteCatalyst

Custom logging target

Updated Wiki: Windows 8 Player Documentation

timgreenfield — Mon, 22 Apr 2013 22:25:03 GMT

Documentation for the Windows 8 Player Framework is a work-in-progress. Please continue to monitor this page as we will be regularly adding more documentation, samples, and demos.

Getting Started

API References

Feature Overviews

Sample Tutorials

Channel 9 sample application for JavaScript

New Comment on "Windows 8 Player Documentation"

mdowney — Mon, 22 Apr 2013 01:19:41 GMT

@phil77 - you need to use the smooth streaming client (SSME) instead of the smooth streaming SDK when building for Windows Phone. I'll make sure we make this clear in our docs. http://www.microsoft.com/en-us/download/details.aspx?id=29940

Updated Wiki: Custom Logging Target

timgreenfield — Fri, 12 Apr 2013 23:09:01 GMT

Building your own logging target to capture logs generated by the analytics plugin is straight forward. You simply need to create a class that implements Microsoft.VideoAnalytics.ILoggingTarget. Note: if your app is a Windows 8 JavaScript app you just need to add a WinRT class library to your solution and built the logging target implementation in C#, VB, or C++.

Building an ILoggingTarget

ILoggingTarget is a very simple interface with only one method:

namespace Microsoft.VideoAnalytics
{
    /// <summary>
    /// An interface to allow an object to become a target of logging events.
    /// </summary>
    public interface ILoggingTarget
    {
        /// <summary>
        /// Called to pass a new log to the target.
        /// </summary>
        /// <param name="log">The log object that was generated.</param>
        void LogEntry(ILog log);
    }
}

Once you register your implementation as a logging target, it will automatically receive all logs generated.

Using and understanding the logs

Each log implements ILog and can be cast to a specific log type to find out more details. There are dozens of different types of logs generated and even more if you wire up the AdaptiveMonitor (see next section below for more details).

A typical way to read and utilize the logs received typically involves checking the object type and depending on the type, casting it to it's true form and reading it's high level properties.

Here's an example of what the code may look like:

public void LogEntry(ILog log)
{
    if (log is PerceivedBandwidthLog)
    {
        var typedLog = (PerceivedBandwidthLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.PerceivedBandwidth);
        chart.AddDataPoint(typedLog.PerceivedBandwidth / (1024 * 8));
    }
    else if (log is BufferSizeLog)
    {
        var typedLog = (BufferSizeLog)log;
        ChartViewModel chart = null;
        if (typedLog.StreamType == "audio")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.AudioBufferSize);
        }
        if (typedLog.StreamType == "video")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.VideoBufferSize);
        }
        if (chart != null)
        {
            chart.AddDataPoint(typedLog.BufferSize);
        }
    }
    else if (log is ChunkDownloadLog)
    {
        var typedLog = (ChunkDownloadLog)log;
        ChartViewModel chart = null;
        if (typedLog.StreamType == "audio")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.AudioDownloadLatencyMilliseconds);
        }
        if (typedLog.StreamType == "video")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.VideoDownloadLatencyMilliseconds);
        }
        if (chart != null)
        {
            chart.AddDataPoint(typedLog.DownloadTimeMs);
        }
    }
    else if (log is BitrateChangedLog)
    {
        var typedLog = (BitrateChangedLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.BitRate);
        chart.AddDataPoint(typedLog.Bitrate);
    }
    else if (log is BufferingChangedLog)
    {
        var typedLog = (BufferingChangedLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.IsBuffering);
        chart.AddDataPoint(typedLog.IsBuffering ? 1 : 0);
    }
    else if (log is StreamLoadedLog)
    {
        var loadLog = log as StreamLoadedLog;
        var bitrateChartData = Charts.First(vm => vm.QualityAttribute == QualityCharts.BitRate);
        bitrateChartData.MaxValue = loadLog.MaxBitrate;
    }
}

Registering your custom logging target

To connect your logging target to the player framework, you only need one line of code:
In JavaScript:

Microsoft.VideoAnalytics.LoggingService.current.loggingTargets.append(new MyNamespace.MyLoggingTarget());

In C#:

LoggingService.Current.LoggingTargets.Add(new MyLoggingTarget());

More data: add your own logs

It is equally easy to add your own data. Simply create a new ILog implementation for each log type you want to create and pass them into the logging service via:
In JavaScript:

Microsoft.VideoAnalytics.LoggingService.current.log(new MyNamespace.MyLog());

In C#:

LoggingService.Current.Log(new MyLog());

Logs can also have data attached to them automatically by logging through the AnalyticsPlugin. Logs sent to this class will automatically be stamped with additional session and media specific data before they are sent to the LoggingService. To do this:
In JavaScript:

mediaPlayer.AnalyticsPlugin.log(new MyNamespace.MyLog());

In C#:

analyticsPlugin.Log(new MyLog());

Note: add to the AnalyticsPlugin.MediaData and AnalyticsPlugin.SessionData dictionaries to include additional data that you want attached to each log. This is particularly useful for VideoID, ...etc.

More data: Connecting the AdaptiveMonitor for Smooth Streaming information

See the Audience Insight getting started guide to learn about how to capture smooth streaming heuristics and diagnostics data.

More data: Capturing unhandled exceptions

See the Audience Insight getting started guide to learn about how to capture unhandled exceptions.

More data: Using the TrackingPlugin

The tracking plugin is a great way to know when specific milestones or playback positions have been reached by your user. These plugins can also generate logs that are automatically captured by the analytics plugin. All you have to do is make sure the events you are tracking have the Area property set to "Analytics".
See the Tracking plugin documentation to learn about how to create playback and position events to track.

Your app can be a logging target too.

Instead of filtering, serializing and sending logs to a server, it is also possible to consume these logs locally. This can be useful for displaying diagnostic information in your app to help debug playback issues. As a proof of concept, we ported the Silverlight Health Monitor to Windows 8 to demonstrate a novel use for this approach. Here you can see a subset of the data being logged and displayed into a real time monitor within your application.

Updated Wiki: Custom Logging Target

timgreenfield — Fri, 12 Apr 2013 23:01:32 GMT

Building an ILoggingTarget

ILoggingTarget is a very simple interface with only one method:

namespace Microsoft.VideoAnalytics
{
    /// <summary>
    /// An interface to allow an object to become a target of logging events.
    /// </summary>
    public interface ILoggingTarget
    {
        /// <summary>
        /// Called to pass a new log to the target.
        /// </summary>
        /// <param name="log">The log object that was generated.</param>
        void LogEntry(ILog log);
    }
}

Once you register your implementation as a logging target, it will automatically receive all logs generated.

Using and understanding the logs

public void LogEntry(ILog log)
{
    if (log is PerceivedBandwidthLog)
    {
        var typedLog = (PerceivedBandwidthLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.PerceivedBandwidth);
        chart.AddDataPoint(typedLog.PerceivedBandwidth / (1024 * 8));
    }
    else if (log is BufferSizeLog)
    {
        var typedLog = (BufferSizeLog)log;
        ChartViewModel chart = null;
        if (typedLog.StreamType == "audio")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.AudioBufferSize);
        }
        if (typedLog.StreamType == "video")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.VideoBufferSize);
        }
        if (chart != null)
        {
            chart.AddDataPoint(typedLog.BufferSize);
        }
    }
    else if (log is ChunkDownloadLog)
    {
        var typedLog = (ChunkDownloadLog)log;
        ChartViewModel chart = null;
        if (typedLog.StreamType == "audio")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.AudioDownloadLatencyMilliseconds);
        }
        if (typedLog.StreamType == "video")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.VideoDownloadLatencyMilliseconds);
        }
        if (chart != null)
        {
            chart.AddDataPoint(typedLog.DownloadTimeMs);
        }
    }
    else if (log is BitrateChangedLog)
    {
        var typedLog = (BitrateChangedLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.BitRate);
        chart.AddDataPoint(typedLog.Bitrate);
    }
    else if (log is BufferingChangedLog)
    {
        var typedLog = (BufferingChangedLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.IsBuffering);
        chart.AddDataPoint(typedLog.IsBuffering ? 1 : 0);
    }
    else if (log is StreamLoadedLog)
    {
        var loadLog = log as StreamLoadedLog;
        var bitrateChartData = Charts.First(vm => vm.QualityAttribute == QualityCharts.BitRate);
        bitrateChartData.MaxValue = loadLog.MaxBitrate;
    }
}

Registering your custom logging target

To connect your logging target to the player framework, you only need one line of code:
In JavaScript:

Microsoft.VideoAnalytics.LoggingService.current.loggingTargets.append(new MyNamespace.MyLoggingTarget());

In C#:

LoggingService.Current.LoggingTargets.Add(new MyLoggingTarget());

More data: add your own logs

It is equally easy to add your own data. Simply create a new ILog implementation for each log type you want to create and pass them into the logging service via:
In JavaScript:

Microsoft.VideoAnalytics.LoggingService.current.log(new MyNamespace.MyLog());

In C#:

LoggingService.Current.Log(new MyLog());

mediaPlayer.AnalyticsPlugin.log(new MyNamespace.MyLog());

In C#:

analyticsPlugin.Log(new MyLog());

Note: add to the AnalyticsPlugin.MediaData and AnalyticsPlugin.SessionData dictionaries to include additional data that you want attached to each log. This is particularly useful for VideoID, ...etc.

More data: Connecting the AdaptiveMonitor for Smooth Streaming information

See the Audience Insight getting started guide to learn about how to capture smooth streaming heuristics and diagnostics data.

More data: Capturing unhandled exceptions

See the Audience Insight getting started guide to learn about how to capture unhandled exceptions.

More data: Using the TrackingPlugin

Updated Wiki: Custom Logging Target

timgreenfield — Fri, 12 Apr 2013 22:44:14 GMT

Building an ILoggingTarget

ILoggingTarget is a very simple interface with only one method:

namespace Microsoft.VideoAnalytics
{
    /// <summary>
    /// An interface to allow an object to become a target of logging events.
    /// </summary>
    public interface ILoggingTarget
    {
        /// <summary>
        /// Called to pass a new log to the target.
        /// </summary>
        /// <param name="log">The log object that was generated.</param>
        void LogEntry(ILog log);
    }
}

Once you register your implementation as a logging target, it will automatically receive all logs generated.

Using and understanding the logs

public void LogEntry(ILog log)
{
    if (log is PerceivedBandwidthLog)
    {
        var typedLog = (PerceivedBandwidthLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.PerceivedBandwidth);
        chart.AddDataPoint(typedLog.PerceivedBandwidth / (1024 * 8));
    }
    else if (log is BufferSizeLog)
    {
        var typedLog = (BufferSizeLog)log;
        ChartViewModel chart = null;
        if (typedLog.StreamType == "audio")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.AudioBufferSize);
        }
        if (typedLog.StreamType == "video")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.VideoBufferSize);
        }
        if (chart != null)
        {
            chart.AddDataPoint(typedLog.BufferSize);
        }
    }
    else if (log is ChunkDownloadLog)
    {
        var typedLog = (ChunkDownloadLog)log;
        ChartViewModel chart = null;
        if (typedLog.StreamType == "audio")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.AudioDownloadLatencyMilliseconds);
        }
        if (typedLog.StreamType == "video")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.VideoDownloadLatencyMilliseconds);
        }
        if (chart != null)
        {
            chart.AddDataPoint(typedLog.DownloadTimeMs);
        }
    }
    else if (log is BitrateChangedLog)
    {
        var typedLog = (BitrateChangedLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.BitRate);
        chart.AddDataPoint(typedLog.Bitrate);
    }
    else if (log is BufferingChangedLog)
    {
        var typedLog = (BufferingChangedLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.IsBuffering);
        chart.AddDataPoint(typedLog.IsBuffering ? 1 : 0);
    }
    else if (log is StreamLoadedLog)
    {
        var loadLog = log as StreamLoadedLog;
        var bitrateChartData = Charts.First(vm => vm.QualityAttribute == QualityCharts.BitRate);
        bitrateChartData.MaxValue = loadLog.MaxBitrate;
    }
}

Registering your custom logging target

To connect your logging target to the player framework, you only need one line of code:
In JavaScript:

Microsoft.VideoAnalytics.LoggingService.current.loggingTargets.append(new MyNamespace.MyLoggingTarget());

In C#:

LoggingService.Current.LoggingTargets.Add(new MyLoggingTarget());

More data: add your own logs

It is equally easy to add your own data. Simply create a new ILog implementation for each log type you want to create and pass them into the logging service via:
In JavaScript:

Microsoft.VideoAnalytics.LoggingService.current.log(new MyNamespace.MyLog());

In C#:

LoggingService.Current.Log(new MyLog());

mediaPlayer.AnalyticsPlugin.log(new MyNamespace.MyLog());

In C#:

analyticsPlugin.Log(new MyLog());

Note: add to AnalyticsPlugin.MediaData and AnalyticsData.SessionData to populate it with values you want attached to each log.

More data: Connecting the AdaptiveMonitor for Smooth Streaming information

More data: Using the TrackingPlugin

Health monitor example

Updated Wiki: Custom Logging Target

timgreenfield — Fri, 12 Apr 2013 22:25:57 GMT

Building an ILoggingTarget

ILoggingTarget is a very simple interface with only one method:

namespace Microsoft.VideoAnalytics
{
    /// <summary>
    /// An interface to allow an object to become a target of logging events.
    /// </summary>
    public interface ILoggingTarget
    {
        /// <summary>
        /// Called to pass a new log to the target.
        /// </summary>
        /// <param name="log">The log object that was generated.</param>
        void LogEntry(ILog log);
    }
}

Once you register your implementation as a logging target, it will automatically receive all logs generated.

Using and understanding the logs

public void LogEntry(ILog log)
{
    if (log is QualityReport)
    {
        var t = Dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, () =>
        {
            QualityReport.DataContext = log;
        });
    }
    if (log is CpuLog)
    {
        var typedLog = (CpuLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.ProcessCPULoad);
        chart.AddDataPoint(typedLog.ProcessCpu);
    }
    else if (log is PerceivedBandwidthLog)
    {
        var typedLog = (PerceivedBandwidthLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.PerceivedBandwidth);
        chart.AddDataPoint(typedLog.PerceivedBandwidth / (1024 * 8));
    }
    else if (log is BufferSizeLog)
    {
        var typedLog = (BufferSizeLog)log;
        ChartViewModel chart = null;
        if (typedLog.StreamType == "audio")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.AudioBufferSize);
        }
        if (typedLog.StreamType == "video")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.VideoBufferSize);
        }
        if (chart != null)
        {
            chart.AddDataPoint(typedLog.BufferSize);
        }
    }
    else if (log is ChunkDownloadLog)
    {
        var typedLog = (ChunkDownloadLog)log;
        ChartViewModel chart = null;
        if (typedLog.StreamType == "audio")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.AudioDownloadLatencyMilliseconds);
        }
        if (typedLog.StreamType == "video")
        {
            chart = Charts.First(c => c.QualityAttribute == QualityCharts.VideoDownloadLatencyMilliseconds);
        }
        if (chart != null)
        {
            chart.AddDataPoint(typedLog.DownloadTimeMs);
        }
    }
    else if (log is BitrateChangedLog)
    {
        var typedLog = (BitrateChangedLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.BitRate);
        chart.AddDataPoint(typedLog.Bitrate);
    }
    else if (log is BufferingChangedLog)
    {
        var typedLog = (BufferingChangedLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.IsBuffering);
        chart.AddDataPoint(typedLog.IsBuffering ? 1 : 0);
    }
    else if (log is FpsLog)
    {
        var typedLog = (FpsLog)log;
        var chart = Charts.First(c => c.QualityAttribute == QualityCharts.RenderedFrames);
        chart.AddDataPoint(typedLog.RenderedFramesPerSecond);
        chart.MaxValue = typedLog.RenderedFramesPerSecond + typedLog.DroppedFramesPerSecond;
    }
    else if (log is StreamLoadedLog)
    {
        var loadLog = log as StreamLoadedLog;
        var bitrateChartData = Charts.First(vm => vm.QualityAttribute == QualityCharts.BitRate);
        bitrateChartData.MaxValue = loadLog.MaxBitrate;
    }
}

Registering your custom logging target

To connect your logging target to the player framework, you only need one line of code:
In JavaScript:

Microsoft.VideoAnalytics.LoggingService.current.loggingTargets.append(new MyNamespace.MyLoggingTarget());

In C#:

LoggingService.Current.LoggingTargets.Add(new MyLoggingTarget());