DoubleClick Studio AS3 API Reference

class com.google.ads.studio.events.StudioVideoEvent

Extends com.google.ads.studio.events:StudioEvent

This class defines the events dispatched by the video classes. In versions 2.1.1 and prior, this class was named VideoEvent. It has been renamed for versions 2.1.2 and higher.

Constants

NameValueDescription
BACKWARDS_SEEKbackwardsSeek

The StudioVideoEvent.BACKWARDS_SEEK property defines the value of the type property of the event object for a backwardsSeek event. The event gets fired the first time a user seeks to a time before the position of the playhead. This event fires once per video controller/reporting identifier.

BUFFEREDbuffered

The StudioVideoEvent.BUFFERED property defines the value of the type property of the event object for an buffered event. The event gets fired when the video is buffered. Note: This is only dispatched by the EnhancedVideoController implementations.

COMPLETEcomplete

The StudioVideoEvent.COMPLETE property defines the value of the type property of the event object for an complete event. The event gets fired when the video playback is complete.

CONNECTION_ERRORconnectionError

The StudioVideoEvent.CONNECTION_ERROR property defines the value of the type property of the event object for an connectionError event. The event gets fired when an error occurs with the video connection.

DURATIONduration

The StudioVideoEvent.DURATION property defines the value of the type property of the event object for an duration event. The event gets fired when the duration of a video is available.

FIRST_QUARTILEfirstQuartile

The StudioVideoEvent.FIRST_QUARTILE property defines the value of the type property of the event object for an firstQuartile event. The event gets fired when the video gets past the first quarter of the video. This event is currently on supported for linear in-stream creatives.

MID_POINTmidPoint

The StudioVideoEvent.MID_POINT property defines the value of the type property of the event object for an midPoint event. The event gets fired when the video reaches its midpoint.

MUTEmute

The StudioVideoEvent.MUTE property defines the value of the type property of the event object for an mute event. The event gets fired when a mute occurs.

NETSTREAM_BUFFER_EMPTYNetStream.Buffer.Empty

The StudioVideoEvent.NETSTREAM_BUFFER_EMPTY property defines the value of the type property of the event object for an NetStream.Buffer.Empty event. The event gets fired by the NetStream object when the buffer is empty.

NETSTREAM_BUFFER_FULLNetStream.Buffer.Full

The StudioVideoEvent.NETSTREAM_BUFFER_FULL property defines the value of the type property of the event object for an NetStream.Buffer.Full event. The event gets fired by the NetStream object when the buffer is full.

NETSTREAM_PLAY_STARTNetStream.Play.Start

The StudioVideoEvent.NETSTREAM_PLAY_START property defines the value of the type property of the event object for an NetStream.Play.Start event. The event gets fired by the NetStream object when the stream starts.

NETSTREAM_PLAY_STREAMNOTFOUNDNetStream.Play.StreamNotFound

The StudioVideoEvent.NETSTREAM_PLAY_STREAMNOTFOUND property defines the value of the type property of the event object for an NetStream.Play.StreamNotFound event. The event gets fired by the NetStream object when the stream is not found.

NETSTREAM_SEEK_INVALID_TIMENetStream.Seek.InvalidTime

The StudioVideoEvent.NETSTREAM_SEEK_INVALID_TIME property defines the value of the type property of the event object for a NetStream.Seek.InvalidTime event. For video downloaded progressively, the user has tried to seek or play past the end of the video data that has downloaded thus far, or past the end of the video once the entire file has downloaded. The info.details property of the event object contains a time code that indicates the last valid position to which the user can seek.

NETSTREAM_SEEK_NOTIFYNetStream.Seek.Notify

The StudioVideoEvent.NETSTREAM_SEEK_NOTIFY property defines the value of the type property of the event object for a NetStream.Seek.Notify event. The event gets fired by the NetStream object when a seek occurs.

NET_CONNECTION_AVAILABLEnetConnectionAvailable

The StudioVideoEvent.NET_CONNECTION_AVAILABLE property defines the value of the type property of the event object for an netConnectionAvailable event. The event gets fired after the AbstractVideoConnection has performed issued a connect on the NetConnection.

NET_CONNECTION_PREINITIALIZEnetConnectionPreInitialize

The StudioVideoEvent.NET_CONNECTION_PREINITIALIZE property defines the value of the type property of the event object for an netConnectionPreInitialize event. The event gets fired right after the NetConnection is constructed but before it is made available to the AbstractVideoConnection.

NET_CONNECTION_STATUSnetConnectionStatus

The StudioVideoEvent.NET_CONNECTION_STATUS property defines the value of the type property of the event object for an netConnectionStatus event. The event gets fired when an onStatus info code is issued by the NetConnection.

The properties of the event object have the following values:

PropertyValue
infoThe info object from the onStatus callback.

NET_STREAM_AVAILABLEnetStreamAvailable

The StudioVideoEvent.NET_STREAM_AVAILABLE property defines the value of the type property of the event object for an netStreamAvailable event. The event gets fired when the NetStream is available and has initiated the play sequence.

NET_STREAM_CUE_POINTnetStreamCuePoint

The StudioVideoEvent.NET_STREAM_CUE_POINT property defines the value of the type property of the event object for an netStreamCuePoint event. The event gets fired when an onCuePoint info code is issued by the NetStream.

The properties of the event object have the following values:

PropertyValue
info The info object from the onCuePoint callback.

NET_STREAM_META_DATAnetStreamMetaData

The StudioVideoEvent.NET_STREAM_META_DATA property defines the value of the type property of the event object for an netStreamMetaData event. The event gets fired when an onMetaData info code is issued by the NetStream.

The properties of the event object have the following values:

PropertyValue
info The info object from the onMetaData callback.

NET_STREAM_PREINITIALIZEnetStreamPreInitialize

The StudioVideoEvent.NET_STREAM_PREINITIALIZE property defines the value of the type property of the event object for an netStreamPreInitialize event. The event gets fired when the NetStream has been constructed but before connection has issued any commands on it.

NET_STREAM_STATUSnetStreamStatus

The StudioVideoEvent.NET_STREAM_STATUS property defines the value of the type property of the event object for an netStreamStatus event. The event gets fired when an onStatus info code is issued by the NetStream.

The properties of the event object have the following values:

PropertyValue
infoThe info object from the onStatus callback.

PAUSEpause

The StudioVideoEvent.PAUSE property defines the value of the type property of the event object for an pause event. The event gets fired when a pause occurs.

PLAYplay

The StudioVideoEvent.PLAY property defines the value of the type property of the event object for an play event. The event gets fired when a play occurs.

PLAYHEAD_MOVEplayheadMove

The StudioVideoEvent.PLAYHEAD_MOVE property defines the value of the type property of the event object for a playheadMove event. The event gets fired whenever the playhead of the video stream moves.

REPLAYreplay

The StudioVideoEvent.REPLAY property defines the value of the type property of the event object for an replay event. The event gets fired when a replay occurs.

RESUMEresume

The StudioVideoEvent.RESUME property defines the value of the type property of the event object for an resume event. The event gets fired when a resume occurs.

STATE_CHANGEstateChange

The StudioVideoEvent.STATE_CHANGE property defines the value of the type property of the event object for an stateChange event. The event gets fired when the player changes its playback state.

STOPstop

The StudioVideoEvent.STOP property defines the value of the type property of the event object for an stop event. The event gets fired when a stop occurs.

THIRD_QUARTILEthirdQuartile

The StudioVideoEvent.THIRD_QUARTILE property defines the value of the type property of the event object for an thirdQuartile event. The event gets fired when the video gets past the third quarter of the video. This event is currently only supported for linear in-stream creatives.

UN_MUTEunMute

The StudioVideoEvent.UN_MUTE property defines the value of the type property of the event object for an unMute event. The event gets fired when a unMute occurs.

VOLUME_CHANGEvolumeChange

The StudioVideoEvent.VOLUME_CHANGE property defines the value of the type property of the event object for a volumeChange event. The event gets fired when the volume changes.

Expand Inherited Fields

Constructors

Expand
StudioVideoEvent(type:String)

Static Methods

StudioVideoEvent.getAllEvents() : Array

Returns an array of strings of all the video events.

StudioVideoEvent.getAllNetStreamInfoEvents() : Array

Returns an array of all the NetStream status events events that are currently used.

StudioVideoEvent.getAllPlaybackEvents() : Array

Returns an array of all the events that relate to video playback.

StudioVideoEvent.getAllPlayerAndPlaybackEvents() : Array

Returns an array of all the events that relate to the video player and video playback.

StudioVideoEvent.getAllPlayerEvents() : Array

Returns an array of all the events that relate to the video player.

Instance Methods

Defined in: com.google.ads.studio.events:StudioEvent

Expand
addProperty(key:String, value:Object) : StudioEvent

Adds a key value property to the event object.

getLogLevel() : int

Gets the logging level associated with the StudioEvent.

Defined in com.google.ads.studio.events:StudioVideoEvent

clone() : Event

Back to top

  1. com.google.ads.studio
    1. AssetLoader
    2. ContextualDiscovery
    3. F2fEnabler
    4. FullScreenButton
    5. HtmlEnabler
    6. ProxyEnabler
    7. VpaidEnabler
  1. com.google.ads.studio.configurable
    1. Configurable
  1. com.google.ads.studio.display
    1. StudioLoader
  1. com.google.ads.studio.events
    1. StudioEvent
    2. StudioVideoEvent
  1. com.google.ads.studio.expanding
    1. Expanding
  1. com.google.ads.studio.localconnect
    1. LocalConnectWrapper
  1. com.google.ads.studio.video
    1. ConfigurableVideoPlayer
    2. EnhancedVideoController
    3. PlayPauseButton
    4. Playlist
    5. Scrubber
    6. SoundToggleButton
    7. VideoController
    8. VideoEntry
    9. VideoPlayer
    10. VideoPlayerAdvanced
  1. com.google.ads.studio.vpaid
    1. VpaidTimer