Packagecom.brightcove.api.modules
Classpublic class AuthModule
InheritanceAuthModule Inheritance APIModule Inheritance flash.events.EventDispatcher

API class for handling media playback. See the article, Player Load and Stream Connection APIs, to download code examples that show how to control player.



Public Properties
 PropertyDefined By
 Inheritedmodule : Object
[read-only] Returns the instance of the module that is wrapped by this instance.
APIModule
Public Methods
 MethodDefined By
  
AuthModule(module:Object)
Constructor.
AuthModule
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
[override] Adds a listener for an event.
APIModule
  
Check content status and send AUTH_NEEDED if applicable
AuthModule
  
playWithToken(pToken:String, pService:String):void
Sets the media token for the currently loaded content
AuthModule
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] Removes a listener for an event.
APIModule
  
Removes the user message and re-enables the controls
AuthModule
  
showMessage(pMessage:String = tve login, pModal:Boolean = true):void
Show the specified message in a player overlay.
AuthModule
Events
 Event Summary Defined By
  AuthModule
Public Constants
 ConstantDefined By
  AUTH_CANCEL : String = cancel
[static]
AuthModule
  AUTH_ERROR : String = error
[static]
AuthModule
  AUTH_TYPE_ADOBEPASS : String = adobepass
[static]
AuthModule
  AUTH_TYPE_AIS : String = ais
[static]
AuthModule
  PASS_REQUESTORID : String = requestorId
[static]
AuthModule
  PASS_RESOURCEID : String = resourceId
[static]
AuthModule
Constructor Detail
AuthModule()Constructor
public function AuthModule(module:Object)

Constructor.

Parameters
module:Object — module to wrap with this API class.
Method Detail
checkStatus()method
public function checkStatus():void

Check content status and send AUTH_NEEDED if applicable

playWithToken()method 
public function playWithToken(pToken:String, pService:String):void

Sets the media token for the currently loaded content

Parameters

pToken:String — The media token to be used
 
pService:String — The authentication serice that the token applies to

removeMessage()method 
public function removeMessage():void

Removes the user message and re-enables the controls

showMessage()method 
public function showMessage(pMessage:String = tve login, pModal:Boolean = true):void

Show the specified message in a player overlay.

Parameters

pMessage:String (default = tve login) — String to be shown to the user
 
pModal:Boolean (default = true) — If true, the player controls will be disabled until removeMessage is called

Event Detail
authNeeded Event
Event Object Type: com.brightcove.api.events.MediaEvent

Constant Detail
AUTH_CANCELConstant
public static const AUTH_CANCEL:String = cancel

AUTH_ERRORConstant 
public static const AUTH_ERROR:String = error

AUTH_TYPE_ADOBEPASSConstant 
public static const AUTH_TYPE_ADOBEPASS:String = adobepass

AUTH_TYPE_AISConstant 
public static const AUTH_TYPE_AIS:String = ais

PASS_REQUESTORIDConstant 
public static const PASS_REQUESTORID:String = requestorId

PASS_RESOURCEIDConstant 
public static const PASS_RESOURCEID:String = resourceId