| Package | mx.messaging.channels |
| Class | public class RTMPChannel |
| Inheritance | RTMPChannel  NetConnectionChannel PollingChannel Channel EventDispatcher Object |
| Subclasses | SecureRTMPChannel |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The RTMPChannel relies on network services native to Flash Player, and exposed to ActionScript by the NetConnection class. This Channel uses NetConnection exclusively.
Channels are created within the framework using the
ServerConfig.getChannel() method. Channels can be constructed
directly and assigned to a ChannelSet if desired.
Channels represent a physical connection to a remote endpoint. Channels are shared across destinations by default. This means that a client targetting different destinations may use the same Channel to communicate with these destinations.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | authenticated : Boolean [read-only]
Indicates if this channel is authenticated. | Channel | |
| channelSets : Array [read-only]
Provides access to the ChannelSets connected to the Channel. | Channel | |
| connected : Boolean [read-only]
Indicates whether this channel has established a connection to the
remote destination. | Channel | |
| connectTimeout : int
Provides access to the connect timeout in seconds for the channel. | Channel | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| endpoint : String [read-only]
Provides access to the endpoint for this channel. | Channel | |
| failoverURIs : Array
Provides access to the set of endpoint URIs that this channel can
attempt to failover to if the endpoint is clustered. | Channel | |
| id : String
Provides access to the id of this channel. | Channel | |
| netConnection : NetConnection [read-only]
Provides access to the associated NetConnection for this Channel. | NetConnectionChannel | |
| protocol : String [override] [read-only]
Returns the protocol for this channel (rtmp or rtmpt). | RTMPChannel | ||
| reconnecting : Boolean [read-only]
Indicates whether this channel is in the process of reconnecting to an
alternate endpoint. | Channel | |
| recordMessageSizes : Boolean [read-only]
Channel property determines the level of performance information injection - whether
we inject message sizes or not. | Channel | |
| recordMessageTimes : Boolean [read-only]
Channel property determines the level of performance information injection - whether
we inject timestamps or not. | Channel | |
| requestTimeout : int
Provides access to the default request timeout in seconds for the
channel. | Channel | |
| uri : String
Provides access to the URI used to create the whole endpoint URI for this channel. | Channel | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Creates an new RTMPChannel instance. | RTMPChannel | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Subclasses should override this method to apply any settings that may be
necessary for an individual channel. | Channel | |
|
Connects the ChannelSet to the Channel. | Channel | |
|
Disables polling based on the number of times enablePolling()
and disablePolling() have been invoked. | PollingChannel | |
|
Disconnects the ChannelSet from the Channel. | Channel | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Enables polling based on the number of times enablePolling()
and disablePolling() have been invoked. | PollingChannel | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Sends a CommandMessage to the server to logout if the Channel is connected. | Channel | |
[override]
Do nothing if the client requests that we poll. | RTMPChannel | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
| [override]
Sends the specified message to its target destination. | PollingChannel | |
|
Sets the credentials to the specified value. | Channel | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
Protected Constants
| Constant | Defined By | ||
|---|---|---|---|
| CODE_CONNECT_CLOSED : String = "Connect.Closed" [static]
Status code for connection closed. | RTMPChannel | ||
| CODE_CONNECT_FAILED : String = "Connect.Failed" [static]
Status code for connection failed. | RTMPChannel | ||
| CODE_CONNECT_NETWORKCHANGE : String = "Connect.NetworkChange" [static]
Status code for connection network change. | RTMPChannel | ||
| CODE_CONNECT_REJECTED : String = "Connect.Rejected" [static]
Status code for connection rejected. | RTMPChannel | ||
| CODE_CONNECT_SUCCESS : String = "Connect.Success" [static]
Status code for connection success. | RTMPChannel | ||
Property Detail
protocol | property |
protocol:String [read-only] [override] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the protocol for this channel (rtmp or rtmpt).
Implementation
override public function get protocol():StringConstructor Detail
RTMPChannel | () | Constructor |
public function RTMPChannel(id:String = null, uri:String = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates an new RTMPChannel instance.
Parametersid:String (default = null) | |
uri:String (default = null) |
Method Detail
poll | () | method |
override public function poll():void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Do nothing if the client requests that we poll.
Constant Detail
CODE_CONNECT_CLOSED | Constant |
protected static const CODE_CONNECT_CLOSED:String = "Connect.Closed"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Status code for connection closed.
CODE_CONNECT_FAILED | Constant |
protected static const CODE_CONNECT_FAILED:String = "Connect.Failed"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Status code for connection failed.
CODE_CONNECT_NETWORKCHANGE | Constant |
protected static const CODE_CONNECT_NETWORKCHANGE:String = "Connect.NetworkChange"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Status code for connection network change.
CODE_CONNECT_REJECTED | Constant |
protected static const CODE_CONNECT_REJECTED:String = "Connect.Rejected"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Status code for connection rejected.
CODE_CONNECT_SUCCESS | Constant |
protected static const CODE_CONNECT_SUCCESS:String = "Connect.Success"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Status code for connection success.
Thu Dec 6 2018, 01:12 PM -08:00