| Modifier and Type | Method and Description |
|---|---|
IScope |
BaseConnection.getScope()
Return the current scope.
|
| Modifier and Type | Method and Description |
|---|---|
Collection<IScope> |
Client.getScopes() |
| Modifier and Type | Method and 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.
|
| Modifier and Type | Field and Description |
|---|---|
protected IScope |
StatefulScopeWrappingAdapter.scope
Wrapped scope
|
| Modifier and Type | Method and Description |
|---|---|
IScope |
StatefulScopeWrappingAdapter.getChildScope(String name)
Return child scope
|
IScope |
StatefulScopeWrappingAdapter.getParent()
Return parent scope
|
IScope |
StatefulScopeWrappingAdapter.getScope()
Getter for wrapped scope
|
| Modifier and Type | Method and 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
|
void |
StatefulScopeWrappingAdapter.setScope(IScope scope)
Set the scope the object is located in.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
IScope |
IConnection.getScope()
Get the scope this is connected to.
|
IScope |
Red5.getScope()
Get the scope
|
IScope |
IContext.resolveScope(IScope root,
String path)
Returns scope by path from given root.
|
IScope |
IContext.resolveScope(String path)
Returns scope by path.
|
| Modifier and Type | Method and Description |
|---|---|
Collection<IScope> |
IClient.getScopes()
Get a set of scopes the client is connected to.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and Description |
|---|---|
void |
IScopeListener.notifyScopeCreated(IScope scope)
A scope has been created.
|
void |
IScopeListener.notifyScopeRemoved(IScope scope)
A scope has been removed.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
IGlobalScope
The global scope that acts as root for all applications in a host.
|
| Modifier and Type | Method and Description |
|---|---|
IScope |
IBasicScope.getParent()
Get this scopes parent.
|
IScope |
IScope.getScope(String name)
Return scope by name
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
IServiceInvoker.invoke(IServiceCall call,
IScope scope)
Execute the passed service call in the given scope.
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and Description |
|---|---|
IScope |
IStream.getScope()
Get the scope this stream is associated with.
|
| Modifier and Type | Method and Description |
|---|---|
String |
IStreamFilenameGenerator.generateFilename(IScope scope,
String name,
IStreamFilenameGenerator.GenerationType type)
Generate a filename without an extension.
|
String |
IStreamFilenameGenerator.generateFilename(IScope scope,
String name,
String extension,
IStreamFilenameGenerator.GenerationType type)
Generate a filename with 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.
|
| Constructor and 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
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
RTMPConnection.connect(IScope newScope,
Object[] params) |
boolean |
RTMPMinaConnection.connect(IScope newScope,
Object[] params) |
| Constructor and Description |
|---|
RamPersistence(IScope scope)
Creates RAM persistence object from scope
|
| Modifier and Type | Class and Description |
|---|---|
class |
Scope
The scope object.
|
| Modifier and Type | Field and Description |
|---|---|
protected IScope |
BasicScope.parent
Parent scope.
|
| Modifier and Type | Method and Description |
|---|---|
IScope |
Scope.getParent()
Return parent scope
|
IScope |
BasicScope.getParent()
Get this scopes parent.
|
IScope |
Scope.getScope(String name)
Return child scope by name
|
| Modifier and Type | Method and 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
|
| Constructor and Description |
|---|
BasicScope(IScope parent,
ScopeType type,
String name,
boolean persistent)
Constructor for basic scope
|
Builder(IScope parent,
ScopeType type,
String name,
boolean persistent) |
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and 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.
|
| Constructor and Description |
|---|
SharedObjectScope(IScope parent,
String name,
boolean persistent,
IPersistenceStore store)
Creates shared object with given parent scope, name, persistence flag state and store object
|
| Modifier and Type | Method and Description |
|---|---|
IScope |
AbstractStream.getScope()
Return scope.
|
| Modifier and Type | Method and Description |
|---|---|
String |
DefaultStreamFilenameGenerator.generateFilename(IScope scope,
String name,
IStreamFilenameGenerator.GenerationType type)
Generate a filename without an extension.
|
String |
DefaultStreamFilenameGenerator.generateFilename(IScope scope,
String name,
String extension,
IStreamFilenameGenerator.GenerationType type)
Generate a filename with 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.
|
static File |
RecordingListener.getRecordFile(IScope scope,
String name)
Get the file we'd be recording to based on scope and given name.
|
protected File |
ClientBroadcastStream.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.
|
| Modifier and Type | Method and Description |
|---|---|
void |
FileConsumer.setScope(IScope scope)
Sets the scope for this consumer.
|
| Constructor and Description |
|---|
FileConsumer(IScope scope,
File file)
Creates file consumer
|
| Modifier and Type | Method and 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.
|
| Modifier and Type | Method and 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.
|
Copyright © 2005–2017 Red5. All rights reserved.