Package com.wowza.wms.transport.media
Interface IMediaTransport
-
public interface IMediaTransport
MediaTransport sub system. It manages transport providers and how objects are passed to each provider.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addTransportDataObject(IMediaTransportDataObject transportDataObject)
Adds a data object to the MediaTransport system which is then pushed to the transport providers configured.void
addTransportListener(IMediaTransportListener listener)
This adds a transport listener which has the following calls onTransportProviderAdd onTransportProviderRemove These are triggered when a transport provider is added or removed.boolean
addTransportProvider(IMediaTransportProvider transportProvider)
This adds a transport provider to the list of providers to use for any data objects passed into the MediaTransport system.boolean
getDebug()
Get the state of the debugging flag.java.util.List<IMediaTransportListener>
getTransportListeners()
Returns a list of transport listeners available to the MediaTransport system.java.util.List<IMediaTransportProvider>
getTransportProviders()
Returns a list of transport providers available to the MediaTransport system.void
init()
Initialises the MediaTransport sub system.boolean
isReady()
Return if the MediaTransport system is ready.boolean
removeTransportProvider(IMediaTransportProvider transportProvider)
This removes a transport provider from the list of providers in use.void
removeTransportProviderListener(IMediaTransportListener listener)
This removes a transport listener.void
setDebug(boolean debug)
Set the debug flag, by default it should be false.void
setIsReady(boolean ready)
This should be set to true if the MediaTransport object initialised correctly.
-
-
-
Method Detail
-
init
void init()
Initialises the MediaTransport sub system. This should be called prior immediately and instantiation.
-
setDebug
void setDebug(boolean debug)
Set the debug flag, by default it should be false.- Parameters:
debug
- boolean
-
getDebug
boolean getDebug()
Get the state of the debugging flag.- Returns:
- boolean
-
isReady
boolean isReady()
Return if the MediaTransport system is ready. It should only return true if at least one(1) transport provider has been added and it initialised correctly.- Returns:
- boolean
-
setIsReady
void setIsReady(boolean ready)
This should be set to true if the MediaTransport object initialised correctly. Even when this is set to true isReady() should only return true if at least one(1) transport provider has been added.- Parameters:
ready
-
-
addTransportProvider
boolean addTransportProvider(IMediaTransportProvider transportProvider)
This adds a transport provider to the list of providers to use for any data objects passed into the MediaTransport system. The transport provider should be fully configured and initialised before being added. If the MediaTransport system allows the provider to be added it returns true. You can not add the same MediaTransport provider more than once, if you want to send objects to similar type destinations you MUST create two providers. When adding a provider it can ONLY return true if the MediaTransport object has been initialised.- Parameters:
transportProvider
-- Returns:
-
removeTransportProvider
boolean removeTransportProvider(IMediaTransportProvider transportProvider)
This removes a transport provider from the list of providers in use. If the transport provider specified is not found as active then false is returned, otherwise it is true. Removing a transport provider should not interrupt any transport in progress.- Parameters:
transportProvider
-- Returns:
-
getTransportProviders
java.util.List<IMediaTransportProvider> getTransportProviders()
Returns a list of transport providers available to the MediaTransport system.- Returns:
- List
-
addTransportListener
void addTransportListener(IMediaTransportListener listener)
This adds a transport listener which has the following calls onTransportProviderAdd onTransportProviderRemove These are triggered when a transport provider is added or removed.- Parameters:
IMediaTransportListener
-
-
removeTransportProviderListener
void removeTransportProviderListener(IMediaTransportListener listener)
This removes a transport listener.- Parameters:
IMediaTransportListener
-
-
getTransportListeners
java.util.List<IMediaTransportListener> getTransportListeners()
Returns a list of transport listeners available to the MediaTransport system.- Returns:
- List
-
addTransportDataObject
void addTransportDataObject(IMediaTransportDataObject transportDataObject)
Adds a data object to the MediaTransport system which is then pushed to the transport providers configured.- Parameters:
IMediaTransportDataObject
-
-
-