BaseAVManager

Kind of class:public class
Package:com.smartfoxserver.v2.redbox
Inherits from:EventDispatcher
Known subclasses:
Author:The gotoAndPlay() Team
http://www.smartfoxserver.com
Classpath:com.smartfoxserver.v2.redbox.BaseAVManager
File last modified:Thursday, 05 May 2011, 09:59:54
SmartFoxServer 2X RedBox base class for Audio/Video managers.
This class is responsible for all base tasks common to the RedBox managers.
Events broadcasted to listeners:
  • RedBoxConnectionEvent with type: AV_CONNECTION_INITIALIZED
    • Dispatched when the connection to Red5 server has been established.
  • RedBoxConnectionEvent with type: AV_CONNECTION_ERROR
    • Dispatched when the connection to Red5 server can't be established.

Summary


Instance properties
  • isConnected : Boolean
    • The status of the connection to the Red5 server.
Instance methods
  • initAVConnection : void
    • Initialize the audio/video connection.
  • destroy : void
    • Destroy the used RedBox manager's instance.

Instance properties

isConnected

final public isConnected:Boolean
(read)

The status of the connection to the Red5 server.
If true, the connection to Red5 is currently available.

Instance methods

destroy

public function destroy (
) : void

Destroy the used RedBox manager's instance.
Depending on the used manager, calling this method can cause the interruption of all the playing streams and chat sessions and the disconnection from Red5.
This method should always be called before deleting the manager's instance.

initAVConnection

public function initAVConnection (
) : void

Initialize the audio/video connection.
Calling this method causes the connection to Red5 to be established and the RedBoxConnectionEvent.AV_CONNECTION_INITIALIZED event to be fired in response.
If the connection can't be established, the RedBoxConnectionEvent.AV_CONNECTION_ERROR event is fired in response.
NOTE: this method is called automatically when the used RedBox manager is instantiated.
Events broadcasted to listeners:
  • RedBoxConnectionEvent with type: AV_CONNECTION_INITIALIZED
    • Dispatched when the connection to Red5 server has been established.
  • RedBoxConnectionEvent with type: AV_CONNECTION_ERROR
    • Dispatched when the connection to Red5 server can't be established.