IApplicationInstance (Wowza Media Server 2 API)

Overview

Package

Class

Use

Tree

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.wowza.wms.application
Interface IApplicationInstance

public interface IApplicationInstance

IApplicationInstance: public interface to ApplicationInstance object

Field Summary
`static String`	`DEFAULT_APPINSTANCE_NAME`

Method Summary
`void`	`addClientListener(IClientNotify clientListener)` Add client listener.
`void`	`addHTTPStreamerSession(IHTTPStreamerSession httpStreamerSession)` Add a HTTPStreamerSession to this application instance
`void`	`addLiveStreamPacketizerListener(ILiveStreamPacketizerActionNotify liveStreamPacketizerListener)` Add a Live Stream Packetizer listener (see: ILiveStreamPacketizerActionNotify)
`void`	`addMediaCasterListener(IMediaCasterNotify mediaCasterListener)` Add mediaCaster listener.
`void`	`addMediaCasterListener(IMediaCasterNotify2 mediaCasterListener)` Add mediaCaster listener.
`void`	`addMediaReaderListener(IMediaReaderActionNotify mediaReaderListener)` Add media reader listener.
`void`	`addMediaStreamListener(IMediaStreamNotify mediaStreamListener)` Add mediaStream listener.
`void`	`addMediaWriterListener(IMediaWriterActionNotify listener)` Add a MediaWriter listener class.
`void`	`addModuleListener(IModuleNotify moduleListener)` Add module listener.
`void`	`addPlayStreamByName(IMediaStream stream, String name)` Add a media stream to the list of streams that are listening for a published stream
`void`	`addPublisher(Publisher publisher)` Add a server side publisher to this application instance
`void`	`addRTPIncomingDatagramPortAll()` Allow all incoming RTP UDP ports for this application instance
`void`	`addRTPIncomingDatagramPortRange(int startPort, int endPort)` Add a port range to the list of valid incoming RTP UDP ports
`void`	`addRTPSession(RTPSession rtpSession)` Add an RTP session to this application instance
`void`	`addSharedObjectListener(ISharedObjectNotify sharedObjectListener, boolean isPersistent)` Add sharedObject listener.
`void`	`broadcastMsg(java.util.List<IClient> clientList, String handlerName)` Broadcast a message to a specific list of clients connected to this application instance
`void`	`broadcastMsg(java.util.List<IClient> clientList, String handlerName, Object... params)` Broadcast a message to a specific list of clients connected to this application instance
`void`	`broadcastMsg(String handlerName, Object... params)` Broadcast a message to all clients connected to this applicationInstance
`boolean`	`containsHTTPStreamer(String httpStreamer)` Does this application instance allow streaming of a given HTTPStreamer
`boolean`	`containsLiveStreamPacketizer(String liveStreamPacketizer)` Does this application instance contain a references to this live stream packetizer.
`String`	`decodeStorageDir(String storageDir)` This function will take a storage path that uses variables and expand the variables based on the context.
`String[]`	`getAllowDomains()` Get the list of domain names used to control access to this application.
`IApplication`	`getApplication()` Get parent application
`int`	`getApplicationInstanceTouchTimeout()` Get the application instance touch timeout (milliseconds).
`int`	`getApplicationTimeout()` Get application timeout (milliseconds)
`IClient`	`getClientById(int index)` Get a client connection by the client Id
`int`	`getClientCount()` Get number of client connections currently connected to applicationInstance
`int`	`getClientCountTotal()` Get number of client connections in total that have connected to this applicationInstance
`int`	`getClientIdleFrequency()` Get default client idle frequency (milliseconds)
`java.util.List<IClient>`	`getClients()` Get the set of clients currently connected to this application instance (replaces getClient(index))
`edu.emory.mathcs.backport.java.util.concurrent.locks.WMSReadWriteLock`	`getClientsLockObj()` Get the read/write lock for this application instance
`ConnectionCounter`	`getConnectionCounter()` Get the connectionCounter for applicationInstance
`com.wowza.wms.client.ConnectionCounterSimple`	`getConnectionCounter(int counterIndex)` Get the connectionCounter for applicationInstance for a specific technology (see IVHost.COUNTER_*)
`String`	`getContextStr()` Returns the application context string in the form [application]/[appInstance].
`String`	`getDateStarted()` Get date applcationInstance started
`IHTTPStreamerApplicationContext`	`getHTTPStreamerApplicationContext(String httpStreamName, boolean doCreate)` Get the HTTPStreamer application context for a given HTTPStreamer adapter
`String`	`getHTTPStreamerList()` Get the comma separated list of HTTPStreamers names being used by this application (see conf/HTTPStreamers.xml)
`WMSProperties`	`getHTTPStreamerProperties()` Get the property collection of HTTPStreamer settings that are specific to this application instance
`int`	`getHTTPStreamerSessionCount()` Get the current number of HTTPStreamerSessions associated with this application instance
`int`	`getHTTPStreamerSessionCount(int protocol)` Get the current number of HTTPStreamerSessions associated with this application instance by protocol.
`int`	`getHTTPStreamerSessionCount(int protocol, String streamName)` Get the current number of HTTPStreamerSessions associated with this application instance and stream name by protocol .
`int`	`getHTTPStreamerSessionCount(String streamName)` Get the current number of HTTPStreamerSessions associated with this application instance and stream name
`java.util.Map<String,Integer>`	`getHTTPStreamerSessionCountsByName(int protocol)` Get a map of session counts by name for a given protocol
`java.util.List<IHTTPStreamerSession>`	`getHTTPStreamerSessions()` Get the HTTPStreamerSessions associated with this application instance
`java.util.List<IHTTPStreamerSession>`	`getHTTPStreamerSessions(int protocol)` Get the HTTPStreamerSessions associated with this application instance by protocol.
`java.util.List<IHTTPStreamerSession>`	`getHTTPStreamerSessions(int protocol, String streamName)` Get the HTTPStreamerSessions associated with this application instance for a stream name by protocol.
`java.util.List<IHTTPStreamerSession>`	`getHTTPStreamerSessions(String streamName)` Get the HTTPStreamerSessions associated with this application instance for a stream name
`IOPerformanceCounter`	`getIOPerformanceCounter()` Get the performance counter for applicationInstance
`IOPerformanceCounter`	`getIOPerformanceCounter(int counterIndex)` Get the performance counter for applicationInstance for a specific technology (see IVHost.COUNTER_*)
`long`	`getLastTouchTime()` Get the last time the instance was touched (milliseconds)
`ILiveStreamPacketizerControl`	`getLiveStreamPacketizerControl()` Get the Live Stream Packetizer Contoller.
`String`	`getLiveStreamPacketizerList()` Get the comma separated list of LiveStreamPacketizers names being used by this application (see conf/LiveStreamPacketizers.xml)
`WMSProperties`	`getLiveStreamPacketizerProperties()` Get the property collection of LiveStreamPacketizer settings that are specific to this application instance
`int`	`getMaximumPendingWriteBytes()` Get maximum number a bytes a client connection can have waiting to be sent before the connection is terminated.
`int`	`getMaximumSetBufferTime()` Get maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call.
`int`	`getMaxStorageDirDepth()` Maximum folder depth allowed for the StreamStorageDir and SharedObjectStorageDir paths
`WMSProperties`	`getMediaCasterProperties()` Get the property collection of media caster settings that are specific to this application instance
`MediaCasterStreamMap`	`getMediaCasterStreams()` Get the media caster streams attached to this application instance
`IMediaCasterValidateMediaCaster`	`getMediaCasterValidator()` Get the MediaCaster validator interface for this application instance
`WMSProperties`	`getMediaReaderProperties()` Get the property collection of media reader settings that are specific to this application instance
`WMSProperties`	`getMediaWriterProperties()` Get the property collection of media reader settings that are specific to this application instance
`com.wowza.wms.module.ModuleFunctions`	`getModFunctions()` Get list of application modules
`Object`	`getModuleInstance(String name)` Get the instance of the module class for this application instance.
`com.wowza.wms.module.ModuleList`	`getModuleList()` Get the list of loaded modules.
`String`	`getName()` Get applicationInstance name
`int`	`getPingTimeout()` Get ping timeout (milliseconds)
`int`	`getPlayStreamCount(String streamName)` Get the number of Flash players playing a given stream name
`java.util.Map<String,Integer>`	`getPlayStreamCountsByName()` Get a map of stream names to number of Flash players playing the stream name
`java.util.List<IMediaStream>`	`getPlayStreamsByName(String name)` Get a list of media streams that are listening for published stream.
`WMSProperties`	`getProperties()` Get applicationInstance properties
`int`	`getPublisherCount()` Get the current number of server side publishers
`java.util.List<Publisher>`	`getPublishers()` Get the set of server side publishers
`java.util.List<String>`	`getPublishStreamNames()` Get the list of live stream names currently being published.
`String`	`getRepeaterOriginUrl()` Get the Repeater Origin URL used by the Live Stream Repeater
`String`	`getRepeaterQueryString()` Get the Repeater query string that is used to connect to the origin.
`String`	`getRsoStorageDir()` Get remote shared object storage path
`String`	`getRsoStoragePath()` Get the resolved storage path to the shared objects
`int`	`getRTPAVSyncMethod()` Get RTP audio/video sync method (RTPStream.AVSYNCMETHODS_SENDERREPORT, RTPStream.AVSYNCMETHODS_SYSTEMCLOCK, RTPStream.AVSYNCMETHODS_RTPTIMECODE)
`int`	`getRTPIdleFrequency()` Set the default RTP idle frequency (milliseconds)
`int`	`getRTPMaxRTCPWaitTime()` Get the maximum time to wait for RTCP packets (milliseconds)
`String`	`getRTPPlayAuthenticationMethod()` Get the RTP play authentication method (as defined in conf/Authentication.xml)
`WMSProperties`	`getRTPProperties()` Get the property collection of RTP settings that are specific to this application instance
`String`	`getRTPPublishAuthenticationMethod()` Get the RTP publish authentication method (as defined in conf/Authentication.xml)
`int`	`getRTPSessionCount()` Get the number of RTP sessions running under this application instance
`int`	`getRTPSessionCount(String streamName)` Get the number of RTP player streams playing a given stream name
`java.util.Map<String,Integer>`	`getRTPSessionCountsByName()` Get a map of stream names and session counts of RTP sessions
`java.util.List<RTPSession>`	`getRTPSessions()` Get a list of RTP sessions running under this application instance
`java.util.List<RTPSession>`	`getRTPSessions(String streamName)` Get a list of RTP sessions running under this application instance playing a given stream name
`String`	`getRTSPBindIpAddress()` Set the IP address to which UDP ports will be bound for RTSP/RTP sessions
`String`	`getRTSPConnectionAddressType()` Get the connection IP address type (IP4) to used in the Session Description Protocol data exchanged for an RTSP/RTP session
`String`	`getRTSPConnectionIpAddress()` Get the connection IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session
`int`	`getRTSPMaximumPendingWriteBytes()` Get the maximum number of pending write bytes for an RTSP session
`String`	`getRTSPOriginAddressType()` Get the origin IP address type (IP4) to used in the Session Description Protocol data exchanged for an RTSP/RTP session
`String`	`getRTSPOriginIpAddress()` Get the origin IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session
`int`	`getRTSPSessionTimeout()` Get the RTSP session timeout (milliseconds)
`String`	`getSharedObjectReadAccess()` Get the default shared object read access
`ISharedObjects`	`getSharedObjects()` Get non-peristent shared object collection
`ISharedObjects`	`getSharedObjects(boolean isPersistent)` Get either persistent or non-persistent shared object collection
`String`	`getSharedObjectWriteAccess()` Get the default shared object write access
`String`	`getStreamAudioSampleAccess()` Get the default stream audio sample access
`int`	`getStreamCount()` Get the total number of open streams attached to this application instance
`IMediaStreamFileMapper`	`getStreamFileMapper()` Get the stream file mapper.
`String`	`getStreamKeyDir()` Get the stream key path
`String`	`getStreamKeyPath()` Get the resolved key path to the MediaStreams encryption keys
`IMediaStreamNameAliasProvider`	`getStreamNameAliasProvider()` Get the stream name alias provider
`WMSProperties`	`getStreamProperties()` Get the property collection of stream settings that are specific to this application instance
`String`	`getStreamReadAccess()` Get the default stream read access
`MediaStreamMap`	`getStreams()` Get all the mediaStream objects attached to this applicationInstance
`String`	`getStreamStorageDir()` Get stream storage path
`String`	`getStreamStoragePath()` Get the resolved storage path to the MediaStreams
`String`	`getStreamType()` Get default streamType for application.
`String`	`getStreamVideoSampleAccess()` Get the default stream video sample access
`String`	`getStreamWriteAccess()` Get the default stream write access
`String`	`getTimeRunning()` Get time applcationInstance running
`double`	`getTimeRunningSeconds()` Get time running in seconds
`int`	`getValidationFrequency()` Get time between validation pings (milliseconds)
`IVHost`	`getVHost()` Get parent vHost
`void`	`incClientCountTotal()` Increment the total number of connected client counter by one
`boolean`	`isAcceptConnection()` Is auto accept connection on/off
`boolean`	`isRTPIncomingDatagramPortValid(int port)` Check a port number to be sure it is a valid RTP UDP port for this application instance
`boolean`	`isValidateFMLEConnections()` Returns true if validating FMLE connection (default is false)
`void`	`notifyLiveStreamPacketizerCreate(ILiveStreamPacketizer liveStreamPacketizer, String streamName)` Notify Live Stream Packetizer Create
`void`	`notifyLiveStreamPacketizerDestroy(ILiveStreamPacketizer liveStreamPacketizer)` Notify Live Stream Packetizer Destory
`void`	`notifyLiveStreamPacketizerInit(ILiveStreamPacketizer liveStreamPacketizer, String streamName)` Notify Live Stream Packetizer Init
`void`	`notifyMediaReaderClose(IMediaReader mediaReader, IMediaStream stream)` Notify media reader notifyMediaReaderClose
`void`	`notifyMediaReaderCreate(IMediaReader mediaReader)` Notify media reader notifyMediaReaderCreate
`void`	`notifyMediaReaderExtractMetaData(IMediaReader mediaReader, IMediaStream stream)` Notify media reader notifyMediaReaderExtractMetaData
`void`	`notifyMediaReaderInit(IMediaReader mediaReader, IMediaStream stream)` Notify media reader notifyMediaReaderInit
`void`	`notifyMediaReaderOpen(IMediaReader mediaReader, IMediaStream stream)` Notify media reader notifyMediaReaderOpen
`void`	`notifyMediaWriterOnFLVAddMetadata(IMediaStream stream, java.util.Map<String,Object> extraMetadata)` Notify all MediaWriter listeners of onFLVAddMetadata
`void`	`notifyMediaWriterOnWriteComplete(IMediaStream stream, java.io.File file)` Notify all MediaWriter listeners of onWriteComplete
`void`	`parseAllowDomains(String domainFilterStr)` Parse a comma delimited list of domain names used to control access to this application.
`String`	`readAppInstConfig(String sName)` Method to read xml config file..
`void`	`registerPlayRTPSession(RTPSession rtpSession)` Register an RTP session as a play session
`void`	`removeClientListener(IClientNotify clientListener)` Remove client listener.
`void`	`removeHTTPStreamerSession(IHTTPStreamerSession httpStreamerSession)` Remove a HTTPStreamerSession from this application instance
`void`	`removeLiveStreamPacketizerListener(ILiveStreamPacketizerActionNotify liveStreamPacketizerListener)` Remove a Live Stream Packetizer listener (see: ILiveStreamPacketizerActionNotify)
`void`	`removeMediaCasterListener(IMediaCasterNotify mediaCasterListener)` Remove mediaCaster listener.
`void`	`removeMediaReaderListener(IMediaReaderActionNotify mediaReaderListener)` Remove media reader listener.
`void`	`removeMediaStreamListener(IMediaStreamNotify mediaStreamListener)` Remove mediaStream listener.
`void`	`removeMediaWriterListener(IMediaWriterActionNotify listener)` remove MediaWriter listener class.
`void`	`removeModuleListener(IModuleNotify moduleListener)` Remove module listener
`void`	`removePlayStreamByName(IMediaStream stream)` Remove media stream from the list of streams that are listening for a published stream
`void`	`removePublisher(Publisher publisher)` Remove a server side publisher from this application instance
`void`	`removeRTPSession(RTPSession rtpSession)` Remove an RTP session from this application instance
`void`	`removeSharedObjectListener(ISharedObjectNotify sharedObjectListener, boolean isPersistent)` Remove sharedObject listener.
`boolean`	`resetMediaCasterStream(String streamName)` Reset a media caster stream
`boolean`	`resetMediaCasterStream(String streamName, String streamExt)` Reset a media caster stream
`void`	`setAcceptConnection(boolean acceptConnection)` Set is auto accept connection
`void`	`setAllowDomains(String[] domainFilter)` Set the list of domain names used to control access to this application.
`void`	`setApplicationInstanceTouchTimeout(int applicationInstanceTouchTimeout)` Set the application instance touch timeout (milliseconds).
`void`	`setApplicationTimeout(int applicationTimeout)` Set application timeout (milliseconds)
`void`	`setClientIdleFrequency(int clientIdleFrequency)` Set default client idle frequency (milliseconds)
`void`	`setHTTPStreamerList(String httpStreamerList)` Set the comma separated list of HTTPStreamer names being used by this application (see conf/HTTPStreamers.xml)
`void`	`setLiveStreamPacketizerControl(ILiveStreamPacketizerControl liveStreamPacketizerControl)` Set the Live Stream Packetizer Contoller.
`void`	`setLiveStreamPacketizerList(String liveStreamPacketizerList)` Set the comma separated list of LiveStreamPacketizers names being used by this application (see conf/LiveStreamPacketizers.xml)
`void`	`setMaximumPendingWriteBytes(int maximumPendingWriteBytes)` Set maximum number a bytes a client connection can have waiting to be sent before the connection is terminated.
`void`	`setMaximumSetBufferTime(int maximumSetBufferTime)` Set maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call.
`void`	`setMaxStorageDirDepth(int maxStorageDirDepth)` Maximum folder depth allowed for the StreamStorageDir and SharedObjectStorageDir paths
`void`	`setMediaCasterValidator(IMediaCasterValidateMediaCaster mediaCasterValidator)` Set the MediaCaster validator interface for this application instance
`void`	`setName(String name)` Set applicationInstance name
`void`	`setPingTimeout(int pingTimeout)` Set ping timeout (millseconds)
`void`	`setRepeaterOriginUrl(String repeaterOriginUrl)` Set the Repeater Origin URL used by the Live Stream Repeater
`void`	`setRepeaterQueryString(String repeaterQueryString)` Set the Repeater query string that is used to connect to the origin.
`void`	`setRsoStorageDir(String rsoStorageDir)` Set remote shared object storage path
`void`	`setRTPAVSyncMethod(int rtpAVSyncMethod)` Set RTP audio/video sync method (RTPStream.AVSYNCMETHODS_SENDERREPORT, RTPStream.AVSYNCMETHODS_SYSTEMCLOCK, RTPStream.AVSYNCMETHODS_RTPTIMECODE)
`void`	`setRTPIdleFrequency(int rtspIdleFrequency)` Get the default RTP idle frequency (milliseconds)
`void`	`setRTPMaxRTCPWaitTime(int rtpMaxRTCPWaitTime)` Set the maximum time to wait for RTCP packets (milliseconds)
`void`	`setRTPPlayAuthenticationMethod(String rtpPlayAuthenticationMethod)` Set the RTP play authentication method (as defined in conf/Authentication.xml)
`void`	`setRTPPublishAuthenticationMethod(String rtpPublishAuthenticationMethod)` Set the RTP publish authentication method (as defined in conf/Authentication.xml)
`void`	`setRTSPBindIpAddress(String rtspBindIpAddress)` Get the IP address to which UDP ports will be bound for RTSP/RTP sessions
`void`	`setRTSPConnectionAddressType(String rtspConnectionAddressType)` Set the connection IP address type (IP4) to used in the Session Description Protocol data exchanged for an RTSP/RTP session
`void`	`setRTSPConnectionIpAddress(String rtspConnectionIpAddress)` Set the connection IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session
`void`	`setRTSPMaximumPendingWriteBytes(int rtspMaximumPendingWriteBytes)` Set the maximum number of pending write bytes for an RTSP session
`void`	`setRTSPOriginAddressType(String rtspOriginAddressType)` Set the origin IP address type (IP4) to used in the Session Description Protocol data exchanged for an RTSP/RTP session
`void`	`setRTSPOriginIpAddress(String rtspOriginIpAddress)` Set the origin IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session
`void`	`setRTSPSessionTimeout(int rtspSessionTimeout)` Set the RTSP session timeout (milliseconds)
`void`	`setSharedObjectReadAccess(String sharedObjectReadAccess)` Set the default shared object read access
`void`	`setSharedObjectWriteAccess(String sharedObjectWriteAccess)` Set the default shared object write access
`void`	`setStreamAudioSampleAccess(String streamAudioSampleAccess)` Set the default stream audio sample access
`void`	`setStreamFileMapper(IMediaStreamFileMapper streamFileMapper)` Set the stream file mapper.
`void`	`setStreamKeyDir(String keyStorageDir)` Set the stream key path
`void`	`setStreamNameAliasProvider(IMediaStreamNameAliasProvider streamNameAliasProvider)` Set the stream name alias provider
`void`	`setStreamReadAccess(String streamReadAccess)` Set the default stream read access
`void`	`setStreamStorageDir(String streamStorageDir)` Set stream storage path
`void`	`setStreamType(String streamType)` Set default stream type for application.
`void`	`setStreamVideoSampleAccess(String streamVideoSampleAccess)` Set the default stream video sample access
`void`	`setStreamWriteAccess(String streamWriteAccess)` Set the default stream write access
`void`	`setValidateFMLEConnections(boolean validateFMLEConnections)` Returns true if validating FMLE connection (default is false)
`void`	`setValidationFrequency(int validationFrequency)` Set time between validation pings (milliseconds)
`void`	`shutdown(boolean isServerShutdown, boolean isAppShutdown)` shutdown applicationInstance
`void`	`shutdownClient(IClient client)` shutdown a client connection immediately
`boolean`	`startMediaCasterStream(String streamName, String mediaCasterType)` Start a media caster stream
`boolean`	`startMediaCasterStream(String streamName, String streamExt, String mediaCasterType)` Start a media caster stream
`void`	`stopMediaCasterStream(String streamName)` Stop a media caster stream
`void`	`touch()` Touch the application instance so that it stays loaded for at least applicationInstanceTouchTimeout
`boolean`	`writeAppInstConfig(String sName, String data)` Method to write xml config file..

Field Detail

DEFAULT_APPINSTANCE_NAME

static final String DEFAULT_APPINSTANCE_NAME

See Also:: Constant Field Values

Method Detail

addClientListener

void addClientListener(IClientNotify clientListener)

Add client listener. Listens for connects, disconnect, accepts and reject

Add a Client Listener

IApplicationInstance appInstance;

class ClientListener implements IClientNotify
{
        public void onClientConnect(IClient client)
        {
                WMSLoggerFactory.getLogger(null).debug("onClientConnect: "+
                        client.getClientId());
        }

        public void onClientDisconnect(IClient client)
        {
                WMSLoggerFactory.getLogger(null).debug("onClientDisconnect: "+
                        client.getClientId());
        }

        public void onClientAccept(IClient client)
        {
                WMSLoggerFactory.getLogger(null).debug("onClientAccept: "+
                        client.getClientId());
        }

        public void onClientReject(IClient client)
        {
                WMSLoggerFactory.getLogger(null).debug("onClientReject: "+
                        client.getClientId());
        }
}

appInstance.addClientListener(new ClientListener());

Parameters:: clientListener - client listener

addHTTPStreamerSession

void addHTTPStreamerSession(IHTTPStreamerSession httpStreamerSession)

Add a HTTPStreamerSession to this application instance

Parameters:: httpStreamerSession - HTTPStreamerSession

addLiveStreamPacketizerListener

void addLiveStreamPacketizerListener(ILiveStreamPacketizerActionNotify liveStreamPacketizerListener)

Add a Live Stream Packetizer listener (see: ILiveStreamPacketizerActionNotify)

Parameters:: liveStreamPacketizerListener - Live Stream Packetizer listener

addMediaCasterListener

void addMediaCasterListener(IMediaCasterNotify mediaCasterListener)

Add mediaCaster listener. Listens for create, destroy, registerPlayer, unregisterPlayer, setSourceStream

Parameters:: mediaCasterListener -

addMediaCasterListener

void addMediaCasterListener(IMediaCasterNotify2 mediaCasterListener)

Add mediaCaster listener. Listens for create, destroy, registerPlayer, unregisterPlayer, setSourceStream

Parameters:: mediaCasterListener -

addMediaReaderListener

void addMediaReaderListener(IMediaReaderActionNotify mediaReaderListener)

Add media reader listener. see IMediaReaderActionNotify

Parameters:: mediaReaderListener - media reader listener

addMediaStreamListener

void addMediaStreamListener(IMediaStreamNotify mediaStreamListener)

Add mediaStream listener. Listens for create and destroy

Add a MediaStream Listener

IApplicationInstance appInstance;

class MediaStreamListener implements IMediaStreamNotify
{
        public void onMediaStreamCreate(IMediaStream stream)
        {
                WMSLoggerFactory.getLogger(null).debug("onMediaStreamCreate: "+
                        stream.getSrc());
        }

        public void onMediaStreamDestroy(IMediaStream stream)
        {
                WMSLoggerFactory.getLogger(null).debug("onMediaStreamDestroy: "+
                        stream.getSrc());
        }
}
appInstance.addMediaStreamListener(new MediaStreamListener());

Parameters:: mediaStreamListener - mediaStream listener

addMediaWriterListener

void addMediaWriterListener(IMediaWriterActionNotify listener)

Add a MediaWriter listener class. See IMediaWriterActionNotify

Parameters:: listener - MediaWriter listener class

addModuleListener

void addModuleListener(IModuleNotify moduleListener)

Add module listener. Listens for onModuleLoad and onModuleUnload events. See IModuleNotify.

Parameters:: moduleListener - module listener

addPlayStreamByName

void addPlayStreamByName(IMediaStream stream,
                         String name)

Add a media stream to the list of streams that are listening for a published stream

Parameters:: stream - media stream; name - stream name

addPublisher

void addPublisher(Publisher publisher)

Add a server side publisher to this application instance

Parameters:: publisher - server side publisher

addRTPIncomingDatagramPortAll

void addRTPIncomingDatagramPortAll()

Allow all incoming RTP UDP ports for this application instance

addRTPIncomingDatagramPortRange

void addRTPIncomingDatagramPortRange(int startPort,
                                     int endPort)

Add a port range to the list of valid incoming RTP UDP ports

Parameters:: startPort - starting port number; endPort - end port number

addRTPSession

void addRTPSession(RTPSession rtpSession)

Add an RTP session to this application instance

Parameters:: rtpSession - RTP session to add

addSharedObjectListener

void addSharedObjectListener(ISharedObjectNotify sharedObjectListener,
                             boolean isPersistent)

Add sharedObject listener. Listens for create, destroy, clientConnect, clientDisconnect

Add SharedObject Listener

IApplicationInstance appInstance;

class SharedObjectListener implements ISharedObjectNotify
{
        public void onSharedObjectCreate(ISharedObject sharedObject)
        {
                WMSLoggerFactory.getLogger(null).debug("onSharedObjectCreate: "+
                        sharedObject.getName());
        }

        public void onSharedObjectDestroy(ISharedObject sharedObject)
        {
                WMSLoggerFactory.getLogger(null).debug("onSharedObjectDestroy: "+
                        sharedObject.getName());
        }

        public void onSharedObjectConnect(ISharedObject sharedObject, IClient client)
        {
                WMSLoggerFactory.getLogger(null).debug("onSharedObjectConnect: "+
                        sharedObject.getName());
        }

        public void onSharedObjectDisconnect(ISharedObject sharedObject, IClient client)
        {
                WMSLoggerFactory.getLogger(null).debug("onSharedObjectDisconnect: "+
                        sharedObject.getName());
        }
}
appInstance.addSharedObjectListener(new SharedObjectListener(), false);

Parameters:: sharedObjectListener - sharedObject listener; isPersistent -

broadcastMsg

void broadcastMsg(java.util.List<IClient> clientList,
                  String handlerName)

Broadcast a message to a specific list of clients connected to this application instance

Parameters:: clientList - list of client; handlerName - handler name

broadcastMsg

void broadcastMsg(java.util.List<IClient> clientList,
                  String handlerName,
                  Object... params)

Broadcast a message to a specific list of clients connected to this application instance

Parameters:: clientList - list of client; handlerName - handler name; params - parameters

broadcastMsg

void broadcastMsg(String handlerName,
                  Object... params)

Broadcast a message to all clients connected to this applicationInstance

Broadcast Message to All Clients

IApplicationInstance appInstance;
appInstance.broadcastMsg("onNotify", "Hello World", 1.2345, false, new Date());

Parameters:: handlerName - handler name; params - variable list of arguments (Java primitive and Strings will be wrapped in AMFData objects)

containsHTTPStreamer

boolean containsHTTPStreamer(String httpStreamer)

Does this application instance allow streaming of a given HTTPStreamer

Parameters:: httpStreamer - HTTP Streamer name
Returns:: true is this type of streaming is allowed

containsLiveStreamPacketizer

boolean containsLiveStreamPacketizer(String liveStreamPacketizer)

Does this application instance contain a references to this live stream packetizer. If it is true we consider this a live stream source for the HTTP streamer. If false then we consider this a video on demand source.

Parameters:: liveStreamPacketizer - live stream packetizer name
Returns:: true if contains reference to it

decodeStorageDir

String decodeStorageDir(String storageDir)

This function will take a storage path that uses variables and expand the variables based on the context. It supports the following variables (as well as any system variables): ${com.wowza.wms.AppHome}: Application home directory ${com.wowza.wms.ConfigHome}: Configuration home directory ${com.wowza.wms.context.VHostConfigHome}: Virtual configuration path ${com.wowza.wms.context.VHost}: Virtual host name ${com.wowza.wms.context.Application}: Application name ${com.wowza.wms.context.ApplicationInstance}: Application instance name

getAllowDomains

String[] getAllowDomains()

Get the list of domain names used to control access to this application. Upon connection, if this list is non-null the client.referrer value is checked to make sure the referrer is from a domain in this list.

Returns:: list of domain names used to control access to this application

getApplication

IApplication getApplication()

Get parent application

Returns:: parent application

getApplicationInstanceTouchTimeout

int getApplicationInstanceTouchTimeout()

Get the application instance touch timeout (milliseconds). Default is 5000.

Returns:: application instance touch timeout (milliseconds)

getApplicationTimeout

int getApplicationTimeout()

Get application timeout (milliseconds)

Returns:: application timeout (milliseconds)

getClientById

IClient getClientById(int index)

Get a client connection by the client Id

Parameters:: index - client Id
Returns:: client connection

getClientCount

int getClientCount()

Get number of client connections currently connected to applicationInstance

Returns:: number of client connections

getClientCountTotal

int getClientCountTotal()

Get number of client connections in total that have connected to this applicationInstance

Returns:: number of client connections

getClientIdleFrequency

int getClientIdleFrequency()

Get default client idle frequency (milliseconds)

Returns:: default client idle frequency (milliseconds)

getClients

java.util.List<IClient> getClients()

Get the set of clients currently connected to this application instance (replaces getClient(index))

Returns:: set of clients

getClientsLockObj

edu.emory.mathcs.backport.java.util.concurrent.locks.WMSReadWriteLock getClientsLockObj()

Get the read/write lock for this application instance

Returns:: read/write lock for this application instance

getConnectionCounter

ConnectionCounter getConnectionCounter()

Get the connectionCounter for applicationInstance

Returns:: connection counter

getConnectionCounter

com.wowza.wms.client.ConnectionCounterSimple getConnectionCounter(int counterIndex)

Get the connectionCounter for applicationInstance for a specific technology (see IVHost.COUNTER_*)

Parameters:: counterIndex - counter index
Returns:: connection counter

getContextStr

String getContextStr()

Returns the application context string in the form [application]/[appInstance].

Returns:: application context string

getDateStarted

String getDateStarted()

Get date applcationInstance started

Returns:: date applcationInstance started

getHTTPStreamerApplicationContext

IHTTPStreamerApplicationContext getHTTPStreamerApplicationContext(String httpStreamName,
                                                                  boolean doCreate)

Get the HTTPStreamer application context for a given HTTPStreamer adapter

Parameters:: httpStreamName - HTTPStreamer adapter name; doCreate - create if it does not exist
Returns:: HTTPStreamer application context

getHTTPStreamerList

String getHTTPStreamerList()

Get the comma separated list of HTTPStreamers names being used by this application (see conf/HTTPStreamers.xml)

Returns:: comma separated list of HTTPStreamers names

getHTTPStreamerProperties

WMSProperties getHTTPStreamerProperties()

Get the property collection of HTTPStreamer settings that are specific to this application instance

Returns:: property collection of HTTPStreamer settings

getHTTPStreamerSessionCount

int getHTTPStreamerSessionCount()

Get the current number of HTTPStreamerSessions associated with this application instance

Returns:: current number of HTTPStreamerSessions associated with this application instance

getHTTPStreamerSessionCount

int getHTTPStreamerSessionCount(int protocol)

Get the current number of HTTPStreamerSessions associated with this application instance by protocol. See (IHTTPStreamerSession.SESSIONPROTOCOL_*) for protocols

Parameters:: protocol - streaming protocol (IHTTPStreamerSession.SESSIONPROTOCOL_*)
Returns:: current number of HTTPStreamerSessions associated with this application instance

getHTTPStreamerSessionCount

int getHTTPStreamerSessionCount(int protocol,
                                String streamName)

Get the current number of HTTPStreamerSessions associated with this application instance and stream name by protocol . See (IHTTPStreamerSession.SESSIONPROTOCOL_*) for protocols

Parameters:: protocol - streaming protocol (IHTTPStreamerSession.SESSIONPROTOCOL_*); streamName - stream name
Returns:: HTTPStreamerSessions associated with this application instance

getHTTPStreamerSessionCount

int getHTTPStreamerSessionCount(String streamName)

Get the current number of HTTPStreamerSessions associated with this application instance and stream name

Parameters:: streamName - stream name
Returns:: number of HTTPStreamerSessions associated with this application instance

getHTTPStreamerSessionCountsByName

java.util.Map<String,Integer> getHTTPStreamerSessionCountsByName(int protocol)

Get a map of session counts by name for a given protocol

Parameters:: protocol - streaming protocol (IHTTPStreamerSession.SESSIONPROTOCOL_*)
Returns:: map of session counts by name

getHTTPStreamerSessions

java.util.List<IHTTPStreamerSession> getHTTPStreamerSessions()

Get the HTTPStreamerSessions associated with this application instance

Returns:: HTTPStreamerSessions associated with this application instance

getHTTPStreamerSessions

java.util.List<IHTTPStreamerSession> getHTTPStreamerSessions(int protocol)

Get the HTTPStreamerSessions associated with this application instance by protocol. See (IHTTPStreamerSession.SESSIONPROTOCOL_*) for protocols

Parameters:: protocol - streaming protocol (IHTTPStreamerSession.SESSIONPROTOCOL_*)
Returns:: HTTPStreamerSessions associated with this application instance

getHTTPStreamerSessions

java.util.List<IHTTPStreamerSession> getHTTPStreamerSessions(int protocol,
                                                             String streamName)

Get the HTTPStreamerSessions associated with this application instance for a stream name by protocol. See (IHTTPStreamerSession.SESSIONPROTOCOL_*) for protocols

Parameters:: protocol - streaming protocol (IHTTPStreamerSession.SESSIONPROTOCOL_*); streamName - stream name
Returns:: HTTPStreamerSessions associated with this application instance

getHTTPStreamerSessions

java.util.List<IHTTPStreamerSession> getHTTPStreamerSessions(String streamName)

Get the HTTPStreamerSessions associated with this application instance for a stream name

Parameters:: streamName - stream name
Returns:: HTTPStreamerSessions associated with this application instance

getIOPerformanceCounter

IOPerformanceCounter getIOPerformanceCounter()

Get the performance counter for applicationInstance

Returns:: io performance counter

getIOPerformanceCounter

IOPerformanceCounter getIOPerformanceCounter(int counterIndex)

Get the performance counter for applicationInstance for a specific technology (see IVHost.COUNTER_*)

Parameters:: counterIndex - counter index (see IVHost.COUNTER_*)
Returns:: connection counter

getLastTouchTime

long getLastTouchTime()

Get the last time the instance was touched (milliseconds)

Returns:: last time the instance was touched (milliseconds)

getLiveStreamPacketizerControl

ILiveStreamPacketizerControl getLiveStreamPacketizerControl()

Get the Live Stream Packetizer Contoller. This class will get called each time a stream is to be packetized using the LiveStreamPacketizer mechanism.

Returns:: Live Stream Packetizer Contoller

getLiveStreamPacketizerList

String getLiveStreamPacketizerList()

Get the comma separated list of LiveStreamPacketizers names being used by this application (see conf/LiveStreamPacketizers.xml)

Returns:: comma separated list of LiveStreamPacketizers names

getLiveStreamPacketizerProperties

WMSProperties getLiveStreamPacketizerProperties()

Get the property collection of LiveStreamPacketizer settings that are specific to this application instance

Returns:: property collection of LiveStreamPacketizer settings

getMaximumPendingWriteBytes

int getMaximumPendingWriteBytes()

Get maximum number a bytes a client connection can have waiting to be sent before the connection is terminated. If set to zero this feature is turned off.

Returns:: maximum number a bytes a client connection can have waiting to be sent before the connection is terminated

getMaximumSetBufferTime

int getMaximumSetBufferTime()

Get maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call. If set to zero this feature is turned off.

Returns:: maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call

getMaxStorageDirDepth

int getMaxStorageDirDepth()

Maximum folder depth allowed for the StreamStorageDir and SharedObjectStorageDir paths

Returns:: folder depth

getMediaCasterProperties

WMSProperties getMediaCasterProperties()

Get the property collection of media caster settings that are specific to this application instance

Returns:: property collection of media caster settings

getMediaCasterStreams

MediaCasterStreamMap getMediaCasterStreams()

Get the media caster streams attached to this application instance

Returns:: media caster streams attached to this application instance

getMediaCasterValidator

IMediaCasterValidateMediaCaster getMediaCasterValidator()

Get the MediaCaster validator interface for this application instance

Returns:: MediaCaster validator interface

getMediaReaderProperties

WMSProperties getMediaReaderProperties()

Get the property collection of media reader settings that are specific to this application instance

Returns:: property collection of media reader settings

getMediaWriterProperties

WMSProperties getMediaWriterProperties()

Get the property collection of media reader settings that are specific to this application instance

Returns:: property collection of media reader settings

getModFunctions

com.wowza.wms.module.ModuleFunctions getModFunctions()

Get list of application modules

Returns:: list of application modules

getModuleInstance

Object getModuleInstance(String name)

Get the instance of the module class for this application instance.

Parameters:: name - module name as defined in Application.xml
Returns:: instance of class for this application instance

getModuleList

com.wowza.wms.module.ModuleList getModuleList()

Get the list of loaded modules.

Returns:: list of loaded modules

getName

String getName()

Get applicationInstance name

Returns:: applicationInstance name

getPingTimeout

int getPingTimeout()

Get ping timeout (milliseconds)

Returns:: ping timeout (milliseconds)

getPlayStreamCount

int getPlayStreamCount(String streamName)

Get the number of Flash players playing a given stream name

Parameters:: streamName - stream name
Returns:: number of players

getPlayStreamCountsByName

java.util.Map<String,Integer> getPlayStreamCountsByName()

Get a map of stream names to number of Flash players playing the stream name

Returns:: map of stream names to number of Flash players playing the stream name

getPlayStreamsByName

java.util.List<IMediaStream> getPlayStreamsByName(String name)

Get a list of media streams that are listening for published stream.

Parameters:: name - stream name
Returns:: list of streams or null if no listeners

getProperties

WMSProperties getProperties()

Get applicationInstance properties

Returns:: applicationInstance properties

getPublisherCount

int getPublisherCount()

Get the current number of server side publishers

Returns:: number of server side publishers

getPublishers

java.util.List<Publisher> getPublishers()

Get the set of server side publishers

Returns:: set of server side publishers

getPublishStreamNames

java.util.List<String> getPublishStreamNames()

Get the list of live stream names currently being published.

Returns:: list of live stream names currently being published

getRepeaterOriginUrl

String getRepeaterOriginUrl()

Get the Repeater Origin URL used by the Live Stream Repeater

Returns:: URL used by the Live Stream Repeater

getRepeaterQueryString

String getRepeaterQueryString()

Get the Repeater query string that is used to connect to the origin. This value can be used to pass secure URL parameters to the origin for security validation.

Returns:: Repeater query string

getRsoStorageDir

String getRsoStorageDir()

Get remote shared object storage path

Returns:: remote shared object storage path

getRsoStoragePath

String getRsoStoragePath()

Get the resolved storage path to the shared objects

Returns:: resolved storage path to the shared objects

getRTPAVSyncMethod

int getRTPAVSyncMethod()

Get RTP audio/video sync method (RTPStream.AVSYNCMETHODS_SENDERREPORT, RTPStream.AVSYNCMETHODS_SYSTEMCLOCK, RTPStream.AVSYNCMETHODS_RTPTIMECODE)

Returns:: RTP audio/video sync method

getRTPIdleFrequency

int getRTPIdleFrequency()

Set the default RTP idle frequency (milliseconds)

Returns:: default RTP idle frequency (milliseconds)

getRTPMaxRTCPWaitTime

int getRTPMaxRTCPWaitTime()

Get the maximum time to wait for RTCP packets (milliseconds)

Returns:: maximum time to wait for RTCP packets (milliseconds)

getRTPPlayAuthenticationMethod

String getRTPPlayAuthenticationMethod()

Get the RTP play authentication method (as defined in conf/Authentication.xml)

Returns:: RTP play authentication method

getRTPProperties

WMSProperties getRTPProperties()

Get the property collection of RTP settings that are specific to this application instance

Returns:: property collection of RTP settings

getRTPPublishAuthenticationMethod

String getRTPPublishAuthenticationMethod()

Get the RTP publish authentication method (as defined in conf/Authentication.xml)

Returns:: RTP publish authentication method

getRTPSessionCount

int getRTPSessionCount()

Get the number of RTP sessions running under this application instance

Returns:: the number of RTP sessions running under this application instance

getRTPSessionCount

int getRTPSessionCount(String streamName)

Get the number of RTP player streams playing a given stream name

Parameters:: streamName - strean name
Returns:: the number of RTP sessions

getRTPSessionCountsByName

java.util.Map<String,Integer> getRTPSessionCountsByName()

Get a map of stream names and session counts of RTP sessions

Returns:: map of stream names and session counts

getRTPSessions

java.util.List<RTPSession> getRTPSessions()

Get a list of RTP sessions running under this application instance

Returns:: list of RTP sessions running under this application instance

getRTPSessions

java.util.List<RTPSession> getRTPSessions(String streamName)

Get a list of RTP sessions running under this application instance playing a given stream name

Parameters:: streamName - stream name
Returns:: list of RTP sessions running under this application instance playing a given stream name

getRTSPBindIpAddress

String getRTSPBindIpAddress()

Set the IP address to which UDP ports will be bound for RTSP/RTP sessions

Returns:: IP address to which UDP ports will be bound for RTSP/RTP sessions

getRTSPConnectionAddressType

String getRTSPConnectionAddressType()

Get the connection IP address type (IP4) to used in the Session Description Protocol data exchanged for an RTSP/RTP session

Returns:: the connection IP address type (IP4) to used in the Session Description Protocol data exchanged for an RTSP/RTP session

getRTSPConnectionIpAddress

String getRTSPConnectionIpAddress()

Get the connection IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session

Returns:: connection IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session

getRTSPMaximumPendingWriteBytes

int getRTSPMaximumPendingWriteBytes()

Get the maximum number of pending write bytes for an RTSP session

Returns:: maximum number of pending write bytes for an RTSP session

getRTSPOriginAddressType

String getRTSPOriginAddressType()

Get the origin IP address type (IP4) to used in the Session Description Protocol data exchanged for an RTSP/RTP session

Returns:: origin IP address type (IP4) to used in the Session Description Protocol data exchanged for an RTSP/RTP session

getRTSPOriginIpAddress

String getRTSPOriginIpAddress()

Get the origin IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session

Returns:: origin IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session

getRTSPSessionTimeout

int getRTSPSessionTimeout()

Get the RTSP session timeout (milliseconds)

Returns:: RTSP session timeout (milliseconds)

getSharedObjectReadAccess

String getSharedObjectReadAccess()

Get the default shared object read access

Returns:: default shared object read access
See Also:: IClient.getSharedObjectReadAccess()

getSharedObjects

ISharedObjects getSharedObjects()

Get non-peristent shared object collection

Returns:: collection of non-persistent shared objects

getSharedObjects

ISharedObjects getSharedObjects(boolean isPersistent)

Get either persistent or non-persistent shared object collection

Parameters:: isPersistent -
Returns:: collection of shared objects

getSharedObjectWriteAccess

String getSharedObjectWriteAccess()

Get the default shared object write access

Returns:: default shared object write access
See Also:: IClient.getSharedObjectWriteAccess()

getStreamAudioSampleAccess

String getStreamAudioSampleAccess()

Get the default stream audio sample access

Returns:: default stream audio sample access
See Also:: IClient.getStreamAudioSampleAccess()

getStreamCount

int getStreamCount()

Get the total number of open streams attached to this application instance

Returns:: the total number of open streams attached to this application instance

getStreamFileMapper

IMediaStreamFileMapper getStreamFileMapper()

Get the stream file mapper. See IMediaStreamFileMapper

Returns:: streamFileMapper stream file mapper

getStreamKeyDir

String getStreamKeyDir()

Get the stream key path

Returns:: stream key path

getStreamKeyPath

String getStreamKeyPath()

Get the resolved key path to the MediaStreams encryption keys

Returns:: resolved key path to the MediaStreams encryption keys

getStreamNameAliasProvider

IMediaStreamNameAliasProvider getStreamNameAliasProvider()

Get the stream name alias provider

Returns:: stream name alias provider

getStreamProperties

WMSProperties getStreamProperties()

Get the property collection of stream settings that are specific to this application instance

Returns:: property collection of stream settings

getStreamReadAccess

String getStreamReadAccess()

Get the default stream read access

Returns:: default stream read access
See Also:: IClient.getStreamReadAccess()

getStreams

MediaStreamMap getStreams()

Get all the mediaStream objects attached to this applicationInstance

Get Stream By StreamId

IClient client;
int streamId;

MediaStreamMap streams = client.getAppInstance().getStreams();
IMediaStream stream = streams.getStream((IClient)null, streamId);

Returns:: collection of mediaStream objects

getStreamStorageDir

String getStreamStorageDir()

Get stream storage path

Returns:: stream storage path

getStreamStoragePath

String getStreamStoragePath()

Get the resolved storage path to the MediaStreams

Returns:: resolved storage path to the MediaStreams

getStreamType

String getStreamType()

Get default streamType for application.

Returns:: streamType name

getStreamVideoSampleAccess

String getStreamVideoSampleAccess()

Get the default stream video sample access

Returns:: default stream video sample access
See Also:: IClient.getStreamVideoSampleAccess()

getStreamWriteAccess

String getStreamWriteAccess()

Get the default stream write access

Returns:: default stream write access
See Also:: IClient.getStreamWriteAccess()

getTimeRunning

String getTimeRunning()

Get time applcationInstance running

Returns:: time applcationInstance running

getTimeRunningSeconds

double getTimeRunningSeconds()

Get time running in seconds

Returns:: time running in seconds

getValidationFrequency

int getValidationFrequency()

Get time between validation pings (milliseconds)

Returns:: time between validation pings (milliseconds)

getVHost

IVHost getVHost()

Get parent vHost

Returns:: parent vHost

incClientCountTotal

void incClientCountTotal()

Increment the total number of connected client counter by one

isAcceptConnection

boolean isAcceptConnection()

Is auto accept connection on/off

Returns:: auto accept connection

isRTPIncomingDatagramPortValid

boolean isRTPIncomingDatagramPortValid(int port)

Check a port number to be sure it is a valid RTP UDP port for this application instance

Parameters:: port - port number
Returns:: true if the port is valid

isValidateFMLEConnections

boolean isValidateFMLEConnections()

Returns true if validating FMLE connection (default is false)

Returns:: true if validating FMLE connection

notifyLiveStreamPacketizerCreate

void notifyLiveStreamPacketizerCreate(ILiveStreamPacketizer liveStreamPacketizer,
                                      String streamName)

Notify Live Stream Packetizer Create

Parameters:: liveStreamPacketizer - Live Stream Packetizer listener

notifyLiveStreamPacketizerDestroy

void notifyLiveStreamPacketizerDestroy(ILiveStreamPacketizer liveStreamPacketizer)

Notify Live Stream Packetizer Destory

Parameters:: liveStreamPacketizer - Live Stream Packetizer listener

notifyLiveStreamPacketizerInit

void notifyLiveStreamPacketizerInit(ILiveStreamPacketizer liveStreamPacketizer,
                                    String streamName)

Notify Live Stream Packetizer Init

Parameters:: liveStreamPacketizer - Live Stream Packetizer listener

notifyMediaReaderClose

void notifyMediaReaderClose(IMediaReader mediaReader,
                            IMediaStream stream)

Notify media reader notifyMediaReaderClose

Parameters:: mediaReader - media reader; stream - media stream

notifyMediaReaderCreate

void notifyMediaReaderCreate(IMediaReader mediaReader)

Notify media reader notifyMediaReaderCreate

Parameters:: mediaReader - media reader

notifyMediaReaderExtractMetaData

void notifyMediaReaderExtractMetaData(IMediaReader mediaReader,
                                      IMediaStream stream)

Notify media reader notifyMediaReaderExtractMetaData

Parameters:: mediaReader - media reader; stream - media stream

notifyMediaReaderInit

void notifyMediaReaderInit(IMediaReader mediaReader,
                           IMediaStream stream)

Notify media reader notifyMediaReaderInit

Parameters:: mediaReader - media reader; stream - media stream

notifyMediaReaderOpen

void notifyMediaReaderOpen(IMediaReader mediaReader,
                           IMediaStream stream)

Notify media reader notifyMediaReaderOpen

Parameters:: mediaReader - media reader; stream - media stream

notifyMediaWriterOnFLVAddMetadata

void notifyMediaWriterOnFLVAddMetadata(IMediaStream stream,
                                       java.util.Map<String,Object> extraMetadata)

Notify all MediaWriter listeners of onFLVAddMetadata

Parameters:: stream - media stream; extraMetadata - meta to add to the file

notifyMediaWriterOnWriteComplete

void notifyMediaWriterOnWriteComplete(IMediaStream stream,
                                      java.io.File file)

Notify all MediaWriter listeners of onWriteComplete

Parameters:: stream - media stream; file - file that was written

parseAllowDomains

void parseAllowDomains(String domainFilterStr)

Parse a comma delimited list of domain names used to control access to this application. Upon connection, if this list is non-null the client.referrer value is checked to make sure the referrer is from a domain in this list.

Parameters:: domainFilterStr - comma delimited list of domain names

readAppInstConfig

String readAppInstConfig(String sName)

Method to read xml config file..

registerPlayRTPSession

void registerPlayRTPSession(RTPSession rtpSession)

Parameters:: rtpSession - RTP session to register

removeClientListener

void removeClientListener(IClientNotify clientListener)

Remove client listener. Listens for connects, disconnect, accepts and reject

Parameters:: clientListener - client listener

removeHTTPStreamerSession

void removeHTTPStreamerSession(IHTTPStreamerSession httpStreamerSession)

Remove a HTTPStreamerSession from this application instance

Parameters:: httpStreamerSession - HTTPStreamerSession

removeLiveStreamPacketizerListener

void removeLiveStreamPacketizerListener(ILiveStreamPacketizerActionNotify liveStreamPacketizerListener)

Remove a Live Stream Packetizer listener (see: ILiveStreamPacketizerActionNotify)

Parameters:: liveStreamPacketizerListener - Live Stream Packetizer listener

removeMediaCasterListener

void removeMediaCasterListener(IMediaCasterNotify mediaCasterListener)

Remove mediaCaster listener. Listens for create, destroy, registerPlayer, unregisterPlayer, setSourceStream

Parameters:: mediaCasterListener -

removeMediaReaderListener

void removeMediaReaderListener(IMediaReaderActionNotify mediaReaderListener)

Remove media reader listener. see IMediaReaderActionNotify

Parameters:: mediaReaderListener - media reader listener

removeMediaStreamListener

void removeMediaStreamListener(IMediaStreamNotify mediaStreamListener)

Remove mediaStream listener. Listens for create and destroy

Parameters:: mediaStreamListener - mediaStream listener

removeMediaWriterListener

void removeMediaWriterListener(IMediaWriterActionNotify listener)

remove MediaWriter listener class. See IMediaWriterActionNotify

Parameters:: listener - MediaWriter listener class

removeModuleListener

void removeModuleListener(IModuleNotify moduleListener)

Remove module listener

Parameters:: moduleListener - module listener

removePlayStreamByName

void removePlayStreamByName(IMediaStream stream)

Remove media stream from the list of streams that are listening for a published stream

Parameters:: stream - media stream

removePublisher

void removePublisher(Publisher publisher)

Remove a server side publisher from this application instance

Parameters:: publisher - server side publisher

removeRTPSession

void removeRTPSession(RTPSession rtpSession)

Remove an RTP session from this application instance

Parameters:: rtpSession - RTP session to remove

removeSharedObjectListener

void removeSharedObjectListener(ISharedObjectNotify sharedObjectListener,
                                boolean isPersistent)

Remove sharedObject listener. Listens for create, destroy, clientConnect, clientDisconnect

Parameters:: sharedObjectListener - sharedObject listener; isPersistent -

resetMediaCasterStream

boolean resetMediaCasterStream(String streamName)

Reset a media caster stream

Parameters:: streamName - stream name
Returns:: true if successful

resetMediaCasterStream

boolean resetMediaCasterStream(String streamName,
                               String streamExt)

Reset a media caster stream

Parameters:: streamName - stream name; streamExt - stream extension
Returns:: true if successful

setAcceptConnection

void setAcceptConnection(boolean acceptConnection)

Set is auto accept connection

Parameters:: acceptConnection - auto accept connection

setAllowDomains

void setAllowDomains(String[] domainFilter)

Set the list of domain names used to control access to this application. Upon connection, if this list is non-null the client.referrer value is checked to make sure the referrer is from a domain in this list.

Parameters:: domainFilter - list of domain names used to control access to this application

setApplicationInstanceTouchTimeout

void setApplicationInstanceTouchTimeout(int applicationInstanceTouchTimeout)

Set the application instance touch timeout (milliseconds). Default is 5000.

Parameters:: applicationInstanceTouchTimeout - application instance touch timeout (milliseconds)

setApplicationTimeout

void setApplicationTimeout(int applicationTimeout)

Set application timeout (milliseconds)

Parameters:: applicationTimeout - application timeout (milliseconds)

setClientIdleFrequency

void setClientIdleFrequency(int clientIdleFrequency)

Set default client idle frequency (milliseconds)

Parameters:: clientIdleFrequency - default client idle frequency (milliseconds)

setHTTPStreamerList

void setHTTPStreamerList(String httpStreamerList)

Set the comma separated list of HTTPStreamer names being used by this application (see conf/HTTPStreamers.xml)

Parameters:: httpStreamerList - comma separated list of HTTPStreamer names

setLiveStreamPacketizerControl

void setLiveStreamPacketizerControl(ILiveStreamPacketizerControl liveStreamPacketizerControl)

Set the Live Stream Packetizer Contoller. This class will get called each time a stream is to be packetized using the LiveStreamPacketizer mechanism.

Parameters:: liveStreamPacketizerControl - Live Stream Packetizer Contoller

setLiveStreamPacketizerList

void setLiveStreamPacketizerList(String liveStreamPacketizerList)

Set the comma separated list of LiveStreamPacketizers names being used by this application (see conf/LiveStreamPacketizers.xml)

Parameters:: liveStreamPacketizerList - comma separated list of LiveStreamPacketizers names

setMaximumPendingWriteBytes

void setMaximumPendingWriteBytes(int maximumPendingWriteBytes)

Set maximum number a bytes a client connection can have waiting to be sent before the connection is terminated. If set to zero this feature is turned off.

Parameters:: maximumPendingWriteBytes - maximum number a bytes a client connection can have waiting to be sent before the connection is terminated

setMaximumSetBufferTime

void setMaximumSetBufferTime(int maximumSetBufferTime)

Set maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call. If set to zero this feature is turned off.

Parameters:: maximumSetBufferTime - maximum number of milliseconds allowed for the NetStream.setBufferTime(secs) call

setMaxStorageDirDepth

void setMaxStorageDirDepth(int maxStorageDirDepth)

Maximum folder depth allowed for the StreamStorageDir and SharedObjectStorageDir paths

Parameters:: maxStorageDirDepth - folder depth

setMediaCasterValidator

void setMediaCasterValidator(IMediaCasterValidateMediaCaster mediaCasterValidator)

Set the MediaCaster validator interface for this application instance

Parameters:: mediaCasterValidator - MediaCaster validator interface

setName

void setName(String name)

Set applicationInstance name

Parameters:: name - applicationInstance name

setPingTimeout

void setPingTimeout(int pingTimeout)

Set ping timeout (millseconds)

Parameters:: pingTimeout - ping timeout (millseconds)

setRepeaterOriginUrl

void setRepeaterOriginUrl(String repeaterOriginUrl)

Set the Repeater Origin URL used by the Live Stream Repeater

Parameters:: repeaterOriginUrl - URL used by the Live Stream Repeater

setRepeaterQueryString

void setRepeaterQueryString(String repeaterQueryString)

Set the Repeater query string that is used to connect to the origin. This value can be used to pass secure URL parameters to the origin for security validation.

Parameters:: repeaterQueryString - Repeater query string

setRsoStorageDir

void setRsoStorageDir(String rsoStorageDir)

Set remote shared object storage path

Parameters:: rsoStorageDir - remote shared object storage path

setRTPAVSyncMethod

void setRTPAVSyncMethod(int rtpAVSyncMethod)

Set RTP audio/video sync method (RTPStream.AVSYNCMETHODS_SENDERREPORT, RTPStream.AVSYNCMETHODS_SYSTEMCLOCK, RTPStream.AVSYNCMETHODS_RTPTIMECODE)

Parameters:: rtpAVSyncMethod - RTP audio/video sync method

setRTPIdleFrequency

void setRTPIdleFrequency(int rtspIdleFrequency)

Get the default RTP idle frequency (milliseconds)

Parameters:: rtspIdleFrequency - default RTP idle frequency (milliseconds)

setRTPMaxRTCPWaitTime

void setRTPMaxRTCPWaitTime(int rtpMaxRTCPWaitTime)

Set the maximum time to wait for RTCP packets (milliseconds)

Parameters:: rtpMaxRTCPWaitTime - maximum time to wait for RTCP packets (milliseconds)

setRTPPlayAuthenticationMethod

void setRTPPlayAuthenticationMethod(String rtpPlayAuthenticationMethod)

Set the RTP play authentication method (as defined in conf/Authentication.xml)

Parameters:: rtpPlayAuthenticationMethod - RTP play authentication method

setRTPPublishAuthenticationMethod

void setRTPPublishAuthenticationMethod(String rtpPublishAuthenticationMethod)

Set the RTP publish authentication method (as defined in conf/Authentication.xml)

Parameters:: rtpPublishAuthenticationMethod - RTP publish authentication method

setRTSPBindIpAddress

void setRTSPBindIpAddress(String rtspBindIpAddress)

Get the IP address to which UDP ports will be bound for RTSP/RTP sessions

Parameters:: rtspBindIpAddress - IP address to which UDP ports will be bound for RTSP/RTP sessions

setRTSPConnectionAddressType

void setRTSPConnectionAddressType(String rtspConnectionAddressType)

Set the connection IP address type (IP4) to used in the Session Description Protocol data exchanged for an RTSP/RTP session

Parameters:: rtspConnectionAddressType -

setRTSPConnectionIpAddress

void setRTSPConnectionIpAddress(String rtspConnectionIpAddress)

Set the connection IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session

Parameters:: rtspConnectionIpAddress - connection IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session

setRTSPMaximumPendingWriteBytes

void setRTSPMaximumPendingWriteBytes(int rtspMaximumPendingWriteBytes)

Set the maximum number of pending write bytes for an RTSP session

Parameters:: rtspMaximumPendingWriteBytes - maximum number of pending write bytes for an RTSP session

setRTSPOriginAddressType

void setRTSPOriginAddressType(String rtspOriginAddressType)

Set the origin IP address type (IP4) to used in the Session Description Protocol data exchanged for an RTSP/RTP session

Parameters:: rtspOriginAddressType - origin IP address type (IP4) to used in the Session Description Protocol data exchanged for an RTSP/RTP session

setRTSPOriginIpAddress

void setRTSPOriginIpAddress(String rtspOriginIpAddress)

Set the origin IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session

Parameters:: rtspOriginIpAddress - origin IP address to used in the Session Description Protocol data exchanged for an RTSP/RTP session

setRTSPSessionTimeout

void setRTSPSessionTimeout(int rtspSessionTimeout)

Set the RTSP session timeout (milliseconds)

Parameters:: rtspSessionTimeout - RTSP session timeout (milliseconds)

setSharedObjectReadAccess

void setSharedObjectReadAccess(String sharedObjectReadAccess)

Set the default shared object read access

Parameters:: sharedObjectReadAccess - default shared object read access
See Also:: IClient.setSharedObjectReadAccess(java.lang.String)

setSharedObjectWriteAccess

void setSharedObjectWriteAccess(String sharedObjectWriteAccess)

Set the default shared object write access

Parameters:: sharedObjectWriteAccess - default shared object write access
See Also:: IClient.setSharedObjectWriteAccess(java.lang.String)

setStreamAudioSampleAccess

void setStreamAudioSampleAccess(String streamAudioSampleAccess)

Set the default stream audio sample access

Parameters:: streamAudioSampleAccess -
See Also:: IClient.setStreamAudioSampleAccess(java.lang.String)

setStreamFileMapper

void setStreamFileMapper(IMediaStreamFileMapper streamFileMapper)

Set the stream file mapper. See IMediaStreamFileMapper

Parameters:: streamFileMapper - stream file mapper

setStreamKeyDir

void setStreamKeyDir(String keyStorageDir)

Set the stream key path

Parameters:: keyStorageDir - stream key path

setStreamNameAliasProvider

void setStreamNameAliasProvider(IMediaStreamNameAliasProvider streamNameAliasProvider)

Set the stream name alias provider

Parameters:: streamNameAliasProvider - stream name alias provider

setStreamReadAccess

void setStreamReadAccess(String streamReadAccess)

Set the default stream read access

Parameters:: streamReadAccess - default stream read access
See Also:: IClient.setStreamReadAccess(java.lang.String)

setStreamStorageDir

void setStreamStorageDir(String streamStorageDir)

Set stream storage path

Parameters:: streamStorageDir - stream storage path

setStreamType

void setStreamType(String streamType)

Set default stream type for application.

Parameters:: streamType - streamType name

setStreamVideoSampleAccess

void setStreamVideoSampleAccess(String streamVideoSampleAccess)

Set the default stream video sample access

Parameters:: streamVideoSampleAccess - default stream video sample access
See Also:: IClient.setStreamVideoSampleAccess(java.lang.String)

setStreamWriteAccess

void setStreamWriteAccess(String streamWriteAccess)

Set the default stream write access

Parameters:: streamWriteAccess - default stream write access
See Also:: IClient.setStreamWriteAccess(java.lang.String)

setValidateFMLEConnections

void setValidateFMLEConnections(boolean validateFMLEConnections)

Returns true if validating FMLE connection (default is false)

Parameters:: validateFMLEConnections - true if validating FMLE connection

setValidationFrequency

void setValidationFrequency(int validationFrequency)

Set time between validation pings (milliseconds)

Parameters:: validationFrequency - time between validation pings (milliseconds)

shutdown

void shutdown(boolean isServerShutdown,
              boolean isAppShutdown)

shutdown applicationInstance

Parameters:: isServerShutdown - true if due to shutdown of server; isAppShutdown - true if due to shutdown of application

shutdownClient

void shutdownClient(IClient client)

shutdown a client connection immediately

Parameters:: client - client connection

startMediaCasterStream

boolean startMediaCasterStream(String streamName,
                               String mediaCasterType)

Start a media caster stream

Parameters:: streamName - stream name; mediaCasterType - media caster stream type
Returns:: true if successful

startMediaCasterStream

boolean startMediaCasterStream(String streamName,
                               String streamExt,
                               String mediaCasterType)

Start a media caster stream

Parameters:: streamName - stream name; streamExt - stream extension; mediaCasterType - media caster stream type
Returns:: true if successful

stopMediaCasterStream

void stopMediaCasterStream(String streamName)

Stop a media caster stream

Parameters:: streamName - stream name

touch

void touch()

Touch the application instance so that it stays loaded for at least applicationInstanceTouchTimeout

writeAppInstConfig

boolean writeAppInstConfig(String sName,
                           String data)

Method to write xml config file..

Overview

Package

Class

Use

Tree

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.wowza.wms.application Interface IApplicationInstance

DEFAULT_APPINSTANCE_NAME

addClientListener

Add a Client Listener

addHTTPStreamerSession

addLiveStreamPacketizerListener

addMediaCasterListener

addMediaCasterListener

addMediaReaderListener

addMediaStreamListener

Add a MediaStream Listener

addMediaWriterListener

addModuleListener

addPlayStreamByName

addPublisher

addRTPIncomingDatagramPortAll

addRTPIncomingDatagramPortRange

addRTPSession

addSharedObjectListener

Add SharedObject Listener

broadcastMsg

broadcastMsg

broadcastMsg

Broadcast Message to All Clients

containsHTTPStreamer

containsLiveStreamPacketizer

decodeStorageDir

getAllowDomains

getApplication

getApplicationInstanceTouchTimeout

getApplicationTimeout

getClientById

getClientCount

getClientCountTotal

getClientIdleFrequency

getClients

getClientsLockObj

getConnectionCounter

getConnectionCounter

getContextStr

getDateStarted

getHTTPStreamerApplicationContext

getHTTPStreamerList

getHTTPStreamerProperties

getHTTPStreamerSessionCount

getHTTPStreamerSessionCount

getHTTPStreamerSessionCount

getHTTPStreamerSessionCount

getHTTPStreamerSessionCountsByName

getHTTPStreamerSessions

getHTTPStreamerSessions

getHTTPStreamerSessions

getHTTPStreamerSessions

getIOPerformanceCounter

getIOPerformanceCounter

getLastTouchTime

getLiveStreamPacketizerControl

getLiveStreamPacketizerList

getLiveStreamPacketizerProperties

getMaximumPendingWriteBytes

getMaximumSetBufferTime

getMaxStorageDirDepth

getMediaCasterProperties

getMediaCasterStreams

getMediaCasterValidator

getMediaReaderProperties

getMediaWriterProperties

getModFunctions

getModuleInstance

getModuleList

getName

getPingTimeout

getPlayStreamCount

getPlayStreamCountsByName

getPlayStreamsByName

getProperties

getPublisherCount

getPublishers

getPublishStreamNames

getRepeaterOriginUrl

com.wowza.wms.application
Interface IApplicationInstance