Authentication interfaces

The Authentication Add-in contains the following interfaces. With this release, all interface names have been changed from “IFme” to “IFmle”. A summary of the interfaces follows; for more information, see the sample application included with the Authentication Add-in.

IFmleAccessAdaptor
The interface of a Client Access Adaptor.

Command

Description

IFmleAccessAdaptor()

Constructor

getVersion( int& iMajor, int& iMinor, int& iMicro )

Gets the module version. The version number contains three integers, representing the major, minor, and micro version numbers, respectively.

getDescription()

Gets the module description.

process( IFmleConnection* pCon )

Processes a connection event.

IFmleAccessContainer
The interface to the adaptor’s container (represents Flash Media Live Encoder).

Command

Description

IFmleAccessContainer()

Constructor

getVersion()

Gets the container (Flash Media Live Encoder) version.

getDescription()

Gets the server description string.

isHeadless()

Indicates whether Flash Media Live Encoder is operating through the command line, that is, without the user interface launched.

onComplete( IFmleConnection* pCon )

Called by the adaptor when it completes the processing of a connect event.

IFmleConnection
The interface used to request a connection. To request that the access adaptor process a connection, provide an instance of this class to the access adaptor. This object is allocated by Flash Media Live Encoder. It is cleaned up once a connection is established or terminated. It carries all the information necessary for the access adaptor to perform authentication and allows the URL to be prepared for connect/reconnect.

Command

Description

getState()

Gets the state of the Connection event.

enum State

The state of the Connection event. Possible values are FMLE_CONNECT, FMLE_REJECTED, FMLE_SUCCESS.

getURL()

Gets the RTMP URL of the connection that is being made with Flash Media Server.

getRejectInfo()

Gets the Reject Message received from Flash Media Server.

setURL( const char* sURL )

Sets the RTMP URL. This URL is used to make a connection to Flash Media Server. The length of the URL cannot exceed STRING_VALUE_BUFFER_LEN, or 1024 characters.

setAction( Action a, const char* sReason )

Takes one of two possible actions, FMLE_CONTINUE or FMLE_ABORT.FMLE_CONTINUE: Perform this action if you want Flash Media Live Encoder to try to connect to Flash Media Server after configuration changes have been made. You can explain the changes in the sReason parameter.FMLE_ABORT: Cancel the connection process to Flash Media Server.

enum Action

The type of Action. Possible values are: FMLE_ABORT, FMLE_CONTINUE

getAdaptorSpecific()

Gets the value passed in the /ap or /ab parameter in command-line mode. This function is applicable only when Flash Media Live Encoder is used in command-line mode.