Packagecom.brightcove.api.events
Classpublic class ContentEvent
InheritanceContentEvent Inheritance flash.events.Event

Events to be broadcast when content is loaded into the player. See the article, Customizing the Player Menu's Additional Media, which has several code examples that use this event.


Public Properties
 PropertyDefined By
  media : MediaDTO
[read-only] Returns the media for which the event was broadcast.
ContentEvent
  mediaCollection : MediaCollectionDTO
[read-only] Returns the media collection for which the event was broadcast.
ContentEvent
Public Methods
 MethodDefined By
  
ContentEvent(type:String, media:MediaDTO = null, mediaCollection:MediaCollectionDTO = null)
Constructor.
ContentEvent
  
clone():Event
[override] Returns a copy of the event instance.
ContentEvent
Public Constants
 ConstantDefined By
  MEDIA_COLLECTION_LOAD : String = mediaCollectionLoad
[static] The ContentEvent.MEDIA_COLLECTION_LOAD constant defines the value of the type property of the event object for a mediaCollectionLoad event.
ContentEvent
  MEDIA_LOAD : String = mediaLoad
[static] The ContentEvent.MEDIA_LOAD constant defines the value of the type property of the event object for a mediaLoad event.
ContentEvent
Property Detail
mediaproperty
media:MediaDTO  [read-only]

Returns the media for which the event was broadcast.


Implementation
    public function get media():MediaDTO
mediaCollectionproperty 
mediaCollection:MediaCollectionDTO  [read-only]

Returns the media collection for which the event was broadcast.


Implementation
    public function get mediaCollection():MediaCollectionDTO
Constructor Detail
ContentEvent()Constructor
public function ContentEvent(type:String, media:MediaDTO = null, mediaCollection:MediaCollectionDTO = null)

Constructor.

Parameters
type:String — event name.
 
media:MediaDTO (default = null) — media, if any, that the event is for.
 
mediaCollection:MediaCollectionDTO (default = null) — media collection, if any, that the event is for.
Method Detail
clone()method
override public function clone():Event

Returns a copy of the event instance.

Returns
Event — A copy of the event.
Constant Detail
MEDIA_COLLECTION_LOADConstant
public static const MEDIA_COLLECTION_LOAD:String = mediaCollectionLoad

The ContentEvent.MEDIA_COLLECTION_LOAD constant defines the value of the type property of the event object for a mediaCollectionLoad event.

MEDIA_LOADConstant 
public static const MEDIA_LOAD:String = mediaLoad

The ContentEvent.MEDIA_LOAD constant defines the value of the type property of the event object for a mediaLoad event.




Generated by Flexmojos

Wed May 2 2012, 10:00 AM -04:00