Uses of Interface
org.red5.server.api.scope.IScope

Packages that use IScope

Package	Description
org.red5.server
org.red5.server.adapter
org.red5.server.api
org.red5.server.api.listeners
org.red5.server.api.scope
org.red5.server.api.service
org.red5.server.api.so
org.red5.server.api.stream
org.red5.server.exception
org.red5.server.jmx.mxbeans
org.red5.server.net.rtmp
org.red5.server.persistence
org.red5.server.scope
org.red5.server.service
org.red5.server.so
org.red5.server.stream
org.red5.server.stream.consumer
org.red5.server.util

Uses of IScope in org.red5.server

Methods in org.red5.server that return IScope

Modifier and Type	Method	Description
IScope	BaseConnection.getScope()	Return the current scope.

Methods in org.red5.server that return types with arguments of type IScope

Modifier and Type	Method	Description
Collection<IScope>	Client.getScopes()

Methods in org.red5.server with parameters of type IScope

Modifier and Type	Method	Description
boolean	BaseConnection.connect(IScope newScope)	Connect to another scope on server
boolean	BaseConnection.connect(IScope newScope, Object[] params)	Connect to another scope on server with given parameters
Set<IConnection>	Client.getConnections(IScope scope)	Return client connections to given scope
void	Server.notifyScopeCreated(IScope scope)	Notify listeners about a newly created scope.
void	Server.notifyScopeRemoved(IScope scope)	Notify listeners that a scope was removed.

Uses of IScope in org.red5.server.adapter

Methods in org.red5.server.adapter that return IScope

Modifier and Type	Method	Description
abstract IScope	AbstractScopeAdapter.getScope()

Methods in org.red5.server.adapter with parameters of type IScope

Modifier and Type	Method	Description
boolean	IApplication.appJoin(IClient client, IScope app)	Called every time client joins app level scope
void	IApplication.appLeave(IClient client, IScope app)	Called every time client leaves the application scope
boolean	IApplication.appStart(IScope app)	Called once when application or room starts
void	IApplication.appStop(IScope app)	Called on application stop
boolean	AbstractScopeAdapter.connect(IConnection conn, IScope scope, Object[] params)	Called just before every connection to a scope.
void	AbstractScopeAdapter.disconnect(IConnection conn, IScope scope)	Called just after the a connection is disconnected.
boolean	AbstractScopeAdapter.join(IClient client, IScope scope)	Called just before a client enters the scope.
void	AbstractScopeAdapter.leave(IClient client, IScope scope)	Called just after the client leaves the scope.
boolean	IApplication.roomJoin(IClient client, IScope room)	Called when user joins room scope
void	IApplication.roomLeave(IClient client, IScope room)	Called when user leaves room scope
boolean	IApplication.roomStart(IScope room)	Called on application room start
void	IApplication.roomStop(IScope room)	Called on room scope stop
boolean	AbstractScopeAdapter.start(IScope scope)	Called when a scope is created for the first time.
void	AbstractScopeAdapter.stop(IScope scope)	Called just before a scope is disposed.

Uses of IScope in org.red5.server.api

Methods in org.red5.server.api that return IScope

Modifier and Type	Method	Description
IScope	IConnection.getScope()	Get the scope this is connected to.
IScope	Red5.getScope()	Get the scope
IScope	IContext.resolveScope(String path)	Returns scope by path.
IScope	IContext.resolveScope(IScope root, String path)	Returns scope by path from given root.

Methods in org.red5.server.api that return types with arguments of type IScope

Modifier and Type	Method	Description
Collection<IScope>	IClient.getScopes()	Get a set of scopes the client is connected to.

Methods in org.red5.server.api with parameters of type IScope

Modifier and Type	Method	Description
boolean	IConnection.connect(IScope scope)	Try to connect to the scope.
boolean	IConnection.connect(IScope scope, Object[] params)	Try to connect to the scope with a list of connection parameters.
Set<IConnection>	IClient.getConnections(IScope scope)	Get a set of connections of a given scope.
IScope	IContext.resolveScope(IScope root, String path)	Returns scope by path from given root.

Uses of IScope in org.red5.server.api.listeners

Methods in org.red5.server.api.listeners with parameters of type IScope

Modifier and Type	Method	Description
void	IScopeListener.notifyScopeCreated(IScope scope)	A scope has been created.
void	ScopeListenerAdapter.notifyScopeCreated(IScope scope)
void	IScopeListener.notifyScopeRemoved(IScope scope)	A scope has been removed.
void	ScopeListenerAdapter.notifyScopeRemoved(IScope scope)

Uses of IScope in org.red5.server.api.scope

Subinterfaces of IScope in org.red5.server.api.scope

Modifier and Type	Interface	Description
interface	IGlobalScope	The global scope that acts as root for all applications in a host.

Methods in org.red5.server.api.scope that return IScope

Modifier and Type	Method	Description
IScope	IBasicScope.getParent()	Get this scopes parent.
IScope	IScope.getScope(String name)	Return scope by name

Methods in org.red5.server.api.scope with parameters of type IScope

Modifier and Type	Method	Description
boolean	IScopeSecurityHandler.allowed(IScope conn)	Determines whether or not a given scope is allowed.
boolean	IScopeHandler.connect(IConnection conn, IScope scope, Object[] params)	Called just before every connection to a scope.
void	IScopeHandler.disconnect(IConnection conn, IScope scope)	Called just after the a connection is disconnected.
boolean	IBasicScope.isScopeAllowed(IScope scope)	Provides a means to allow a scope to perform processing on another scope prior to additional scope handling.
boolean	IScopeHandler.join(IClient client, IScope scope)	Called just before a client enters the scope.
void	IScopeHandler.leave(IClient client, IScope scope)	Called just after the client leaves the scope.
void	IScopeAware.setScope(IScope scope)	Set the scope the object is located in.
boolean	IScopeHandler.start(IScope scope)	Called when a scope is created for the first time.
void	IScopeHandler.stop(IScope scope)	Called just before a scope is disposed.

Uses of IScope in org.red5.server.api.service

Methods in org.red5.server.api.service with parameters of type IScope

Modifier and Type	Method	Description
IBroadcastStream	IBroadcastStreamService.getBroadcastStream(IScope scope, String name)	Get a broadcast stream by name
Set<String>	IBroadcastStreamService.getBroadcastStreamNames(IScope scope)	Get a set containing the names of all the broadcasts
Set<IBroadcastStream>	IBroadcastStreamService.getBroadcastStreams(IScope scope)	Returns broadcast streams registered on the scope.
IOnDemandStream	IOnDemandStreamService.getOnDemandStream(IScope scope, String name)	Get a stream that can be used for playback of the on-demand stream
ISubscriberStream	ISubscriberStreamService.getSubscriberStream(IScope scope, String name)	Returns a stream that can subscribe a broadcast stream with the given name using "IBroadcastStream.subscribe".
boolean	IBroadcastStreamService.hasBroadcastStream(IScope scope, String name)	Does the scope have a broadcast stream registered with a given name
boolean	IOnDemandStreamService.hasOnDemandStream(IScope scope, String name)	Has the service an on-demand stream with the passed name?
boolean	IServiceInvoker.invoke(IServiceCall call, IScope scope)	Execute the passed service call in the given scope.
static void	ServiceUtils.invokeOnAllConnections(IScope scope, String method, Object[] params)	Deprecated. Use ServiceUtils.invokeOnAllScopeConnections(IScope, String, Object[], IPendingServiceCallback) instead
static void	ServiceUtils.invokeOnAllConnections(IScope scope, String method, Object[] params, IPendingServiceCallback callback)	Invoke a method on all connections to a given scope and handle result.
static void	ServiceUtils.invokeOnAllScopeConnections(IScope scope, String method, Object[] params, IPendingServiceCallback callback)	Invoke a method on all connections of a scope and handle result.
static void	ServiceUtils.invokeOnClient(IClient client, IScope scope, String method, Object[] params)	Invoke a method on all connections of a client to a given scope.
static void	ServiceUtils.invokeOnClient(IClient client, IScope scope, String method, Object[] params, IPendingServiceCallback callback)	Deprecated. Use ServiceUtils.invokeOnAllScopeConnections(IScope, String, Object[], IPendingServiceCallback) instead
static void	ServiceUtils.notifyOnAllConnections(IScope scope, String method, Object[] params)	Deprecated. Use ServiceUtils.notifyOnAllScopeConnections(IScope, String, Object[]) instead
static void	ServiceUtils.notifyOnAllScopeConnections(IScope scope, String method, Object[] params)	Notify a method on all connections of a scope.
static void	ServiceUtils.notifyOnClient(IClient client, IScope scope, String method, Object[] params)	Deprecated. Use ServiceUtils.notifyOnAllScopeConnections(IScope, String, Object[]) instead

Uses of IScope in org.red5.server.api.so

Methods in org.red5.server.api.so with parameters of type IScope

Modifier and Type	Method	Description
boolean	ISharedObjectService.clearSharedObjects(IScope scope, String name)	Deletes persistent shared objects specified by name and clears all properties from active shared objects (persistent and nonpersistent).
boolean	ISharedObjectService.createSharedObject(IScope scope, String name, boolean persistent)	Create a new shared object.
ISharedObject	ISharedObjectService.getSharedObject(IScope scope, String name)	Get a shared object by name.
ISharedObject	ISharedObjectService.getSharedObject(IScope scope, String name, boolean persistent)	Get a shared object by name and create it if it doesn't exist.
Set<String>	ISharedObjectService.getSharedObjectNames(IScope scope)	Get a set of the shared object names.
boolean	ISharedObjectService.hasSharedObject(IScope scope, String name)	Check if a shared object exists.
boolean	ISharedObjectSecurity.isCreationAllowed(IScope scope, String name, boolean persistent)	Check if the a shared object may be created in the given scope.

Uses of IScope in org.red5.server.api.stream

Methods in org.red5.server.api.stream that return IScope

Modifier and Type	Method	Description
IScope	IStream.getScope()	Get the scope this stream is associated with.

Methods in org.red5.server.api.stream with parameters of type IScope

Modifier and Type	Method	Description
String	IStreamFilenameGenerator.generateFilename(IScope scope, String name, String extension, IStreamFilenameGenerator.GenerationType type)	Generate a filename with an extension.
String	IStreamFilenameGenerator.generateFilename(IScope scope, String name, IStreamFilenameGenerator.GenerationType type)	Generate a filename without an extension.
boolean	IRtmpSampleAccess.isAudioAllowed(IScope scope)	Return true if sample access allowed on audio stream.
boolean	IStreamPlaybackSecurity.isPlaybackAllowed(IScope scope, String name, int start, int length, boolean flushPlaylist)	Check if playback of a stream with the given name is allowed.
boolean	IStreamPublishSecurity.isPublishAllowed(IScope scope, String name, String mode)	Check if publishing a stream with the given name is allowed.
boolean	IRtmpSampleAccess.isVideoAllowed(IScope scope)	Return true if sample access allowed on video stream.

Uses of IScope in org.red5.server.exception

Constructors in org.red5.server.exception with parameters of type IScope

Modifier	Constructor	Description
	ScopeNotFoundException(IScope scope, String childName)	Create exception from given scope object and given child subscope
	ScopeShuttingDownException(IScope scope)	Create exception from given scope object

Uses of IScope in org.red5.server.jmx.mxbeans

Methods in org.red5.server.jmx.mxbeans with parameters of type IScope

Modifier and Type	Method	Description
boolean	ApplicationMXBean.appJoin(IClient client, IScope app)
void	ApplicationMXBean.appLeave(IClient client, IScope app)
boolean	ApplicationMXBean.appStart(IScope app)
void	ApplicationMXBean.appStop(IScope app)
boolean	ApplicationMXBean.roomJoin(IClient client, IScope room)
void	ApplicationMXBean.roomLeave(IClient client, IScope room)
boolean	ApplicationMXBean.roomStart(IScope room)
void	ApplicationMXBean.roomStop(IScope room)

Uses of IScope in org.red5.server.net.rtmp

Methods in org.red5.server.net.rtmp with parameters of type IScope

Modifier and Type	Method	Description
boolean	RTMPConnection.connect(IScope newScope, Object[] params)
boolean	RTMPMinaConnection.connect(IScope newScope, Object[] params)

Uses of IScope in org.red5.server.persistence

Constructors in org.red5.server.persistence with parameters of type IScope

Modifier	Constructor	Description
	RamPersistence(IScope scope)	Creates RAM persistence object from scope

Uses of IScope in org.red5.server.scope

Classes in org.red5.server.scope that implement IScope

Modifier and Type	Class	Description
class	Scope	The scope object.

Fields in org.red5.server.scope declared as IScope

Modifier and Type	Field	Description
protected IScope	BasicScope.parent	Parent scope.

Methods in org.red5.server.scope that return IScope

Modifier and Type	Method	Description
IScope	BasicScope.getParent()	Get this scopes parent.
IScope	Scope.getParent()	Return parent scope
IScope	Scope.getScope(String name)	Return child scope by name

Methods in org.red5.server.scope with parameters of type IScope

Modifier and Type	Method	Description
boolean	ScopeSecurityHandler.allowed(IScope scope)
boolean	BasicScope.isScopeAllowed(IScope scope)	Provides a means to allow a scope to perform processing on another scope prior to additional scope handling.
void	Scope.setParent(IScope parent)	Setter for parent scope

Constructors in org.red5.server.scope with parameters of type IScope

Modifier	Constructor	Description
	BasicScope(IScope parent, ScopeType type, String name, boolean persistent)	Constructor for basic scope
	Scope(IScope parent, ScopeType type, String name, boolean persistent)	Creates scope via parameters.

Uses of IScope in org.red5.server.service

Methods in org.red5.server.service with parameters of type IScope

Modifier and Type	Method	Description
boolean	ServiceInvoker.invoke(IServiceCall call, IScope scope)	Execute the passed service call in the given scope.
Object	IServiceResolver.resolveService(IScope scope, String serviceName)	Search for a service with the given name in the scope.

Uses of IScope in org.red5.server.so

Methods in org.red5.server.so with parameters of type IScope

Modifier and Type	Method	Description
boolean	SharedObjectService.clearSharedObjects(IScope scope, String name)	Deletes persistent shared objects specified by name and clears all properties from active shared objects (persistent and nonpersistent).
boolean	SharedObjectService.createSharedObject(IScope scope, String name, boolean persistent)	Create a new shared object.
ISharedObject	SharedObjectService.getSharedObject(IScope scope, String name)	Get a shared object by name.
ISharedObject	SharedObjectService.getSharedObject(IScope scope, String name, boolean persistent)	Get a shared object by name and create it if it doesn't exist.
Set<String>	SharedObjectService.getSharedObjectNames(IScope scope)	Get a set of the shared object names.
boolean	SharedObjectService.hasSharedObject(IScope scope, String name)	Check if a shared object exists.

Constructors in org.red5.server.so with parameters of type IScope

Modifier	Constructor	Description
	SharedObjectScope(IScope parent, String name, boolean persistent, IPersistenceStore store)	Creates shared object with given parent scope, name, persistence flag state and store object

Uses of IScope in org.red5.server.stream

Methods in org.red5.server.stream that return IScope

Modifier and Type	Method	Description
IScope	AbstractStream.getScope()	Return scope.

Methods in org.red5.server.stream with parameters of type IScope

Modifier and Type	Method	Description
String	DefaultStreamFilenameGenerator.generateFilename(IScope scope, String name, String extension, IStreamFilenameGenerator.GenerationType type)	Generate a filename with an extension.
String	DefaultStreamFilenameGenerator.generateFilename(IScope scope, String name, IStreamFilenameGenerator.GenerationType type)	Generate a filename without an extension.
IBroadcastScope	StreamService.getBroadcastScope(IScope scope, String name)	Return broadcast scope object for given scope and child scope name.
Set<String>	IProviderService.getBroadcastStreamNames(IScope scope)	Get names of existing broadcast streams in a scope.
IMessageInput	IProviderService.getLiveProviderInput(IScope scope, String name, boolean needCreate)	Get a named Live provider as the source of input.
IMessageInput	IProviderService.getProviderInput(IScope scope, String name)	Get a named provider as the source of input.
protected File	ClientBroadcastStream.getRecordFile(IScope scope, String name)	Get the file we'd be recording to based on scope and given name.
static File	RecordingListener.getRecordFile(IScope scope, String name)	Get the file we'd be recording to based on scope and given name.
File	IProviderService.getVODProviderFile(IScope scope, String name)	Get a named VOD source file.
IMessageInput	IProviderService.getVODProviderInput(IScope scope, String name)	Get a named VOD provider as the source of input.
boolean	IRecordingListener.init(IScope scope, String name, boolean isAppend)	Initialize the listener.
boolean	RecordingListener.init(IScope scope, String name, boolean isAppend)	Initialize the listener.
IProviderService.INPUT_TYPE	IProviderService.lookupProviderInput(IScope scope, String name, int type)	Returns the input type for a named provider if a source of input exists.
boolean	IProviderService.registerBroadcastStream(IScope scope, String name, IBroadcastStream stream)	Register a broadcast stream to a scope.
void	AbstractStream.setScope(IScope scope)	Setter for scope.
boolean	IProviderService.unregisterBroadcastStream(IScope scope, String name)	Unregister a broadcast stream of a specific name from a scope.
boolean	IProviderService.unregisterBroadcastStream(IScope scope, String name, IBroadcastStream stream)	Unregister a broadcast stream of a specific name from a scope.

Uses of IScope in org.red5.server.stream.consumer

Methods in org.red5.server.stream.consumer with parameters of type IScope

Modifier and Type	Method	Description
void	FileConsumer.setScope(IScope scope)	Sets the scope for this consumer.
void	SlicedFileConsumer.setScope(IScope scope)	Sets the scope for this consumer.

Constructors in org.red5.server.stream.consumer with parameters of type IScope

Modifier	Constructor	Description
	FileConsumer(IScope scope, File file)	Creates file consumer
	FileConsumer(IScope scope, String fileName, String mode)	Creates file consumer
	SlicedFileConsumer(IScope scope, File file)	Creates file consumer
	SlicedFileConsumer(IScope scope, String fileName, String mode)	Creates file consumer

Uses of IScope in org.red5.server.util

Methods in org.red5.server.util that return IScope

Modifier and Type	Method	Description
static IScope	ScopeUtils.findApplication(IScope from)	Returns the application scope for specified scope.
static IScope	ScopeUtils.findRoot(IScope from)	Finds root scope for specified scope object.
static IScope	ScopeUtils.resolveScope(IScope from, String path)	Resolves scope for specified scope and path.

Methods in org.red5.server.util with parameters of type IScope

Modifier and Type	Method	Description
static IScope	ScopeUtils.findApplication(IScope from)	Returns the application scope for specified scope.
static IScope	ScopeUtils.findRoot(IScope from)	Finds root scope for specified scope object.
static Object	ScopeUtils.getScopeService(IScope scope, Class<?> intf)	Returns scope service that implements a given interface.
static Object	ScopeUtils.getScopeService(IScope scope, Class<?> intf, boolean checkHandler)
static Object	ScopeUtils.getScopeService(IScope scope, Class<?> intf, Class<?> defaultClass)	Returns scope service that implements a given interface.
static Object	ScopeUtils.getScopeService(IScope scope, Class<?> intf, Class<?> defaultClass, boolean checkHandler)
protected static Object	ScopeUtils.getScopeService(IScope scope, String name)	Returns scope service by bean name.
protected static Object	ScopeUtils.getScopeService(IScope scope, String name, Class<?> defaultClass)	Returns scope services (e.g.
static IScope	ScopeUtils.resolveScope(IScope from, String path)	Resolves scope for specified scope and path.