ESNetscapePluginStream

Inherits fromNSObject
FrameworkFlashInApp.framework
Declared in ESNetscapePluginStream.h
Companion guideFlash’In’App Programming Guide 
Required system version Mac OS X 10.4 and higher

 

Class description of ESNetscapePluginStream


ESNetscapePluginStream class is assigned to load and send data to NetscapePlugin. SWF file and certain external resources, which are required by Flash movie, are loaded through ESNetscapePluginStream.

 

Tasks of ESNetscapePluginStream


Configuring stream

Starting and canceling

Delivering data

 

Instance Methods


setRequestUrl:

Sets requested URL.

 – (void)setRequestURL:(NSURL *)theRequestURL;

Parameters

theRequestURL – requested URL

Discussion

This method is called internally and should not be accessed directly.

 

requestURL 

Returns the requested URL.

 – (NSURL *) requestURL;

Return Value

The requested URL.

 

setResponseURL:

Sets the response URL of the receiver.

 – (void)setResponseURL:(NSURL *)theResponseURL;

Parameters

theResponseURL – response URL

Discussions

This method is called internally and should not be accessed directly. If you have a requirement to replace the response URL, please, use startStreamWithResponse: instead, however this can be done only if flashView:shouldLoadRequest:onTarget: returns StreamLoadType_External

 
responseURL

Returns responsed URL.

 – (NSURL *) responseURL;

Return Value

The responsed URL.

 
receivedData:

Passes a portion of data to plugin.

 – (void)receivedData:(NSData *)data;

Parameters

data – portion of data which will be sent to plugin

Discussion

This method means that a file was not received totally, it passes a portion of data to plugin.

 

startStreamWithResponse:

This method starts loading data with a certain response.

 – (void)startStreamWithResponse:(NSURLResponse *)r;

Parameters

r – URL response

Discussion

This method is required to initialize Stream object.

 


destroyStreamWithError:

DestroyStreamWithError tells the plug-in that the load is completed (error == nil) or ended in error.

– (void)destroyStreamWithError:(NSError *)error;

Parameters

An error object containing details of why the connection failed to load the request successfully.

 

start

Starts internal loading.

– (void)start;

Discussion

Internal use only, should not be publicly accessed.

 
stop

Stops internal loading.

– (void)stop;

Discussion

Internal use only, should not be publicly accessed.

 

finishedLoadingWithData:

Notifies Stream object that data loading is finished.

– (void)finishedLoadingWithData:(NSData *)data;

Parameters

data – not used now (must be nil)

 

cancelLoadAndDestroyStreamWithError:

This will cancel loading any resources with ‘error’ argument, and destroy the Stream. You should call this in case there’s an error loading any resource.

– (void)cancelLoadAndDestroyStreamWithError:(NSError *)error;

Parameters

An error object containing details of why the connection failed to load the request successfully.