Video

Full control of all your video playback and tracking needs is now available through a simple to use user interface. You can assign up to 15 videos and track events for each video independently. Cue points are fully supported but as an enhancement the timed actions panel allows you to easy synchronize animation with video content through custom functions. All technical steps have been simplified enabling increasingly complex video executions to be achieved in no time at all.

 

Explore the video settings

Video v 2.0.6

Component Property Inspector

 

Settings

Description

Buffer time Sets the number of seconds that will buffer before playback can begin

Streaming | Progressive

Check Streaming box for streaming video and uncheck box for progressive download

With bandwidth detection Enables bandwidth detection which will serve a different video file based on the bandwidth available.
Okay to fallback to progressive Allows the component to fallback to a progressive download if the streaming server fails.

Play on load

The first video from the playlist will start once the buffer is full

Start with audio on Sets the audio to on when the video initially plays

Maximum audio volume

Set the maximum initial volume level

Explore the video playlist settings

Video v 2.0.6

Component Property Inspector

 

Settings

Description

ID An automatically generated video ID which cannot be edited.
Video Movie # The index of the movie variable which holds the FLV in the links and descriptions.
Add Video Adds a new video to the playlist
Delete Video Deletes the currently selected video from the playlist.
Loop whole playlist Loop Toggle Plays a single video from the playlist | Plays the entire playlist
Copy example FLV Copies the example FLV into your current working directory. (PC only)
Loop Count The number entered here will be used in both of the playback types above. If "Click to Play Single Video"is selected it will loop the video the specified times. If you select to play the entire playlist it will loop the entire playlist by the specified number.

Explore the event tracking settings

Video v 2.0.6

Event Tracking Inspector

 

Note - The event numbers registered here must be present in the 'Links and Descriptions' layer to track correctly within the media console.


//------------------------------------------------
// Events | Declare your custom events here.
// e.g. event1desc = "User clicked to play video";
// e.g. event2desc = "User closed ad";
// (minimum 0 | maximum 75)
//------------------------------------------------ event1desc = "25% of the first video played";
event2desc = "50% of the fisrt video played";
event3desc = "75% of the first video played";
event4desc = "100% of the first video played";
event5desc = "First video played";
event6desc = "First video stopped";
event7desc = "First video unmuted";
event8desc = "First video muted";

Settings

Description

ID The unique video ID.

25% Played

Triggered when 25% of the selected video has been played.

50% Played Triggered when 50% of the selected video has been played.

75% Played

Triggered when 75% of the selected video has been played.

100% Played

Triggered when 100% of the selected video has been played.

Play

Triggered when the selected video is played.

Stop

Triggered when the selected video is stopped.

Audio on Triggered when the audio is unmuted.
Audio off Triggered when the audio is muted.

Explore the timed actions settings

Video v 2.0.6

Event Tracking Inspector

 

Settings

Description

Time

The time from the start of the creative when the function should be called (In seconds).

Function

The name of the custom function to trigger when the time is reached. The function must be declared on the same level as the component.
ID The video to assign the timed action too ( ID from 'Video Playlist' ).

Add Video

Adds a new entry to the timed actions list

Delete Video Deletes an entry in the timed actions list

Expand the 'Explore the video API and broadcast events'Explore the video API and broadcast events

API

You can access the methods of the component through it's instance name. By default it is set to VideoDisplay. e.g. VideoDisplay.play(0); // Plays the first video from the playlist.

Methods

Descriptions

play([index:Number]):Void

Plays the video located at the specifed index in the playlist. If there is only a single video in the playlist then the index number is not required. e.g. play();

pause([flag:Boolean]):Void

Pauses or resumes playback of a stream. The flag value specifies whether to pause play (true) or resume play (false). If you omit this parameter, pause() acts as a toggle.

stop():Void Stops the current video.
seek([second:Number]):Void Plays the video from the specified seconds.
clear():Void Clears the video currently displayed in the component.
setVolume([volume:Number]):Void Sets the volume of the video. [0=muted , 100=unmuted]
toggleAudio():Void Toggles the audio of the video on or off.

The netStream object can be also referenced via the component instance name e.g. VideoDisplay.ns.time;

Broadcast Events

The video component broadcasts the following events which can be listened for through a _root level function called MRM_component_events.

Event Type

Descriptions

onVideoStreamStarted Fires when the video playback starts (i.e. each time play(), seek() and pause(false) are called).
onVideoStreamStopped Fires when the video stream stops playing.

onVideoStreamCompleted

Fires when the video stream completes playing.

onVideoStreamUnPaused Fires when the video stream is unpaused.

onVideoStreamPaused

Fires when the video stream is paused.

onVideoStreamMuted

Fires when the video stream audio is muted.
onVideoStreamUnMuted Fires when the video stream audio is unmuted.
onVideoStreamCuePoint Fires when a cue point is reached.
onVideoStreamCueText Fires when cueText is available. (FP 9 & 10)
onVideoStreamBufferEmpty Fires when the video stream buffer is empty.
onVideoStreamBufferFull Fires when the video stream buffer is full.
onVideoStreamBufferFlush Fires when the video stream is fully loaded and the buffer is about the flush.
onVideoStreamFailed Fires when the video stream fails to play including progressive fallback.
onVideoStreamStreamingFailed Fires if the streaming server is unavailable and the user has chosen not to use progressive fallback
onVideoStreamConnectionSuccess Fires when the video connection is successful
onVideoStreamConnectionClosed Fires when the video connection is closed, after the client has been idle for over 5 minutes

 

To setup the timeline function you can use the action hints panel and select the Video Events and then the MRM_component_events

Component Action Hints

 


//----------------------------------------------------------------------------------- 
// 	MRM_component_events | Video.  e.g.evtObj.type == "onVideoStreamStarted"
//----------------------------------------------------------------------------------- 
//	evtObj.type			The broadcast event.
//	evtObj.target			The component which broadcasts the event.
//	evtObj.videoIndex		The index number of the video playing. (Starts at zero)
//	evtObj.cueData			An object containing the cuePoint or cueTextPoint parameters.
//-----------------------------------------------------------------------------------
//	Video event types
//-----------------------------------------------------------------------------------
//	onVideoStreamStarted 	 	Fires when the video playback starts (i.e. each time play(), seek() and pause(false) are called). 
//	onVideoStreamStopped  		Fires when the video stream stops playing. 
//	onVideoStreamCompleted  	Fires when the video stream completes playing. 
//	onVideoStreamUnPaused 		Fires when the video stream is unpaused. 
//	onVideoStreamPaused 		Fires when the video stream is paused. 
//	onVideoStreamMuted 		Fires when the audio is muted. 
//	onVideoStreamUnMuted  		Fires when the audio is unmuted. 
//	onVideoStreamCuePoint 		Fires when a cue point is reached.
//	onVideoStreamCueText 		Fires when cueText is available. (FP 9 & 10)
//	onVideoStreamBufferEmpty	Fires when the video stream buffer is empty.
//	onVideoStreamBufferFull		Fires when the video stream buffer is full.
//	onVideoStreamBufferFlush	Fires when the video stream is fully loaded and the buffer is about the flush.
//	onVideoStreamFailed		Fires when the video stream fails to play including progressive fallback.
//	onVideoStreamStreamingFailed	Fires if the streaming server is unavailable and the user has chosen not to use progressive fallback.
//	onVideoStreamConnectionSuccess	Fires when the video connection is successful.
//	onVideoStreamConnectionClosed	Fires when the video connection is closed, after the client has been idle for over 5 minutes.
//-----------------------------------------------------------------------------------

function MRM_component_events(evtObj:Object)
{
	if(evtObj.type == "onVideoStreamStarted")
	{
		trace("onVideoStreamStarted");
	}
	
	if(evtObj.videoIndex == 0 && evtObj.type == "onVideoStreamCompleted")
	{
		trace("The first video in the playlist has completed playing");

	}
}
	

To trace all cue points


if  (evtObj.type == "onVideoStreamCuePoint")
{
	for  (var par:String in evtObj.cueData)
	{
		trace(par  + " - " + evtObj.cueData[par]);
	}
}

 

 

Help Files

The component help files are available offline if no internet connection is available.

Video Tutorials

When there is a video tutorial available for the component an extra button is revealed which will load the demo into the components inspector panel. (Please note - This will not appear when working offline.)

Additional Variables

There are two additional variables isPause, and isMuted. They can be referenced using video component isntance name (eg. [video_instance_name].isPaused , [video_instance_name].isMuted).