| Package | com.mi.rs.multiview.core |
| Interface | public interface IView extends IViewBasic, IScopeNode, IService, IService, IScope, flash.events.IEventDispatcher, flash.events.IEventDispatcher |
| Implementors | ViewBase |
| Property | Defined By | ||
|---|---|---|---|
 |
baseURL : String [read-only]
Returns the base URL to the service.
|
IService | |
|
camera : CameraSet
The camera property is used by this view to request scene renders.
|
IViewBasic | |
|
connectorName : String [read-only]
Returns the name of the current connector.
|
IService | |
|
defaultStateData : IStateData
The default state data for this IService instance.
|
IService | |
|
isRendering : Boolean [read-only]
Checks the view rendering status.
In HTTP mode: Returns true if the view is waiting for a rendered image
to return.
In RTMP mode: Always returns true.
|
IView | ||
|
isViewRunning : Boolean [read-only]
Returns true if the view is currently running.
|
IView | ||
|
options : ViewOptions [read-only]
Options for the view.
|
IView | ||
|
scene : IScene
The scene this view is connected to.
|
IView | ||
|
target : DisplayObjectContainer
The target is the container for the ImageRenderTarget
and Video components of the view.
|
IViewBasic | |
|
viewScope : IScope
The viewScope property is the same as the view defaultStateData property.
|
IView | ||
| Method | Defined By | ||
|---|---|---|---|
|
addCallback(callback:Function, stateData:IStateData = null, delayProcessing:Boolean = false):void
Adds a callback to the end of the callback queue.
|
IService | |
|
addCommand(cmd:ICommand, responseHandler:Function = null, stateData:IStateData = null, delayProcessing:Boolean = false):void
Adds a command to be processed.
|
IService | |
|
cancelCallback(callback:Function):Boolean
Cancels a registered process commands callback.
|
IService | |
|
render(force:Boolean = false):void
Initiates a render call to the server.The
returned image is displayed in the view target.
|
IViewBasic | |
|
startView(ignoreRenderRequest:Boolean = false):void
Starts the view if it is not running.
|
IView | ||
|
stopView():void
Stops the view from running, which prevents any further render operations
until the view is started again.
|
IView | ||
| isRendering | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesisRendering:Boolean [read-only]
Checks the view rendering status.
In HTTP mode: Returns true if the view is waiting for a rendered image to return.
In RTMP mode: Always returns true.
public function get isRendering():BooleanSee also
| isViewRunning | property |
isViewRunning:Boolean [read-only]
Returns true if the view is currently running.
public function get isViewRunning():Boolean| options | property |
options:ViewOptions [read-only]
Options for the view. This options set often has the IScene options as its parent.
public function get options():ViewOptions| scene | property |
scene:IScene
The scene this view is connected to. A view can have its scene set once only.
public function get scene():IScene public function set scene(value:IScene):void| viewScope | property |
viewScope:IScope
The viewScope property is the same as the view defaultStateData property. However, the viewScope property needs to be an IChainedStateData type. The viewScope property can be changed at any time.
public function get viewScope():IScope public function set viewScope(value:IScope):void| startView | () | method |
public function startView(ignoreRenderRequest:Boolean = false):void
Starts the view if it is not running. This function:
The view cannot render until this function is called. It is up to the user implementation to decide when this function should be called.
Parameters
ignoreRenderRequest:Boolean (default = false) |
See also
| stopView | () | method |
public function stopView():void
Stops the view from running, which prevents any further render operations until the view is started again.
When the view is not running, options can be changed without affecting the server or requesting a render.
See also